--- title: Get a list of refunds slug: reference/get-a-list-of-refunds docTags: createdAt: 2026-08-23T06:01:06.452Z --- { "id": "FvLOGDt1XMdRECjrKurAw", "type": "api-oas-v2", "data": { "method": "GET", "url": "/api/refunds", "servers": [], "name": "Get a list of refunds", "description": "", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [ { "kind": "required", "name": "paymentId", "type": "string", "description": "Identifier for the payment" }, { "kind": "optional", "name": "createdAfter", "type": "string", "example": "2025-06-15T07:13:23Z", "description": "

Return refunds created at or after this timestamp (ISO 8601 format)

", "format": "date-time" }, { "kind": "optional", "name": "createdBefore", "type": "string", "example": "2025-06-15T09:13:23Z", "description": "

Return refunds created at or before this timestamp (ISO 8601 format)

", "format": "date-time" }, { "kind": "optional", "name": "limit", "type": "number", "example": 13, "description": "Limit on the number of refunds to return", "default": 10 } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "List of refunds", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ListRefundsResponseDTO", "schema": [ { "name": "data", "kind": "required", "type": "array", "description": "List of refund objects", "modelRef": "#/components/schemas/RefundResponseDTO", "customType": "RefundResponseDTO[]", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for the refund" }, { "name": "amount", "kind": "required", "type": "number", "description": "Amount of the refund in the lowest denomination of the currency", "example": 1357 }, { "name": "currency", "kind": "required", "type": "string", "description": "

Currency code for the refund, e.g., USD, EUR

", "example": "GBP", "enum": [ "AED", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BWP", "BYN", "BZD", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SEK", "SGD", "SHP", "SLE", "SLL", "SOS", "SRD", "SSP", "STN", "SVC", "SZL", "THB", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW" ] }, { "name": "status", "kind": "required", "type": "string", "description": "Status of the refund", "example": "succeeded", "enum": [ "pending", "succeeded", "failed", "voided" ] }, { "name": "reason", "kind": "optional", "type": "string", "description": "Reason for payment refund", "example": "duplicate", "enum": [ "duplicate", "fraudulent", "requested_by_customer", "other" ] }, { "name": "processor", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ProcessorDTO", "description": "", "modelRef": "#/components/schemas/ProcessorDTO", "schema": [ { "name": "name", "kind": "optional", "type": "string", "description": "Processor used for the payment", "enum": [ "stripe", "adyen", "braintree", "airwallex", "connexpay", "echo", "fiserv" ] }, { "name": "transactionId", "kind": "optional", "type": "string", "description": "

Processor-assigned transaction id

", "example": "pi_abc123" }, { "name": "chargeId", "kind": "optional", "type": "string", "description": "

Processor-assigned charge id

", "example": "ch_xyz789" } ] } ], "schema": [] }, { "name": "createdAt", "kind": "optional", "type": "string", "description": "

ISO 8601 formatted timestamp (e.g., 2025-07-14T12:34

.000Z)

", "example": "2025-07-14T12:34:56.000Z", "format": "date-time" } ] } ], "modelRef": "#/components/schemas/ListRefundsResponseDTO", "isExpanded": true } ] }, { "statusCode": "400", "description": "Bad request", "jsonExample": "", "isExpanded": true }, { "statusCode": "401", "description": "Unauthorized", "jsonExample": "", "isExpanded": true }, { "statusCode": "404", "description": "Not found", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "QJ-HuBPdIR6PWHgo__t6N", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url '/api/refunds?paymentId=string&limit=10' \\\n --header 'accept: application/json'" }, { "id": "zsNW6SF0hjfcQsd_PHSAa", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"/api/refunds?paymentId=string&limit=10\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "lnw-UtusfLFY1EwQLqtxf", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"/api/refunds?paymentId=string&limit=10\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = http.request(request)\nputs response.read_body\n" }, { "id": "YrqUM4S0RAmj1n6R1XDMQ", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"/api/refunds?paymentId=string&limit=10\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "QJ-HuBPdIR6PWHgo__t6N" }, "results": { "languages": [ { "id": "x-g8I6UHuBNzc_2XzYLPZ", "language": "200", "code": "// List of refunds\n{\n \"data\": [\n {\n \"id\": \"\",\n \"amount\": 1357,\n \"currency\": \"GBP\",\n \"status\": \"succeeded\",\n \"reason\": \"duplicate\",\n \"processor\": {},\n \"createdAt\": \"2025-07-14T12:34:56.000Z\"\n }\n ]\n}" }, { "id": "GO7YFWorp07KWE3JCI9TT", "language": "400", "code": "// Bad request\n" }, { "id": "pPD_Kcn5_EOV_F4H0mMdk", "language": "401", "code": "// Unauthorized\n" }, { "id": "TyBjR7tICQJLWN_21irwx", "language": "404", "code": "// Not found\n" } ], "selectedLanguageId": "x-g8I6UHuBNzc_2XzYLPZ" } }, "children": [ { "text": "" } ] }