Sign in

v1

latestOpenAPI 3.0.32026-07-26214048.5 KB
Provider

List v2 payment orders (provider)

Returns a paginated list of payment orders assigned to the authenticated provider, in the v2 response schema. Requires a currency query parameter. Supports optional direction (onramp / offramp), search, export=csv, from/to date filters, and ordering (asc/desc).

get/provider/orders

Query parameters

currencystring required
Example:NGN

Fiat currency to filter orders by (e.g. NGN, KES).

pageinteger
pageSizeinteger
status'initiated' | 'deposited' | 'pending' | 'fulfilling' | 'fulfilled' | 'validated' | 'settling' | 'settled' | 'cancelled' | 'refunding' | 'refunded' | 'expired'
ordering'asc' | 'desc'
searchstring

Search by order ID, reference, or account identifier.

export'csv'

Pass export=csv with from and to to download a CSV export.

fromstring date

Start date for CSV export (YYYY-MM-DD). Required when export=csv.

tostring date

End date for CSV export (YYYY-MM-DD). Required when export=csv.

direction'onramp' | 'offramp'

Filter to onramp (fiat → crypto) or offramp (crypto → fiat). Omit to include both directions.

On stats endpoints, invalid values return 400 Bad Request. On list endpoints, values other than onramp or offramp are ignored (no direction filter).

HMAC (GET): the signed payload includes all query parameters—include direction when you send it (alongside timestamp, currency, etc.).

Response

Paginated list of orders

statusstring
messagestring

Example response

{
  "status": "success"
}