RevKeenDocs
StatusSupport
API Reference

List refunds

Retrieve a paginated list of refunds with optional filters. Results are ordered by creation date (newest first). --- **Related endpoints** - `POST /refunds` — Create a refund - `GET /refunds/{id}` — Get refund by ID **Common errors** - `401 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. **Pagination** Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers.

GET
/refunds

Retrieve a paginated list of refunds with optional filters. Results are ordered by creation date (newest first).

Related endpoints

  • POST /refunds — Create a refund
  • GET /refunds/{id} — Get refund by ID

Common errors

  • 401 authentication_error — missing, invalid, expired, or revoked credential. Codes: authentication_failed, invalid_api_key, expired_api_key, api_key_revoked, session_invalid, merchant_required. Carries a WWW-Authenticate: Bearer challenge.

Pagination

Offset-based with limit (default 25, max 100) and offset. The response pagination block includes total and hasMore. See the pagination guide for SDK auto-paging helpers.

Authorization

x-api-key<token>

Your RevKeen merchant API key. Create and manage keys in Dashboard → Settings → Developer. Use rk_sandbox_* for staging/test and rk_live_* for production. The same key may be sent as Authorization: Bearer <key> if that suits your HTTP client better. A missing, invalid, expired, or revoked key returns 401 with a WWW-Authenticate: Bearer challenge; a valid key without the required scope returns 403.

In: header

Query Parameters

status?string

Filter by refund status

Value in

  • "pending"
  • "processing"
  • "succeeded"
  • "failed"
  • "canceled"
payment_id?string

Filter by original payment ID

Formatuuid
gateway?string

Filter by payment gateway (nmi, stripe, etc.)

reason?string

Filter by refund reason

Value in

  • "customer_request"
  • "duplicate"
  • "fraudulent"
  • "product_not_received"
  • "product_unacceptable"
  • "subscription_canceled"
  • "other"
created_after?string

ISO 8601 date - only refunds created after this date

created_before?string

ISO 8601 date - only refunds created before this date

limit?number

Number of results to return (1-100)

Range1 <= value <= 100
Default20
offset?|

Number of results to skip

Range0 <= value
Default0

Response Body

application/json

application/json

application/json

application/json

Stuck on an error response? Ask the RevKeen assistant to explain it.
curl "https://api.revkeen.com/v2/refunds" \
  -H "x-api-key: $REVKEEN_API_KEY"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "public_id": "string",      "payment_id": "d43b87f9-9e28-4802-8eaa-6ee91a40ea71",      "parent_transaction_id": "2862f816-fb62-4845-833b-6951bbef56b3",      "order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",      "gateway": "string",      "gateway_refund_id": "string",      "amount_minor": 0,      "currency": "string",      "reason": "customer_request",      "reason_details": "string",      "status": "pending",      "failure_reason": "string",      "failure_code": "string",      "processed_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "total": 0,    "limit": 0,    "offset": 0,    "has_more": true  }}

Get refund by ID GET

Retrieve a single refund by its public ID (ref_xxx) or internal UUID. --- **Related endpoints** - `GET /refunds` — List refunds - `POST /refunds` — Create a refund **Common errors** - `401 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.

Register a storefront origin POST

Register an exact web origin (scheme://host[:port]) for publishable-key storefront calls. Wildcards are rejected; http is allowed only for localhost. --- **Related endpoints** - `GET /storefront/products` — List storefront products - `GET /storefront/products/{productId}` — Get a storefront product - `GET /storefront/origins` — List storefront origins - `DELETE /storefront/origins/{originId}` — Remove a storefront origin - `GET /storefront/status` — Get storefront integration status **Common errors** - `400 invalid_request` — malformed payload or failed validation. - `401 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. - `403 authorization_error` — the caller is identified but the action is denied. Codes include `insufficient_permissions`, `ip_not_allowed`, `merchant_mismatch`, and `origin_not_allowed`. - `409 conflict` — Idempotency-Key collision with a different body, or a concurrent state-transition conflict. **Idempotency** Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).