List refunds for payment

Returns all refunds for the specified payment, most recent first. Uses cursor-based pagination — pass cursor from a previous response to fetch the next page. Default page size is 20, maximum 100. Returns an empty list if the payment has no refunds.

Authorization

bearer

AuthorizationBearer <token>

In: header

Path Parameters

paymentId*string

Query Parameters

status?string

Filter by refund lifecycle status (e.g. succeeded, failed, pending).

merchantId?string

Filter by merchant ID. Ignored for merchant-scoped API keys (auto-restricted).

Formatuuid

paymentId?string

Filter by originating payment ID. Usually redundant with the :paymentId path parameter.

Formatuuid

livemode?string

Accepted for compatibility. Refunds always belong to the caller mode.

Value in"true" | "false"

cursor?string

Pagination cursor returned from a previous list response.

limit?integer

Page size. Default 20, maximum 100.

Default20

Range1 <= value <= 100

sortOrder?string

Sort by createdAt. Defaults to descending (newest first).

Value in"asc" | "desc"

Response Body

`application/json`

curl -X GET "https://<api-host>/v1/payments/string/refunds"

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
      "livemode": true,
      "paymentId": "472e651e-5a1e-424d-8098-23858bf03ad7",
      "status": "pending",
      "amount": {
        "currency": "string",
        "valueMinor": 9007199254740991
      },
      "reason": "string",
      "merchantReference": "string",
      "statusReason": "string",
      "items": [
        {
          "id": "string",
          "productId": "string",
          "label": "string",
          "description": "string",
          "imageUrl": "string",
          "unitAmount": {
            "currency": "string",
            "valueMinor": 9007199254740991
          },
          "quantity": 1,
          "taxRate": 0,
          "taxAmount": {
            "currency": "string",
            "valueMinor": 9007199254740991
          },
          "metadata": {
            "property1": "string",
            "property2": "string"
          }
        }
      ],
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "pagination": {
    "nextCursor": "string",
    "prevCursor": "string",
    "hasMore": true,
    "totalCount": 0
  }
}

Empty