Get a Batch Payment
GET/payment-batches/:id
Get a Batch Payment
Request
Path Parameters
id stringrequired
Responses
- 200
OK
Response Headers
Acme-Mode
string
Has the value LIVE if the data exists in live production mode or the value TEST if the data exists in test sandbox mode.
- application/json
- Schema
- Example (from schema)
Schema
id string
Unique identifier for the object.
type string
Possible values: [ACT
, FAST
, PAYNOW
, TT
, MEPS
, GIRO
, MY_DUITNOW
]
Type of payment
paymentDate string
The date payment should be sent.
senderAccountId string
The Acme-specific internal id of the source bank account.
currency string
Three-letter ISO 4217 currency code in full uppercase. Must be a currency supported by the payment type.
For example, FAST only supports SGD
.
status string
Possible values: [OPEN
, PROCESSING
, SUBMITTED
, FAILED
, COMPLETED
]
Status of the batch
createdAt string
Time at which the object was created. In ISO 8601 format.
updatedAt string
Time at which the object was last updated. In ISO 8601 format.
{
"id": "bpmt_0FGDYHZMRZF49",
"type": "TT",
"paymentDate": "2024-12-31",
"senderAccountId": "intacc_0FGDYHZMRZF49",
"currency": "SGD",
"status": "SUBMITTED",
"createdAt": "2023-04-24T00:00:00.000000Z",
"updatedAt": "2023-04-24T00:00:00.000000Z"
}
Loading...