Create, price, submit, and cancel the payouts in a batch.
A payment sends money from your ledger account to one payee. It lives in a batch, and its amount is in the currency of the ledger account that funds it. Payment IDs start with P-. The payee chooses the payout method, and you can restrict methods per batch.
Create the payment as a DRAFT, check fees and FX with the dry run, then submit it. Read the isEditable, isSubmittable, and isCancellable flags on the payment to learn what you can do next.
| Status | Meaning |
|---|---|
DRAFT | Created and not submitted. You can edit, submit, or cancel it. |
SUBMITTED | Accepted for payout and being sent. Funding and payout-method checks happen in this state. |
WAITING_PAYABILITY | Auto-submitted, waiting for the payee to become payable. It is submitted automatically when they do. |
WAITING_PAYMENT_METHOD | Waiting for the payee to choose a valid payout method. |
WAITING_COMPLIANCE | Under compliance review by the payout provider. |
PROCESSING | Sent to the payout provider and in transit. |
COMPLETED | Delivered to the payee. |
FAILED | The payout attempt failed. You can submit it again or cancel it. |
RETURNED | Delivered, then returned by the receiving bank. You can submit it again or cancel it. |
RESTRICTED | The payee's country is in the batch's denied countries. |
CANCELLED | Cancelled. Final. |
EXPIRED | Not submitted, or not sent again, within your payment availability period. Final. |
Subscribe to payment-status-changed to follow a payment. See Creating and Submitting Payments and Payment Statuses.