Payments & Fund TransfersBatch Payments
List Batch Payments
Retrieve batch payments that you have created.
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"
Response Body
*/*
application/json
application/json
curl -X GET "https://example.com/v1/payment-batches"One page of batches. payments is never included when listing.
{
"data": [
{
"id": "bpmt_0J7Q4A2M8V5X1",
"type": "FAST",
"paymentDate": "2026-09-10",
"senderAccountId": "intacc_0H3BQY9BK1FCG",
"senderAccountCurrency": "SGD",
"currency": "SGD",
"status": "COMPLETED",
"createdAt": "2026-09-09T01:02:03.401556Z",
"updatedAt": "2026-09-10T02:30:11.004871Z"
},
{
"id": "bpmt_0J7Q4V2Q7Z3B5",
"type": "GIRO",
"paymentDate": "2026-09-10",
"senderAccountId": "intacc_0H3BQY9BK1FCG",
"senderAccountCurrency": "SGD",
"currency": "SGD",
"status": "FAILED",
"underlyingErrorMessage": "Rejected by bank: debit account not enabled for GIRO",
"createdAt": "2026-09-09T03:14:58.735201Z",
"updatedAt": "2026-09-09T03:20:02.118644Z"
}
],
"hasMore": false
}