VOvopay
Account Endpoints

account/auto-balance-transfer

Changed on

This endpoint allows you to set up an auto-balance transfer from your VoPay account to your default operational bank account. The frequency available to set the auto-transfer can be daily, weekly, bi-weekly or monthly.

This option requires special permission.

post/account/auto-balance-transfer

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/account/auto-balance-transfer
  • 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

ScheduleStartDatestring required

Date from which the schedule will be started

TypeOfFrequencystring required

Type of frequency that you which to receive the deposit, the posibles values are: daily, weekly, biweekly, monthly

AutoBalanceTransferAmountnumber

The minumum amount to have in your VoPay account to initiate this scheduled transfer, if not provided, the default amount will be 0.01.

Currencystring

The currency of the funds you want to trasnfer to your bank account. If not currency is provdied, your VoPay account's default currency will be used.

SplitByCounterpartyboolean

Set to true to create one transfer per counterparty (contact) whose transactions make up the available balance, instead of a single transfer for the whole balance. The transfers always add up to the available balance. If omitted, the stored value is kept (false for a new auto balance transfer). Only false is accepted for accounts with client accounts enabled and for client-account auto balance transfers; true is rejected with INVALID_PARAMETER.

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

Example response

{
  "Success": true
}

Changes