Payment Quotes

Price a payment intent in BTC or USDT, get the address to pay, and refresh the 5-minute price lock.

4 endpoints

Endpoints

GET/v2/payment_intents/{intent_id}/payment_quotesAuth

List payment quotes

Returns every quote raised against a payment intent, in any status.

POST/v2/payment_intents/{intent_id}/payment_quotesAuth

Create a payment quote

Prices the amount still due on a payment intent in one cryptocurrency and returns the address to pay. The price is locked for 5 minutes (expiresin seconds). After that, refresh the

GET/v2/payment_intents/{intent_id}/payment_quotes/{quote_id}Auth

Get a payment quote

Returns a single payment quote, including how many seconds are left on its price lock.

POST/v2/payment_intents/{intent_id}/payment_quotes/{quote_id}/refreshAuth

Refresh a payment quote

Re-prices a quote at the current exchange rate for the amount still due and restarts its 5-minute price lock. The quote keeps its ID and address.

object

The `payment_quote` object

The amount due on a payment intent, priced in one cryptocurrency, with the address to pay and a 5-minute price lock.

Attributes

idstring (uuid)

Unique identifier of the quote

payment_intent_idstring (uuid)

Payment intent the quote belongs to

amountinteger

Amount to pay, in the crypto's smallest unit: satoshis for BTC (8 decimals), 1/1,000,000 USDT for USDT (6 decimals)

paid_amountinteger

Amount received, in the same unit as amount. Can be higher than amount if the customer overpaid.

cryptostring

Cryptocurrency of the quote

Allowed: BTCUSDT

addressstring

Address to pay. A new address for each BTC quote. For USDT, the store's wallet address.

statusstring

pending = waiting for payment. unconfirmed = payment seen, not yet confirmed. partially_confirmed = 1 confirmation. confirmed = final, counted towards the intent. expired = price lock ran out with no payment, can be refreshed. failed = the payment was dropped or reverted.

Allowed: pendingunconfirmedpartially_confirmedconfirmedexpiredfailed

txidstring

Transaction that paid the quote

paid_timestampinteger

Unix time of the latest payment status change on this quote

expires_ininteger

Seconds left on the price lock, 0 once it has run out. Only returned when a single quote is returned.

Example object

{
  "id": "d81111b2-0165-4831-bd12-7a09011d4aa6",
  "payment_intent_id": "d5e88bd4-2964-4554-9a81-ab64c391d174",
  "amount": 11982,
  "paid_amount": 0,
  "crypto": "BTC",
  "address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
  "status": "pending",
  "expires_in": 299
}