Sell
Users can use this service to initiate an exchange. Sellers can provide the amount of cryptocurrency they wish to trade and which currency they want in return. The user also has the option to provide a Minimum Sell Rate to trigger an approval process in case the finalized rate drops below a desirable threshold.
The response will provide you with the newly created Exchange's Reference Id which you can use for future tracking. You will also be provided with a Wallet Address which you will need in order to transfer the cryptocurrency. The system will automatically monitor for the arrival of the cryptocurrency and the process will continue once the cryptocurrency has arrived.
Inputs
| Variable | Description | |
|---|---|---|
| Merchant ID | merchant_id | Your unique merchant id. This can be found under your Account Settings. |
| Crypto Amount | crypto_amount | The amount of cryptocurrency you want to sell. |
| Currency Code | currency_code | The currency code you want in exchange for the cryptocurrency. This must use the 3-digit ISO 4217 standard. |
| Cryptocurrency Code | cryptocurrency_code | The cryptocurrency code you want to exchange. We currently only support BTC. |
| Min Sell Rate | min_sell_rate | The finalized settlement may go below the initial estimate as exchange rates fluctuate. The system will automatically require an approval before beginning the trade if the finalized rate falls below this value. |
| Hash Value | hash_value | The resulting hash of your input arguments and your API Key. |
Example Input
https://exchange.nekbit.com/api/v1/sell/?merchant_id=B4FFFAE5-2618-4C2B-A8A0-1A62421CF227&crypto_amount=1¤cy_code=cad&cryptocurrency_code=btc&min_sell_rate=4200.00&hash_value=479c3769583fd6fe366607ec4deb6b18
Outputs
| Variable | Description | |
|---|---|---|
| Type | type | Indicates either success or error. |
| Data | data | Contains variables unique to this query type. |
| Timestamp | timestamp | The current date/time UTC. |
| Reference Id | reference_id | The Reference Id of the newly created exchange. You can use this as a handle to cancel and approve the exchange later. |
| Settlement Value | settlement_value | The estimated value of the settlement before considering cryptocurrency fees and exchange rate fluctuations. |
| Wallet Address | wallet_address | The address that has been generated and associated with this exchange. You should be sending your cryptocurrency to this address. |
| Exchange Limit | exchange_limit | The maximum amount the system will allow from you after the creation of the new exchange. |
Example Output
{
"type": "success",
"data": {
"reference_id": "2aa3b74c3c2e048e928d4f7fba6c12d3",
"settlement_value": 5248.46888256,
"wallet_address": "17ycQUtLf5gnCNqFVnv4qwh3JunwdKAGxL",
"exchange_limit": 9
},
"timestamp": "2018-12-21 13:24:18"
}