Payout Batch Header

The payout header that is returned in response to a payout header request. Shows details for an entire payout request.

Schema Information

Type:object

Properties

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.

time_completed

Type: string

Format: date-time

Min length: 0

Max length: 100

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

time_closed

Type: string

Format: date-time

Min length: 0

Max length: 100

The date and time when the payout was closed, in Internet date and time format. A payout is considered closed when all items in a batch are processed and the available balance from the temporary hold is released.

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.

funding_source

Type: string

Enum: "BALANCE"

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

Min length: 1

Max length: 36

The ID to differentiate a PayPal balance-funded transaction from a PayPal treasury-funded transaction.

amount

Type: object

The currency and total amount requested for the payouts.

currencyrequired

Type: string

The three-character ISO-4217 currency code.

valuerequired

Type: string

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency codes - ISO 4217.

fees

Type: object

The currency and amount of the total estimate for the applicable payouts fees. Initially, the fee is 0. The fee is populated after the payout moves to the PROCESSING state.

currencyrequired

Type: string

The three-character ISO-4217 currency code.

valuerequired

Type: string

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency codes - ISO 4217.

Properties

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.

time_completed

Type: string

Format: date-time

Min length: 0

Max length: 100

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

time_closed

Type: string

Format: date-time

Min length: 0

Max length: 100

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.

funding_source

Type: string

Enum: "BALANCE"

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

Min length: 1

Max length: 36

The ID to differentiate a PayPal balance-funded transaction from a PayPal treasury-funded transaction.

amount

Type: object

The currency and total amount requested for the payouts.

currencyrequired

Type: string

The three-character ISO-4217 currency code.

valuerequired

Type: string

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency codes - ISO 4217.

fees

Type: object

The currency and amount of the total estimate for the applicable payouts fees. Initially, the fee is 0. The fee is populated after the payout moves to the PROCESSING state.

currencyrequired

Type: string

The three-character ISO-4217 currency code.

valuerequired

Type: string

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency codes - ISO 4217.

Payout Batch Header

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

Payout Batch Header

Schema Information

Properties