Skip to main content
POST
Simulate a payment on a sandbox invoice

Authorizations

x-api-key
string
header
required

Path Parameters

invoice_id
string
required

Unique 24-character hex invoice id.

Body

application/json

Drive a SANDBOX invoice into a terminal (or partial) status.

Sandbox only — there is nothing to simulate on a live invoice, whose status is determined by the chain.

status
enum<string>
required

Status to move the invoice into.

Available options:
success,
partially_paid,
paid_over,
expired,
cancelled,
failed,
refunded
paid_amount

Amount paid in the invoice's fiat_currency. Defaults to a sensible value for the chosen status: the full amount for success, half for partially_paid, 125% for paid_over.

Required range: x > 0
send_webhook
boolean
default:true

Whether to deliver the webhook for this transition.

notify_url
string | null

Override the webhook destination for this call only.

Response

OK

ok
boolean
required
result
SimulatedInvoice · object
required

Result of driving a sandbox invoice into a new status.

Example: