Sender Batch Header

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_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.

The ID type that identifies the recipient of the payment. For example, EMAIL.

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.

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

The payouts and item-level notes are concatenated in the email. The maximum combined length of the notes is 1000 characters.