paypal/withdraw

post

https://earthnode-dev.vopay.com/api/v2/paypal/withdraw

This endpoint is used to send funds from your VoPay account to a PayPal account.

If a ClientAccountID is provided, the client account's default PayPal wallet will be used for the transaction.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Form Data

AccountID

string

required

Your account ID

Key

string

required

API key for the account

Signature

string

required

Hashed signature for the request

ClientAccountID

string

Client Account ID

ContactID

string

The ID of the contact to use for this transaction. The contacts payment method associated with this transaction type will be used.

PayPalToken

string

The token identifying the PayPal wallet to send funds to.

PayPalRecipientType

string

The type of the PayPal wallet you are sending funds to. Valid values are 'EMAIL', 'PHONE', 'PAYPAL_ID'.

RecipientID

string

The recipient ID (email address, phone number, or PayPal ID) of the PayPal wallet you are sending funds to. This value corresponds with the PayPalRecipientType value in the request.

RecipientName

string

required

The full name of the recipient receiving the funds.

Amount

number

required

The amount to send to the customers PayPal wallet.

Currency

string

3 character currency code for the currency to be charged to the customer's PayPal wallet. If this is not specified the transaction will use the account's local currency.

Notes

string

Optional notes for the transaction.

ClientReferenceNumber

string

Optional client reference number for the transaction.

IdempotencyKey

string

A unique key which the server can use to recognize and reject subsequent retries of the same request.

GLCode

string

An optional unique identification general ledger code.

TransactionTypeCode

string

CPA transaction code. Use the /api/v2/account/transactions/codes endpoint to retrieve a list of valid transaction codes. If not specified, the transaction will be created using code 450 (miscellaneous).

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200