CollectionsDirect DebitCollections

List Direct Debit Collections

"Direct Debit Payment" in the API path refers to a direct debit collection transaction where funds are collected from the debtor account.

GET
/v1/direct-debit-payments

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.

Formatint32
order?string

Sort list objects in either ascending or descending order.

Value in

  • "ASC"
  • "DESC"

Response Body

*/*

application/json

application/json

curl -X GET "https://example.com/v1/direct-debit-payments"

One page of collections.

{
  "data": [
    {
      "id": "dpymt_0J7Q7A2M8V5X1",
      "type": "FAST",
      "amount": 1250,
      "currency": "SGD",
      "directDebitAuthorizationId": "dda_0J7Q6A3M8V5X1",
      "customerReference": "SUB-2026-09",
      "receiver": {
        "bankAccountNumber": "0052312891"
      },
      "status": "SUCCEEDED",
      "resultCode": null,
      "underlyingErrorMessage": null,
      "createdAt": "2026-09-09T03:00:14.557605Z",
      "updatedAt": "2026-09-09T03:00:16.135109Z"
    },
    {
      "id": "dpymt_0J7Q7NF3H6D2V",
      "type": "FAST",
      "amount": 1250,
      "currency": "SGD",
      "directDebitAuthorizationId": "dda_0J7Q6A3M8V5X1",
      "customerReference": "SUB-2026-10",
      "receiver": {
        "bankAccountNumber": "0052312891"
      },
      "status": "FAILED",
      "resultCode": "INSUFFICIENT_FUNDS",
      "underlyingErrorMessage": "AM04: Insufficient funds",
      "createdAt": "2026-10-09T03:00:14.512879Z",
      "updatedAt": "2026-10-09T03:00:16.298416Z"
    }
  ],
  "hasMore": false
}