{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "#/components/schemas/payout_item", "title": "Payout Item", "type": "object", "description": "The sender-created payout to a recipient.", "properties": { "recipient_type": { "type": "string", "description": "The recipient type. Value is:
If the sender_batch_header includes the recipient_type attribute, payout items use the recipient_type of the sender_batch_header, unless a payout item has its own recipient_type attribute. If the sender_batch_header omits the recipient_type attribute, each payout item must include its own recipient_type value.", "minLength": 0, "maxLength": 13, "pattern": "^.*$" }, "amount": { "description": "The currency and amount to pay the receiver.", "$ref": "#/components/schemas/currency" }, "note": { "type": "string", "description": "The sender-specified note for notifications. Supports up to 4000 ASCII characters and 1000 non-ASCII characters.", "minLength": 0, "maxLength": 4000, "pattern": "^.*$" }, "receiver": { "type": "string", "description": "The receiver of the payment. Corresponds to the `recipient_type` value in the request. Max value of up to 127 single-byte characters.", "minLength": 0, "maxLength": 127, "pattern": "^.*$" }, "sender_item_id": { "type": "string", "description": "The sender-specified ID number. Tracks the payout in an accounting system.", "minLength": 0, "maxLength": 63, "pattern": "^.*$" }, "recipient_wallet": { "type": "string", "description": "The recipient wallet.", "default": "PAYPAL", "minLength": 0, "maxLength": 36, "pattern": "^.*$" }, "alternate_notification_method": { "description": "Captures additional notification modes to reach out to the receiver regarding this payment.", "$ref": "#/components/schemas/alternate_notification_method" }, "notification_language": { "$ref": "#/components/schemas/language", "description": "The language in which to show the payout recipient's email message. Used only when the recipient does not have a PayPal account. If you omit the language or provide invalid language and the recipient does not have a PayPal account, the email message is sent in the language of the merchant's PayPal account." }, "application_context": { "description": "Metadata for accepting additional information from merchants to Venmo.", "$ref": "#/components/schemas/application_context" }, "purpose": { "description": "The purpose of the transaction.", "$ref": "#/components/schemas/purpose_enum" } }, "required": [ "amount", "receiver" ] }