API Reference

account/client-accounts

get
https://earthnode-dev.vopay.com/api/v2/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).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Your account ID

string
required

API key for the account

string
required

Hashed signature for the request

string

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

boolean

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

string

Filter by the Client account ID

string

Filter by the Label

integer

Limit the number of records that are returned.

integer

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

string

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

Response

Updated 6 days ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 days ago