curl --request POST \
--url https://checkout.kalixo.io/v1/test-helpers/payments/{id}/dispute \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"stage": "opened"
}
'{
"object": "dispute_simulation",
"payment": "pay_01M75N56PRT5WA5G2JF25B20RJ",
"dispute": null,
"stage": "opened",
"status": "pending"
}Test helpers
Simulate a dispute on a sandbox payment
Sandbox only. Moves a dispute on a captured payment to stage, the way a
real chargeback does. The dispute and its events (dispute.created,
dispute.funds_withdrawn, dispute.won, dispute.lost) follow
asynchronously, usually within seconds.
stage | Dispute status | Events |
|---|---|---|
opened | needs_response | dispute.created |
funds_withdrawn | funds_withdrawn | dispute.funds_withdrawn |
won | won | dispute.won |
lost | lost | dispute.lost |
Later stages apply to the payment’s open dispute, or open a new one. Works for payments made with the sandbox test cards only.
POST
/
v1
/
test-helpers
/
payments
/
{id}
/
dispute
curl --request POST \
--url https://checkout.kalixo.io/v1/test-helpers/payments/{id}/dispute \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"stage": "opened"
}
'{
"object": "dispute_simulation",
"payment": "pay_01M75N56PRT5WA5G2JF25B20RJ",
"dispute": null,
"stage": "opened",
"status": "pending"
}Authorizations
Headers
Body
application/json
Response
The simulation was queued.