CollectionsDirect DebitAuthorizations
List Direct Debit Authorizations
Authorization
authorization AuthorizationBearer <token>
Set Your Secret API Key
In: header
Query Parameters
after?string
An object ID used as a cursor in pagination. If a list request returns 100 objects ending with obj_0KSEVXZ2ZF0AV, a subsequent call can include after=obj_0KSEVXZ2ZF0AV to fetch the next page of the list.
limit?integer
A limit on the number of objects to be returned, between 1 and 100.
Format
int32order?string
Sort list objects in either ascending or descending order.
Value in
- "ASC"
- "DESC"
status?string
Filter by direct debit authorization status.
Value in
- "REQUIRES_AUTHORIZATION"
- "PROCESSING"
- "SUBMITTED"
- "SUCCEEDED"
- "FAILED"
- "REQUIRES_AUTHORIZATION_FOR_CANCELLATION"
- "CANCELED"
Response Body
*/*
curl -X GET "https://example.com/v1/direct-debit-authorizations"{ "data": [ { "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" } ], "hasMore": true}