Skip to main content
Create payout in PayPal
Wrk Product avatar
Written by Wrk Product
Updated over a month ago

Create payout in PayPal.

Application

  • PayPal

Inputs (what you have)

Name

Description

Data Type

Required?

Example

Connected account

The connected account to use for the request

Connected Account

Yes

Sender batch ID

A sender-specified ID number. Tracks the payout in an accounting system

Text (Short)

Yes

Payout 1 recipient type

Predefined Choice List

No

Payout 1 receiver value

The receiver of the payment. Corresponds to the recipient_type value in the request. Max length: 127 characters

Text (Short)

Yes

Payout 1 currency

Predefined Choice List

No

Payout 1 amount

Text (Short)

Yes

Payout 1 note

The sender-specified note for notifications. Supports up to 4000 ASCII characters and 1000 non-ASCII characters

Text (Long)

No

Payout 1 sender item ID

The sender-specified ID number. Tracks the payout in an accounting system

Text (Short)

No

Payout 1 recipient wallet

Predefined Choice List

No

Payout 2 recipient type

Predefined Choice List

No

Payout 2 receiver value

The receiver of the payment. Corresponds to the recipient_type value in the request. Max length: 127 characters

Text (Short)

Yes

Payout 2 currency

Predefined Choice List

No

Payout 2 amount

Text (Short)

Yes

Payout 2 note

The sender-specified note for notifications. Supports up to 4000 ASCII characters and 1000 non-ASCII characters

Text (Long)

No

Payout 2 sender item ID

The sender-specified ID number. Tracks the payout in an accounting system

Text (Short)

No

Payout 2 recipient wallett

Predefined Choice List

No

Payout 3 recipient type

Predefined Choice List

No

Payout 3 receiver value

The receiver of the payment. Corresponds to the recipient_type value in the request. Max length: 127 characters

Text (Short)

Yes

Payout 3 currency

Predefined Choice List

No

Payout 3 amount

Text (Short)

Yes

Payout note

The sender-specified note for notifications. Supports up to 4000 ASCII characters and 1000 non-ASCII characters

Text (Long)

No

Payout 3 sender item ID

The sender-specified ID number. Tracks the payout in an accounting system

Text (Short)

No

Payout 3 recipient wallet

Predefined Choice List

No

Email subject

The subject line for the email that PayPal sends when payment for a payout item completes. The subject line is the same for all recipients. Max length: 255 characters

Text (Short)

No

Email message

The email message that PayPal sends when the payout item completes. The message is the same for all recipients

Text (Long)

No

Note

The payouts and item-level notes are concatenated in the email. Max length: 1000 characters

Text (Long)

No

Outputs (what you get)

Name

Description

Data Type

Required?

Example

JSON Output

JSON output returned by the API

Text (Long)

No

Outcomes

Name

Description

Success

This status is selected if the job has successfully completed.

Unsuccessful

This status is selected if the job has completed unsuccessfully.

Requirements

  • N/A

Did this answer your question?