Verify Account Number

post

https://sandboxapi.fincra.com/core/accounts/resolve

This API lets you verify a bank account

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

⚠️
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.

Verify a PayShap ID

Use type=bank_account with currency=ZAR to verify a PayShap ID. A PayShap ID is an alias for a South African bank account. For ZAR, PayShap is currently the only supported verification method.

Set bankCode to PAYSHAP_ID and send the full PayShap ID in accountNumber, in the format number@bank, for example 0713058274@nedbank.

If the PayShap ID cannot be validated, the request returns a 422 with errorType: UNPROCESSABLE_ENTITY. Handle the failure using the status code and errorType, not the error text, because the text can change.

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

accountNumber

string

Defaults to 092929292

The account number. This is required for NUBAN accounts. For ZAR, send the full PayShap ID in the format number@bank, for example 0713058274@nedbank. There is no digit or length rule for ZAR.

bankCode

string

The bank code. This is required for NUBAN accounts and when currency is ZAR. For ZAR the value is PAYSHAP_ID, which is returned by the List banks endpoint.

bankSwiftCode

string

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

mobileMoneyCode

string

Required for type=mobile_money

type

string

enum

required

Defaults to nuban

The type of account number

Allowed:

iban

string

The international bank account number.

currency

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

interacEmail

string

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

Responses

Note

Verify a PayShap ID

Verify an Interac recipient

Confirm the resolved account name

Autodeposit not enabled

200200

422422