v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

Client Account Auto Balance Transfer Endpoints

account/client-accounts/auto-balance-transfer

This endpoint is used to retrieve the information of your auto balance transfer.

This option requires special permissions.

get/account/client-accounts/auto-balance-transfer

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

ClientAccountIDstring required

The Client Account ID to which the wallet belongs

Response

Successboolean

True if the request was successful, false if it failed

ErrorMessagestring

Contains a description of the error if the request failed

ScheduleStartDatestring date

Date from which the auto transfer will be started

Descriptionstring

Description of the of the auto transfer balance

NameOfFrequencystring

The frequency of the auto transfer (recurring)

AutoBalanceTransferAmountnumber

The minumum amount to have in your VoPay account to start the auto transfer balance

Statusstring

A message indicating the current status of the auto transfer. Statuses are: cancelled, completed, or in progress

Currencystring

The currency of the funds transferred to your bank account.

AccountHolderNamestring

The name of the account holder

AccountNumberstring

Recipient's bank account number that funds were deposited to.

FinancialInstitutionNumberstring

Three digit institution number of the customer's Canadian bank account.

BranchTransitNumberstring

Transit number for the customer's Canadian bank account.

ABARoutingNumberstring

Nine digit ABA routing number of the customer's US bank account.

Example response

{
  "ScheduleStartDate": "2020-01-01",
  "NameOfFrequency": "recurring",
  "Status": "in progress",
  "Currency": "CAD",
  "AccountHolderName": "John Doe",
  "AccountNumber": "13434387",
  "FinancialInstitutionNumber": "112",
  "BranchTransitNumber": "**809",
  "ABARoutingNumber": "123456789"
}