Withdrawal
[POST] Create request for automated withdrawal
This request should be executed to initiate automated withdrawal request.
/private-api/{slug}/withdrawal
{slug} – unique instance name defined for the company.
Parameters
Name | Type | Required | Description |
---|---|---|---|
amount | string | Y | amount to withdraw |
currency | string | N | currency for withdraw |
wallet | string | Y | card number (for fiat currency) or wallet address (for cryptocurrency) |
network | string | Y, in case if balance is stored in crypto currency | cryptocurrency network |
memo | string | Y, in case if currencies network requires memo | memo tag |
external_id | string | N | external id for withdrawal operation |
comment | string | N | description for withdrawal operation |
Request Payload
{
"amount":"100",
"currency":"USDT",
"wallet":"djfhku2h345h43l63jh423j4v2",
"network":"TRC20",
"external_id":"123456",
"comment":"comment for withdrawal"
}
Response Payload
{
"request_id":"123",
"transactions":[
{
"id":"123",
"currency":{
"id":"123",
"ticker":"USDT",
"is_fiat":true,
"is_used_for_order_exchange":true,
"icon":"https://icon.svg",
"precision":2,
"title":"Tether US"
},
"value":"77",
"status":"PENDING_WITHDRAWAL",
"type":"CRYPTO_WALLET",
"network":null,
"fee":"1",
"created_at":"2022-11-18 14:27:36",
"completed_at":null
}
]
}
Check out Transaction entity reference for detailed description.
[POST] Create request for IBAN withdrawal
This request should be executed to initiate funds withdrawal to IBAN.
/private-api/withdrawal-iban
Parameters
Attribute | Type | Required | Description |
---|---|---|---|
amount | number | Y | amount to withdraw |
message | string | Y | data on bank account (IBAN, address etc) |
exchange_currency | string | Y/N | currency of exchange after withdrawal. Required in case if main balance is in crypto. |
external_id | string | N | external id for withdrawal operation |
comment | string | N | description for withdrawal operation |
Request Payload
{
"amount":"200",
"message":"IBAN address",
"exchange_currency":"EUR",
"external_id":"1234external123",
"comment":"comment"
}
Response Payload
{
"request_id": "baa8c39a-2c95-4967-8437-7920513041a1"
}
[GET] Show withdrawal fees and limits
This request should be executed to get data on withdrawal fees and limits.
/private-api/withdrawals/fees
Response Payload
{
"currencies":[
{
"fees":null,
"network_fees":{
"TRC20":{
"fixed":"1",
"max_amount":"0",
"min_amount":"10",
"is_memo_required":false,
"flex":{
"minFee":"0",
"maxFee":"0",
"percent":"0"
}
},
"TON":{
"fixed":"1",
"max_amount":"0",
"min_amount":"10",
"is_memo_required":false,
"flex":{
"minFee":"0",
"maxFee":"0",
"percent":"0"
}
},
"CCHAIN":{
"fixed":"1",
"max_amount":"0",
"min_amount":"10",
"is_memo_required":false,
"flex":{
"minFee":"0",
"maxFee":"0",
"percent":"0"
}
},
"ERC20":{
"fixed":"18.78",
"max_amount":"0",
"min_amount":"10",
"is_memo_required":false,
"flex":{
"minFee":"0",
"maxFee":"0",
"percent":"0"
}
},
"NEAR":{
"fixed":"1",
"max_amount":"0",
"min_amount":"1",
"is_memo_required":false,
"flex":{
"minFee":"0",
"maxFee":"0",
"percent":"0"
}
},
"ARBITRUM":{
"fixed":"1",
"max_amount":"0",
"min_amount":"10",
"is_memo_required":false,
"flex":{
"minFee":"0",
"maxFee":"0",
"percent":"0"
}
},
"POLYGON":{
"fixed":"1",
"max_amount":"0",
"min_amount":"10",
"is_memo_required":false,
"flex":{
"minFee":"0",
"maxFee":"0",
"percent":"0"
}
},
"SOL":{
"fixed":"1",
"max_amount":"0",
"min_amount":"10",
"is_memo_required":false,
"flex":{
"minFee":"0",
"maxFee":"0",
"percent":"0"
}
}
},
"networks":[
"TRC20",
"TON",
"CCHAIN",
"ERC20",
"NEAR",
"ARBITRUM",
"POLYGON",
"SOL"
],
"currency":{
"id":"d9da4bdc-1c0b-4835-8ec6-a7118247340f",
"ticker":"USDT",
"is_fiat":false,
"title":"Tether US",
"is_used_for_order_exchange":true,
"is_billable":true,
"precision":2,
"icon":"https://media.whitepay.com/c9409283-ed01-436f-bb6d-8763ff06ba54/USDT-(2).svg",
"crm_icon":"https://media.whitepay.com/e2d19518-2d8e-4c95-9db0-89f64b792da9/AWS-S3-Bucket-Cost-(1).png",
"networks":{
"deposits":[
"TRC20",
"TON",
"CCHAIN",
"ERC20",
"NEAR",
"ARBITRUM",
"POLYGON",
"SOL"
],
"withdraws":[
"TRC20",
"TON",
"CCHAIN",
"ERC20",
"NEAR",
"ARBITRUM",
"POLYGON",
"SOL"
]
},
"exchange_currencies":[
{
"id":"6e2372bb-76b4-48b0-9d74-39f6902cabf8",
"ticker":"UAH",
"is_fiat":true,
"is_stable":false,
"is_used_for_order_exchange":true,
"icon":"https://media.whitepay.com/daf4a261-bba4-4bad-9731-00e091184eae/UAH.svg",
"crm_icon":"https://media.whitepay.com/daf4a261-bba4-4bad-9731-00e091184eae/UAH.svg",
"precision":2,
"title":"UAH Hryvnia",
"min_exchange_amount":"0"
},
{
"id":"2b49449f-7757-4ad0-8e42-1ac75a002ecf",
"ticker":"USD",
"is_fiat":true,
"is_stable":false,
"is_used_for_order_exchange":true,
"icon":"https://media.whitepay.com/0d109b34-8ee3-44d2-92b7-27003944d781/USD.svg",
"crm_icon":"https://media.whitepay.com/0d109b34-8ee3-44d2-92b7-27003944d781/USD.svg",
"precision":2,
"title":"US Dollar",
"min_exchange_amount":"1"
},
{
"id":"a4d2e5b4-aa82-43dc-af9c-663e8d5c33d5",
"ticker":"EUR",
"is_fiat":true,
"is_stable":true,
"is_used_for_order_exchange":true,
"icon":"https://media.whitepay.com/03f2fa65-4930-4064-be1c-a15793c380f9/eur.svg",
"crm_icon":"https://media.whitepay.com/03f2fa65-4930-4064-be1c-a15793c380f9/eur.svg",
"precision":2,
"title":"Euro",
"min_exchange_amount":"2"
}
]
},
"company_crypto_withdrawal_commission":"0"
}
],
"meta":{
"current_page":1,
"last_page":1,
"total":1
}
}
Filters
Param | Type | Required | Description |
---|---|---|---|
ticker | string | N | currency ticker to get data on specified currency |