VOvopay
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

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/account/client-accounts/auto-balance-transfer
  • Auth
    none declared

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 required

True if the request was successful, false if it failed

ErrorMessagestring required

Contains a description of the error if the request failed

ScheduleStartDatestring date required

Date from which the auto transfer will be started

Descriptionstring required

Description of the of the auto transfer balance

NameOfFrequencystring required

The frequency of the auto transfer (recurring)

AutoBalanceTransferAmountnumber required

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

Statusstring required

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

Currencystring required

The currency of the funds transferred to your bank account.

SplitByCounterpartyboolean required

True if the auto balance transfer creates one transfer per counterparty instead of a single transfer for the whole balance.

AccountHolderNamestring required

The name of the account holder

AccountNumberstring required

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

FinancialInstitutionNumberstring required

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

BranchTransitNumberstring required

Transit number for the customer's Canadian bank account.

ABARoutingNumberstring required

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

Example response

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

Changes

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