Track payout item status

You can track the status of the individual payout items in a payout batch.

Use a valid access token and make a GET call to the /v1/payments/payouts-item/{PAYOUT-ITEM-ID} endpoint.
Path parameter: PAYOUT-ITEM-ID is the payout_item_id returned as part of the payout batch details response.

Sample request

curl -v -X GET https://api-m.sandbox.paypal.com/v1/payments/payouts-item/8AELMXH8UB2P8 \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer ACCESS-TOKEN'  

A successful call returns a 200 OK response. The response includes the transaction_status parameter, which indicates the current status of the payout item.

The following table summarizes the possible values of transaction_status and what they mean:

Status	Description	Possible management action
SUCCESS	PayPal has completed processing the payout and credited the money to the recipient’s account.	No action required.
FAILED	The payout has failed. PayPal does not deduct money from your account.	Review the failure reason and create a new payout request if needed.
PENDING	PayPal is processing the payout.	Check the status again later.
UNCLAIMED	The recipient has not claimed the payout. This typically occurs when the recipient does not have a PayPal or Venmo account. PayPal sends a signup link, and the payout status remains unclaimed until claimed or returned. For more information, see Handle unclaimed payouts.	Notify the recipient to claim the payout.
RETURNED	PayPal has returned the money to your account. This occurs when the recipient does not claim the payout or you cancel it.	Create a new payout request if needed.
ONHOLD	PayPal has temporarily placed the payout on hold.	Check the status again later.
BLOCKED	PayPal has blocked the payout.	Review the reason, resolve the issues, and create a new payout request if needed.
REFUNDED	The recipient has refunded the payout. PayPal returns the money to your account.	No action required.
REVERSED	PayPal has reversed the payout. PayPal returns the money to your account. This status is specific to payouts created through web uploads.	No action required.