Batch Status Enum

This section provides details on batch-level statuses when retrieving a disbursement by ID. Use these references to understand and handle the status field more effectively.

Status Values

Status	Description
`draft`	The batch was created but not yet finalized. Typically, additional steps—such as adding recipient details—may be needed before progressing.
`need_approval`	The batch is pending approval. It requires a review by an administrator or an automated process before it can move on.
`approved`	The batch has been approved and can now proceed to the next stage in the disbursement workflow.
`partially_success`	Some transactions in the batch succeeded, while others failed. You can inspect individual failures and attempt to resolve or retry them without impacting those that succeeded.
`success`	All transactions in the batch were processed successfully. No additional action is required, though you may still review transaction details for record-keeping.
`failed`	The batch failed entirely. Review error messages or logs to determine the failure point and retry if appropriate.
`need_revision`	The batch requires changes before it can proceed. This might be triggered by validation errors (e.g., incorrect amounts or missing info). Update the necessary fields and resubmit for approval if your workflow requires it.