Docs
Orders

List orders

GET
/v1/orders

Your orders, newest first. Use it to reconcile a period, or to look one up by the reference you assigned when you created it.

Paging is cursor-based. Pass the next_cursor from one page as cursor on the next. When next_cursor is absent, you have reached the end. Ordering is newest first and stable, so a row added mid-pagination cannot shuffle earlier pages.

Filtering by reference returns at most one order, since a reference is unique within your business across both flows.

Authorization

ApiKeyAuth
X-API-Key<token>

Your API key. Identifies your business; you never send a business id.

In: header

Query Parameters

reference?string

Your reference, exact match.

type?string

Filter by flow.

Value in

  • "onramp"
  • "offramp"
from?string

RFC3339 timestamp, inclusive lower bound on creation time.

Formatdate-time
to?string

RFC3339 timestamp, inclusive upper bound on creation time.

Formatdate-time
per_page?integer

Page size. Values above 100 are reduced to 100.

Rangevalue <= 100
Default20
cursor?string

The next_cursor from the previous page.

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": "piggy-txn-88213",      "type": "onramp",      "status": "completed",      "rate": "1538.46",      "source": {        "currency": "NGN",        "amount": "150000"      },      "destination": {        "currency": "USDT",        "network": "POLYGON",        "amount": "97.50"      },      "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

Reads one of your orders, either flow. Scoped to your business; another business's order id returns 404, not 403. `destination.amount` is quoted, not delivered. Reconcile the delivered amount from the `order.completed` webhook.

Create a quote POST

Locks a rate for 10 minutes. The direction is inferred from the currency pair; exactly one side must be NGN. A quote is single-use, consumed by the order created against it. The rate is all-in: Pulse's pricing adjustment and any required network conversion cost are included in the rate. The API does not add a separate fee to the quoted source or destination amount. `network` is required and names the chain the crypto leg settles on. It is never inferred, since a wrong chain means unrecoverable funds. Onramp quotes support 10,000–100,000,000 NGN. Offramp quotes support a minimum of 10 USDC or USDT and a maximum amount whose NGN destination is 100,000,000.