Skip to main content


No description

union BatchStatus =
| BatchPending
| BatchProcessing
| BatchError
| BatchCompleted

Possible types

BatchCreated object

Batch has been created but is empty, it may not be submitted in this state.

BatchPending object

Batch is in a staging state awaiting submission. Payouts can be added and removed.

BatchProcessing object

Batch has been submitted for processing and payouts within the batch are being initiated

BatchError object

An error occured during the submission of a batch or it failed validation

BatchCompleted object

All payouts within a Batch have reached a final state, processing is complete