Banks

Resolve a bank account

POST
/v1/banks/resolve

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.

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

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

List the codes accepted by `bank_account.bank_code`.

Create a collection POST

Give one of your users permanent payment details. The payout account in `recipient_id` decides the kind of collection: - A `bank_account` creates an `offramp` collection: permanent stablecoin deposit addresses. Each deposit becomes an offramp order that pays naira to the bank account. - A `crypto_address` creates an `onramp` collection: a permanent naira bank account. Each transfer becomes an onramp order that sends the payout account's stablecoin to its address. `reference` makes the request safe to retry. Sending the same `reference` with the same kind of payout account returns the existing collection and ignores the other fields.