v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

Bank Account Endpoints

bank-account/set-my-bank-account

This endpoint allows you to identify a bank account as belonging to the VoPay account holder.

Optionally, you can use this endpoint to identify a bank account as being the VoPay account holder's default operational and/or billing bank account. The VoPay account holder's default operational bank account is used in the /account/fund-my-account and /account/withdraw-my-account endpoints. The VoPay account holder's default billing bank account is used to collect monthly invoices. Note, a VoPay account can only have one default operational and one default billing bank account per currency.

post/bank-account/set-my-bank-account

Response

Successboolean required

True if the request was successful, false if it failed

ErrorMessagestring required

Contains a description of the error if the request failed

Tokenstring required

Bank account token

IsDefaultboolean required

Is this the VoPay account holder's default bank account

Example response

{
  "Success": true,
  "Token": "ACBDF-GAFSHD-AHBS-123456",
  "IsDefault": true
}