Skip to main content
GET
Bank network status

Overview

How transfers to each Nigerian bank are going right now. When a bank is slow or having problems, tell your customer before they send, and let them choose: send anyway, or pay into another account. A status never blocks a payout. Show message to your customer as it is. It is written for them and never names a payment provider. Pass bank_code for one bank, as you hold it: the code from List banks, or one saved on a beneficiary. banks is empty when we know nothing about that code. Without bank_code you get every bank we have a status for; a bank can appear under more than one code. Verify a bank account returns the same object as bank_status for Nigerian accounts, so you can show it right after the account name.

Caching

The status is recomputed every few minutes. Answers are cached for 60 seconds (Cache-Control: public, max-age=60), so polling more often than once a minute returns the same answer. A status older than 10 minutes is reported as grey. If the status can’t be read, the endpoint answers 503. Treat that as “no status” and carry on with the payout.

Authorizations

X-API-Key
string
header
required

API key for authentication.

Query Parameters

bank_code
string

One bank's code, as you hold it (from List banks or a beneficiary you saved). Omit it for every bank.

Maximum string length: 16

Response

Status of every bank, or of the one asked for. banks is empty when we know nothing of that code.

status
boolean
data
object
error
any[]
message
string