---
title: "account/auto-balance-transfer"
method: POST
path: "/account/auto-balance-transfer"
tags: ["Account Endpoints"]
---

# account/auto-balance-transfer

`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

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.

## Request body `application/x-www-form-urlencoded`

- object
  - `AccountID` string, required: Your account ID
  - `Key` string, required: API key for the account
  - `Signature` string, required: Hashed signature for the request
  - `ScheduleStartDate` string, required: Date from which the schedule will be started
  - `TypeOfFrequency` string, required: Type of frequency that you which to receive the deposit, the posibles values are: daily, weekly, biweekly, monthly
  - `AutoBalanceTransferAmount` number: The minumum amount to have in your VoPay account to initiate this scheduled transfer, if not provided, the default amount will be 0.01.
  - `Currency` string: 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.
  - `SplitByCounterparty` boolean: 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 `200`

- object
  - `Success` boolean, required: True if the request was successful, false if it failed
  - `ErrorMessage` string, required: Contains a description of the error if the request failed

## Changes

- **2026-11-03** `71f251deb318`: 1 info
  - added the new optional request property `SplitByCounterparty`

[Operation history](https://skmtc.dev/vopay/apis/accounts/changes/account/auto-balance-transfer/post.md)

---

[API](https://skmtc.dev/vopay/apis/accounts.md) - [All operations](https://skmtc.dev/vopay/apis/accounts/llms.txt) - [OpenAPI document](https://skmtc.dev/vopay/apis/accounts/revisions/71f251deb318?raw)