Get an order
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.
Authorization
ApiKeyAuth Your API key. Identifies your business; you never send a business id.
In: header
Path Parameters
The order id returned when you created the order.
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": "piggy-txn-88213", "type": "onramp", "status": "processing", "rate": "1538.46", "source": { "currency": "NGN", "amount": "150000" }, "destination": { "currency": "USDT", "network": "POLYGON", "amount": "97.50" }, "funding_account": { "account_name": "Shiga/Ada Obi", "account_number": "9901234567", "bank_name": "Rubies MFB", "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
NGN to crypto. Returns a virtual account for the customer to transfer into. Once it is funded, Pulse delivers crypto to the destination address. The virtual account remains valid for 30 minutes. Use its `expires_at` value as the exact deadline and require the customer to transfer `account.amount`. `reference` is your idempotency key. Send the same one again and you get the original order, not a second. Max 128 characters, and unique within your business across both flows. `nin` and `bvn` are required for regulatory purposes. Each value must contain 11 digits. Pulse encrypts both at rest and omits them from API responses.
List orders GET
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.