> For the complete documentation index, see [llms.txt](https://6dot50.gitbook.io/6dot50-apis/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://6dot50.gitbook.io/6dot50-apis/pay-api/batches.md).

# Batches

Batches contain **one or more Payments** to be made to users from an Organisation's PAY [Account](/6dot50-apis/accounts.md).&#x20;

### Batch Status Codes

Every Batch has a Status. Based on a Batch's status, certain operations can be performed against the Batch:

| Batch Status Code | Description                                                                                                                                                                                                                                                                          | Allowed Operations                                                                                                                                                                                                                                                                                                                                                                                     |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| DRAFT             | When a new Batch is created, it is created in a DRAFT status.                                                                                                                                                                                                                        | <p>Update Batch details using <a href="/6dot50-apis/pay-api/batches/put-batches-id.md"><code>PUT batches/{id}</code></a><br><br>Add Payments using <a href="/6dot50-apis/pay-api/batches/post-batches-id-payments.md"><code>POST batches/{id}/payments</code></a><br><br>Remove Payments using <a href="/6dot50-apis/pay-api/payments/delete-payments-id.md"><code>DELETE payments/{id}</code></a></p> |
| OPEN              | <p>When a Batch is submitted for processing, it changes to an OPEN state.<br><br>A Batch will remain OPEN as long as there are payments pending to non-6DOT50 members.</p>                                                                                                           | Read current Batch status using [`GET /batches/{id}`](/6dot50-apis/pay-api/batches/get-batches-id.md)                                                                                                                                                                                                                                                                                                  |
| CLOSED            | <p>A Batch will have a CLOSED status when all payments in the Batch have been processed.<br><br>A Batch becomes immutable once it is closed.</p>                                                                                                                                     | Read Batch details (history) using [`GET /batches/{id}`](/6dot50-apis/pay-api/batches/get-batches-id.md).                                                                                                                                                                                                                                                                                              |
| CANCELLED         | <p>A Batch will only have a CANCELLED status if it was cancelled using the <a href="/6dot50-apis/pay-api/batches/post-batches-id-cancel.md"><code>POST /batches/{id}/cancel</code></a> operation.<br><br>A Batch becomes immutable once it is cancelled and cannot be re-opened.</p> | Read Batch details (history) using [`GET /batches/{id}`](/6dot50-apis/pay-api/batches/get-batches-id.md).                                                                                                                                                                                                                                                                                              |

{% hint style="info" %}
Creating a Batch does not immediately initiate any payments to users. Payments will only be made if the Batch is submitted for processing using [`POST /batches/{id}/submit`](/6dot50-apis/pay-api/batches/post-batches-id-submit.md).
{% endhint %}
