Skip to main content

Issue quote for invoice

Required scopes:

  • partner.invoice.quote.generate
Path Parameters
invoiceId uuid REQUIRED

Id of invoice for which the quote is requested

Request Body

The optional body containing lightning invoice details

descriptionHash string

Lightning invoice description hash hex string. If provided, the invoice description will be ignored in favor of this hash

Responses
201

Created

Schema OPTIONAL
quoteId uuid
description string OPTIONAL

Quote description

lnInvoice string

Bolt 11 encoded lightning invoice

onchainAddress string OPTIONAL

On-chain address that can be used to pay the invoice. Will be present only if you are eligible for on-chain payments

expiration date-time

Time at which quote is expiring

expirationInSec int64

Time period in seconds for which quote is valid

targetAmount object

Quote amount in currency that will be credited. This currency cannot be BTC

amount string

Currency amount in decimal format

currency string

Possible values: [BTC, USD, EUR, USDT]

Currency code

sourceAmount object

Quote amount in currency that will be debited. At quote creation time this will always be BTC, but that can change to other currencies later in case the transaction is upgraded to direct transfer (happens if the payer is also Strike user)

amount string

Currency amount in decimal format

currency string

Possible values: [BTC, USD, EUR, USDT]

Currency code

conversionRate object

Applied source -> target currency conversion rate

amount string

Currency amount in decimal format

sourceCurrency string

Possible values: [BTC, USD, EUR, USDT]

Source currency code

targetCurrency string

Possible values: [BTC, USD, EUR, USDT]

Target currency code