Skip to main content
An order is the central transaction record. Create orders via POST /v1/orders; the API infers flow type from quote legs or a reserved quote_id.

Order types

Type is returned as type in API responses.

Response shape

List endpoints and webhooks return the summary shape. GET /v1/orders/:reference adds payin, recipient, and optional refund. Pass include=payout and/or include=timeline for those fields.

Creation flow

  1. QuotePOST /v1/orders/quote to lock pricing (Quotes)
  2. CreatePOST /v1/orders with quote_id or explicit from/to legs
  3. Pay in — Present payin instructions to the end user
  4. Confirm — Payment is auto-detected. Optionally call POST /v1/orders/:reference/fulfill if confirmation is delayed
  5. Settle — Listen for webhooks or poll the order
Use a unique merchant_reference and deduplicate retries on your side. See Idempotency.

Filtering and retrieval

GET /v1/orders supports pagination and filters by status, type, network_identifier, crypto_currency_symbol, fiat_currency_code, customer_reference, and date range (date_from / date_to as DD/MM/YYYY). See Listing orders.