API Reference
Payments
Read confirmed on-chain payments you have received.
The Payment object
A confirmed on-chain payment received by your account, usually tied to the invoice it settled.
objectstring- Always `"payment"`.
idstring- Unique identifier for the payment.
invoice_idstring | null- The invoice this payment settled, if any.
assetstring- Asset received. Currently always `BTC`.
amount_satsinteger- Amount received, in satoshis.
amount_usd_at_receiptnumber | null- USD value at the time of receipt. `null` if unavailable.
tx_hashstring | null- On-chain transaction hash.
created_atstring- ISO 8601 timestamp the payment confirmed.
Example payment
application/json
List payments
readGET
Returns confirmed on-chain payments received by the merchant, optionally filtered to a single invoice.
Query parameters
limitintegerOptional- Maximum number of items to return, newest first.1–100 · Default: 50
invoice_idstringOptional- Return only payments that settled this invoice.
Request
Response · 200
application/json
Errors
400invalid_requestThe request was malformed — a field is missing, the wrong type, or out of range. The message names the offending field.