Skip to main content

Cancel a Direct Debit Authorization

POST 
/direct-debit-authorizations/:id/cancel

Cancel a Direct Debit Authorization

Request​

Path Parameters

    id stringrequired

Header Parameters

    Idempotency-Key string

    A unique value, eg. a UUID.

Body

    cancelReturnUrl stringrequired

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

Responses​

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.

Schema

    id stringrequired
    billReferenceNumber stringrequired

    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.

    payerSwiftBic stringrequired

    Payer's bank SWIFT/BIC code

    payerSegment stringrequired

    Your payer's segment: RETAIL or CORPORATE.

    payerName stringrequired

    Payer's name

    payerBankAccountNumber string

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

    payerIdHash string

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

    payerIdType string

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

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

    failureReason string

    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.
    returnUrl stringrequired

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

    cancelReturnUrl string

    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.

    status stringrequired

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

    • 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.
    startDate stringrequired
    maxAmount integerrequired
    maxAmountCurrency stringrequired

    Possible values: [SGD]

    Three-letter ISO 4217 currency code in full uppercase.

    precheckMinAmount integer
    precheckMaxAmount integer
    precheckCurrency string

    Possible values: [SGD]

    Three-letter ISO 4217 currency code in full uppercase.

    endDate string
    authorizeUrl string

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

    cancelUrl string

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

    createdAt stringrequired
    updatedAt stringrequired
Loading...