Skip to navigation

Validate Bank Account

View as Markdown

Resolves a beneficiary account name before paying out to it, and reserves a verify_id for the next 15 minutes to use in Send Payout.

Errors: 400 invalid PIN, account does not exist, or settlement account not found.

Body (JSON) - checked by Joi (verifysettlementPayoutSchema).

FieldTypeRequiredRules
bank_codestringyes4-10 chars; use a code from List Supported Banks (e.g. 000013 GTBank)
account_numberstringyes9-11 chars (10-digit NUBAN)
pinstringyesexactly 4 chars - your transaction PIN
fromSettlementIdnumberyesThe settlement account to pay from

Behaviour notes

  • Resolves the beneficiary name. data.id is the verify_id for Send Payout, and later the payout reference used by Check Payout Status / Fetch One Settlement Transaction.
  • The code sets no expiry on a verify_id.
  • Each verify_id can be used for one payout only.
  • Business errors are HTTP 400 { "error": " failed: <reason>" }; the message starts with a space.

Authentication

AuthorizationBearer

Access token from Generate Access Token (valid 15 minutes).

Request

This endpoint expects an object.
bank_codestringOptional
account_numberstringOptional
pinstringOptional
fromSettlementIdintegerOptional

Response

OK
dataobjectOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error