Get receive requests

Required scopes:

• partner.receive-request.read

Query Parameters
$skip int32 Skip the specified number of entries
$top int32 Get the top X number of records. Max value: 100
$onchainAddress string[] Filter by onchain address(es)
$bolt11Invoice string[] Filter by bolt 11 invoice(s)
$paymentHash string[] Filter by bolt 11 invoice payment hash(es)

Responses

200 OK Schema — OPTIONAL items object[] The page items. 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. count int64 Total number of records.