Concepts
Batch lifecycle
The states a batch and each payment go through.
A batch is a group of payments. You create it as a draft, submit it, and then it is approved, sent and settled. Each payment has its own status, so one failure never hides the rest.
Batch statuses
| Status | Meaning |
|---|---|
| Draft | Saved, not sent for approval. You can still change it on the website, submit it or cancel it. |
| PendingApproval | Waiting for the people your approval rules require. |
| Approved | Approved. The money is reserved and the batch is waiting to be sent. |
| Rejected | An approver rejected it. Nothing was paid. |
| Processing | Payments are being sent and settled. |
| Successful | Every payment was paid. |
| PartiallySuccessful | Some were paid and some failed. |
| Failed | No payment was paid. Reserved money is back in your balance. |
| Cancelled | Cancelled before it was sent. |
Payment statuses
| Status | Meaning |
|---|---|
| Pending | Not sent yet. |
| Processing | Sent, waiting for the result. |
| Success | Paid. |
| Failed | Not paid. failureCode and failureReason explain why. The money returns to your balance. |
| RetryPending | A temporary problem; we will try again. |
| Reversed | Paid and then returned. |
| Cancelled | Cancelled with the batch. |
Following a batch
Either fetch the batch (GET /api/v1/payout-batches/{id}) until it is no longer Processing, or subscribe to webhooks and be told the moment each payment succeeds or fails. Webhooks are better for anything you check often.