Docs
Banks

Resolve a bank account

POST
/v1/banks/resolve

Confirms an account exists and returns the registered name. Call it before creating an offramp order so the customer can check the name first.

Authorization

ApiKeyAuth
X-API-Key<token>

Your API key. Identifies your business; you never send 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

curl -X POST "https://example.com/v1/banks/resolve" \  -H "Content-Type: application/json" \  -d '{    "bank_code": "string",    "account_number": "string"  }'
{  "status": true,  "data": {    "account_number": "0123456789",    "account_name": "ADA OBI",    "bank_code": "058",    "bank_name": "GTBank"  }}

List banks GET

The bank codes accepted by `bank_account.bank_code` on an offramp order.

Create an offramp order POST

Crypto to NGN. Returns a deposit address. Once the crypto arrives, Pulse settles NGN to the beneficiary's bank account. The account number is verified with the bank before the order is created. A wrong one fails with `account_verification_failed`; no order is created. Account numbers are 10 digits. Use `GET /v1/banks` for valid bank codes. `reference` is your idempotency key, unique within your business across both flows. `beneficiary.nin` and `beneficiary.bvn` are required for regulatory purposes. Pulse encrypts both at rest and omits them from API responses.