Batches

Batches contain one or more Payments to be made to users from an Organisation's PAY Account.

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.	Update Batch details using PUT batches/{id} Add Payments using POST batches/{id}/payments Remove Payments using DELETE payments/{id}
OPEN	When a Batch is submitted for processing, it changes to an OPEN state. A Batch will remain OPEN as long as there are payments pending to non-6DOT50 members.	Read current Batch status using GET /batches/{id}
CLOSED	A Batch will have a CLOSED status when all payments in the Batch have been processed. A Batch becomes immutable once it is closed.	Read Batch details (history) using GET /batches/{id}.
CANCELLED	A Batch will only have a CANCELLED status if it was cancelled using the POST /batches/{id}/cancel operation. A Batch becomes immutable once it is cancelled and cannot be re-opened.	Read Batch details (history) using GET /batches/{id}.

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.