Create a Direct Debit Authorization
Authorization
authorization Set Your Secret API Key
In: header
Header Parameters
A unique value, eg. a UUID.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Bill reference number for your payer. Must be at most 35 characters. Only alphanumeric characters and dashes are accepted. This must be unique for each new Direct Debit Authorization that you create.
^[a-zA-Z0-9\-]+$1 <= length <= 35Business unit identifier, where your organization uses one.
1 <= length <= 5Value in
- "SG"
- "MY"
- "HK"
- "KR"
- "AU"
- "US"
- "ID"
- "TW"
- "BR"
- "DK"
- "PH"
- "VN"
- "AE"
- "GB"
- "IN"
- "MX"
- "CN"
If the payer sets an expiry date earlier than this end date with their bank during authorization, Acme will fail this authorization.
dateA positive integer value in the specified currency's smallest unit. E.g. SGD $10 will be represented as 1000 (in cents). Some banks allow payers to set deduction limits when they are approving the Direct Debit Authorizations. If the payer sets a deduction limit that is lower than maxAmount, Acme will fail the Direct Debit Authorization. Deprecated: use precheckMinAmount and precheckMaxAmount instead.
1 <= value <= 20000000Three-letter ISO 4217 currency code in full uppercase. Currently supports SGD. Deprecated: use precheckCurrency instead.
Payer's name.
1 <= length <= 140Your payer's segment: RETAIL or CORPORATE.
Value in
- "CORPORATE"
- "RETAIL"
Your payer's bank SWIFT/BIC code. Use List Direct Debit Banks for the banks that support eGIRO and their current status.
^[A-Z0-9]{4}SG[A-Z0-9]{5}$1 <= lengthThree-letter ISO 4217 currency code in full uppercase. Currently supports SGD. This is required if either precheckMinAmount or precheckMaxAmount is set.
A positive integer value in the specified currency's smallest unit. E.g. SGD $10 will be represented as 1000 (in cents).
If you attempt to create a Direct Debit Payment (for this Direct Debit Authorization) with an amount greater than precheckMaxAmount, Acme will reject the Direct Debit Payment request. Use this as a guardrail to prevent yourself from overcharging your payers.
If the payer sets a deduction limit that is lower than precheckMaxAmount, precheckMaxAmount will be updated to the lower deduction limit.
If precheckMaxAmount is not set, it will be updated to the deduction limit set by the payer. If the payer does not set a deduction limit, and the payer's bank does not set a default deduction limit, Acme will set precheckMaxAmount to SGD $200,000.00.
1 <= value <= 20000000A positive integer value in the specified currency's smallest unit. E.g. SGD $10 will be represented as 1000 (in cents). Some banks allow payers to set deduction limits when they are approving Direct Debit Authorizations. If the payer sets a deduction limit that is lower than precheckMinAmount, Acme will fail the Direct Debit Authorization. If you attempt to create a Direct Debit Payment with an amount lower than precheckMinAmount, Acme will reject the Direct Debit Payment request.
1 <= value <= 20000000Payer will be redirected to this URL after they have authorized the Direct Debit Authorisation at their bank's website.
^[A-Za-z][A-Za-z0-9+\-\.]+:\/\/[^:\?\/]+(:[0-9]+)?((\/[^\/\?]*)*\/?(\?[^\?\/]*)?)?$0 <= length <= 2048Response Body
*/*
curl -X POST "https://example.com/v1/direct-debit-authorizations" \ -H "Content-Type: application/json" \ -d '{ "billReferenceNumber": "string", "endDate": "2019-08-24", "payerName": "string", "payerSegment": "CORPORATE", "payerSwiftBic": "string", "returnUrl": "string" }'{ "authorizeUrl": "string", "billReferenceNumber": "string", "cancelReturnUrl": "string", "cancelUrl": "string", "createdAt": "string", "endDate": "string", "failureReason": "string", "id": "string", "maxAmount": 0, "maxAmountCurrency": "string", "metadata": { "property1": "string", "property2": "string" }, "payerAuthorizedMaxAmount": 0, "payerBankAccountNumber": "string", "payerBankCode": "string", "payerIdHash": "string", "payerIdType": "string", "payerName": "string", "payerSegment": "string", "payerSwiftBic": "string", "precheckCurrency": "string", "precheckMaxAmount": 0, "precheckMinAmount": 0, "returnUrl": "string", "startDate": "string", "status": "string", "transactionReference": "string", "underlyingErrorMessage": "string", "updatedAt": "string"}