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

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/bank-account/set-my-bank-account
  • Auth
    none declared

Request body application/x-www-form-urlencoded

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

Tokenstring required

Bank account token

ClientAccountIDstring

Client Account ID. Not valid for partner accounts, which have no client accounts; supplying it returns an INVALID_PARAMETER error.

SetAsDefaultboolean

Identify bank account as a default bank account

Purposestring

Identify bank account purpose. Input can be a comma-delimited list. Valid values are: operational and billing. Default value is operational.

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
}

Changes

No recorded changes to this operation across all 1 revision of this API.