Create auto-swap

The method create auto-swap request

Amount limits apply to creation:

• the amount must be more than $20 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
address	string	yes	Destination address
currency	string	yes	The coin you want to receive
network	string	yes	The network where you want to receive coins
amountFrom	string	no	Outgoing amount
amountTo	string	no	The final amount
feeInAmount	boolean	no	Include the network commission in the swap amount
webhookUrl	string	no	URL for sending notifications when the status changes

It is necessary to send one of the parameters: amountFrom or amountTo When specifying two parameters, the priority will be amountFrom

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 amount amountTo 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
id	string	Auto-swap ID
organizationId	string	Organization ID
status	enum	Status
currencyFrom	string	Outgoing coin of the address selected for auto-swap
networkFrom	string	Outgoing network of the address selected for auto-swap
currencyTo	string	The final coin to be sent to the client
networkTo	string	The final network to be sent to the client
amountFrom	string	The amount spent for the operation
amountFromUSD	string	The amount spent for the operation in terms of USD
amountTo	string	The final amount after the swap
amountToUSD	string	The final amount after the swap in terms of USD
amountToReceive	string	The amount that the client will receive
rate	string	Swap rate
blockchainFeeFrom	string	The network's commission for sending coins to the provider for making a swap
blockchainFeeFromUSD	string	The network's commission for sending coins to the provider for making a swap in terms of USD
blockchainFeeTo	string	The network's commission for sending coins from the provider to the client's address
blockchainFeeToUSD	string	The network's commission for sending coins from the provider to the client's address in terms of USD
serviceFee	string	Service commission for the operation
webhookUrl	string	URL for sending status change notification
createdAt	string	Date of creation of the auto-exchange
updatedAt	string	Date of the last update of the change

Statuses:

Status	Description
PENDING	In processing
WITHDRAWING	Waiting to be sent to the destination address
PROCESSED	Successfully
REJECTED	Rejected
ERROR	Processing error

Create auto-swap

POSThttps://ocp.onchainpay.io/api-gateway/auto-swaps/create

Header parameters

Body

application/json

address*string

The address to receive

Example: "1CGuTUAx7icKniPVKGiyiT7QLycpkxULLP"

currency*string

The coin you want to receive

Example: "BTC"

network*string

The network where you want to receive coins

Example: "bitcoin"

amountFromstring

Outgoing amount

Example: "1000"

amountTostring

The final amount

Example: "0.1"

feeInAmountboolean

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

webhookUrlstring

URL for sending a status change notification

Example: "https://merchant.domain/webhooks/..."

Response

200

Body

application/json

success*boolean

Request success indicator

response*AutoSwap (object)

Request

JavaScriptCurlPython

const response = await fetch('https://ocp.onchainpay.io/api-gateway/auto-swaps/create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "address": "1CGuTUAx7icKniPVKGiyiT7QLycpkxULLP",
      "currency": "BTC",
      "network": "bitcoin"
    }),
});
const data = await response.json();

Response

200

{
  "success": false,
  "response": {
    "id": "b10a6b6a-93dc-48a4-af4e-938f3b673f5b",
    "organizationId": "54fecdc6-9e25-4fd8-adda-8240e0448e6e",
    "status": "PENDING",
    "message": null,
    "addressRiskLevel": "Low",
    "currencyFrom": "USDT",
    "networkFrom": "bsc",
    "currencyTo": "BTC",
    "networkTo": "bitcoin",
    "amountFrom": "1000",
    "amountFromUSD": "1000",
    "amountTo": "0.1",
    "amountToUSD": "990",
    "amountToReceive": "0.999",
    "rate": "10000",
    "blockchainFeeFrom": "0.34",
    "blockchainFeeFromUSD": "0.34",
    "blockchainFeeTo": "0.001",
    "blockchainFeeToUSD": "10",
    "serviceFee": "10",
    "webhookUrl": "https://merchant.domain/webhooks/...",
    "createdAt": "2024-11-07T12:41:09.788Z",
    "updatedAt": "2024-11-07T12:41:09.788Z"
  }
}