Orders

Get an order

GET
/v1/orders/{id}

Retrieve one order from either flow. An unknown order and another business's order both return 404.

The response reports the effective rate and destination amount. Late funding can change both values. The order.completed event confirms the delivered amount.

Authorization

ApiKeyAuth
X-API-Key<token>

The API key identifies your business. Requests do not include a business ID.

In: header

Path Parameters

id*string

The create response returns this order ID.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/orders/0198e2d0-1c4a-7f3b-9a2e-6b1d5c8e0f21"
{  "status": true,  "data": {    "id": "0198e2d0-1c4a-7f3b-9a2e-6b1d5c8e0f21",    "reference": "partner-order-88213",    "type": "onramp",    "status": "processing",    "rate": "1538.46",    "source": {      "currency": "NGN",      "amount": "150000"    },    "destination": {      "currency": "USDT",      "network": "POLYGON",      "amount": "97.499512"    },    "party": {      "name": "Ada Obi",      "email": "ada@example.com"    },    "funding_account": {      "account_name": "Ada Obi",      "account_number": "9901234567",      "bank_code": "090175",      "bank_name": "Rubies MFB",      "amount": "150000"    },    "expires_at": "2026-07-28T10:32:00Z",    "created_at": "2026-07-28T10:02:00Z",    "updated_at": "2026-07-28T10:12:00Z"  }}

Create an onramp order POST

Collect NGN through a virtual account. Pulse delivers crypto after the customer funds the account.

List orders GET

List your orders from newest to oldest. Filter by `reference` to find one order. Pass `next_cursor` as `cursor` on the next request. Stop when `next_cursor` is absent. New orders do not change earlier pages during pagination. A `reference` filter returns at most one order.