Sign in

v1

latestOpenAPI 3.0.02026-07-22290108.6 KB
Request
V2/Request

Get request status

Get the status of a payment request

get/v2/request/{requestId}

Path parameters

requestIdstring required
Example:01e273ecc29d4b526df3a0f1f05ffc59372af8752c2b678096e49ac270416a7cdb

The requestId for the request

Headers

x-api-keystring

API key for authentication (optional if using Client ID)

x-client-idstring

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

Originstring

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

Response

Request status retrieved successfully

hasBeenPaidboolean

Whether the request has been paid

paymentReferencestring

Unique identifier used for payments and status checks

requestIdstring

Unique identifier of the request

isListeningboolean

Whether the system is actively listening for payments on this request

txHashstring nullable

Transaction hash of the payment, null if not yet paid

recurrenceobject

Recurrence configuration for recurring requests

originalRequestIdstring

Original request ID for recurring requests

statusstring

Current status of the request

isCryptoToFiatAvailableboolean

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

originalRequestPaymentReferencestring

Payment reference of the original request for recurring payments

paymentsobject[]

Array of payments made to this request

isRecurrenceStoppedboolean

Whether recurrence has been stopped for this request

referencestring nullable

Merchant reference for receipt tracking and identification

amountInUsdstring nullable

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

conversionRatestring nullable

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'lifi' | 'chainlink' | 'coingecko' | 'unknown' | 'mixed'

Source of the conversion rate