Sign in

v1

latestOpenAPI 3.0.02026-07-2640301.0 MB
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

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
}