/initiateofframp or /cngnofframp, you need at least one verified bank account on file. Accounts are automatically validated against live bank records at the time of addition - you cannot add an account whose number does not match the account name at the issuing bank.
Endpoints Overview
Retrieve Supported Banks
POST /getbankscode
Returns the full list of Nigerian banks currently supported for payout, along with their NIBSS bank codes. Use these bankCode values when calling /addbankaccount or /cngnofframp.
object
Response
Add a Bank Account
POST /addbankaccount
Adds a Nigerian bank account to your fintech configuration and immediately verifies it against bank records. The account is only activated if the account number is valid and the account name resolves correctly at the bank.
Accounts are automatically verified against live bank records before activation. Verification is synchronous - the response includes the resolved
verifiedAccountName and isValidated flag.string
required
The 10-digit Nigerian bank account number.
string
required
The NIBSS bank identifier code (e.g.
044 for Access Bank). Use /getbankscode to look up the correct code.boolean
When
true, this account becomes the default payout destination. Defaults to false.object
Response
Validation error
Verification failed
Update a Bank Account
PUT /updatebankaccount
Updates the label or default status of an existing bank account. You cannot change the account number or bank code - delete the account and add a new one instead.
string
required
UUID of the bank account to update, as returned by
/addbankaccount.boolean
When
true, sets this account as the default payout destination.Response
Account not found
Delete a Bank Account
DELETE /deletebankaccount
Permanently removes a bank account from your fintech configuration. This action cannot be undone.
Bank accounts with pending offramp transactions cannot be deleted. Wait for all in-progress transactions to settle before attempting deletion.
string
required
UUID of the bank account to delete, as returned by
/addbankaccount.Response
Pending transactions
Retrieve a Single Bank Account
GET /getbankaccounts
Returns the details of a single bank account by its UUID.
string
required
UUID of the bank account to retrieve, as returned by
/addbankaccount.object
Response
Retrieve All Bank Accounts
GET /listbankaccounts
Returns all bank accounts configured on your fintech account, along with a summary of the current default account.
object
Response