Skip to main content
You can track the status of the individual payout items in a payout batch.
  1. Use a valid access token and send a GET request to /v1/payments/payouts/{id}.
    Path parameter: id is the payout batch ID returned as part of the Create payout batch response.
    Response: On successful processing, PayPal returns the payout_item_id for all items in the payout batch.
  2. Use a valid access token and send a GET request to /v1/payments/payouts-item/{payout_item_id}. Path parameter: payout_item_id is the payout item ID returned in the previous step.
    Response: On successful processing, PayPal returns the transaction_status of the payout item.
The following table summarizes the various values of transaction_status and what they mean:
StatusDescription
PENDINGPayPal processes your payout. The recipient receives the money after processing.
SUCCESSPayPal credits money to the recipient’s account.
UNCLAIMEDThe recipient does not have a PayPal or Venmo account. PayPal sends a signup link, and the payout status remains unclaimed until claimed or returned.
REFUNDEDThe recipient refunds the payout. PayPal returns the money to your account.
FAILEDThe payout fails. PayPal does not deduct money from your account.
ON_HOLDPayPal reviews the payout. The payout stays temporarily on hold.
BLOCKEDPayPal blocks the payout request.
DENIEDPayPal denies the payout. PayPal does not deduct money from your account.
RETURNEDPayPal returns the money to your account. This happens if the recipient does not claim the payout or you cancel it.
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>'