Test helpers
Test mode only: simulate chain activity
POST /v1/test_helpers/invoices/{id}/simulate_payment
Simulate a payment (test mode only).
A synthetic transfer to the invoice's real deposit address goes through the real pipeline (attribution by the address lease, confirmation policy, invoice state machine, ledger, live status, webhooks), once per finality step. It never touches a chain and never exists in live mode.
Authentication: Secret key
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
idrequired | path | string | Invoice id (inv_…) |
Idempotency-Keyrequired | header | string | Unique per simulated payment |
Request body
application/json
| Field | Type | Description |
|---|---|---|
asset | string or null | The payment option to pay: an asset code (
|
network | string or null | CAIP-2 network ( |
amount | string or null | Whole tokens to "send", as a decimal string. Defaults to the option's amount due. Send more to test an overpayment, less for an underpayment.
|
finality_steps | array of string or null | Finality levels the payment passes through, in order: |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | The invoice after the simulated payment | Invoice application/json |
| 400 | ErrorResponse application/json | |
| 403 | Not a test-mode key | ErrorResponse application/json |
| 404 | No such invoice, or a live-mode server | ErrorResponse application/json |