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. Informational

Get status definitions for Invoice and payout

Invoice statuses:

id

name

is final status

description

0, 6

Waiting

false

Initial status. Waiting for money transfer.

1

Pending confirm

false

Invoice accepted payment, waiting for transaction confirmation in blockchain network.

2

Unpaid

true

Expired, the invoice was not paid.

3

Successful

true

The invoice was successfully paid.

4

Rejected

true

An error occurred on the pay processing invoice

5

Underpaid

false

Partially paid. The system will wait till the client sends the rest amount to wallet

Payout statuses:

id

name

is final status

description

0

Waiting

false

Initial status.

1

Successful

true

The payout was successfully processed.

2

Rejected

true

An error occurred on the pay processing payout.

3, 4, 5, 8

Processing

false

Processing payout.

6

Unpaid

true

Expired, the payout was not paid.

7

Cancelled

true

Canceled payout.

POST https://app.thedex.cloud/api/v1/info/statuses

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 (Empty JSON)

Name
Type
Description

{
   "invoice":[
      {
         "id":0,
         "name":"Waiting"
      },
      {
         "id":1,
         "name":"Pending confirm"
      },
      {
         "id":2,
         "name":"Unpaid"
      },
      {
         "id":3,
         "name":"Successful"
      },
      {
         "id":4,
         "name":"Rejected"
      },
      {
         "id":5,
         "name":"Underpaid"
      },
      {
         "id":6,
         "name":"Waiting"
      },
      {
         "id":7,
         "name":"Cancelled"
      },
      {
         "id":8,
         "name":"Refund pending"
      },
      {
         "id":9,
         "name":"Refund"
      }
   ],
   "payout":[
      {
         "id":0,
         "name":"Waiting"
      },
      {
         "id":1,
         "name":"Successful"
      },
      {
         "id":2,
         "name":"Rejected"
      },
      {
         "id":3,
         "name":"Processing"
      },
      {
         "id":4,
         "name":"Processing"
      },
      {
         "id":5,
         "name":"Processing"
      },
      {
         "id":6,
         "name":"Unpaid"
      },
      {
         "id":7,
         "name":"Cancelled"
      },
      {
         "id":8,
         "name":"Processing"
      }
   ]
}

Request curl:

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

Response JSON attributes:

"invoice"

object array

Invoice status values

"payout"

object array

Payout status values

"invoice.id", "payout.id"

Integer

Usually used for response JSON attribute "status"

"invoice.name", "payout.name"

String

Usually used for response JSON attribute "statusName"

PreviousInformationalNextGet active crypto and fiat currencies

Last updated 3 months ago