POST

Simulate a dispute network event

ENDPOINT/v1/simulate/disputes/{dispute_id}/network-event

Delivers a Visa/Mastercard dispute-network event to a sandbox dispute and moves it to the supplied status (for example REPRESENTMENT or CASE_WON). Served only on the sandbox host.

Authentication & Headers

Header	Type	Requirement	Description
Authorization	string	REQUIRED	API key passed as an HTTP Bearer token: `Bearer rk_live_...`
X-Program-ID	UUID	PROGRAM-SCOPED	Program boundary UUID that scopes the issuing card, wallet, or transfer.
Content-Type	string	REQUIRED	Must be `application/json`.
Idempotency-Key	string	OPTIONAL	Unique UUID to prevent duplicate execution of financial creations or mutations.

Path Parameters

Parameter	Type	Requirement	Description
dispute_id	string	REQUIRED	Unique identifier of the dispute.

Request Body Schema

application/json

statusstring

REQUIRED

Chargeback lifecycle of a dispute. Allowed transitions: `NEW` → `PENDING_CUSTOMER`, `SUBMITTED`, `WITHDRAWN`. `PENDING_CUSTOMER` → `SUBMITTED`, `WITHDRAWN`. `SUBMITTED` → `REPRESENTMENT`, `CASE_WON`, `CASE_CLOSED`, `WITHDRAWN`. `REPRESENTMENT` → `PREARBITRATION`, `CASE_WON`, `CASE_CLOSED`. `PREARBITRATION` → `ARBITRATION`, `CASE_WON`, `CASE_CLOSED`. `ARBITRATION` → `CASE_WON`, `CASE_CLOSED`. `CASE_WON`, `CASE_CLOSED`, and `WITHDRAWN` are terminal. Integrators move a case only with `POST /v1/disputes/{dispute_id}/withdraw` (`NEW`, `PENDING_CUSTOMER`, or `SUBMITTED` → `WITHDRAWN`). Every other transition is recorded by Rook as the cardholder, merchant, or network responds. PATCH of `amount`, `reason`, and `note` is accepted only in `NEW` and `PENDING_CUSTOMER`. Evidence create and delete are accepted only in `NEW` and `PENDING_CUSTOMER`.

Enum values:NEWPENDING_CUSTOMERSUBMITTEDREPRESENTMENTPREARBITRATIONARBITRATIONCASE_WONCASE_CLOSEDWITHDRAWN

Response Codes & Schemas

200The dispute after the network event.

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"
  }
}

409Conflict: incompatible state, or Idempotency-Key reused with a different body.

application/json

{
  "error": {
    "type": "conflict_error",
    "code": "conflict",
    "message": "The card cannot be reissued from its current state.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/conflict"
  }
}

422Unprocessable Entity: the document is valid JSON but violates a business rule.

application/json

{
  "error": {
    "type": "invalid_request_error",
    "code": "insufficient_funds",
    "message": "The source financial account does not have enough available balance.",
    "param": "amount",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/insufficient_funds"
  }
}

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"
  }
}