v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

PayPal Endpoints

paypal/recipients

This endpoint allows you fetch a list all of your PayPal recipients

get/paypal/recipients

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

ClientControlledboolean

When set to true, this endpoint will only return PayPal accounts linked to your VoPay account. When set to false, it will return a list of your customer's PayPal accounts.

Limitinteger

Limit the number of records that are returned.

Offsetinteger

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

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

Example response

{
  "Success": true,
  "PaypalRecipients": {
    "0": {
      "RecipientName": "John Doe",
      "RecipientID": "bob@gmail.com",
      "PayPalRecipientType": "EMAIL",
      "PayPalToken": "1e7mtunsbhygfnfpm83zd8rig1hqoqu76y618x3eps4omcye0w83mjj2kk884w0o",
      "ClientControlledPayPalAccount": "1",
      "IsDefault": "1"
    }
  }
}