Skip to main content
GET
List v2 payment orders (provider)
On provider order endpoints, transactionFee is the protocol fee deducted from that order, net of any rebate once the order is settled. Before settlement it reflects the gross fee.

Authorizations

API-Key
string
header
required

Query Parameters

currency
string
required

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

Example:

"NGN"

page
integer
default:1
pageSize
integer
default:10
status
enum<string>
Available options:
initiated,
deposited,
pending,
fulfilling,
fulfilled,
validated,
settling,
settled,
cancelled,
refunding,
refunded,
expired
ordering
enum<string>
default:desc
Available options:
asc,
desc

Search by order ID, reference, or account identifier.

export
enum<string>

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

Available options:
csv
from
string<date>

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

to
string<date>

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

direction
enum<string>

Filter to on-ramp (fiat → crypto) or off-ramp (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.).

Available options:
onramp,
offramp

Response

Paginated list of orders

status
string
Example:

"success"

message
string
data
object