---
updatedAt: 2026-08-17T19:31:34.000Z
agentTools:
  projectIndex: https://docs.vopay.com/llms.txt
---

# account/client-accounts/auto-balance-transfer

This endpoint is used to retrieve the information of your auto balance transfer. 

 This option requires special permissions.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "version": "2.0",
    "title": "Client Accounts",
    "description": "The Client Accounts API allows you to create, manage and retrieve information about client accounts.",
    "contact": {
      "name": "API Support",
      "email": "help@vopay.com"
    }
  },
  "paths": {
    "/account/client-accounts/auto-balance-transfer": {
      "get": {
        "description": "This endpoint is used to retrieve the information of your auto balance transfer. \n\n This option requires special permissions.",
        "summary": "account/client-accounts/auto-balance-transfer",
        "tags": [
          "Client Account Auto Balance Transfer Endpoints"
        ],
        "operationId": "ClientAccountAutoBalanceTransferGET",
        "deprecated": false,
        "parameters": [
          {
            "name": "AccountID",
            "in": "query",
            "required": true,
            "description": "Your account ID",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Key",
            "in": "query",
            "required": true,
            "description": "API key for the account",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Signature",
            "in": "query",
            "required": true,
            "description": "Hashed signature for the request",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "ClientAccountID",
            "in": "query",
            "required": true,
            "description": "The Client Account ID to which the wallet belongs",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "Success",
                    "ErrorMessage",
                    "ScheduleStartDate",
                    "Description",
                    "NameOfFrequency",
                    "AutoBalanceTransferAmount",
                    "Status",
                    "Currency",
                    "AccountHolderName",
                    "AccountNumber",
                    "FinancialInstitutionNumber",
                    "BranchTransitNumber",
                    "ABARoutingNumber"
                  ],
                  "properties": {
                    "Success": {
                      "type": "boolean",
                      "description": "True if the request was successful, false if it failed",
                      "example": true
                    },
                    "ErrorMessage": {
                      "type": "string",
                      "description": "Contains a description of the error if the request failed",
                      "example": ""
                    },
                    "ScheduleStartDate": {
                      "type": "string",
                      "format": "date",
                      "description": "Date from which the auto transfer will be started ",
                      "example": "2020-01-01"
                    },
                    "Description": {
                      "type": "string",
                      "description": "Description of the of the auto transfer balance",
                      "example": ""
                    },
                    "NameOfFrequency": {
                      "type": "string",
                      "description": "The frequency of the auto transfer (recurring)",
                      "example": "recurring"
                    },
                    "AutoBalanceTransferAmount": {
                      "type": "number",
                      "description": "The minumum amount to have in your VoPay account to start the auto transfer balance",
                      "example": "25.00"
                    },
                    "Status": {
                      "type": "string",
                      "description": "A message indicating the current status of the auto transfer. Statuses are: cancelled, completed, or in progress",
                      "example": "in progress"
                    },
                    "Currency": {
                      "type": "string",
                      "description": "The currency of the funds transferred to your bank account.",
                      "example": "CAD"
                    },
                    "AccountHolderName": {
                      "type": "string",
                      "description": "The name of the account holder",
                      "example": "John Doe"
                    },
                    "AccountNumber": {
                      "type": "string",
                      "description": "Recipient's bank account number that funds were deposited to.",
                      "example": "13434387"
                    },
                    "FinancialInstitutionNumber": {
                      "type": "string",
                      "description": "Three digit institution number of the customer's Canadian bank account.",
                      "example": "112"
                    },
                    "BranchTransitNumber": {
                      "type": "string",
                      "description": "Transit number for the customer's Canadian bank account.",
                      "example": "**809"
                    },
                    "ABARoutingNumber": {
                      "type": "string",
                      "description": "Nine digit ABA routing number of the customer's US bank account.",
                      "example": "123456789"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://earthnode-dev.vopay.com/api/v2"
    }
  ]
}
```