Orders

List orders

GET
/v1/orders

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.

Authorization

ApiKeyAuth
X-API-Key<token>

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

In: header

Query Parameters

reference?string

The filter matches reference exactly.

type?string

The filter selects one order flow.

Value in

  • "onramp"
  • "offramp"
from?string

Orders created at or after this RFC 3339 timestamp are included.

Formatdate-time
to?string

Orders created at or before this RFC 3339 timestamp are included.

Formatdate-time
per_page?integer

The page contains 20 orders by default and at most 100 orders.

Rangevalue <= 100
Default20
cursor?string

Pass the previous page's next_cursor value.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/orders"
{  "status": true,  "data": [    {      "id": "0198e2d0-1c4a-7f3b-9a2e-6b1d5c8e0f21",      "reference": "partner-order-88213",      "type": "onramp",      "status": "completed",      "rate": "1538.46",      "source": {        "currency": "NGN",        "amount": "150000"      },      "destination": {        "currency": "USDT",        "network": "POLYGON",        "amount": "97.499512"      },      "expires_at": "2026-07-28T10:32:00Z",      "created_at": "2026-07-28T10:02:00Z",      "updated_at": "2026-07-28T10:20:00Z"    }  ],  "meta": {    "next_cursor": "0198e2c1-8f7a-7c2d-b3e1-9a0f4d6c2b55"  }}

Get an order GET

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.

Create a quote POST

The endpoint locks a rate for one order. The quote expires after two minutes. The rate includes Pulse's pricing adjustment and applicable network conversion costs. No separate fee changes either quoted amount.