Skip to main content

List refunds

Availability pending. Check applicability.

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

GET /v1/refunds

Returns the current merchant's Refunds in descending creation time, then descending ID. All statuses are included unless filtered. Multiple filters are combined.

AttributeLocationTypeRequiredDescription
payment_intentquerystringNoFilter by original payment identifier
attempt_idquerystringNoFilter by payment identifier
statusquerystringNorequires_action, processing, succeeded or canceled
page_sizequeryintegerNoDefault 20; range 1–100
page_tokenquerystringNoPrior next_page_token; omit on first page

Keep filters unchanged when paginating. No Idempotency-Key or body is required.

Request:

GET /v1/refunds?payment_intent=pi_example&status=succeeded&page_size=20
Authorization: Bearer inv_test_...

Response: 200 OK, complete Refund objects in data; an empty next_page_token ends pagination.

{
"data": [
{
"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"
}
],
"next_page_token": ""
}

No matches returns {"data":[],"next_page_token":""}.

Business error codes