Create a receive request

Required scopes:

• partner.receive-request.create

Request Body — REQUIRED
bolt11 object Bolt11 receive params. Send as an empty object to use a default configuration. If the object is not set at all, bolt11 invoice will not be created for the receive request. amount object Amount to be used for the lightning invoice. If not set, zero amount invoice will be created. If currency is not BTC, the amount will be converted to BTC using the current exchange rate. amount string — REQUIRED Currency amount in decimal format currency string — REQUIRED Possible values: [BTC, USD, EUR, USDT, GBP] Currency code description string Possible values: 1 ≤ length ≤ 250 Lightning invoice description. descriptionHash string Lightning invoice description hash hex string. If provided, the invoice description will be ignored in favor of this hash expiryInSeconds int64 Lightning invoice expiry in seconds
onchain object Onchain receive params. Send as an empty object to use a default configuration. If the object is not set at all, onchain address will not be created for the receive request. amount object Amount to be suggested to the payer. amount string — REQUIRED Currency amount in decimal format currency string — REQUIRED Possible values: [BTC, USD, EUR, USDT, GBP] Currency code
targetCurrency string Possible values: [BTC, USD, EUR, USDT, GBP] Currency to convert the received amounts to. Each receive for this request will be converted to the target currency using the current exchange rate. The amount credited can be different from the requested amount due to exchange rate fluctuations.

Responses

201 Created Schema — OPTIONAL receiveRequestId uuid ID of the receive request. created date-time Time of receive request creation. targetCurrency string — OPTIONAL Possible values: [BTC, USD, EUR, USDT, GBP] Currency to which each receive for this request will be converted. Conversion will be done using the current exchange rate at the time of the receive. The amount credited can be different from the requested amount due to exchange rate fluctuations. bolt11 object — OPTIONAL Bolt11 receive request. invoice string BOLT 11 lightning invoice. requestedAmount object — OPTIONAL Requested invoice amount. amount string Currency amount in decimal format currency string Possible values: [BTC, USD, EUR, USDT, GBP] Currency code btcAmount string — OPTIONAL Invoice amount in BTC. This is a requested amount converted to BTC based on the current exchange rate. If the requested amount is already in BTC the values will be the same. description string — OPTIONAL Invoice description. descriptionHash string — OPTIONAL Invoice description hash hex string. paymentHash string Invoice payment hash hex string. expires date-time Time of invoice expiration. onchain object — OPTIONAL Onchain receive request. address string Onchain address to be paid to. addressUri string Onchain address URI to be paid to. requestedAmount object — OPTIONAL Requested amount. amount string Currency amount in decimal format currency string Possible values: [BTC, USD, EUR, USDT, GBP] Currency code btcAmount string — OPTIONAL Amount in BTC suggested to be paid. This is a requested amount converted to BTC based on the current exchange rate. If the requested amount is already in BTC the values will be the same.