v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

Client Account Auto Balance Transfer Endpoints

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.

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

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

ClientAccountIDstring required

The Client Account ID to which the wallet belongs

Response

Successboolean

True if the request was successful, false if it failed

ErrorMessagestring

Contains a description of the error if the request failed

Example response

{
  "Wallets": {
    "0": {
      "ScheduleStartDate": "2020-01-01",
      "NameOfFrequency": "recurring",
      "Status": "in progress",
      "Currency": "CAD",
      "ClientAccountID": "ClientAccount1"
    }
  }
}