Fetch status definitions for Invoice and payout

Returns a list of all statuses for invoices and payouts

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

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
7	Cancelled	true	Canceled invoice
8	Refund pending	false	Invoice is in process for refunding
9	Refund	true	Invoice was refunded

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.

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)

{ }

Request JSON attributes

Name	Type	Description
-	-	-

Response Body

200 invoice and payout statuses

{
   "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"
      }
   ]
}

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"

Request Curl

curl --location --request POST '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 '{}'

Example Curl

curl --location --request POST 'https://app.thedex.cloud/api/v1/info/statuses' \
--header 'X-EX-APIKEY: abcd1234apikeyexample' \
--header 'X-EX-PAYLOAD: e30=' \
--header 'X-EX-SIGNATURE: 6f1a2b3c4d5e6f7890abcdef1234567890abcdef1234567890abcdef12345678' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--data '{}'