RevKeenDocs
StatusSupport
API Reference

List disputes

Retrieve a paginated list of disputes/chargebacks with optional filters. Results are ordered by disputed date (newest first). --- **Related endpoints** - `GET /disputes/open` — Get open disputes requiring action - `GET /disputes/{id}` — Get dispute 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
/disputes

Retrieve a paginated list of disputes/chargebacks with optional filters. Results are ordered by disputed date (newest first).

Related endpoints

  • GET /disputes/open — Get open disputes requiring action
  • GET /disputes/{id} — Get dispute 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 dispute status

Value in

  • "needs_response"
  • "under_review"
  • "won"
  • "lost"
  • "warning_closed"
  • "warning_needs_response"
resolution?string

Filter by resolution outcome

Value in

  • "won"
  • "lost"
  • "withdrawn"
payment_id?string

Filter by original payment ID

Formatuuid
gateway?string

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

disputed_after?string

ISO 8601 date - only disputes after this date

disputed_before?string

ISO 8601 date - only disputes before this date

needs_evidence?string

Only show disputes that need evidence submission

Value in

  • "true"
  • "false"
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/disputes" \
  -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",      "gateway": "string",      "payment_rail": "string",      "dispute_kind": "string",      "gateway_dispute_id": "string",      "gateway_transaction_id": "string",      "amount_minor": 0,      "currency": "string",      "reason_code": "string",      "reason": "string",      "network_reason_code": "string",      "network_reason_description": "string",      "customer_name": "string",      "card_brand": "string",      "card_last4": "string",      "evidence_due_by": "string",      "evidence_submitted": true,      "evidence_submitted_at": "2019-08-24T14:15:22Z",      "status": "needs_response",      "resolution": "won",      "resolved_at": "2019-08-24T14:15:22Z",      "disputed_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "total": 0,    "limit": 0,    "offset": 0,    "has_more": true  }}

Get dispute by ID GET

Retrieve a single dispute by its public ID (dsp_xxx) or internal UUID. --- **Related endpoints** - `GET /disputes` — List disputes - `GET /disputes/open` — Get open disputes requiring action **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.

Check entitlement access GET

Check if a customer has access to a specific benefit by key. This is the primary endpoint for feature gating and licensing checks. --- **Related endpoints** - `GET /customers/{customerId}/entitlements` — List customer entitlements - `POST /customers/{customerId}/entitlements` — Grant entitlement to customer - `DELETE /customers/{customerId}/entitlements` — Revoke entitlement by benefit key - `GET /customers/{customerId}/entitlements/check` — Check customer entitlement - `DELETE /customers/{customerId}/entitlements/{entitlementId}` — Revoke entitlement by ID - `GET /entitlements` — List entitlements **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.