On this page
No Headings
The sender-provided payout header for a payout request.
objectsender_batch_idstring^.*$A 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^.*$The ID type that identifies the recipient of the payment. For example, EMAIL.
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 of up to 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.
notestring^.*$The payouts and item-level notes are concatenated in the email. The maximum combined length of the notes is 1000 characters.