Create Payout Response

The create payout response.

Schema Information

Type:object

Properties

batch_header

Type: object

The payout header.

payout_batch_idrequired

Type: string

Pattern: ^.*$

Min length: 0

Max length: 30

The PayPal-generated ID for a payout.

batch_statusrequired

Type: string

Enum: "DENIED", "PENDING", "PROCESSING", "SUCCESS", "CANCELED"

Pattern: ^[0-9A-Z_]+$

Min length: 1

Max length: 36

The PayPal-generated payout status. If the payout passes preliminary checks, the status is PENDING.

time_created

Type: string

Format: date-time

Min length: 0

Max length: 100

The date and time when processing for the payout began, in Internet date and time format.

sender_batch_headerrequired

Type: object

The original payout header, as provided by the payment sender.

sender_batch_id

Type: string

Pattern: ^.*$

Min length: 0

Max length: 256

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

Note:
PayPal does not process duplicate payouts. If you specify a sender_batch_id that was used in the last 30 days, the API rejects the request with an error message that shows the duplicate sender_batch_id and includes a HATEOAS link to the original payout with the same sender_batch_id.
If you receive an HTTP 5nn status code, you can safely retry the request with the same sender_batch_id. The API completes a payment only once for a sender_batch_id that is used within 30 days.

recipient_type

Type: string

Enum: "EMAIL", "PHONE", "PAYPAL_ID"

Pattern: ^[0-9A-Z_]+$

Min length: 1

Max length: 36

The ID type that identifies the payment receiver.

email_subject

Type: string

Pattern: ^.*$

Min length: 0

Max length: 255

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. Value is an alphanumeric string with a maximum length of 255 single-byte characters.

email_message

Type: string

Pattern: ^.*$

Min length: 0

Max length: 1000

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

links

Type: array

An array of request-related HATEOAS links.

Array Items

items

Type: object

The request-related HATEOAS link information.

hrefrequired

Type: string

The complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the $, (, and ) characters. The href is the key HATEOAS component that links a completed call with a subsequent call.

relrequired

Type: string

The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.

method

Type: string

Enum: "GET", "POST", "PUT", "DELETE", "HEAD", "CONNECT", "OPTIONS", "PATCH"

The HTTP method required to make the related call.

Properties

batch_header

Type: object

The payout header.

payout_batch_idrequired

Type: string

Pattern: ^.*$

Min length: 0

Max length: 30

The PayPal-generated ID for a payout.

batch_statusrequired

Type: string

Enum: "DENIED", "PENDING", "PROCESSING", "SUCCESS", "CANCELED"

Pattern: ^[0-9A-Z_]+$

Min length: 1

Max length: 36

The PayPal-generated payout status. If the payout passes preliminary checks, the status is PENDING.

time_created

Type: string

Format: date-time

Min length: 0

Max length: 100

The date and time when processing for the payout began, in Internet date and time format.

sender_batch_headerrequired

Type: object

The original payout header, as provided by the payment sender.

sender_batch_id

Type: string

Pattern: ^.*$

Min length: 0

Max length: 256

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

Note:
PayPal does not process duplicate payouts. If you specify a sender_batch_id that was used in the last 30 days, the API rejects the request with an error message that shows the duplicate sender_batch_id and includes a HATEOAS link to the original payout with the same sender_batch_id.
If you receive an HTTP 5nn status code, you can safely retry the request with the same sender_batch_id. The API completes a payment only once for a sender_batch_id that is used within 30 days.

recipient_type

Type: string

Enum: "EMAIL", "PHONE", "PAYPAL_ID"

Pattern: ^[0-9A-Z_]+$

Min length: 1

Max length: 36

The ID type that identifies the payment receiver.

email_subject

Type: string

Pattern: ^.*$

Min length: 0

Max length: 255

email_message

Type: string

Pattern: ^.*$

Min length: 0

Max length: 1000

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

links

Type: array

An array of request-related HATEOAS links.

Array Items

items

Type: object

The request-related HATEOAS link information.

hrefrequired

Type: string

relrequired

Type: string

The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.

method

Type: string

Enum: "GET", "POST", "PUT", "DELETE", "HEAD", "CONNECT", "OPTIONS", "PATCH"

The HTTP method required to make the related call.

Create Payout Response

Schema Information

Properties

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

Create Payout Response

Schema Information

Properties