Get invoice

View as Markdown

Get the public V4 checkout invoice view.

This endpoint is public and requires no authentication. Merchants usually hand public_invoice_id to agents and retain the merchant-side UUID.

Path parameters

idstringRequiredformat: "^inv_[A-Za-z0-9]{20,}$"

Public invoice ID (inv_*)

Response headers

X-Request-Idstring
Unique request identifier for debugging and support
Cache-Controlstring

Response

Invoice details
schema_versionenum
Allowed values:
idstringformat: "^inv_[A-Za-z0-9]{20,}$"
statusenum
Allowed values:
amountobject
expires_atdatetime
created_atdatetime
merchantobject
status_checkobject
pricingobject
descriptionstring
metadatamap from strings to any
payment_methodslist of objects
paid_atdatetime
paid_amountlong>=1

USDC amount in atomic units (6 decimals). Used in REST response bodies. 1000000 = 1.00 USDC.

payment_chainenum
Allowed values:
payment_chain_caip2string
paid_tx_hashstring
tx_urlstringformat: "uri"

Errors

400
Bad Request Error
404
Not Found Error