Verify bank account details
Verifies a bank account and returns detailed verification results from the verification network, including bank name, account status, and response codes. Unlike a pass/fail verification, this endpoint returns granular data to support decision-making and troubleshooting.
When bank authentication is enabled for the paypoint's organization, the endpoint performs an identity verification check on the account holder. Otherwise, it performs an account existence check. When bank authentication is enabled, the `accountHolderType` and `holderName` fields are required.
Requires `inboundpayments_create` or `outboundpayments_create` permission.
Authentication
requestTokenstring
API Key authentication via header
Path parameters
entry
The paypoint's entry name identifier.
Request
This endpoint expects an object.
routingNumber
The bank routing number to verify.
accountNumber
The bank account number to verify.
accountType
The type of bank account, such as Checking or Savings.
country
The ISO country code for the bank account, such as US.
accountHolderType
The type of account holder. Accepted values are personal or business. Required when bank authentication is enabled for the paypoint’s organization.
holderName
The name of the bank account holder. For personal accounts, provide the holder’s full name (for example, Jane Doe); the value is split on the first space into first and last name. For business accounts, provide the legal business name. Required when bank authentication is enabled for the paypoint’s organization.
Response
Success
responseText
Response text for operation: ‘Success’ or ‘Declined’.
isSuccess
Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.
responseData
Detailed bank account verification results from the verification network.
Errors
400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error
