Fetch payouts

Returns a list of payouts created within the given time window (From/To).

POST https://app.thedex.cloud/api/v1/payouts

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

{
    "from": "Number", // timestamp
    "to": "Number" // timestamp
}

Request JSON attributes

Name	Type	Description
from*	Long	Timestamp (from) in milliseconds since Unix epoch
to*	Long	Timestamp (to) in milliseconds since Unix epoch

Response Body

200 payout

[
{
   "id": "String",
   "status": "Integer",
   "statusName": "String",
   "fiatCurrency": "String",
   "payCurrency": "String",
   "amountInPayCurrency": "String",
   "address": "String",
   "memo": "Integer",
   "createDate":"String",
   "modifiedDate":"String",
   "transactionId":"String",
   "withdrawalAmount":"String",
   "transferAmount":"String",
   "blockchainFee":"String",
   "payoutCommissionPercentage":"String",
   "isApiCalled":"Boolean",
   "uniqueUserId":"String",
   "description":"String",
   "merchantId":"String",
   "callbackUrl":"String",
   "creationWay":"String"
},

{...}

]

Response JSON attributes

"id"	String	Payout id
"status"	Integer	reach out all accessed values by link: /api/v1/info/statuses
"statusName"	String	reach out all accessed values by link: /api/v1/info/statuses
"fiatCurrency"	String	Fiat currency
"payCurrency"	String	Cryptocurrency
"amountInPayCurrency"	String	Cryptocurrency amount
"address"	String	Address is used to widthrawal
"memo"	Integer	Additional destination info
createDate	String	Creation date
"modifiedDate"	String	Modification date
"transactionId"	String	Transaction id
"withdrawalAmount"	String	Withdrawal amount
"transferAmount"	String	Transfer amount
"blockchainFee"	String	Blockchain fee
"payoutCommissionPercentage"	String	Payout commission in percentage
"isApiCalled"	Boolean	Always true for this API
"uniqueUserId"	String	User UUID
"description"	String	Description
"merchantId"	String	Merchant id
"callbackUrl"	String	Callback url
"creationWay"	String	How payout was created (e.g. with "API" , on "UI")

Request curl:

curl --location --request POST 'https://app.thedex.cloud/api/v1/payouts' \
--header 'X-EX-APIKEY: <string>' \
--header 'X-EX-PAYLOAD: <string>' \
--header 'X-EX-SIGNATURE: <string>' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--data '{
  "from": "<Long>",
  "to": "<Long>"
}'

Example Curl

curl --location --request POST 'https://app.thedex.cloud/api/v1/payouts' \
--header 'X-EX-APIKEY: abcd1234apikeyexample' \
--header 'X-EX-PAYLOAD: eyJmcm9tIjoxNjg5MDAwMDAwMCwidG8iOjE2ODkwMDA4MDAwfQ==' \
--header 'X-EX-SIGNATURE: a1b2c3d4e5f67890123456789abcdef0123456789abcdef0123456789abcdef' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--data '{
  "from": 1689000000000,
  "to": 1689000800000
}'