Create Debit Presentation

Initiates a debit presentation plan in the specified frequency against a registered eNACH mandate using the UMRN. This API is used to trigger fund collection based on mandate terms such as amount, frequency, and recurrence.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Unique Mandate Registration Number (UMRN) against which the debit presentation is to be created. This must reference an active and valid mandate.

double
required

The exact amount to be debited in each presentation. It should not exceed the maximumCollectionAmount defined in the mandate.

date-time
required

Indicates whether the debit presentation is recurring. Use "true" for recurring payments and "false" for one-time payments.

string
required

Indicates if the presentation is recurring. Acceptable values (true/false)

string
required

Frequency of debit presentations. Must be one of the following values: • onetime – Single debit only • daily – Every day • weekly – Every week • monthly – Once a month • quarterly – Every 3 months • half-yearly – Every 6 months • yearly – Once a yea

string
required

Total number of debit attempts to be made. For one-time debits, this should be 1. For recurring debits, it denotes the total number of cycles.

Headers
string
Defaults to {{X-Client-Key}}

API key generated from Castler dashboard

string
Defaults to {{x-api-key}}

X-API key generated from Castler dashboard

Response

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json