Skip to main content
POST
Fetch a payment invoice

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
invoiceId
string
required

ID of the payment invoice to fetch

Response

Payment invoice retrieved successfully

id
string
merchantId
string
paymentUrl
string<uri>
status
enum<string>
Available options:
PENDING,
CONFIRMING,
UNDER_PAID,
PAID,
FAILED,
EXPIRED
address
string
txHash
string
amount
number
amountCurrency
string
rate
number
payAmount
number
cryptoCurrency
object
network
object
feePaidByPayer
boolean
underPaidCover
number
isWhiteLabel
boolean
returnUrl
string<uri>
expiresAt
string<date-time>
createdAt
string<date-time>