Sign in

v1

latestOpenAPI 3.1.02026-07-2656258207.2 KB
Refunds

List refunds

get/refunds

Query parameters

pageinteger

The page of the data to retrieve. The most recent data entry is on page 1.

sizeinteger

Length of data returned. Defaults to 10.

fromstring date-time

The start date and time for a period. This parameter is used in conjunction with the 'to' parameter to define a time range. The value should be in ISO 8601 format.

tostring date-time

The end date and time for a period. This parameter is used in conjunction with the 'from' parameter to define a time range. The value should be in ISO 8601 format.

Headers

X-Trace-Idstring

A unique identifier to track this operation. It must be between 12 and 255 characters in length.

Response

OK

status'success' | 'failed'
messagestring

Example response

{
  "data": [
    {
      "amount_refunded": 12.34,
      "reason": "requested_by_customer",
      "status": "new",
      "charge_id": "chg_VnUihmASmF"
    }
  ]
}