VOvopay
Partner Endpoints

partner/partners/entitlements

Changed on

This endpoint returns the entitlements 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/entitlements

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/partner/partners/entitlements
  • 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

Example response

{
  "Success": true,
  "PartnerAccountID": "PA-12345",
  "Entitlements": {
    "AccountManagementEnabled": true,
    "AccountOnboardingFormAccess": true,
    "AccountEndpointAccess": true,
    "AccountCredentialsAccess": true,
    "AccountTransfersEnabled": true,
    "SetAccountPermissionsEnabled": true,
    "PartnerBillsAccount": true,
    "PartnerEmailsAccount": true,
    "CanAddDomesticAccounts": true,
    "CanAddForeignAccounts": true
  }
}

Changes