{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "#/components/schemas/payout_sender_batch_header", "title": "Payout Sender Batch Header", "type": "object", "description": "The sender-provided header for a payout request.", "properties": { "sender_batch_id": { "type": "string", "description": "The sender-specified ID number. Tracks the payout in an accounting system.
Note:", "minLength": 0, "maxLength": 256, "pattern": "^.*$" }, "recipient_type": { "$ref": "#/components/schemas/recipient_enum" }, "email_subject": { "type": "string", "description": "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.", "minLength": 0, "maxLength": 255, "pattern": "^.*$" }, "email_message": { "type": "string", "description": "The email message that PayPal sends when the payout item completes. The message is the same for all recipients.", "minLength": 0, "maxLength": 1000, "pattern": "^.*$" } } }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.