v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

PayPal Endpoints

paypal/default-recipient

This endpoint retrieves the default PayPal recipient associated with your VoPay account

get/paypal/default-recipient

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

ClientAccountIDstring

When provided, this endpoint will return the default PayPal recipient associated with this Client Account ID

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,
  "DefaultPayPalRecipient": {
    "0": {
      "ClientControlledPayPalAccount": "1",
      "RecipientName": "Bob",
      "RecipientID": "bob@gmail.com",
      "PayPalRecipientType": "EMAIL",
      "IsActive": "true",
      "IsDefault": "true",
      "PayPalToken": "1e7mtunsbhygfnfpm83zd8rig1hqoqu76y618x3eps4omcye0w83mjj2kk884w0o",
      "DateAdded": "2024-05-02 18:28:13"
    }
  }
}