Orders

Create an onramp order

POST
/v1/onramp/orders

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

Authorization

ApiKeyAuth
X-API-Key<token>

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

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Send exactly one of destination or recipient_id. A request with both, or with neither, returns bad_request. A business that pays its customers sends destination. A business that pays out only to its own accounts sends recipient_id.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/onramp/orders" \  -H "Content-Type: application/json" \  -d '{    "reference": "string",    "quote_id": "string",    "payer": {      "name": "string",      "email": "user@example.com",      "nin": "string",      "bvn": "string"    }  }'
{  "status": true,  "data": {    "id": "0198e2d0-1c4a-7f3b-9a2e-6b1d5c8e0f21",    "reference": "partner-order-88213",    "type": "onramp",    "status": "awaiting_payment",    "rate": "1538.46",    "source": {      "currency": "NGN",      "amount": "150000"    },    "destination": {      "currency": "USDT",      "network": "POLYGON",      "amount": "97.500097"    },    "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-30T12:12:00Z",    "created_at": "2026-07-30T11:32:00Z",    "updated_at": "2026-07-30T11:32:00Z"  }}

Create an offramp order POST

Collect crypto through a deposit address. Pulse pays NGN to the beneficiary after the crypto arrives.

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.