Skip to main content
POST

Authorizations

Authorization
string
header
required

Secret key, kc_sk_test_... or kc_sk_live_.... Server-side only.

Headers

Idempotency-Key
string
required

Unique key per logical request, reused on retries. 1 to 255 characters, kept for 24 hours. A retry with the same key and body returns the stored response with the header Idempotent-Replayed: true.

Required string length: 1 - 255

Path Parameters

id
string
required

Body

application/json
stage
enum<string>
default:opened
Available options:
opened,
funds_withdrawn,
won,
lost

Response

The simulation was queued.

object
string
required
Allowed value: "dispute_simulation"
payment
string
required
dispute
string | null
required

The open dispute the stage applies to. null when a new dispute will be opened.

stage
enum<string>
required
Available options:
opened,
funds_withdrawn,
won,
lost
status
string
required

The dispute changes asynchronously; watch for dispute.* events.

Allowed value: "pending"