Асинхронный вывод

Метод позволяет создать запрос на вывод монет с адреса и получить результат исполнения на указанный URL в параметре webhookUrl

Асинхронный вывод

post
Header parameters
x-api-public-keystringOptional

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

x-api-signaturestringOptional

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

Content-typestringOptional

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

Example: application/json
Body

Тело запроса создания вывода

addressIdstringRequired

Идентификатор адреса, с которого надо вывести монеты

Example: 258e95ed-a3c2-4c85-bf6f-09f8b8f1c0be
addressstringRequired

Адрес для отправки монет

Example: 0x00000005707bf50efa35a2db020ede9ac08ae226
tagstring | nullOptional

Тег (memo) адреса (актуально для сетей поддерживающих тег, например Ripple)

amountstringRequired

Сумма вывода

Example: 123.12
feeTokenstringRequired

Токен комисси, который без создан при запросе /request-fee

Example: U2FsdGVkX1+vPIiq/7dwkv3tpvPiGUKv3S6HZWEtQtNk/L3Ohew8fIzUoFTKRPv6kdl2Zs4n8vZKfWfAYCa+UI8SSG+yfiwf8qiQW600rVGUdvD10Mm0CTklhd8ZZqcnz9Z9bUGm8OnatpXLrAx1uPhVoUdKwKQ/Xs1Vzmkjj3Y=
feeInAmountbooleanOptional

(Актуально для вывода монет) Удерживать комиссию сети из суммы вывода или из средств плательщика. По умолчанию комиссия сети берется из суммы вывода

webhookUrlstringOptional

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

Example: https://merchant.domain/webhooks/withdraw
Responses
200Success
application/json
post
POST /api-gateway/make-withdrawal-async HTTP/1.1
Host: ocp.onchainpay.io
Content-Type: application/json
Accept: */*
Content-Length: 398

{
  "addressId": "258e95ed-a3c2-4c85-bf6f-09f8b8f1c0be",
  "address": "0x00000005707bf50efa35a2db020ede9ac08ae226",
  "tag": null,
  "amount": "123.12",
  "feeToken": "U2FsdGVkX1+vPIiq/7dwkv3tpvPiGUKv3S6HZWEtQtNk/L3Ohew8fIzUoFTKRPv6kdl2Zs4n8vZKfWfAYCa+UI8SSG+yfiwf8qiQW600rVGUdvD10Mm0CTklhd8ZZqcnz9Z9bUGm8OnatpXLrAx1uPhVoUdKwKQ/Xs1Vzmkjj3Y=",
  "feeInAmount": true,
  "webhookUrl": "https://merchant.domain/webhooks/withdraw"
}
200Success
{
  "success": true,
  "response": {
    "id": "f2ca718f-cda4-4d0f-be0f-dd9c578c63b9",
    "addressId": "258e95ed-a3c2-4c85-bf6f-09f8b8f1c0be",
    "currency": "USDT",
    "network": "ethereum",
    "tx": "null",
    "status": "pending",
    "address": "0x00000005707bf50efa35a2db020ede9ac08ae226",
    "tag": null,
    "amount": "123.12",
    "feeCurrency": "0x00000005707Bf50EfA35a2db020eDe9Ac0780b9f",
    "feeSource": "advanced_balance",
    "feeAmount": "1.12",
    "webhookUrl": "https://merchant.domain/webhooks/withdraw",
    "createdAt": "2025-06-09T13:18:11.522Z"
  }
}

Last updated