ROOKDocs
GET

Retrieve a dispute

ENDPOINT/v1/disputes/{dispute_id}

Returns a single dispute by id, including reason, lifecycle status, resolution, network claim ids, provisional credit, and the chronological events timeline. This operation is program-scoped.

Authentication & Headers

HeaderTypeRequirementDescription
AuthorizationstringREQUIREDAPI key passed as an HTTP Bearer token: Bearer rk_live_...
X-Program-IDUUIDPROGRAM-SCOPEDProgram boundary UUID that scopes the issuing card, wallet, or transfer.

Path Parameters

ParameterTypeRequirementDescription
dispute_idstringREQUIREDUnique identifier of the dispute.

Response Codes & Schemas

200The requested dispute.
application/json
{
  "id": "1d4b7e82-5f9c-4e34-d1a6-0b3e6f1d5687",
  "object": "dispute",
  "transaction_id": "2b5f7a28-9c4d-4e01-a6f3-1d8e0b7c2354",
  "wallet_id": "4d8f2a10-6c3e-4b91-9e5a-2f7c8d1e0b44",
  "amount": {
    "amount": 4280,
    "currency": "USD"
  },
  "reason": "GOODS_SERVICES_NOT_RECEIVED",
  "status": "SUBMITTED",
  "customer_filed_date": "2026-08-27",
  "customer_note": "Merchant confirmed non-delivery.",
  "resolution": null,
  "network_claim_ids": [
    "CB-88421-2026"
  ],
  "events": [
    {
      "type": "CREATED",
      "status_from": null,
      "status_to": "NEW",
      "note": "Opened for goods not received.",
      "created_at": "2026-08-27T18:00:00Z"
    },
    {
      "type": "PROVISIONAL_CREDIT_POSTED",
      "status_from": "NEW",
      "status_to": "NEW",
      "note": "Provisional credit posted to the wallet.",
      "created_at": "2026-08-27T18:00:01Z"
    },
    {
      "type": "UPDATED",
      "status_from": "NEW",
      "status_to": "NEW",
      "note": "Merchant confirmed non-delivery.",
      "created_at": "2026-08-27T18:04:00Z"
    },
    {
      "type": "EVIDENCE_ADDED",
      "status_from": "NEW",
      "status_to": "NEW",
      "note": "receipt.pdf",
      "created_at": "2026-08-27T18:05:00Z"
    },
    {
      "type": "STATUS_CHANGED",
      "status_from": "NEW",
      "status_to": "PENDING_CUSTOMER",
      "note": "Additional cardholder documentation requested.",
      "created_at": "2026-08-27T18:08:00Z"
    },
    {
      "type": "STATUS_CHANGED",
      "status_from": "PENDING_CUSTOMER",
      "status_to": "SUBMITTED",
      "note": "Filed with the card network.",
      "created_at": "2026-08-27T18:12:00Z"
    }
  ],
  "provisional_credit": {
    "amount": {
      "amount": 4280,
      "currency": "USD"
    },
    "status": "POSTED"
  },
  "created_at": "2026-08-27T18:00:00Z",
  "updated_at": "2026-08-27T18:12:00Z"
}
400Bad Request: malformed JSON, failed schema validation, or conflicting parameters.
application/json
{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_request",
    "message": "invalid order by: foo. Valid options are: [created_at updated_at]",
    "param": "order_by",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/invalid_request"
  }
}
401Unauthorized: missing, malformed, or unknown API key.
application/json
{
  "error": {
    "type": "authentication_error",
    "code": "authentication_error",
    "message": "A valid API key is required.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/authentication_error"
  }
}
403Forbidden: the API key is denied by RBAC, or it cannot access this program. A resource that exists on another program or organization returns `404 not_found`, not `403`.
application/json
{
  "error": {
    "type": "permission_error",
    "code": "permission_denied",
    "message": "The API key cannot access this program.",
    "param": "X-Program-ID",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/permission_denied"
  }
}
404Not Found: unknown id, or the resource is not visible to this API key.
application/json
{
  "error": {
    "type": "not_found_error",
    "code": "not_found",
    "message": "No card found for the given id.",
    "param": "card_id",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/not_found"
  }
}
429Too Many Requests: the API key exceeded its rate limit.
application/json
{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limited",
    "message": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/rate_limited"
  }
}
500Internal Server Error: unexpected failure. Retry with the same Idempotency-Key.
application/json
{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "An unexpected error occurred. Retry with the same Idempotency-Key.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/internal_error"
  }
}