List Direct Debit Authorizations
GET/direct-debit-authorizations
List Direct Debit Authorizations
Request
Query Parameters
An object ID that is used as a cursor in pagination. For instance, if you make a list request and receive 100 objects, ending with obj_foo42, your subsequent call can include after=obj_foo42 in order to fetch the next page of the list.
Possible values: >= 1
and <= 100
Default value: 10
A limit on the number of objects to be returned, between 1 and 100.
Possible values: [ASC
, DESC
]
Default value: DESC
Sort list objects in either ascending or descending order.
Possible values: [REQUIRES_AUTHORIZATION
, PROCESSING
, SUCCEEDED
, FAILED
]
Responses
- 200
OK
Response Headers
Acme-Mode
string
Has the value LIVE if the data exists in live production mode or the value TEST if the data exists in test sandbox mode.
- application/json
- Schema
- Example (from schema)
Schema
Array [
PAYER_AUTHORIZATION_FAILED
: Payer has failed to authorize the Direct Debit Authorization.PAYER_AUTHORIZATION_TIMEOUT
: Acme did not receive an authorization response in time. Acme will wait up to 20 minutes forRETAIL
payer segment Direct Debit Authorizations, and up to 48 hours forCORPORATE
payer segment Direct Debit Authorizations.PAYER_SPECIFIED_LOWER_MAX_AMOUNT
: Payer has authorized the Direct Debit Authorization with a lower maximum amount than what is required.PAYER_SPECIFIED_EARLIER_END_DATE
: Payer has authorized the Direct Debit Authorization with an earlier end date than what is required.]
data
object[]
required
Possible values: Value must match regular expression ^[a-zA-Z0-9\-]{1,35}$
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.
Payer's bank SWIFT/BIC code
Your payer's segment: RETAIL or CORPORATE.
Payer's name
Payer's bank account number. This field is only set after the payer has approved the Direct Debit Authorization.
Hash value of the payer's identification number stored in the payer's bank system.
Possible values: [NRIC
, FIN
, PASSPORT
, UEN
]
Payer's identification type stored in the payer's bank system.
If status is FAILED, this provides additional information about the failure.
Payer will be redirected to this URL after they have authorized the Direct Debit Authorisation at their bank's website.
Payer will be redirected to this URL after they have cancelled the Direct Debit Authorisation at their bank's website. This is only present when DDA is being cancelled.
Possible values: [REQUIRES_AUTHORIZATION
, PROCESSING
, SUCCEEDED
, FAILED
]
Possible values: [SGD
]
Three-letter ISO 4217 currency code in full uppercase.
Possible values: [SGD
]
Three-letter ISO 4217 currency code in full uppercase.
Redirect payer to this URL for logging into their bank to perform authorization. This is only present when the DDA status is REQUIRES_AUTHORIZATION.
Redirect payer to this URL for logging into their bank to perform cancellation. This is only present when you request for cancellation.
{
"data": [
{
"id": "dda_0H3BQV117M511",
"billReferenceNumber": "A0012334455",
"payerSwiftBic": "DBSSSGSGXXX",
"payerSegment": "RETAIL",
"payerName": "Richard Hendricks",
"payerBankAccountNumber": "0052312891",
"payerIdHash": "a3f0d8331c9d860aa685df22501d80ef33aa15fa53df87017a5caeb226cc6e2a",
"payerIdType": "NRIC",
"failureReason": "string",
"returnUrl": "https://example.com/return",
"cancelReturnUrl": "https://example.com/return",
"status": "REQUIRES_AUTHORIZATION",
"startDate": "2023-04-24",
"maxAmount": 42000,
"maxAmountCurrency": "SGD",
"precheckMinAmount": 42000,
"precheckMaxAmount": 100000,
"precheckCurrency": "SGD",
"endDate": "2042-04-24",
"authorizeUrl": "https://redirect.tryacme.com/dda",
"cancelUrl": "https://redirect.tryacme.com/dda",
"createdAt": "2023-04-24T00:00:00.000000Z",
"updatedAt": "2023-04-24T00:00:00.000000Z"
}
],
"hasMore": true
}