VOvopay
Partner Endpoints

partner/partners/details

Changed on

This endpoint returns the details of a partner account created by the calling partner. Requires the PartnerCreationEnabled permission. Returns RESOURCE_NOT_FOUND when the partner account does not exist or was not created by the caller.

get/partner/partners/details

Request

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

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

PartnerAccountIDstring required

The APIAccountID of a partner account created by the caller, as returned by /partner/partners. Requires PartnerCreationEnabled. Returns RESOURCE_NOT_FOUND when the partner account does not exist or was not created by the caller.

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

PartnerAccountIDstring required

APIAccountID of the partner account

Namestring required

Partner account name

AccountStatusstring required

Current onboarding status of the partner account. Empty string when no status is set yet.

AccountStatusDatestring nullable required

Date the partner account entered its current status. Falls back to DateAdded.

IsActiveboolean required

Whether the partner account is active

DateAddedstring required

Date the partner account was created

DateActivatedstring nullable required

Date the partner account was first activated

AccountNumberstring nullable required

Account number, assigned on activation

PartnerTypestring required

Partner account type

PartnerTypeLabelstring required

Display label of the partner type. Empty string when none applies.

RevSharestring nullable required

Revenue share percentage. Null when not applicable. Mutually exclusive with MinimumProgramFee.

MinimumProgramFeestring nullable required

Minimum program fee. Null when not applicable. Mutually exclusive with RevShare.

Countrystring required

Country name of the partner account

Currencystring required

Currency of the partner account, short form

ApiKeystring

Returned only when the partner account is Active and has an active API key

ApiSharedSecretstring

Returned only when the partner account is Active and has an active API key

Example response

{
  "Success": true,
  "PartnerAccountID": "PA-12345",
  "Name": "Acme Referrals",
  "AccountStatus": "Agreement Pending",
  "AccountStatusDate": "2026-02-01 10:00:00",
  "IsActive": true,
  "DateAdded": "2026-01-15 09:30:00",
  "PartnerType": "Referral",
  "PartnerTypeLabel": "Referral ISV",
  "RevShare": "10.00",
  "Country": "Canada",
  "Currency": "CAD",
  "ApiKey": "a1b2c3d4e5f6",
  "ApiSharedSecret": "s3cr3tsharedvalue",
  "Agreement": {
    "DocumentSent": true,
    "DocumentCategory": "referral-agreement"
  }
}

Changes