Sign in
Payments

Simulate a payment

Drive a sandbox payment to a terminal status immediately, whatever its amount and payment method. Sandbox only: a production API key and a production payment id are both rejected with 403. REFUNDED marks the payment paid if it is not already and then issues a full refund; DISPUTED marks it paid if it is not already and then moves it to CHARGEBACK, which is a chargeback and not a MED.

post/v1/payments/{paymentId}/simulate

Path parameters

paymentIdstring uuid required

The sandbox payment ID to simulate.

Headers

X-Idempotency-Keystring

Optional for this endpoint. Honoured when sent — replay and payload check apply — but omitting it is not rejected.

Request body

status'PAID' | 'CANCELLED' | 'EXPIRED' | 'REFUNDED' | 'DISPUTED'

Terminal outcome to apply. Defaults to PAID when the body is empty or omitted.

Response

The payment after the simulated transition.

Changes

Changed in 1 of the 13 revisions of this API.1