Get request status

Get the status of a payment request

Headers

x-api-key · string

API key for authentication (optional if using Client ID)

x-client-id · string

Client ID for frontend authentication (optional if using API key)

Origin · string

Origin header (required for Client ID auth, automatically set by browser)

Path Parameters

requestId · string · required

The requestId for the request

Example:

"01e273ecc29d4b526df3a0f1f05ffc59372af8752c2b678096e49ac270416a7cdb"

Response

200

application/json

Request status retrieved successfully

hasBeenPaid · boolean

Whether the request has been paid

paymentReference · string

Unique identifier used for payments and status checks

requestId · string

Unique identifier of the request

isListening · boolean

Whether the system is actively listening for payments on this request

txHash · string | null

Transaction hash of the payment, null if not yet paid

recurrence · object

Recurrence configuration for recurring requests

originalRequestId · string

Original request ID for recurring requests

status · string

Current status of the request

isCryptoToFiatAvailable · boolean

Whether crypto-to-fiat conversion is available for this request

originalRequestPaymentReference · string

Payment reference of the original request for recurring payments

payments · object[]

Array of payments made to this request

isRecurrenceStopped · boolean

Whether recurrence has been stopped for this request

customerInfo · object | null

Customer information for merchant receipt tracking

Show child attributes

reference · string | null

Merchant reference for receipt tracking and identification

amountInUsd · string | null

Request amount in USD (actual if paid, current market rate if unpaid)

conversionRate · string | null

Conversion rate. Available for: unpaid requests and fully paid requests with single payment. Null for: partially paid requests and fully paid requests with multiple payments.

rateSource · enum<string>

Source of the conversion rate

Available options:

lifi,

chainlink,

coingecko,

unknown,

mixed

conversionBreakdown · object | null

Detailed breakdown for partial payments or multiple payments. Provides individual payment rates when top-level rate is null.

Show child attributes

fees · object[] | null

Associated fees (actual if paid, empty if unpaid)

Show child attributes