Create quick crypto invoice
Last updated
Last updated
X-EX-APIKEY*
String
Your API key
X-EX-PAYLOAD*
String
Body to base64
X-EX-SIGNATURE*
String
Encrypted body with the secret key
amount*
BigDecimal
To check minimal limit amount, use:
api/v1/info/invoice/limit/crypto
payCurrency*
String
Reach out all available crypto currencies by endpoint: /api/v1/info/currencies
merchantId*
String
Merchant ID
You can find it on page 'Merchants' in your account
orderId
String
Order ID in your system
String
Used as additional details for invoice.
Or required in couple with field "needsEmailConfirmation".
In the second case, this email will receive confirmation link, necessary to get access to “Define invoice currency” mentioned in "Steps to complete and read the invoice using email confirmation".
clientId
String
ID of your client
title
String
max size = 50
description
String
max size = 300
recalculation
boolean
Default = false
If recalculation = false, the invoice will be expecting a payment that is equal to or greater than 'amountInPayCurrency'
'amountInPayCurrency' and 'merchantBalance' of invoice will not be recalculated in the case of
Successfulstatus. If client send amount that less than 'amountInPayCurrency' status of invoice will be Underpaid
If recalculation = true, the invoice will be expecting a payment that is equal to or greater than 'amountInPayCurrency'
'amountInPayCurrency' and 'merchantBalance' of invoice will be recalculated in the case of
Successfulstatus. If the client send amount that is less than 'amountInPayCurrency' status of invoice will be Underpaid
Reach out all available invoice statuses by endpoint:
successUrl
String
Custom successUrl for an invoice, that can be differ from merchant settings
failureUrl
String
Custom failureUrl for an invoice, that can be differ from merchant settings
callbackUrl
String
Custom callbackUrl for an invoice, that can be differ from merchant settings
unfixAmount
boolean
Default = false
If unfixAmount = true, the amount of the invoice will be unfixed, so the client can send any amount, and 'amountInPayCurrency' will be recalculated.
In this case, only one transaction is allowed to pay.
If unfixAmount = true, the flow of processing invoice will be as recalculation parameter setting
"invoiceId"
String
Invoice id
"merchantId"
String
Merchant Id
"orderId"
String
Order id
"clientId"
String
Client id
"purse"
String
Purse (crypto wallet)
"payCurrency"
String
Pay currency (crypto currency)
"blockchainFee"
String
Deposit blockchain fee
"amountInPayCurrency"
String
Amount in crypto currency
"createDate"
String
Creation date
"modifiedDate"
String
Modification date
"status"
Integer
reach out all accessed values by link: /api/v1/info/statuses
"payUrl"
String
Pay Url