On this page
No Headings
The details for a sender-created payout to a single recipient.
objectrecipient_typestring"EMAIL", "PHONE", "PAYPAL_ID"^[0-9A-Z_]+$The ID type that identifies the payment receiver.
amountrequiredobjectThe currency and amount of payout item. Might be an integer for currencies like JPY that are not typically fractional or a decimal fraction for currencies like TND that are subdivided into thousandths. For the required number of decimal places for a currency code, see Currency codes - ISO 4217.
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.
sender_item_idstring^.*$A sender-specified ID number. Tracks the payout in an accounting system.
recipient_nameobjectThe name of the recipient where money is credited. For UNCLAIMED payments, the recipient name is populated after the payment is claimed.
prefixstringThe prefix, or title, to the party's name.
given_namestringWhen the party is a person, the party's given, or first, name.
surnamestringWhen the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.
middle_namestringWhen the party is a person, the party's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name.
suffixstringThe suffix for the party's name.
alternate_full_namestringDEPRECATED. The party's alternate name. Can be a business name, nickname, or any other name that cannot be split into first, last name. Required when the party is a business.
full_namestringWhen the party is a person, the party's full name.
recipient_walletstring"PAYPAL", "VENMO"^[0-9A-Z_]+$"PAYPAL"The recipient wallet.
purposestring"AWARDS", "PRIZES", "DONATIONS", "GOODS", "SERVICES", "REBATES", "CASHBACK", "DISCOUNTS", "NON_GOODS_OR_SERVICES"^[A-Z0-9_]+$The purpose of the transaction.