Payments & Fund TransfersBatch Payments

Close a Batch Payment

Close an open batch payment so no further payments can be added. Only batches in OPEN status can be closed.

POST
/v1/payment-batches/{id}/close

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.

Response Body

*/*

application/json

curl -X POST "https://example.com/v1/payment-batches/string/close"

The batch after closing. It moves from OPEN to PROCESSING and Acme starts building the file for the bank.

{
  "id": "bpmt_0J7Q4S9N4V7Y2",
  "type": "FAST",
  "paymentDate": "2026-09-10",
  "senderAccountId": "intacc_0H3BQY9BK1FCG",
  "senderAccountCurrency": "SGD",
  "currency": "SGD",
  "status": "PROCESSING",
  "createdAt": "2026-09-09T02:00:00.084512Z",
  "updatedAt": "2026-09-09T02:07:41.662090Z"
}