search

Create full invoice

Creates a full invoice without indicating which cryptocurrency to pay with

POST https://app.thedex.cloud/api/v1/invoices/create

hashtag
Headers

Name
Type
Description

X-EX-APIKEY*

String

Your API key

X-EX-PAYLOAD*

String

Body to base64

X-EX-SIGNATURE*

String

Encrypted body with the secret key

hashtag
Request Body

{
    "amount": "Number",
    "currency": "String",
    "merchantId": "String",
    "orderId": "String",        // optional 
    "email": "String",          // optional 
    "clientId": "String",       // optional 
    "title": "String",          // optional 
    "description": "String",    // optional 
    "recalculation": "boolean", // optional 
    "successUrl": "String",     // optional 
    "failureUrl": "String",     // optional 
    "callbackUrl": "String",    // optional 
    "returnUrl": "String",      // optional 
    "unfixAmount": "boolean"    // optional 
}

Request JSON attributes

Name
Type
Description

amount*

BigDecimal

To check minimal limit amount, use: api/v1/info/invoice/limit/fiat

currency*

String

Reach out all available fiat 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

email

String

email of your client

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:

/api/v1/info/statuses

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

returnUrl

String

Custom returnUrl for an invoice, that can be differ from merchant settings. Rewrites merchantSiteUrl for invoice

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

Response body

Response JSON attributes

"invoiceId"

String

Invoice id

"merchantId"

String

Merchant Id

"orderId"

String

Order id

"clientId"

String

Client id

"createDate"

String

Creation date

"modifiedDate"

String

Modification date

"createTimestamp"

Long

Creation date in milliseconds

"modifiedTimestamp"

Long

Modified date in milliseconds

"expirationTimestamp"

Long

Expiration date in milliseconds

"status"

Integer

reach out all accessed values by link: /api/v1/info/statuses

"payUrl"

String

Pay Url

"amount"

"String"

Amount to Pay in Fiat currency

Curl request

Example Curl

PreviousInvoicesNextDefine full invoice crypto-currency

Last updated