PayPal · Schema

Sender Batch Header

The sender-provided payout header for a payout request.

BillingCommerceDisputesInvoicesOrdersPaymentsPayoutsSubscriptionsTokensWebhooks

Properties

Name Type Description
sender_batch_id string 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 t
recipient_type string The ID type that identifies the recipient of the payment. For example, EMAIL.
email_subject string 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 cha
email_message string The email message that PayPal sends when the payout item completes. The message is the same for all recipients.
note string The payouts and item-level notes are concatenated in the email. The maximum combined length of the notes is 1000 characters.
View JSON Schema on GitHub

JSON Schema

paypal-sender-batch-header-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/sender_batch_header",
  "title": "Sender Batch Header",
  "type": "object",
  "description": "The sender-provided payout header for a payout request.",
  "properties": {
    "sender_batch_id": {
      "type": "string",
      "description": "A sender-specified ID number. Tracks the payout in an accounting system.<blockquote><strong>Note:</strong> <p>PayPal does not process duplicate payouts. If you specify a <code>sender_batch_id</code> that was used in the last 30 days, the API rejects the request with an error message that shows the duplicate <code>sender_batch_id</code> and includes a HATEOAS link to the original payout with the same <code>sender_batch_id</code>.</p><p>If you receive an HTTP <code>5<i>nn</i></code> status code, you can safely retry the request with the same <code>sender_batch_id</code>. The API completes a payment only once for a <code>sender_batch_id</code> that is used within 30 days.</p></blockquote>",
      "minLength": 0,
      "maxLength": 256,
      "pattern": "^.*$"
    },
    "recipient_type": {
      "type": "string",
      "description": "The ID type that identifies the recipient of the payment. For example, <code>EMAIL</code>.",
      "minLength": 0,
      "maxLength": 13,
      "pattern": "^.*$"
    },
    "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 of up to 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": "^.*$"
    },
    "note": {
      "type": "string",
      "description": "The payouts and item-level notes are concatenated in the email. The maximum combined length of the notes is 1000 characters.",
      "minLength": 0,
      "maxLength": 1000,
      "pattern": "^.*$"
    }
  }
}