Cancel a refund
Availability pending. Check applicability.
Object and complete fields · Authentication, amounts and errors · Integration guide
POST /v1/refunds/{id}/cancel
Only requires_action may request cancellation; the result determines whether cancellation is permitted. processing and succeeded reject cancellation. Canceling an already canceled Refund returns its current object.
| Attribute | Location | Type | Required | Description |
|---|---|---|---|---|
Idempotency-Key | header | string | Yes | Unique operation key; retain for retries |
id | path | string | Yes | Refund identifier |
Send {} as the body. Only the current merchant may operate the Refund; missing or inaccessible objects return 404. Errors and idempotency follow common conventions.
Successful cancellation releases reserved funds before a replacement Refund can be created. If cancellation times out or is unknown, retry with the same key. A valid replay returns the first result.
Request:
POST /v1/refunds/re_cancel_example/cancel
Authorization: Bearer inv_test_...
Content-Type: application/json
Idempotency-Key: ec3a7e90-673e-41a1-94d0-6724fba6a339
{}
Response: 200 OK, complete canceled Refund with next_action=null. Cancellation retains any previous execution error and does not add one:
{
"id": "re_cancel_example",
"attempt_id": "8b8fbb6b-4ec7-48d1-92a1-3b20c24b0c21",
"payment_intent": "pi_example",
"amount": "2.5",
"currency": "usdc",
"status": "canceled",
"payment_method": {
"type": "erc20_transfer",
"erc20_transfer": {
"chain": 56,
"recipient_address": "0x1234567890abcdef1234567890abcdef12345678"
}
},
"next_action": null,
"last_execution_error": null,
"description": "Price adjustment",
"metadata": {
"return_id": "RETURN_001"
},
"created_at": "2026-10-27T08:00:00Z",
"updated_at": "2026-10-27T08:01:00Z"
}