Cancel unclaimed payout item
POST {{base_url}}/v1/payments/payouts-item/:payout_item_id/cancel
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
transaction_status
of
UNCLAIMED
.
HEADERS
| Key | Datatype | Required | Description |
| Content-Type | string | | The Content-Type header field is used to specify the nature of the data in the body of an entity. PayPal REST APIs support application/json. |
| PayPal-Request-Id | string | | The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager. |
| PayPal-Client-Metadata-Id | string | | Optional. Verifies that the payment originates from a valid, user-consented device and application. Reduces fraud and decreases declines. Transactions that do not include a client metadata ID are not eligible for PayPal Seller Protection. |
| PayPal-Partner-Attribution-Id | string | | Optional. Identifies the caller as a PayPal partner. To receive revenue attribution, specify a unique build notation (BN) code. BN codes provide tracking on all transactions that originate or are associated with a particular partner. To find your BN code, see Code and Credential Reference. |
| PayPal-Auth-Assertion | string | | An API client-provided JSON Web Token (JWT) assertion that identifies the merchant. To use this header, you must get consent to act on behalf of a merchant.
|
| Prefer | string | | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul> |
| Prefer | string | | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul> |
RESPONSES
status: OK
{"payout_item_id":"S697W7QJMAEX4","transaction_id":"0FY48488BY887313U","activity_id":"53C6543893640342P","transaction_status":"RETURNED","payout_item_fee":{"currency":"USD","value":"0.25"},"payout_batch_id":"MJ77GF8MQ2TF6","sender_batch_id":"Payouts_1681157804","payout_item":{"recipient_type":"PHONE","amount":{"currency":"USD","value":"20.00"},"note":"Thanks for your support!","receiver":"15562941698","sender_item_id":"201403140002","recipient_wallet":"PAYPAL"},"time_processed":"2023-04-10T20:16:45Z","errors":{"name":"RECEIVER_UNREGISTERED","message":"The recipient for this payout does not have an account. A link to sign up for an account was sent to the recipient. However, if the recipient does not claim this payout within 30 days, the funds will be returned to your account.","information_link":"https://developer.paypal.com/docs/api/payments.payouts-batch/#errors","details":[],"links":[]},"links":[{"href":"https://api.sandbox.paypal.com/v1/payments/payouts-item/S697W7QJMAEX4","rel":"self","method":"GET","encType":"application/json"},{"href":"https://api.sandbox.paypal.com/v1/payments/payouts/MJ77GF8MQ2TF6","rel":"batch","method":"GET","encType":"application/json"}]}