Create fiat-to-crypto payout

Creates a payout from the user's wallet based on a specified fiat amount, automatically calculating the equivalent in a defined cryptocurrency.

POST https://app.thedex.cloud/api/v1/payouts/fiat-to-crypto/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

{
  "fiatAmount": "Number",
  "fiatCurrency": "String",
  "payCurrency": "String",
  "address": "String",
  "memo": "Number",               // Optional
  "description": "String",        // Optional
  "callbackUrl": "String"         // Optional
}

Request JSON attributes

Name

Type

Description

fiatCurrency*

String

Reach out accessed values to define attribute by link: /api/v1/info/currencies attribute "fiatCurrencies"

payCurrency*

String

Reach out accessed values to define attribute by link: /api/v1/info/currencies attribute "payCurrencies"

fiatAmount*

String

Amount in fiat currency that will be used to calculate the "transferAmount" based on the actual rate.

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

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

General validation error: missing or malformed parameters.

{
    "error": "Bad Request",
    "status": 400,
    "timestamp": "2026-01-01 00:00:00",
    "message": "fiatAmount: must not be null. "
}

Insufficient funds to perform payout.

{
    "errors": {
        "balance": "Not enough balance to create payout with amount `payout amount`. Available balance is `available amount` `payout currency`"
    },
    "status": 6
}

Invalid or incorrectly formatted address.

{
    "errors": {
        "address": "The wallet address is invalid"
    },
    "status": 6
}

Transaction exceeds daily limits.

{
    "errors": {
        "limit": "The daily limit has been exceeded."
    },
    "status": 6
}

Specific field validation error. (Minimal limits, etc)

{
    "error": "Unprocessable Entity",
    "status": 422,
    "timestamp": "2026-01-01 00:00:00",
    "message": "Minimal limit amount doesn't exceed"
}

Blockchain related errors.

{
    "error": "Internal Server Error",
    "status": 422,
    "timestamp": "2026-01-01 00:00:00",
    "message": "Cannot create payout"
}

In case of not existing parameters, incorrect headers, etc..

Empty response

Similar for not whitelisted address in merchant settings

{
    "error": "Forbidden",
    "status": 403,
    "timestamp": "2026-01-01 00:00:00",
    "message": "Unauthorized access: IP address not in whitelist"
}

Response JSON attributes:

"id"

String

Payout id

"status"

Integer

each 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

"fiatAmount"

String

Amount in fiat currency

"payCurrency"

String

Cryptocurrency

"address"

String

Address is used to widthrawal

"memo"

String

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

"rate"

String

Rate

"isApiCalled"

Boolean

Always true for this API

"description"

String

Description

"merchantId"

String

MerchantId

"callbackUrl"

String

Custom callbackUrl for a payout, that can be differ from user settings

Request curl

curl --location --request POST 'https://app.thedex.cloud/api/v1/payouts/fiat-to-crypto/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>",
  "fiatAmount": "<string>",
  "fiatCurrency": "<string>",
  "payCurrency": "<string>",
  "description": "<string>",
  "memo": "<Number>",   
  "callbackUrl": "<string>" 
}'

Example Curl

curl --location --request POST 'https://app.thedex.cloud/api/v1/payouts/fiat-to-crypto/create' \
--header 'X-EX-APIKEY: abcd1234apikeyexample' \
--header 'X-EX-PAYLOAD: eyJmaWF0QW1vdW50IjoxMjAwLCJmaWF0Q3VycmVuY3kiOiJNWE4iLCJwYXlDdXJyZW5jeSI6IlVTRFRfRVRIRVJFVU0iLCJhZGRyZXNzIjoiMHhlOWMwODAxRjdFYTNBNzFCRjBiYTRlMDI5MWQ4NTVBYTY3RmNkMkFiIiwibWVtbyI6IiIsImRlc2NyaXB0aW9uIjoiIiwiY2FsbGJhY2tVcmwiOiJodHRwczovL215LXNpdGUuY29tL2NhbGxiYWNrIn0=' \
--header 'X-EX-SIGNATURE: 4a1d9f9c4d8bfc304c8123abc1f1b7cf56ff1e1b724f6c1c7c2b9dbeb1e5f012' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--data '{
  "address": "0xe9c080SF7Ea3u71BF0ba4a0291d855Aa67Fcd2Aa",
  "fiatAmount": "1200",
  "fiatCurrency": "MXN",
  "payCurrency": "USDT_ETHEREUM",
  "description": "Monthly contractor payout",
  "memo": "",
  "callbackUrl": "https://my-site.com/callback"
}'

PreviousCreate payout NextFetch payout

Last updated 9 days ago

hashtagHeaders

hashtagRequest Body

Headers

Request Body