Get invoice status
Lightweight status poll including deposit details and swap processing state.
Authorizations
Store-scoped API key. Prefix with sk_live_.
Example: Authorization: Bearer sk_live_EXAMPLE_DO_NOT_USE
Path Parameters
Invoice ID from create or list responses (starts with inv_).
^(inv_|txn_|plink_|wh_|whd_|evt_|int_)[0-9a-z]{20,32}$Response
Invoice status
Lightweight status for polling. Use this to check if a customer has paid.
Invoice ID (inv_...).
^(inv_|txn_|plink_|wh_|whd_|evt_|int_)[0-9a-z]{20,32}$Where the invoice is in the payment flow:
pending: created, not yet ready for paymentquoted: price quote ready; customer can proceed to payawaiting_payment: waiting for the customer to send fundspaid: payment received and confirmedunderpaid: customer paid less than the requested amountexpired: not paid before the deadlinefailed: payment or processing failedrefunded: payment was returned to the customercancelled: invoice was cancelled before completion
pending, quoted, awaiting_payment, paid, underpaid, expired, failed, refunded, cancelled processing: customer paid; funds are being converted and sent to you.
Only present during this step; omit or null otherwise.
processing "processing"
What the customer sent (e.g. "100.00"). null if not paid yet.
"100.00"
What lands in your wallet after fees (e.g. "99.50"). null until settled.
"99.50"
Difference between received_amount and paid_amount (e.g. "-0.50" for fees). null if not paid.
"-0.50"
Blockchain transaction ID once payment is confirmed.
When payment was confirmed (UTC). null if unpaid.
Address shown to the customer during checkout to send payment.
Extra reference the customer must include with payment, if required by the network.
Redirect URL after checkout, if configured.