Skip to main content
POST
Simulate a sandbox payment
POST /v1/checkout/sandbox/simulate Test-mode only (sk_test_... / pk_test_...) — marks a test checkout as paid (or failed) without any real money moving, so you can test your integration end-to-end.
string
required
The reference from a checkout initialized in test mode
string
default:"success"
success or failed
Calling this with a live key returns a 403:
A successful simulation fires the same webhook a real payment would, so you can test your webhook handler end-to-end too.

Authorizations

Authorization
string
header
required

sk_live_... or sk_test_... — can call every endpoint. Server-side only.

Body

application/json
reference
string
required
Example:

"PAY-A1B2C3D4E5"

status
enum<string>
default:success
Available options:
success,
failed

Response

Simulated