Withdrawal / Mass withdrawal
1. Create your website and get the “SECRET_KEY”. Instruction can be found here.
2. Send the “GET” request to create withdrawal.
Note: for the correct work of the service it is necessary to set Request IP
Endpoint:
https://api.plisio.net/api/v1/operations/withdraw
Withdrawal cURL request example:
curl --location --request GET https://api.plisio.net/api/v1/operations/withdraw
?currency=BTC
&type=cash_out
&to=2N3cD7vQxBqmHFVFrgK2o7HonHnVoFxxDVB
&amount=0.002
&api_key=SECRET_KEY
Mass withdrawal cURL request example:
curl --location --request GET https://api.plisio.net/api/v1/operations/withdraw
?currency=BTC
&type=mass_cash_out
&to=2N3cD7vQxBqmHFVFrgK2o7HonHnVoFxxDVB,2NAAdn1BiHuXgckPKmREfVc8WTX3U3N7Qo4
&amount=0.002,0.0013
&api_key=SECRET_KEY
List of all supported request fields:
Field | Description |
---|---|
currency | one of the cryptocurrencies supported by Plisio (ID column from supported cryptocurrencies) |
type | “cash_out ” or “mass_cash_out ” to send to single or multiple comma separated hashes |
to | hash or multiple comma separated hashes pooled for the “mass_cash_out ” |
amount | any comma separated float values for the “ mass_cash_out ” in the order that hashes are in “to ” parameter |
feePlan | a name of the one of: normal or priority (more info) |
api_key | “Secret key” value from your API » Api settingspage |
* - required
Success response example:
{
"status": "success",
"data": {
"type": "cash_out",
"status": "completed",
"psys_cid": "BTC",
"currency": "BTC",
"source_currency": "USD",
"source_rate": "0.00010282",
"fee": "0.00000256",
--- type=cash_out ---
"wallet_hash": "2N3cD7vQxBqmHFVFrgK2o7HonHnVoFxxDVB",
--- type=mass_cash_out ---
"sendmany": {
"2NAAdn1BiHuXgckPKmREfVc8WTX3U3N7Qo4": "0.00020000",
"2N7cy1atVsNZhH6EuKE7HPseMSW5QbEEC6g": "0.00020000"
},
---
"params": {
"fee": {
"conf_target": 3,
"plan": "normal",
"value": "0.00000256"
}
},
"created_at_utc": 1591707445,
"amount": "0.00200000",
"tx_url": "https://sochain.com/resolver?query=08c702dd754ef0acd29b7cc59816a71577fa0c143d6e7a784a5bab1d7813f37d",
"id": "5edf873d9ed3a558712be543"
}
}
HTTP response status code: 201
Success response:
Field | Description |
---|---|
status | success |
type | “cash_out |
status | specifies whether the operation was completed or not (completed, error) |
psys_cid | ID column from supported cryptocurrencies |
currency | Code column from supported cryptocurrencies |
source_currency | name of the fiat currency (only USD available) |
source_rate | exchange rate from the “psys_cid ” to the “source_currency ” at the moment of transfer |
fee | transaction fee stated in the transfer |
wallet_hash | destination hash (if type=cash_out) |
sendmany | pairs of hashes and values (if type=mass_cash_out) |
params.fee | “conf_target” - estimated fee parameter to confirm the transaction in the “conf_target” blocks plan - the Plisio’s fee plan name value - fee value |
created_at_utc | timestamp in the UTC timezone; it may need to be divided by 1000 |
amount | transfer amount in cryptocurrency |
tx_url | link to the cryptocurrency block explorer |
id | internal Plisio operation ID |
Error response example:
{
"status": "error",
"data": {
"name": "Bad Request",
"message": "{\"fee\":[\"The transaction fee cannot be estimated. Please check the balance\"]}",
"code": 115
}
}
HTTP response status code: 400, 401, 422, 500
Error response:
Field | Description |
---|---|
status | error |
data.name | error name |
data.message | error explanation |
data.code | error code |