Reference

Statuses

Every resource exposes an observable lifecycle state so you always know where a payment stands. Branch on these states in your integration — and write your code to tolerate states being added over time.

Order, deposit, and withdrawal statuses are PascalCase — note Canceled with one l — and KYC/KYB states are UPPERCASE. The API reference is the authoritative source for the current set of states. New states may appear as corridors and rails evolve, so treat any value you don't recognize as non-terminal and keep polling (or wait for the next webhook) rather than failing.

Order statuses

An order moves from creation through collection, exchange, and payout to a terminal outcome. The API reports this progress with a small, stable set of statuses — the many internal processing steps are collapsed into Processing, so you integrate against six values rather than the internal state machine. Pending, Processing, and Reviewing are transient; Success, Failed, and Canceled are terminal.

Pending Processing Reviewing Success Failed Canceled
StatusMeaningTerminal
PendingThe order is created and waiting for the origin funds to arrive.No
ProcessingFunds have arrived and the order is being worked through the corridor — the internal collection, exchange, and payout steps are reported as Processing (a few transient internal states report as Pending).No
ReviewingThe order is held for compliance review.No
SuccessFunds have been paid out to the destination. Nothing further will change.Yes
FailedThe order could not be completed. Any collected funds are returned per the corridor's rules.Yes
CanceledThe order was canceled before payout. It will not progress further.Yes

When filtering orders with GET /v1/orders?status=…, use these six values. For backward compatibility the filter also still accepts the older, more granular internal states (e.g. Exchanging, Withdrawn), but they are never returned when you read an order (detail or list) — a read order always carries one of the six statuses above.

Deposit statuses

A deposit tracks incoming origin funds against an order. It is Received once the money is confirmed and available to settle the order, and Success once fully processed.

Pending Received Success Failed
StatusMeaningTerminal
PendingA deposit is expected but the funds have not yet arrived on the rail.No
ProcessingFunds have arrived and are being confirmed and reconciled.No
ReceivedFunds are confirmed and available to settle the order.No
ReviewingThe deposit is held for compliance review.No
PendingCancelA cancellation has been requested and is being processed.No
SuccessThe deposit is fully processed. Nothing further will change.Yes
FailedThe deposit could not be processed — for example it was returned or reversed on the rail.Yes
CanceledThe deposit was canceled. It will not progress further.Yes

Withdrawal statuses

A withdrawal tracks the outbound payout leg to the destination. It ends in Success, Failed, Rejected, or Canceled.

Pending Processing Success Failed
StatusMeaningTerminal
PendingThe withdrawal is accepted and queued for processing.No
Pending2FAWaiting for two-factor approval. Approving via POST /v1/withdrawals/approve moves it to Pending.No
PendingVerificationWaiting for verification to complete before processing.No
ComplianceThe withdrawal is held for compliance checks.No
ReviewThe withdrawal is flagged for manual review.No
ReviewingThe withdrawal is under review.No
AcceptedThe withdrawal has been accepted for processing.No
ApprovedThe withdrawal has been approved and is proceeding to payout.No
PendingWithdrawalThe payout is queued on the destination rail.No
ProcessingThe payout has been submitted to the destination rail and is in flight.No
PendingCancelA cancellation has been requested and is being processed.No
SuccessFunds have been delivered to the destination. Nothing further will change.Yes
FailedThe payout could not be delivered — for example the destination was rejected by the rail.Yes
RejectedThe withdrawal was rejected during review or compliance checks.Yes
CanceledThe withdrawal was canceled before delivery. It will not progress further.Yes

KYC / KYB statuses

Identity verification for an entity uses UPPERCASE states. Poll the entity or subscribe to webhooks to react when it becomes APPROVED or REJECTED.

PENDING REVIEWING APPROVED REJECTED
StatusMeaningTerminal
PENDINGVerification has been requested and is awaiting the required information.No
IN_PROGRESSThe entity is completing the verification flow.No
REVIEWINGThe submitted information is being assessed.No
APPROVEDThe entity is verified and can transact.Yes
REJECTEDVerification did not pass. Follow up through your account contact to resolve.Yes
NOT_AVAILABLENo verification is available for this entity.No

These states are the public contract. Internal verification details — the checks performed, review reasons, and provider specifics — are not exposed on the API. Build against the states above only.

Deposit method deprecation

Deposit methods identify how origin funds reach us for a corridor. The generic method is being retired in favor of corridor-specific types.

The generic LOCALBANK deposit type is deprecated. Use the corridor-specific types instead — for example SEPA, PIX, and the country-specific bank types — which you can discover per currency via GET /v1/currencies/{currency}/payin-schema. Existing integrations must continue to handle LOCALBANK on historical records.

← Prev
Errors