Create payout

Creates payout from user wallet for defined crypto-currency

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

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

{
    "amountInPayCurrency": "Number",
    "payCurrency": "String",
    "address": "String",
    "memo": "Number",         // optional 
    "description": "String",  // optional 
    "callbackUrl": "String"   // optional 
}

Request JSON attributes

Name	Type	Description
payCurrency*	String	Reach out accessed values to define attribute by link: /api/v1/info/currencies attribute "payCurrencies"
amountInPayCurrency*	BigDecimal	Amount in cryptocurrency that will be transferred to the address. Please ensure the value respects the precision limits for each currency and blockchain (see Precision Limits for details).
address*	String	Address of crypto wallet
memo	Integer	An additional TON or Ripple specific field to define the intended recipient or destination.
description	String	max size = 300
callbackUrl	String	Custom callbackUrl for a payout, that can be differ from user settings

Response body

200 payout

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

400

422

403

401

Response JSON attributes:

"id"	String	Payout id
"status"	BigDecimal	each out all accessed values by link: /api/v1/info/statuses
"statusName"	String	reach out all accessed values by link: /api/v1/info/statuses
"payCurrency"	String	Cryptocurrency
"address"	String	Address is used to widthrawal
"memo"	Integer	Additional destination info
"createDate"	String	Creation date
"modifiedDate"	String	Modification date
"transactionId"	String	Could be ignored for this API.
"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
"fiatAmount"	String	Fiat amount of payout
"description"	String	Description
"merchantId"	String	Merchant id
"fiatCurrency"	String	Fiat currency of payout

Request curl

curl --location --request POST 'https://app.thedex.cloud/api/v1/payouts/create' \
--header 'X-EX-APIKEY: <string>' \
--header 'X-EX-PAYLOAD: <string>' \
--header 'X-EX-SIGNATURE: <string>' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--data '{
  "address": "<string>",
  "amountInPayCurrency": "<number>",
  "description": "<string>",
  "payCurrency": "<string>",
  "memo": "<Number>",
  "callbackUrl": "<String>"
}'

Example Curl

curl --location --request POST 'https://app.thedex.cloud/api/v1/payouts/create' \
--header 'X-EX-APIKEY: test_api_key_123456' \
--header 'X-EX-PAYLOAD: eyJhZGRyZXNzIjogIjB4QWJjMTIzIiwgImFtb3VudEluUGF5Q3VycmVuY3kiOiAxMCwgImRlc2NyaXB0aW9uIjogIlRlc3QgcGF5b3V0IiwgInBheUN1cnJlbmN5IjogIkVUSCIsICJtZW1vIjogIjEyMzQ1IiwgImNhbGxiYWNrVXJsIjogImh0dHBzOi8vY2FsbGJhY2suZXhhbXBsZS5jb20ifQ==' \
--header 'X-EX-SIGNATURE: dummy_signature_abc123' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--data-raw '{
  "address": "0xAbc123",
  "amountInPayCurrency": 10,
  "description": "Test payout",
  "payCurrency": "ETH",
  "memo": "12345",
  "callbackUrl": "https://callback.example.com"
}'

Amount Precision Limits

For payout operations, the amountInPayCurrency field is subject to precision (decimal scale) limits that depend on the selected blockchain and cryptocurrency.

Each cryptocurrency supports a maximum number of decimal places. Values with a scale greater than the allowed limit will be rejected.

Below is the list of supported currencies and their maximum allowed decimal scale:

Precision by Currency and Blockchain

Currency	Confirms
Bitcoin Network
BTC_BITCOIN	8
Ethereum Network
ETH_ETHEREUM	18
USDT_ETHEREUM	6
USDC_ETHEREUM	6
DAI_ETHEREUM	18
Litecoin Network
LTC_LITECOIN	8
Tron Network
TRX_TRON	6
USDT_TRON	6
Ripple Network
XRP_RIPPLE	6
The Open Network
TON_TON	9
USDT_TON	6
Doge Network
DOGE_DOGECOIN	8
Polygon Network
POL_POLYGON	18
USDT_POLYGON	6
USDC_POLYGON	6
Arbitrum Network
ARB_ARBITRUM	18
ETH_ARBITRUM	18
USDT_ARBITRUM	6
USDC_ARBITRUM	6
Optimism Network
OP_OPTIMISM	18
ETH_OPTIMISM	18
USDT_OPTIMISM	6
USDC_OPTIMISM	6
BSC Network
BNB_BSC	18
USDT_BSC	18
USDC_BSC	18
Solana Network
SOL_SOLANA	9
USDT_SOLANA	6
USDC_SOLANA	6
Base Network
ETH_BASE	18
USDC_BASE	6

Notes

• The precision limit applies only to the number of decimal places, not to the total amount.

• If the provided amountInPayCurrency exceeds the allowed decimal scale for the selected currency and blockchain, the request will fail validation.

• Clients should round or truncate values to the supported precision before submitting payout requests.