Создание авто-вывода

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

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

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

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

Параметр

Тип

Обязательно

Описание

address

string

yes

Адрес назначения

currency

string

yes

Монета к получению

network

string

yes

Сеть к получению

amountFrom

string

Сумма, которую хотите поменять и отправить

amountTo

string

Сумма, которую хотите получить

feeInAmount

boolean

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

webhookUrl

string

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

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

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

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

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

Дополнительное подтверждение

При создании вывода из виджета приема оплат будет отправлен вебхук на URL указанный для потверждения вывода при создании виджета.

В теле вебхука будет указан пользователь запросивший вывод, запрошенная сумма, запрошенная монет и пересчет к выбранной для вывода монете. Вы можете подтвердить или отклонить вывод отправил соответствующее значение в запросе

Дополнительные поля в теле ответа:

Имя

Описание

approveUrl

Урл отправки вебхука для подтверждения

approveResult

Данные о подтверждении

approveResult.apiKey

Данные об API-ключе

approveResult.apiKey.public

Публичная часть API-ключа, с которого пришло подтверждение

approveResult.request

Данные о запросе

approveResult.request.ip

IP адрес, с которого пришел запрос

approveResult.request.userAgent

User-Agent, с которого пришел запрос

approveResult.approve

Подтвержден или отклонен

approveResult.time

Время запроса

requestedClientId

Идентификатор пользователя в системе мерчанта, который запросил вывод

requestedCurrency

Запрошенная монета при создании вывода

requestedAmount

Запрошенная сумма при создании вывода

Создание авто-вывода

post

Header parameters

x-api-public-keystringOptional

Публичный API-ключ

x-api-signaturestringOptional

Подпись тела запроса приватным API-ключем

Content-typestringOptional

Тип тела запроса

Example: application/json

Body

addressstringRequired

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

Example: 1CGuTUAx7icKniPVKGiyiT7QLycpkxULLP

currencystringRequired

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

Example: BTC

networkstringRequired

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

Example: bitcoin

amountFromstringOptional

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

Example: 1000

amountTostringOptional

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

Example: 0.1

feeInAmountbooleanOptional

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

webhookUrlstringOptional

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

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

Responses

200Success

application/json

post

POST /api-gateway/auto-withdrawals/create HTTP/1.1
Host: ocp.onchainpay.io
Content-Type: application/json
Accept: */*
Content-Length: 193

{
  "address": "1CGuTUAx7icKniPVKGiyiT7QLycpkxULLP",
  "currency": "BTC",
  "network": "bitcoin",
  "amountFrom": "1000",
  "amountTo": "0.1",
  "feeInAmount": true,
  "webhookUrl": "https://merchant.domain/webhooks/..."
}

200Success

{
  "success": true,
  "response": {
    "id": "d2de09da-cec1-46b7-86d9-a344f4579df7",
    "organizationId": "da2fa0f7-3ac9-493e-b240-7e37555b1cfb",
    "type": "WITHDRAWAL",
    "status": "PENDING",
    "message": null,
    "addressRiskLevel": "Low",
    "currencyFrom": "USDT",
    "networkFrom": "bsc",
    "currencyTo": "BTC",
    "networkTo": "bitcoin",
    "addressFromId": "25a8de42-a359-47f1-bb82-bc9f6c20f1b9",
    "addressFrom": "0xD65D24ABCd85165a243C33Cf8133ffBaaa98255D",
    "addressTo": "0x22aECc7ff5b435E38be5457C8538256918783F67",
    "amountFrom": "1000",
    "amountFromUSD": "1000",
    "amountTo": "0.1",
    "amountToUSD": "990",
    "amountToReceive": "0.999",
    "rate": "10000",
    "blockchainFeeFrom": "0.34",
    "blockchainFeeFromUSD": "0.34",
    "blockchainFeeToSource": "ADVANCED",
    "blockchainFeeTo": "0.001",
    "blockchainFeeToUSD": "10",
    "serviceFee": "10",
    "txId": "0xadcc95b8bcd123e41612c46b057df889e32a73297e973c21e8b38046ac04130a",
    "webhookUrl": "https://merchant.domain/webhooks/...",
    "approveUrl": "https://merchant.domain/webhooks/...",
    "approveResult": {
      "apiKey": {
        "id": "9d22fec0-c979-46a2-9a71-264e0c4cb75c",
        "public": "c9jeO7OJcJb7cnBTVXrgtRzazf60W4Lbsz3/wOYM1m2EsJyZz5wGfbIIuoJ4Ugs6HMowQj8zlv2jf8Vt1ra4Fw=="
      },
      "request": {
        "ip": "123.231.123.100",
        "userAgent": "axios/1.6.0"
      },
      "approve": true,
      "time": "2025-06-09T13:18:11.513Z"
    },
    "requestedClientId": "c2e0461d-344c-45ef-9418-456a678a9a5f",
    "requestedCurrency": "EUR",
    "requestedAmount": "5500",
    "createdAt": "2025-06-09T13:18:11.513Z",
    "updatedAt": "2025-06-09T13:18:11.513Z"
  }
}

PreviousВыплаты 2.0 NextПоиск авто-вывода по ID

Last updated 7 months ago