Cancel a payout item
You can cancel a payout item only if its status isUNCLAIMED
. Use the PayPal business account dashboard or Payouts API to cancel unclaimed payout items.
To implement payment cancellation functionality, you can use the dashboard or the Payouts API.
Note: Unclaimed payouts expire in 30 days, and PayPal returns the money to your PayPal account.
Use the dashboard
- Log into your PayPal business account.
- Select Activity > Transactions > All Transactions.
- On the Transactions page:
- Select Email address from the drop-down list.
- Enter the recipient’s email address in the search box.
- Select Filter.
- Select the date range.
- Select Apply Filters. The search results display the transaction list that match your criteria.
- Select the title of the unclaimed payment you want to cancel.
- On the details page, select Cancel and follow the on-screen instructions.
Use the Payouts API
- Send the POST request to the
/v1/payments/payouts-item/{payout_item_id}/cancel
endpoint. Replace{payout_item_id}
with the payout item ID retrieved from the Show payout batch details response. - Review the response to confirm the cancellation of the payout item. A successful request returns the HTTP
200 OK
status code with a JSON response body that shows payout item details.
Reverse payouts
PayPal cannot reverse payments that a payer sends to an incorrect email address or phone number. However, if the status of the payout item isUNCLAIMED
, a payer can cancel the payout item and create a new payout with the correct recipient details.
If not, all unclaimed payouts expire in 30 days, and PayPal returns the money to the payer’s PayPal account.
API reference
Cancel unclaimed payout item:/v1/payments/payouts-item/{payout_item_id}/cancel