Skip to main content

Find receive request by ID

Required scopes:

  • partner.receive-request.read
Path Parameters
receiveRequestId uuid REQUIRED

Receive request ID

Responses
200

OK

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.