On this page
No Headings
The payout header that is returned in response to a payout header request. Shows details for an entire payout request.
objectpayout_batch_idrequiredstring^.*$The PayPal-generated ID for a payout.
batch_statusrequiredstring"DENIED", "PENDING", "PROCESSING", "SUCCESS", "CANCELED"^[0-9A-Z_]+$The PayPal-generated payout status. If the payout passes preliminary checks, the status is PENDING.
time_createdstringdate-timeThe date and time when processing for the payout began, in Internet date and time format.
sender_batch_headerrequiredobjectThe original payout header, as provided by the payment sender.
sender_batch_idstring^.*$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_idthat was used in the last 30 days, the API rejects the request with an error message that shows the duplicatesender_batch_idand includes a HATEOAS link to the original payout with the samesender_batch_id.If you receive an HTTP
5nnstatus code, you can safely retry the request with the samesender_batch_id. The API completes a payment only once for asender_batch_idthat is used within 30 days.
recipient_typestring"EMAIL", "PHONE", "PAYPAL_ID"^[0-9A-Z_]+$The ID type that identifies the payment receiver.
email_subjectstring^.*$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_messagestring^.*$The email message that PayPal sends when the payout item completes. The message is the same for all recipients.