Skip to main content
GET
/
v1
/
refunds
List
curl --request GET \
  --url https://{defaultHost}/v1/refunds \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "pagination": {
    "count": 1,
    "limit": 20,
    "page": 1,
    "url": "/v1/refunds"
  },
  "data": [
    {
      "id": "20f50179-18a2-42a6-a307-0918452f8720",
      "object": "refund",
      "amount": 1450,
      "currency": "usd",
      "external_refund_id": "vdb9w8v9ogl8fr2",
      "failure_reason": null,
      "live_mode": true,
      "metadata": {},
      "reason": "requested_by_customer",
      "status": "pending",
      "charge": "267185fc-b787-4ec4-a1da-675dd6db8065",
      "customer": "f44028ad-5096-4999-89d0-9579b21e3fe1",
      "return_request": null,
      "created_at": 1772113031,
      "updated_at": 1772113031
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
charge_ids[]
string[]

Only return objects with the given charge IDs.

​
customer_ids[]
string[]

Only return objects that belong to the given customers.

​
ids[]
string[]

Only return objects with the given IDs.

​
limit
integer

A limit on the number of items to be returned, between 1 and 100.

​
live_mode
boolean

Only return objects that are live mode or test mode.

​
page
integer

The page of items you want returned.

​
return_request_ids[]
string[]

Only return objects that belong to the given return requests.

Response

200 - application/json

Success

​
object
string

A string describing the object type returned.

​
pagination
object
​
data
array

An array of objects.