CollectionsDirect DebitBatch Collections

List Batch Direct Debit Collections

GET
/v1/direct-debit-payment-batches

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-payment-batches"

One page of batches. payments is never included when listing.

{  "data": [    {      "id": "bddp_0J7Q8A2M8V5X1",      "type": "GIRO",      "paymentDate": "2026-09-10",      "currency": "SGD",      "status": "COMPLETED",      "createdAt": "2026-09-09T05:02:03.401556Z",      "updatedAt": "2026-09-10T02:30:11.004871Z",      "metadata": {        "fileName": "GP8120207003.xml"      }    }  ],  "hasMore": false}