Verify Account Number

This API lets you verify a bank account

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
⚠️

Note

  • Please note that when validating an IBAN (iban) or NUBAN (nuban) there should be no spaces between the values, as this would return an error response.
  • For ZAR bank account verification using PayShap, send the full PayShap ID (including everything after the @) as the accountNumber, and use PAYSHAP_ID as the bankCode.

Verify an Interac recipient

Use type=interac_etransfer before creating a CAD Interac payout. It checks whether the recipient's email is registered for Interac Autodeposit.

The endpoint does not create or submit a payout. Only proceed with the payout when autoDepositEnabled is true.

📘

Confirm the resolved account name

When autoDepositEnabled is true, confirm the returned accountName and use it as beneficiary.accountHolderName when creating the payout.

🚧

Autodeposit not enabled

autoDepositEnabled: false is a successful resolution response, not an API error. Do not create the payout. Ask the recipient to enable Interac Autodeposit and verify the email again.

Body Params
string
Defaults to 092929292

The account number. This is required for NUBAN accounts

string

The bank Code. This is required for NUBAN accounts

string

The bank swift code. Use this for GHS bank account verification

string

Required for type=mobile_money

string
enum
required
Defaults to nuban

The type of account number

Allowed:
string

The international bank account number.

string

The currency, i.e NGN, GHS, ZAR. Note, this is only required for bank_account and mobile_money. For interac_etransfer, the value must be CAD when provided, and it defaults to CAD

string

The recipient's valid Interac email address. This is required for type=interac_etransfer

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json