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

# account/auto-balance-transfer

`GET /account/auto-balance-transfer`

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.
  - `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.

---

[API](https://skmtc.net/vopay/apis/accounts.md) · [All operations](https://skmtc.net/vopay/apis/accounts/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vopay/accounts/revisions/7033bd231ec7/schema)