Create auto-swap
The method create auto-swap request
Amount limits apply to creation:
the amount must be more than $30 in equivalent
the amount must be twice the commission of the network of the final coin/network (see the method of obtaining available coins)
Description of the request parameters
Parameter | Type | Required | Description |
---|---|---|---|
|
| yes | Destination address |
|
| yes | The coin you want to receive |
|
| yes | The network where you want to receive coins |
|
| no | Outgoing amount |
|
| no | The final amount |
|
| no | Include the network commission in the swap amount |
|
| no | URL for sending notifications when the status changes |
It is necessary to send one of the parameters:
amountFrom
oramountTo
When specifying two parameters, the priority will beamountFrom
Include the network's commission in the swap amount
By specifying the feeInAmount
parameter in the value true
, the specified amount + network commission will be debited from the address
If you specify
amountFrom
, the final amountamountTo
may slip (it may differ from the one specified after the creation request)If you specify
amountTo
, the estimated amount of the debit from the address will be blocked + a percentage to cover the insurance of slippage. After the exchange is completed, the amount will be corrected to the amount that was spent for the swap. There may be a slight slippage (≈ 0.1%) of the final amount due to the imposition of swap filters on the amount to be received
Description of the response parameters
Parameter | Type | Description |
---|---|---|
|
| Auto-swap ID |
|
| Organization ID |
|
| Status |
|
| Outgoing coin of the address selected for auto-swap |
|
| Outgoing network of the address selected for auto-swap |
|
| The final coin to be sent to the client |
|
| The final network to be sent to the client |
|
| The amount spent for the operation |
|
| The amount spent for the operation in terms of USD |
|
| The final amount after the swap |
|
| The final amount after the swap in terms of USD |
|
| The amount that the client will receive |
|
| Swap rate |
|
| The network's commission for sending coins to the provider for making a swap |
|
| The network's commission for sending coins to the provider for making a swap in terms of USD |
|
| The network's commission for sending coins from the provider to the client's address |
|
| The network's commission for sending coins from the provider to the client's address in terms of USD |
|
| Service commission for the operation |
|
| URL for sending status change notification |
|
| Date of creation of the auto-exchange |
|
| Date of the last update of the change |
Statuses:
Status | Description |
---|---|
| In processing |
| Waiting to be sent to the destination address |
| Successfully |
| Rejected |
| Processing error |
Create auto-swap
The address to receive
"1CGuTUAx7icKniPVKGiyiT7QLycpkxULLP"
The coin you want to receive
"BTC"
The network where you want to receive coins
"bitcoin"
Outgoing amount
"1000"
The final amount
"0.1"
To include the network commission in the amount to swap, when specifying this parameter, the amountTo will be equal to the amount that the address will receive
URL for sending a status change notification
"https://merchant.domain/webhooks/..."
Request success indicator
Last updated