RevKeenDocs
StatusSupport
API Reference
💳 Core PaymentsRefunds

List refunds

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

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"
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 -X GET "https://api.revkeen.com/v2/refunds?status=pending&payment_id=11111111-1111-4111-8111-111111111111" \
  -H "x-api-key: $REVKEEN_API_KEY"

Synthetic documentation data, validated against the response schema; not a live API result.

{  "data": [    {      "id": "1b2c3d4e-5f6a-4b87-9c98-0d1e2f3a4b86",      "public_id": "ref_example_7k2m",      "payment_id": "7b8c9d0e-1f2a-4b43-9d4e-5f6a7b8c9d42",      "parent_transaction_id": "7b8c9d0e-1f2a-4b43-9d4e-5f6a7b8c9d42",      "order_id": null,      "gateway": "nmi",      "gateway_refund_id": "10482739012",      "amount_minor": 1176,      "currency": "GBP",      "reason": "customer_request",      "reason_details": "Goodwill credit: one week of the Pro plan.",      "status": "succeeded",      "failure_reason": null,      "failure_code": null,      "processed_at": "2026-04-20T14:31:00.000Z",      "created_at": "2026-04-20T14:30:00.000Z"    }  ],  "meta": {    "total": 1,    "limit": 20,    "offset": 0,    "has_more": false  }}