PayPal Endpoints

paypal/set-my-recipient

This endpoint allows you to identify a PayPal recipient as belonging to the VoPay account holder. Optionally, you can use this endpoint to identify a PayPal recipient as being the VoPay account holder's default PayPal recipient. Note, a VoPay account can only have one default PayPal recipient.

post/paypal/set-my-recipient

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/paypal/set-my-recipient
  • Auth
    none declared

Request body application/x-www-form-urlencoded

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

PayPalTokenstring required

The token identifying the PayPal wallet to send funds to.

ClientAccountIDstring

Client Account ID

SetAsDefaultboolean

Identify credit card as default PayPal recipient

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

PayPalTokenstring required

PayPal recipient token

IsDefaultboolean required

Is this the VoPay account holder's default PayPal recipient

Example response

{
  "Success": true,
  "PayPalToken": "ACBDF-GAFSHD-AHBS-123456",
  "IsDefault": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.