Create a payout

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

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

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

{
   "id": "String",
   "status": "Integer",
   "statusName": "String",
   "fiatCurrency": "String",
   "payCurrency": "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"
}

Request curl:

curl --location '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>"
}'

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"

Boolean

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

"uniqueUserId"

String

User UUID

"description"

String

Description

"merchantId"

String

Merchant id

Last updated