Sign in

v1

latestOpenAPI 3.0.42026-07-2286621993.2 KB
payouts-item

Cancel unclaimed payout item

Cancels an unclaimed payout item, by ID. If no one claims the unclaimed item within 30 days, the API automatically returns the funds to the sender. Use this call to cancel the unclaimed item before the automatic 30-day refund. You can cancel payout items with a <code>transaction_status</code> of <code>UNCLAIMED</code>.

post/v1/payments/payouts-item/{payout_item_id}/cancel

Path parameters

payout_item_idstring required

The ID of the payout item to cancel.

Response

A successful request returns the HTTP 200 OK status code with a JSON response body that shows payout item details.

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.