Создание авто-обмена

Метод создает запрос на авто-обмен

На создание распространяются лимиты сумм:

• сумма должна быть больше $20 в эквиваленте

• сумма должна быть в два раза больше комиссии сети конечной монеты/сети (см. метод получения доступных монет)

Описание параметров запроса

Параметр	Тип	Обязательно	Описание
address	string	yes	Адрес назначения
currency	string	yes	Монета к получению
network	string	yes	Сеть к получению
amountFrom	string	no	Сумма, которую хотите поменять и отправить
amountTo	string	no	Сумма, которую хотите получить
feeInAmount	boolean	no	Закладывать комиссию сети в сумму обмена
webhookUrl	string	no	URL для отправки уведомлений при изменении статуса

Обязательно надо отправить один из параметров: amountFrom или amountTo При указании двух параметров приоритет будет иметь amountFrom

Закладывать комиссию сети в сумму обмена

Указывая параметр feeInAmount в значении true с адреса будет списана указанная сумма + комиссия сети

• Если указывате amountFrom - возможно проскальзывание конечной суммы amountTo (может отличаться от указаной после запроса создания)

• Если указываете amountTo - будет заблокирована расчетная сумма списания с адреса + процент для покрытия страховки проскальзывания. После завершения обмена сумма будет откорректирована, до той, которая была израсходована для проведения обмена. Возможно небольшое проскальзывание (≈ 0.1%) конечной суммы из-за наложения фильтров обмена на сумму к получению

Описание параметров ответа

Параметр	Тип	Описание
id	string	Идентификатор авто-обмена
organizationId	string	Идентификатор организации
status	enum	Статус
currencyFrom	string	Исходящая монета адреса выбранного для проведения авто-обменов
networkFrom	string	Исходящая сеть адреса выбранного для проведения авто-обменов
currencyTo	string	Конечная монета, которая будет отправлена клиенту
networkTo	string	Конечная сеть, которая будет отправлена клиенту
amountFrom	string	Сумма потраченная для проведения операции
amountFromUSD	string	Сумма потраченная для проведения операции в пересчете к USD
amountTo	string	Конечная сумма после обмена
amountToUSD	string	Конечная сумма после обмена в пересчете к USD
amountToReceive	string	Сумма, которую получит клиент
rate	string	Курс обмена
blockchainFeeFrom	string	Комиссия сети за отправку монет провайдеру для совершения обмена
blockchainFeeFromUSD	string	Комиссия сети за отправку монет провайдеру для совершения обмена в пересчете к USD
blockchainFeeTo	string	Комиссия сети за отправку монет от провайдера на адрес клиента
blockchainFeeToUSD	string	Комиссия сети за отправку монет от провайдера на адрес клиента в пересчете к USD
serviceFee	string	Комиссия сервиса за проведение операции
webhookUrl	string	URL для отправки уведомления об изменении статуса
createdAt	string	Дата создания авто-обмена
updatedAt	string	Дата последнего обновления изменения

Статусы:

Статус	Описание
PENDING	В обработке
WITHDRAWING	Ожидание отправки на конечный адрес
PROCESSED	Успешно
REJECTED	Отклонен
ERROR	Ошибка при обработке

Создание авто-обмена

POSThttps://app.apollopayment.io/api-gateway/auto-swaps/create

Header parameters

Body

application/json

address*string

Адрес для получения

Example: "1CGuTUAx7icKniPVKGiyiT7QLycpkxULLP"

currency*string

Монета, которую хотите получить

Example: "BTC"

network*string

Сеть, в которой хотите получить монеты

Example: "bitcoin"

amountFromstring

Исходящая сумма

Example: "1000"

amountTostring

Конечная сумма

Example: "0.1"

feeInAmountboolean

Включать комиссию сети в сумму к обмену, при указании данного параметра amountTo будет равняться сумме, которую получить адрес

webhookUrlstring

URL для отправки уведомления об изменении статуса

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

Response

200

Body

application/json

success*boolean

Признак успешности запроса

response*AutoSwap (object)

Request

JavaScriptCurlPython

const response = await fetch('https://app.apollopayment.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": "6112242a-9f9c-441f-9371-47813752b2c7",
    "organizationId": "d17658a9-7040-4eba-8698-17bfc4fa483b",
    "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:42:22.628Z",
    "updatedAt": "2024-11-07T12:42:22.628Z"
  }
}