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

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

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

POSThttps://ocp.onchainpay.io/api-gateway/make-withdrawal-async

Header parameters

Body

application/json

advancedBalanceId*string

Идентификатор авансового баланса для списания комиссий

Example: "dcde70b7-e684-434f-9a7c-377d2010e66e"

addressId*string

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

Example: "66d31527-ab99-4909-b8cc-77f26577c6e7"

address*string

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

Example: "0x00000005707bf50efa35a2db020ede9ac08ae226"

tagstringnull

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

amount*string

Сумма вывода

Example: "123.12"

feeToken*string

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

Example: "U2FsdGVkX1/opVdHWVex7i4wIwJHPzja3S+OQaF5/4BNxztxTIlLpNF1BmtSnvMKghe+IA6B8ylQ9vZ7Fl/DC7W5yoW5zLZ51dQWexgnBOWIdq7YJOk06wVYLJ9dRW4n8Pb4ZVDVcMYLVvJS5Dd3zuYvNoRJz4cMFDkpZD3Y7ig="

feeInAmountboolean

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

webhookUrlstring

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

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

Response

200

Body

application/json

success*boolean

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

response*MakeAsyncWithdrawResponse (object)

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

Request

JavaScriptCurlPython

const response = await fetch('https://ocp.onchainpay.io/api-gateway/make-withdrawal-async', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "advancedBalanceId": "dcde70b7-e684-434f-9a7c-377d2010e66e",
      "addressId": "66d31527-ab99-4909-b8cc-77f26577c6e7",
      "address": "0x00000005707bf50efa35a2db020ede9ac08ae226",
      "amount": "123.12",
      "feeToken": "U2FsdGVkX1/opVdHWVex7i4wIwJHPzja3S+OQaF5/4BNxztxTIlLpNF1BmtSnvMKghe+IA6B8ylQ9vZ7Fl/DC7W5yoW5zLZ51dQWexgnBOWIdq7YJOk06wVYLJ9dRW4n8Pb4ZVDVcMYLVvJS5Dd3zuYvNoRJz4cMFDkpZD3Y7ig="
    }),
});
const data = await response.json();

Response

200

{
  "success": false,
  "response": {
    "id": "5670ea74-e274-4824-b898-e6a17505e7eb",
    "advancedBalanceId": "dcde70b7-e684-434f-9a7c-377d2010e66e",
    "addressId": "66d31527-ab99-4909-b8cc-77f26577c6e7",
    "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": "2024-12-11T10:54:03.327Z"
  }
}