Partner Endpoints

partner/partners/status-summary

Changed on

This endpoint returns per-status counts of the partner accounts created by the calling partner. Requires the PartnerCreationEnabled permission.

get/partner/partners/status-summary

Request

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

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

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

TotalPartnerAccountsinteger required

Total number of partner accounts created by the caller, including those with no status yet.

Example response

{
  "Success": true,
  "TotalPartnerAccounts": 4,
  "StatusCounts": {
    "Active": 3
  }
}

Changes