VOvopay
Partner Endpoints

partner/partners/permissions

Changed on

This endpoint returns the payment rail permissions of a partner account created by the calling partner, as on-off toggles in the same nested structure as the account permissions (payment-rails, send or collect, sub-group, rails). Only rails that apply to the partner account's country are listed; limits, amounts and velocities are not included. 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/permissions

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/partner/partners/permissions
  • 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",
  "PermissionValues": {
    "payment-rails": {
      "send": {
        "bank-account": {
          "bank-payment-rails": {
            "0": {
              "Permission": "EFTSendEnabled",
              "Type": "boolean",
              "Section": "bank-payment-rails",
              "Label": "EFT Send",
              "Value": true
            }
          }
        },
        "email": {
          "email-rails": {
            "0": {
              "Permission": "InteracBulkPayoutEnabled",
              "Type": "boolean",
              "Section": "email-rails",
              "Label": "Interac e-Transfer® Send",
              "Value": true
            }
          }
        },
        "global-send": {
          "global-send-rails": {
            "0": {
              "Permission": "GCMEnabled",
              "Type": "boolean",
              "Section": "global-send-rails",
              "Label": "Global Send",
              "Value": true
            }
          }
        },
        "debit-card": {
          "debit-card-rails": {
            "0": {
              "Permission": "PushToCardEnabled",
              "Type": "boolean",
              "Section": "debit-card-rails",
              "Label": "Debit Card - Push to Card",
              "Value": true
            }
          }
        },
        "bill-pay": {
          "bill-pay-rails": {
            "0": {
              "Permission": "BillPayEnabled",
              "Type": "boolean",
              "Section": "bill-pay-rails",
              "Label": "Bill Pay",
              "Value": true
            }
          }
        }
      },
      "collect": {
        "bank-account": {
          "bank-payment-rails": {
            "0": {
              "Permission": "EFTCollectEnabled",
              "Type": "boolean",
              "Section": "bank-payment-rails",
              "Label": "EFT Collect",
              "Value": true
            }
          }
        },
        "email": {
          "email-rails": {
            "0": {
              "Permission": "InteracMoneyRequestEnabled",
              "Type": "boolean",
              "Section": "email-rails",
              "Label": "Interac e-Transfer® Request Money",
              "Value": true
            }
          }
        },
        "debit-card": {
          "debit-card-rails": {
            "0": {
              "Permission": "AFTEnabled",
              "Type": "boolean",
              "Section": "debit-card-rails",
              "Label": "Debit Card - Pull from Card",
              "Value": true
            }
          }
        },
        "credit-card": {
          "credit-card-rails": {
            "0": {
              "Permission": "CreditCardEnabled",
              "Type": "boolean",
              "Section": "credit-card-rails",
              "Label": "Credit Card",
              "Value": true
            }
          }
        },
        "digital-wallets": {
          "digital-wallets-rails": {
            "0": {
              "Permission": "GooglePayEnabled",
              "Type": "boolean",
              "Section": "digital-wallets-rails",
              "Label": "Google Pay",
              "Value": true
            }
          }
        }
      }
    }
  }
}

Changes