CollectionsDirect DebitAuthorizations
Cancel a Direct Debit Authorization
Authorization
authorization AuthorizationBearer <token>
Set Your Secret API Key
In: header
Path Parameters
id*string
Header Parameters
Idempotency-Key?string
A unique value, eg. a UUID.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
cancelReturnUrl*string
Payer will be redirected to this URL after they have cancelled the Direct Debit Authorisation at their bank's website. Conditionally required: not applicable for HK direct debit authorizations.
Match
^[A-Za-z][A-Za-z0-9+\-\.]+:\/\/[^:\?\/]+(:[0-9]+)?((\/[^\/\?]*)*\/?(\?[^\?\/]*)?)?$Length
0 <= length <= 2048country?string
Value in
- "SG"
- "MY"
- "HK"
- "KR"
- "AU"
- "US"
- "ID"
- "TW"
- "BR"
- "DK"
- "PH"
- "VN"
- "AE"
- "GB"
- "IN"
- "MX"
- "CN"
Response Body
*/*
curl -X POST "https://example.com/v1/direct-debit-authorizations/string/cancel" \ -H "Content-Type: application/json" \ -d '{ "cancelReturnUrl": "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"}