Refund captured payment
POST {{base_url}}/v2/payments/captures/:capture_id/refund
Refunds a captured payment, by ID. For a full refund, include an empty payload in the JSON request body. For a partial refund, include an amount object in the JSON request body.
Request Body
{"amount"=>{"value"=>"10.00", "currency_code"=>"USD"}, "invoice_id"=>"{{$timestamp}}", "note_to_payer"=>"Defective product"}
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: Created
{"id":"74C09851BT735224L","amount":{"currency_code":"USD","value":"50.00"},"seller_payable_breakdown":{"gross_amount":{"currency_code":"USD","value":"50.00"},"paypal_fee":{"currency_code":"USD","value":"1.75"},"net_amount":{"currency_code":"USD","value":"48.25"},"total_refunded_amount":{"currency_code":"USD","value":"60.00"}},"invoice_id":"1644280649","status":"COMPLETED","create_time":"2022-02-07T16:38:15-08:00","update_time":"2022-02-07T16:38:15-08:00","links":[{"href":"https://api.sandbox.paypal.com/v2/payments/refunds/74C09851BT735224L","rel":"self","method":"GET"},{"href":"https://api.sandbox.paypal.com/v2/payments/captures/1DL556911D1752055","rel":"up","method":"GET"}]}