Orders

Create an offramp order

POST
/v1/offramp/orders

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

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.

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/offramp/orders" \  -H "Content-Type: application/json" \  -d '{    "reference": "string",    "quote_id": "string",    "beneficiary": {      "name": "string",      "email": "user@example.com",      "nin": "string",      "bvn": "string",      "bank_account": {        "bank_code": "string",        "account_number": "string"      }    }  }'
{  "status": true,  "data": {    "id": "0198e400-3c2b-7d5e-9f01-2a3b4c5d6e7f",    "reference": "partner-order-88214",    "type": "offramp",    "status": "awaiting_payment",    "rate": "1383.05",    "source": {      "currency": "USDT",      "network": "POLYGON",      "amount": "100"    },    "destination": {      "currency": "NGN",      "amount": "138305"    },    "party": {      "name": "Ada Obi",      "email": "ada@example.com"    },    "funding_account": {      "deposit_address": "0xDeF0000000000000000000000000000000000000",      "network": "POLYGON"    },    "expires_at": "2026-07-30T12:10:00Z",    "created_at": "2026-07-30T11:40:00Z",    "updated_at": "2026-07-30T11:40:00Z"  }}

Resolve a bank account POST

Confirm an account and retrieve its registered name. Call this endpoint before you create an offramp order. Ask the customer to confirm the returned name.

Create an onramp order POST

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