Sign in

v1

latestOpenAPI 3.0.42026-07-2286621993.2 KB
payouts-item

Show payout item details

Shows details for a payout item, by ID. A <code>payout_item_id</code> helps you identify denied payments. If a payment is denied, you can use the <code>payout_item_id</code> to identify the payment even if it lacks a <code>transaction_id</code>.

get/v1/payments/payouts-item/{payout_item_id}

Path parameters

payout_item_idstring required

The ID of the payout item to cancel.

Response

A successful request returns the HTTP <code>200 OK</code> status code and a JSON response body with a <code>payout_item_details</code> object, which contains data about a payout item including the transaction status.

payout_item_idstring required

The ID for the payout item. Visible when you show details for a payout.

transaction_idstring

The PayPal-generated ID for the transaction.

activity_idstring

The unique PayPal-generated common ID that links the sender- and receiver-side transactions. Used for tracking.

transaction_status'SUCCESS' | 'FAILED' | 'PENDING' | 'UNCLAIMED' | 'RETURNED' | 'ONHOLD' | 'BLOCKED' | 'REFUNDED' | 'REVERSED'

The item transaction status.<blockquote><strong>Note:</strong> For <code>POST/v1/payments/payouts-item/{payout_item_id}/cancel</code>, the only possible <code>transaction_status</code> value is <code>RETURNED</code>.</blockquote>

payout_batch_idstring required

The PayPal-generated ID for the payout batch.

sender_batch_idstring

A sender-specified ID. Tracks the payout in an accounting system. Should be unique within 30 days.

time_processedstring date-time

The date and time when this item was last processed, in Internet date and time format.