Skip to main content
POST
Create 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
amount
number
required

Payment amount

Required range: x >= 0
amountCurrency
string
default:USD

Currency for the amount

acceptedCoins
string[]

List of accepted cryptocurrency symbols

underPaidCover
number

Percentage of underpayment to accept

Required range: 0 <= x <= 50Must be a multiple of 0.1
feePaidByPayer
boolean

Whether the fee is paid by the payer

lifeTime
number
default:1440

Invoice lifetime in minutes

Required range: 1 <= x <= 1440
returnUrl
string<uri>

URL to return to after payment

Response

Payment invoice created 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>