The PayPal-generated batch status.
batch_headerobject<payout_batch_header>Optionalbatch_statusenum<batch_enum>Requiredtime_closedstringOptionalsender_batch_headerobject<payout_sender_batch_header>Requiredsender_batch_idstringOptionalNote: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_typeenum<recipient_enum>Optionalfunding_sourceenum<funding_source>Optionalamountobject<currency>OptionalvaluestringRequiredfeesobject<currency>OptionalvaluestringRequiredtransaction_statusenum<transaction_enum>OptionalNote: ForPOST/v1/payments/payouts-item/{payout_item_id}/cancel, the only possibletransaction_statusvalue isRETURNED.
payout_item_feeobject<currency>OptionalvaluestringRequiredpayout_itemobject<payout_item_detail>Requiredrecipient_typeenum<recipient_enum>Optionalamountobject<currency>RequiredvaluestringRequiredrecipient_nameobject<name>Optionalrecipient_walletenum<recipient_wallet_enum>Optionalpurposeenum<purpose_enum>Optionalcurrency_conversionobject<payout_currency_conversion>Optionalfrom_amountobject<currency>OptionalvaluestringRequiredto_amountobject<currency>OptionalvaluestringRequirederrorsobject<error>Optionaldetailsobject<error_details-2>[]Optionallinksobject<link_description>[]OptionalhrefstringRequiredlinksobject<link_description>[]OptionalhrefstringRequiredlinksobject<link_description>[]OptionalhrefstringRequired