v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

Client Account Management Endpoints

account/client-accounts

This endpoint returns a list of the available client accounts and some of its details.

It is also possible to filter the list of client accounts by ClientAccountID, its status (active or inactive), and client type (business, individual, receive-only).

get/account/client-accounts

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

ClientTypestring

Type of account to be filtered. Use either 'individual', 'business' or 'receive-only'

AccountStatusboolean

Filter by account status. Use true for active accounts and false for inactive.

ClientAccountIDstring

Filter by the Client account ID

Labelstring

Filter by the Label

Limit integer

Limit the number of records that are returned.

Offset integer

Use this parameter to set the starting point in the dataset.

SearchTextstring

A text string to search for in the email addresses, names and business number.

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

{
  "ClientAccounts": {
    "0": {
      "ClientAccountID": "ClientAccount1",
      "ClientName": "John Doe",
      "EmailAddress": "subaccount.mail@email.com",
      "BusinessNumber": "123456789",
      "BusinessWebsite": "www.example.com",
      "BusinessIndustry": "Retail",
      "BusinessCategory": "Home Electronics",
      "VerificationStatus": {
        "Email": {
          "Enhanced": "verified",
          "Basic": "unverified"
        },
        "Phone": {
          "Enhanced": "verified"
        },
        "Address": {
          "Basic": "verified"
        }
      },
      "Address1": "112 Bentall Street",
      "City": "Vancouver",
      "Province": "BC",
      "Country": "Canada",
      "Nationality": "Canada",
      "PostalCode": "A1A1A1",
      "IdentificationNumber": "I19923",
      "ParentAccountID": "account1",
      "Balances": {
        "0": {
          "Currency": "CAD",
          "Balance": "25776.73",
          "PendingBalance": "16146.00"
        }
      },
      "Labels": {
        "0": {
          "Label": "Billing",
          "LabelID": "283"
        }
      }
    }
  },
  "Pagination": {
    "TotalRecords": "1000",
    "Offset": "1000",
    "Limit": "1000"
  }
}