Skip to main content
POST
Locks the pay currency for an AWAITING_CURRENCY invoice, derives the deposit address and returns the crypto quote. This powers the hosted invoice page, and it’s safe to call from the payer’s browser if you’re building a custom checkout UI. All data is redacted — no fees, no merchant internals.

Authorization

None — this endpoint is public. It only accepts the public invoice id (the last segment of invoiceUrl, e.g. exampleslug1); raw 24-hex payment ids are rejected so payments can’t be enumerated. Rate limit: 20/min.

Parameters

string
required
The public invoice id — the last segment of the payment’s invoiceUrl. Raw 24-hex payment ids are rejected.
string
required
The currency the payer chose (e.g. LTC). Must be one of the currencies returned by List currency options.
Always fetch List currency options first and only offer currencies it marks available: true — anything else is rejected here.

Response

string
The freshly derived deposit address for the selected currency.
number
The crypto amount payable at the current quote.
string
The locked pay currency.
string
ISO timestamp when the invoice expires.
string
ISO timestamp when the crypto quote expires.
string
Invoice status after selection (WAITING).
number
Crypto amount received so far.
After selection, poll Get invoice status for payment progress.

See also