On this page
No Headings
The PayPal-generated batch status.
objecttotal_itemsintegerThe total number of items in the full result list.
total_pagesintegerThe total number of pages.
batch_headerobjectA payout header. Includes the generated payout status.
payout_batch_idrequiredstring^.*$The PayPal-generated ID for a payout.
batch_statusrequiredstring"DENIED", "PENDING", "PROCESSING", "SUCCESS", "CANCELED"^[0-9A-Z_]+$The PayPal-generated payout status. If the payout passes preliminary checks, the status is PENDING.
time_createdstringdate-timeThe date and time when processing for the payout began, in Internet date and time format.
time_completedstringdate-timeThe date and time when processing for the payout was completed, in Internet date and time format.
time_closedstringdate-timeThe date and time when the payout was closed, in Internet date and time format. A payout is considered closed when all items in a batch are processed and the available balance from the temporary hold is released.
sender_batch_headerrequiredobjectThe original payout header, as provided by the payment sender.
sender_batch_idstring^.*$The 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"EMAIL", "PHONE", "PAYPAL_ID"^[0-9A-Z_]+$The ID type that identifies the payment receiver.
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 with a maximum length of 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.
funding_sourcestring"BALANCE"^[0-9A-Z_]+$The ID to differentiate a PayPal balance-funded transaction from a PayPal treasury-funded transaction.
amountobjectThe currency and total amount requested for the payouts.
valuerequiredstringThe value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.feesobjectThe currency and amount of the total estimate for the applicable payouts fees. Initially, the fee is 0. The fee is populated after the payout moves to the PROCESSING state.
valuerequiredstringThe value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.itemsarrayAn array of individual items.
itemsobjectThe payout item status and other details.
payout_item_idrequiredstring^.*$The ID for the payout item. Viewable when you show details for a payout.
transaction_idstring^.*$The PayPal-generated ID for the transaction.
activity_idstring^.*$The unique PayPal-generated common ID created to link sender side and receiver side transaction. Used for tracking.
transaction_statusstring"SUCCESS", "FAILED", "PENDING", "UNCLAIMED", "RETURNED", "ONHOLD", "BLOCKED", "REFUNDED", "REVERSED"^[0-9A-Z_]+$The item transaction status.
Note: ForPOST/v1/payments/payouts-item/{payout_item_id}/cancel, the only possibletransaction_statusvalue isRETURNED.
payout_item_feeobjectThe fee, in U.S. dollars.
valuerequiredstringThe value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.payout_batch_idrequiredstring^.*$The PayPal-generated ID for the payout.
payout_itemrequiredobjectThe sender-provided information for the payout item.
recipient_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.
currency_conversionobjectThe currency conversion applicable for this payout item.
from_amountobjectThe amount that is converted from.
valuerequiredstringThe value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.to_amountobjectThe amount that is converted to.
valuerequiredstringThe value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.exchange_ratestring^.*$The exchange rate that is applied for this payout.
time_processedstringdate-timeThe date and time when this item was last processed, in Internet date and time format.
errorsobjectThe error details.
namerequiredstringThe human-readable, unique name of the error.
messagerequiredstringThe message that describes the error.
debug_idrequiredstringThe PayPal internal ID. Used for correlation purposes.
information_linkstringThe information link, or URI, that shows detailed information about this error for the developer.
detailsarrayAn array of additional details about the error.
itemsobjectThe error details. Required for client-side 4XX errors.
fieldstringThe field that caused the error. If this field is in the body, set this value to the field's JSON pointer value. Required for client-side errors.
valuestringThe value of the field that caused the error.
locationstring"body"The location of the field that caused the error. Value is body, path, or query.
issuerequiredstringThe unique, fine-grained application-level error code.
descriptionstringThe human-readable description for an issue. The description can change over the lifetime of an API, so clients must not depend on this value.
linksarrayAn array of request-related HATEOAS links.
itemsobjectThe request-related HATEOAS link information.
hrefrequiredstringThe complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the $, (, and ) characters. The href is the key HATEOAS component that links a completed call with a subsequent call.
relrequiredstringThe link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.
methodstring"GET", "POST", "PUT", "DELETE", "HEAD", "CONNECT", "OPTIONS", "PATCH"The HTTP method required to make the related call.
linksarrayAn array of request-related HATEOAS links.
itemsobjectThe request-related HATEOAS link information.
hrefrequiredstringThe complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the $, (, and ) characters. The href is the key HATEOAS component that links a completed call with a subsequent call.
relrequiredstringThe link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.
methodstring"GET", "POST", "PUT", "DELETE", "HEAD", "CONNECT", "OPTIONS", "PATCH"The HTTP method required to make the related call.
linksarrayAn array of request-related HATEOAS links.
itemsobjectThe request-related HATEOAS link information.
hrefrequiredstringThe complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the $, (, and ) characters. The href is the key HATEOAS component that links a completed call with a subsequent call.
relrequiredstringThe link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.
methodstring"GET", "POST", "PUT", "DELETE", "HEAD", "CONNECT", "OPTIONS", "PATCH"The HTTP method required to make the related call.