---
updatedAt: 2026-04-29T19:17:17.000Z
agentTools:
  projectIndex: https://docs.vopay.com/llms.txt
---

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

This endpoint is used to retrieve a list of all your auto balance transfers. 

 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-list": {
      "get": {
        "description": "This endpoint is used to retrieve a list of all your auto balance transfers. \n\n This option requires special permissions.",
        "summary": "account/client-accounts/auto-balance-transfer-list",
        "tags": [
          "Client Account Auto Balance Transfer Endpoints"
        ],
        "operationId": "ClientAccountAutoBalanceTransferListGET",
        "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",
                    "Wallets"
                  ],
                  "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": ""
                    },
                    "Wallets": {
                      "type": "object",
                      "description": "Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no auto balance transfers.",
                      "x-list-of": "inline",
                      "x-empty-when": "no auto balance transfers",
                      "properties": {
                        "0": {
                          "type": "object",
                          "required": [
                            "AutoBalanceTransferID",
                            "ScheduleStartDate",
                            "Description",
                            "NameOfFrequency",
                            "AutoBalanceTransferAmount",
                            "Status",
                            "Currency",
                            "ClientAccountID"
                          ],
                          "properties": {
                            "AutoBalanceTransferID": {
                              "type": "integer",
                              "description": "ID of the auto balance transfer",
                              "example": "1234"
                            },
                            "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 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"
                            },
                            "ClientAccountID": {
                              "type": "string",
                              "description": "The associated client account.",
                              "example": "ClientAccount1"
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://earthnode-dev.vopay.com/api/v2"
    }
  ]
}
```