Banks
List valid bank codes, and resolve an account before an offramp.
Use these endpoints to pay naira to a bank account. Every bank_code comes from
the bank list. An offramp order uses it in beneficiary.bank_account, and a
payout account uses it in bank_account.
List banks
Retrieve the codes accepted by bank_account.bank_code.
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
Resolve the selected account before you create an offramp order. Show the returned
account_name to the customer for confirmation. A payout account does not need
this call, because Pulse verifies the account when you add it.
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 contain 10 digits. An unconfirmed account returns
account_verification_failed. Order creation repeats this check and rejects an
invalid account.
See the List banks and Resolve a bank account references.