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.

Send exactly one of beneficiary or recipient_id. A request with both, or with neither, returns bad_request. A business that pays its customers sends beneficiary. 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/offramp/orders" \  -H "Content-Type: application/json" \  -d '{    "reference": "string",    "quote_id": "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"  }}

Update a collection PATCH

Change the payout account or the status. A new `recipient_id` must be the same kind of payout account as the old one. It applies to payments that arrive after the change. Pulse holds payments that arrive while the collection is `disabled`.

Create an onramp order POST

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