A Batch is a grouping for any transactions that took place within a certain timeframe. Batches do not directly contain a collection of transactions. Instead, a transaction is associated with a Batch automatically when the transaction is created.
Properties
| Property | Type | Description | Example |
|---|---|---|---|
id | Number(integer) | A read-only unique identifier. | 1234567890 |
status | String | Read-only. "open", "closed" | "open" |
date_opened | String(YYYY-MM-DD HH:MM:SS) | The date that the batch was created. | "2023-01-01 05:06:07" |
date_closed | String(YYYY-MM-DD HH:MM:SS) | The date that the batch was closed. | "2023-01-02 05:06:07" |
external_id | String | Unique identifier used to look up batch. This is not generated by PaidYET. | "1234567890" |
Example
{
"id": 1234567890,
"status": "open",
"date_opened": "2023-01-01 05:06:07",
"date_closed": "2023-01-01 05:06:07",
"external_id": "1234567890"
}