Thedex
  • Introduction
    • Merchant Payment Gateway
    • Currencies and networks
    • Confirmations and limits
  • Documentation
    • API Overview
    • Invoices
      • Create full invoice
      • Define full invoice crypto-currency
      • Create quick crypto invoice
      • Create quick fiat invoice
      • Get Invoice
      • Get invoices
      • Create static wallet
      • Get static wallet
      • Deprecated
        • Create quick invoice
    • Payouts
      • Create a payout
      • Create fiat-to-crypto payout
      • Get payout
      • Get payouts
    • Swaps
      • Get swaps
    • Balances
      • Get all user balances
    • Informational
      • Get status definitions for Invoice and payout
      • Get active crypto and fiat currencies
      • Get cryptocurrency to fiat-currency rate
      • Get fiat currency amount limits on invoice creation
      • Get fiat currency amount limits on payout creation
      • Get cryptocurrency amount limits on invoice creation
      • Get cryptocurrency amount limits on payout creation
      • Get Invoice creation ways
    • Commissions
      • Get payout commissions
      • Get invoice commissions
    • Merchant Preferences
      • Get merchant wallet whitelist
      • Add wallet to whitelist
      • Remove wallet to whitelist
  • E-Commerce plugins
    • WHMCS
    • WooCommerce (WordPress)
Powered by GitBook
On this page
  1. Documentation
  2. Invoices

Get Invoice

Get the invoice by "invoiceId" or "orderId" attribute.

Returns the invoice by "invoiceId" or "orderId" attribute.

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

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

Request Body

Name
Type
Description

invoiceId

String

Optional if "orderId" is filled

orderId

String

Optional if "invoiceId" is filled. Order id that merchant can sent on creation invoice. Merchant could define order id by their wish. (f.e. If you have own id in database).

{
   "invoiceId": "String",
   "merchantId": "String",
   "orderId": "String",
   "clientId": "String",
   "status": "Integer",
   "statusName": "String",
   "createDate": "String",
   "modifiedDate": "String",
   "expirationDate": "String",
   "expirationDateInMilliseconds": "Long",
   "purse": "String",
   "currency": "String",
   "payCurrency": "String",
   "amount": "String",
   "amountInPayCurrency": "String",
   "paidAmount":"String",
   "paidAmountFiat": "String",
   "payUrl": "String",
   "creationWay": "String",
   "merchantCommission": "String",
   "merchantBalance": "String",
   "title": "String",
   "description": "String",
   "uniqueUserId":" String",
   "depositBlockchainFee": "String",
   "rate": "String",
   "rateWithCommission": "String",
   "txId": "String"[],
   "successUrl": "String",
   "failureUrl": "String",
   "merchantSiteUrl": "String",
   "callbackUrl": "String"
}

Request curl:

curl --location 'https://app.thedex.cloud/api/v1/invoices/one' \
--header 'X-EX-APIKEY: <string>' \
--header 'X-EX-PAYLOAD: <string>' \
--header 'X-EX-SIGNATURE: <string>' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--data '{
  "invoiceId": "<string>"
}'

Response JSON attributes:

"invoiceId"

String

Invoice id.

"merchantId"

String

Merchant id.

"orderId"

String

Order id.

"clientId"

String

Client id.

"status"

Integer

"statusName"

String

"createDate"

String

Creation date.

"modifiedDate"

String

Modification date.

"expirationDate"

String

Expiration date.

"createTimestamp"

Long

Creation date in milliseconds

"modifiedTimestamp"

Long

Modified date in milliseconds

"expirationTimestamp"

Long

Expiration date in milliseconds

"expirationDateInMilliseconds"

Long

Left expiration time in milliseconds.

"purse"

String

Crypto-address is used by client to send cryptocurrency.

"currency"

String

"payCurrency"

String

"amount"

String

Amount in fiat currency.

"amountInPayCurrency"

String

Converted amount in cryptocurrency.

"paidAmount"

String

Represents paid amount in crypto-currency.

"paidAmountFiat"

String

Represents paid amount in fiat currency.

"payUrl"

String

Url is used to deposit.

"callbackUrl"

String

Callback URL. To reach out more about statuses that trigger callback read the section about

"creationWay"

String

For this usage “API“.

"merchantCommission"

String

Merchant commission.

"merchantBalance"

String

Merchant balance.

"title"

String

Title.

"description"

String

Description.

"uniqueUserId"

String

User UUID.

"depositBlockchainFee"

String

Deposit blockchain fee.

"rate"

String

Rate.

"rateWithCommission"

String

Rate with commission.

"txId"

String[]

Transactions list

"failureUrl"

String

Used for redirect to this reference on failure invoice status. You could set this URL individually to merchant.

"successUrl"

String

Used for redirect to this reference on success invoice status. You could set this URL individually to merchant.

"merchantSiteUrl"

String

Used for redirect to this reference if successUrl or failureUrl are not defined.

PreviousCreate quick fiat invoiceNextGet invoices

Last updated 4 months ago

reach out all accessed values by link:

reach out all accessed values by link:

reach out all accessed values by link:

reach out all accessed values by link:

To reach out more creation ways use:

/api/v1/info/statuses
/api/v1/info/statuses
/api/v1/info/currencies
/api/v1/info/currencies
/api/v1/info/statuses
/api/v1/info/invoice/creation/ways