# List refund reasons `GET /api/v1/refund-reasons` The store's refund reason catalogue: the vocabulary every refund on this store is categorised against, and what a refund's reason id resolves to. ONE LIST COVERS BOTH QUESTIONS a client asks. ?is_active=true is the set a merchant still offers on a new refund; ?is_active=false is what they have retired; omitting it returns both, which is what you want when resolving the reason on a historical refund, because a retired reason stays attached to every refund that already cites it. PAGED BY CREATION TIME, NOT BY code. code reads first in the dashboard, but a merchant can rename one, and a cursor over an editable column would drop or repeat reasons the moment they did. Sort on code yourself once you hold the page. created_by IS NOT PUBLISHED. The row records the merchant user who authored the reason for their own audit trail; it is an internal identifier, and it is empty on every reason written through this API, since a key has no user. ## Query parameters - `is_active` (boolean) — true narrows the page to the reasons the merchant still offers on a new refund, false to the ones they have retired. Omit it for both, which is what you want when resolving the reason on a historical refund: a retired reason stays attached to every refund that already cites it. A value that is not a boolean is a 400 rather than an ignored filter, because a client handed every reason in the store would offer a withdrawn one back to an agent. - `limit` (integer) — Rows per page. Out of range is a 400 rather than a silent clamp, so a client asking for more than 100 learns it did not get it. - `after` (string) — The next_cursor from the previous page. Opaque: decode nothing from it and construct nothing by hand, since its encoding is not part of this contract. Omit it to read the first page. ## Responses - `200` — Success - `400` — The request was refused before any state changed. `code` is one of: `invalid_body`, a write body this route will not take. `reason` partitions it and `field` names the key when one key is at fault. `invalid_query`, a query parameter, including limit and after. `invalid_text`, a NUL byte or bytes that are not valid UTF-8 anywhere in the path, the query or the body. Strip control characters before sending. `idempotency_key_required`, a write sent without the Idempotency-Key header. `invalid_request`, an Idempotency-Key longer than 255 bytes. Routes add their own codes for rules only they know. Switch with a default arm. - `401` — No credential, or one this API does not accept. `code` is always `unauthorized`. THE BODY IS DELIBERATELY UNINFORMATIVE. An expired key, a revoked key, a publishable key, a key belonging to another merchant and a key that never existed are all refused with the same bytes, so this response cannot be used to probe which keys exist. Check the key's state in the dashboard rather than inferring it here. Send the key as `Authorization: Bearer ` or as `X-API-Key: `. It is never accepted in a query string. - `403` — The key lacks the read_refund_reasons scope. `code` is `insufficient_scope` and the message names the scope to ask the merchant for. - `429` — Too many requests. `code` is `rate_limited`. Two limits apply independently: one on the credential and the route family, one on the client address. The headers describe whichever has less left, so honouring Retry-After always clears the window that bound. - `default` — Any status this operation does not list, in the same envelope. A 5xx means the request may or may not have applied. Retry it with the SAME Idempotency-Key: that is the only way to find out without risking a duplicate, and it is what the key is for. A few 4xx conditions arrive here rather than as a listed status because they depend on the merchant's plan or on a module being wired: 402 when a quota or a plan limit is reached, and 503 when a capability the route needs is not configured on this deployment. Both carry a `code` naming which. ## Example ```bash curl --request GET \ --url 'https://api.mercemur.com/api/v1/refund-reasons' \ --header 'Authorization: Bearer ' ```