Skip to main content

Retrieve a refund

Availability pending. Check applicability.

Object and complete fields · Authentication, amounts and errors · Integration guide

GET /v1/refunds/{id}

Read current status, signing entry and latest execution error to restore a signing page or reconcile results.

AttributeLocationTypeRequiredDescription
idpathstringYesRefund identifier

Only the current merchant's Refund is readable. Missing or inaccessible refunds return 404 under common error conventions. No Idempotency-Key or body is required.

Request:

GET /v1/refunds/re_example
Authorization: Bearer inv_test_...

Response: 200 OK, the complete Refund. This example has succeeded and needs no wallet action:

{
"id": "re_example",
"attempt_id": "8b8fbb6b-4ec7-48d1-92a1-3b20c24b0c21",
"payment_intent": "pi_example",
"amount": "2.5",
"currency": "usdc",
"status": "succeeded",
"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:05:00Z"
}

Business error codes