Skip to main content

Get a Direct Debit Authorization

GET 
https://api.tryacme.com/v1/direct-debit-authorizations/:id

Get a Direct Debit Authorization

Request​

Path Parameters

    id stringrequired

Responses​

OK

Response Headers
    Acme-Mode

    Has the value LIVE if the data exists in live production mode or the value TEST if the data exists in test sandbox mode.

Schema
    idstringrequired
    Example: dda_0H3BQV117M511
    billReferenceNumberstringrequired

    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.

    Possible values: Value must match regular expression ^[a-zA-Z0-9\-]{1,35}$

    Example: A0012334455
    payerSwiftBicstringrequired

    Payer's bank SWIFT/BIC code

    Example: DBSSSGSGXXX
    payerSegmentstringrequired

    Your payer's segment: RETAIL or CORPORATE.

    Example: RETAIL
    payerNamestringrequired

    Payer's name

    Example: Richard Hendricks
    payerBankAccountNumberstring

    Payer's bank account number. This field is only set after the payer has approved the Direct Debit Authorization.

    Example: 0052312891
    payerIdHashstring

    Hash value of the payer's identification number stored in the payer's bank system.

    Example: a3f0d8331c9d860aa685df22501d80ef33aa15fa53df87017a5caeb226cc6e2a
    payerIdTypestring

    Payer's identification type stored in the payer's bank system.

    Possible values: [NRIC, FIN, PASSPORT, UEN]

    failureReasonstring

    If status is FAILED, this provides additional information about the failure.

    • 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 for RETAIL payer segment Direct Debit Authorizations, and up to 48 hours for CORPORATE 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.
    returnUrlstringrequired

    Payer will be redirected to this URL after they have authorized the Direct Debit Authorisation at their bank's website.

    Example: https://example.com/return
    cancelReturnUrlstring

    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.

    Example: https://example.com/return
    statusstringrequired
    • REQUIRES_AUTHORIZATION: Requires the payer to perform authorization with their bank.
    • PROCESSING: A creation callback was received from the payer's bank. Normally, a DDA will transition very quickly from PROCESSING to SUBMITTED.
    • SUBMITTED: A DDA creation request was sent to the Industry Aggregator and is awaiting the final callback.
    • SUCCEEDED: The DDA has been created successfully with the bank and is ready to be used for creating Direct Debit Payments.
    • FAILED: The DDA creation failed. You should create a new DDA if you wish to try again.
    • CANCELED: The DDA has been canceled by the payer.

    Possible values: [REQUIRES_AUTHORIZATION, PROCESSING, SUBMITTED, SUCCEEDED, FAILED, CANCELED]

    startDatestringrequired
    Example: 2023-04-24
    maxAmountintegerrequired
    Example: 42000
    maxAmountCurrencystringrequired

    Three-letter ISO 4217 currency code in full uppercase.

    Possible values: [SGD]

    Example: SGD
    precheckMinAmountinteger
    Example: 42000
    precheckMaxAmountinteger
    Example: 100000
    precheckCurrencystring

    Three-letter ISO 4217 currency code in full uppercase.

    Possible values: [SGD]

    Example: SGD
    endDatestring
    Example: 2042-04-24
    authorizeUrlstring

    Redirect payer to this URL for logging into their bank to perform authorization. This is only present when the DDA status is REQUIRES_AUTHORIZATION.

    Example: https://redirect.tryacme.com/dda
    cancelUrlstring

    Redirect payer to this URL for logging into their bank to perform cancellation. This is only present when you request for cancellation.

    Example: https://redirect.tryacme.com/dda
    createdAtstringrequired
    Example: 2023-04-24T00:00:00.000000Z
    updatedAtstringrequired
    Example: 2023-04-24T00:00:00.000000Z

Authorization: http

name: authorizationtype: httpscheme: bearerdescription: Set Your Secret API KeybearerFormat: SECRET_API_KEY
curl -L 'https://api.tryacme.com/v1/direct-debit-authorizations/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>'
Request Collapse all
Base URL
https://api.tryacme.com/v1
Auth
Parameters
— pathrequired