Validate Bank Account
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).
Behaviour notes
- Resolves the beneficiary name.
data.idis theverify_idfor Send Payout, and later the payoutreferenceused by Check Payout Status / Fetch One Settlement Transaction. - The code sets no expiry on a
verify_id. - Each
verify_idcan 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_code
account_number
pin
fromSettlementId
Response
OK
data
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
