VOvopay
Partner Endpoints

partner/partners

Changed on

This endpoint returns the partner accounts created by the calling partner. Requires the PartnerCreationEnabled permission. With ExportCSV=true the listing is returned as a base64 CSV file instead of JSON rows; the CSV columns are Date Added, Partner Name, Partner Account ID, Status, Status Date, Country, Accounts, followed by one "Total Balance (XXX)" column per currency.

get/partner/partners

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/partner/partners
  • Auth
    none declared

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

Limitinteger

Limit the number of records that are returned.

Offsetinteger

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

AccountStatusstring

Only return partner accounts in this status.

SearchTextstring

Only return partner accounts matching this text.

ShowTokenboolean

When true, each partner row includes a Token for partner dashboard access.

ExportCSVboolean

When true, returns all matching partner accounts (up to 10,000 rows; filters apply, pagination is ignored) as a CSV file in CSVFile instead of Partners and PaginationMetaData.

Response

Successboolean required

True if the request was successful, false if it failed

ErrorMessagestring required

Contains a description of the error if the request failed

CSVFilestring

Base64 data URI of the CSV file.

Example response

{
  "Success": true,
  "Partners": {
    "0": {
      "PartnerAccountID": "PA-12345",
      "Name": "Acme Referrals",
      "AccountStatus": "Active",
      "Country": "Canada",
      "EmailAddress": "ops@acme.example",
      "IsActive": true,
      "DateAdded": "2026-01-15 09:30:00",
      "Currency": "CAD",
      "AccountCount": 3,
      "TotalBalances": {
        "CAD": "1200.00"
      },
      "AccountStatusDate": "2026-02-01 10:00:00",
      "DateActivated": "2026-02-01 10:00:00",
      "Token": "eyJ0eXAiOiJKV1QiLCJhbGciOi..."
    }
  },
  "PaginationMetaData": {
    "TotalRecords": 25,
    "Limit": 10
  },
  "CSVFile": "data:text/csv;base64,RGF0ZSBBZGRlZCxQYXJ0bmVyIE5hbWUs..."
}

Changes