On this page
No Headings
The create payout request.
objectsender_batch_headerrequiredobjectThe sender-provided payout header for a payout request.
sender_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.
itemsrequiredarrayAn array of individual payout items.
itemsobjectThe sender-created payout to a recipient.
recipient_typestring^.*$The recipient type. Value is:
EMAIL. The unencrypted email. Value is a string of up to 127 single-byte characters.
PHONE. The unencrypted phone number.
Note: The PayPal sandbox does not support the PHONE recipient type.PAYPAL_ID. The encrypted PayPal account number.
USER_HANDLE. User handle (or) Username associated with Venmo account.
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.amountrequiredobjectThe currency and amount to pay the receiver.
valuerequiredstringThe value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.notestring^.*$The sender-specified note for notifications. Supports up to 4000 ASCII characters and 1000 non-ASCII characters.
receiverrequiredstring^.*$The receiver of the payment. Corresponds to the recipient_type value in the request. Max value of up to 127 single-byte characters.
sender_item_idstring^.*$The sender-specified ID number. Tracks the payout in an accounting system.
recipient_walletstring^.*$"PAYPAL"The recipient wallet.
alternate_notification_methodobjectCaptures additional notification modes to reach out to the receiver regarding this payment.
phoneobjectThe mobile phone number of the receiver.
country_coderequiredstring^[0-9]{1,3}?$The country calling code (CC), in its canonical international E.164 numbering plan format. The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).
national_numberrequiredstring^[0-9]{1,14}?$The national number, in its canonical international E.164 numbering plan format. The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).
extension_numberstring^[0-9]{1,15}?$The extension number.
notification_languagestringppaas_common_language_v3^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}))?$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_contextobjectMetadata for accepting additional information from merchants to Venmo.
social_feed_privacystring^.*$"PRIVATE"This attribute controls the privacy of a payout transaction in recipient’s feed. PUBLIC, FRIENDS_ONLY & PRIVATE are the values that can be used. PUBLIC - The payment displays on the recipient's public Venmo feed. FRIENDS_ONLY - The payment displays only to the recipient's Venmo friends. PRIVATE - The payment displays only on the recipient's personal feed. Defaults to PRIVATE if left blank.
holler_urlstringuriLink to a Holler sticker. For Venmo recipients, the sticker displays with the payout message. The maximum URL length is 151.
logo_urlstringuriLink to a logo that displays as the sender's profile image in the recipient's Venmo feed. Used to add or update the business profile image. Max image size: 1024 x 1024 pixels. The image should be square and maximum URL length is 2000.
purposestring"AWARDS", "PRIZES", "DONATIONS", "GOODS", "SERVICES", "REBATES", "CASHBACK", "DISCOUNTS", "NON_GOODS_OR_SERVICES"^[A-Z0-9_]+$The purpose of the transaction.