Docs

Banks

List valid bank codes, and resolve an account before an offramp.

Two endpoints support offramp payouts. List the banks Pulse accepts, and resolve an account to confirm it exists and read its registered name.

List banks

Returns the bank codes accepted by bank_account.bank_code on an offramp order.

curl https://engine-api.pilot.pulseshiga.io/v1/banks \
  -H "X-API-Key: <your key>"
{
  "status": true,
  "data": [
    { "name": "Access Bank", "code": "044" },
    { "name": "GTBank",      "code": "058" }
  ]
}

Resolve an account

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

curl https://engine-api.pilot.pulseshiga.io/v1/banks/resolve \
  -H "X-API-Key: <your key>" \
  -H "Content-Type: application/json" \
  -d '{ "bank_code": "058", "account_number": "0123456789" }'
{
  "status": true,
  "data": {
    "account_number": "0123456789",
    "account_name": "ADA OBI",
    "bank_code": "058",
    "bank_name": "GTBank"
  }
}

Account numbers are 10 digits. An account that cannot be confirmed fails with account_verification_failed. The same check runs when you create the offramp order, so a bad account never becomes an order.

See the List banks and Resolve a bank account references.

On this page