Track payout item status

You can track the status of the payout items in a payout batch using the Payouts API.

• Send a GET request to /v1/payments/payouts-item/{payout_item_id}. Replace {payout_item_id} with the payout item ID retrieved from the Show payout batch details response.
• The response includes the transaction_status for each payout item in the batch.

The following table summarizes payout statuses at the item level:

Status	Description
PENDING	PayPal processes your payout. The recipient receives the money after processing.
SUCCESS	PayPal credits money to the recipient's account.
UNCLAIMED	The recipient does not have a PayPal or Venmo account. PayPal sends a signup link, and the payout status stays unclaimed until claimed or returned.
REFUNDED	The recipient refunds the payout. The money returns to your account.
FAILED	The payout fails, and PayPal does not deduct money from your account.
ON_HOLD	PayPal reviews the payout. The payout stays temporarily on hold.
BLOCKED	PayPal blocks the payout request.
DENIED	PayPal denies the payout. Money is not deducted from your account.
RETURNED	Money returns to your account. This happens if the recipient does not claim the payout or you cancel it.

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>'  

Sample response

{
  "payout_item_id": "8AELMXH8UB2P8",
  "transaction_id": "0C413693MN970190K",
  "activity_id": "0E158638XS0329106",
  "transaction_status": "SUCCESS",
  "payout_item_fee": {
    "currency": "USD",
    "value": "0.35"
  },
  "payout_batch_id": "Q8KVJG9TZTNN4",
  "sender_batch_id": "Payouts_1753867886",
  "payout_item": {
    "recipient_type": "EMAIL",
    "amount": {
      "value": "9.87",
      "currency": "USD"
    },
    "note": "Thanks for your patronage!",
    "receiver": "[email protected]",
    "sender_item_id": "14Feb_234",
    "recipient_wallet": "PAYPAL",
    "purpose": "GOODS"
  },
  "time_processed": "2018-01-27T10:17:41Z",
  "links": [
    {
      "rel": "self",
      "href": "https://api-m.sandbox.paypal.com/v1/payments/payouts-item/8AELMXH8UB2P8",
      "method": "GET",
      "encType": "application/json"
    },
    {
      "href": "https://api-m.sandbox.paypal.com/v1/payments/payouts/Q8KVJG9TZTNN4",
      "rel": "batch",
      "method": "GET",
      "encType": "application/json"
    }
  ]
}