Checkout API operations
Additional public operations used by hosted checkout.
Most integrations should use the checkout URL returned by invoice creation. The hosted checkout already handles token selection, network selection, rate previews, and confirmation progress.
Available operations
| Method and path | Purpose |
|---|---|
GET /api/invoices/:id | Read the current public invoice. |
GET /api/invoices/:id/rate?token_code=... | Preview the amount for a token. |
POST /api/invoices/:id/rate | Compatibility form of the rate preview; body contains token_code. |
POST /api/invoices/:id/method | Issue a method using network_code and, when needed, token_code. |
POST /api/invoices/:id/tokens | Read global active token codes. |
GET /api/networks?token_code=... | Read global active network codes, optionally filtered by token. |
These operations are public and must not receive a merchant secret. The downloadable OpenAPI currently covers the merchant integration operations and public invoice read; this supplementary section describes the checkout surface separately.
Quote versus issued amount
A rate preview does not allocate an address or lock a payment amount. After selecting a method, use the returned pay.amount_expected and address. A fiat-priced invoice needs an explicit token when selecting a method.
A method-selection response can fail after the method was committed, for example if the following read times out. Reconcile the public invoice before changing your operation.
Global lists are not invoice eligibility
The tokens and networks list operations are global and can contain repeated codes. They do not establish whether an asset is accepted for a specific merchant or invoice. Use the invoice's tokens and networks combinations; the method operation validates eligibility.
An expired invoice cannot obtain a new payment method or quote. An identical replay of an already issued method returns its saved instructions.