Statuses
Order and payout statuses returned on create, query, and webhooks.
Orders
| Status | Meaning |
|---|---|
pending | Created; quote not locked. |
awaiting_payment | Quote locked; waiting for funds. |
paid_partial | Part of the quote arrived and the timer is still running. Anything else sent to the same address counts. |
paid | The total received is within your tolerances of the quote, or a review was accepted. Balance reflects crypto received. |
paid_over | More than the quote plus overpay tolerance, accepted in review. |
review | Still short when the timer ended, over the overpay tolerance, or the wrong network or token. It waits for a person to accept or reject it, and anything sent to its address meanwhile counts. Do not fulfil yet. |
expired | Timer elapsed while still open. |
cancelled | Payer closed checkout. |
Payouts
| Status | Meaning |
|---|---|
awaiting_approval | Customer withdrawal created. The net USD amount is held until the merchant approves. |
pending | Approved, being handed to the network. |
submitted | Approved and sent on-chain. |
completed | On-chain confirmation received. |
rejected | Merchant declined. The held amount returns to the balance. |
failed | Did not complete. The held amount returns to the balance. |
Open vs terminal
Open orders are pending, awaiting_payment, and paid_partial. Reading an open order after expiry marks it expired and emits order.expired. A paid_partial order still short when the timer ends goes to review instead. review is held until someone accepts or rejects it, and it does not expire. Paid and paid_over cannot be cancelled (40900). There is no CRM refund endpoint in this API. Customer payouts are open as awaiting_approval, pending or submitted. Rejected and failed payouts return the held amount to the balance.
Matching events
Webhooks fire as order.paid, order.paid_partial, order.paid_over, order.review, order.expired, and order.cancelled. Payouts fire the same name as the row status: payout.awaiting_approval, payout.pending, payout.rejected, payout.submitted, payout.completed, and payout.failed. Full payloads on Payment notification and Payout notification.