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

# account/auto-balance-transfer

`GET /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 is used to retrieve the information of your auto balance transfer. 

 This option requires special permissions.

## Query parameters

- `AccountID` string, required
- `Key` string, required
- `Signature` string, required

## 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
  - `ScheduleStartDate` string, date, required: Date from which the auto transfer will be started
  - `Description` string, required: Description of the of the auto transfer balance
  - `NameOfFrequency` string, required: The frequency of the auto transfer (recurring)
  - `AutoBalanceTransferAmount` number, required: The minumum amount to have in your VoPay account to start the auto transfer balance
  - `Status` string, required: A message indicating the current status of the auto transfer. Statuses are: cancelled, completed, or in progress
  - `Currency` string, required: The currency of the funds transferred to your bank account.
  - `SplitByCounterparty` boolean, required: True if the auto balance transfer creates one transfer per counterparty instead of a single transfer for the whole balance.
  - `AccountHolderName` string, required: The name of the account holder
  - `AccountNumber` string, required: Recipient's bank account number that funds were deposited to.
  - `FinancialInstitutionNumber` string, required: Three digit institution number of the customer's Canadian bank account.
  - `BranchTransitNumber` string, required: Transit number for the customer's Canadian bank account.
  - `ABARoutingNumber` string, required: Nine digit ABA routing number of the customer's US bank account.

## Changes

- **2026-11-03** `71f251deb318`: 1 info
  - added the required property `SplitByCounterparty` to the response with the `200` status

[Operation history](https://skmtc.dev/vopay/apis/accounts/changes/account/auto-balance-transfer/get.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)