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

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

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

post

Header parameters

x-api-public-keystringOptional

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

x-api-signaturestringOptional

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

Content-typestringOptional

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

Example: application/json

Body

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

advancedBalanceIdstringRequired

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

Example: 1503cf18-597f-447f-b172-112dfe377e1b

addressIdstringRequired

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

Example: 42a54680-0511-4aa0-ba46-5cf1b7de1fd3

addressstringRequired

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

Example: 0x00000005707bf50efa35a2db020ede9ac08ae226

tagstring | nullOptional

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

amountstringRequired

Сумма вывода

Example: 123.12

feeTokenstringRequired

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

Example: U2FsdGVkX18zwuJHC+JzLQLOeFMPozM2diobszws+xbhUjrQ9nmxW0R7FWHWETqc1Z2VFpvftm/pMiQ27CUmbDl7mTNmcPZmZViPc3b7kdZuToWPQl+xuabnnkHCB3WpS4vDP0D/bu9fgOsKswzivs220+CORn1sM44k0eY9CsM=

feeInAmountbooleanOptional

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

webhookUrlstringOptional

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

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

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /api-gateway/make-withdrawal-async HTTP/1.1
Host: ocp.onchainpay.io
Content-Type: application/json
Accept: */*
Content-Length: 457

{
  "advancedBalanceId": "1503cf18-597f-447f-b172-112dfe377e1b",
  "addressId": "42a54680-0511-4aa0-ba46-5cf1b7de1fd3",
  "address": "0x00000005707bf50efa35a2db020ede9ac08ae226",
  "tag": null,
  "amount": "123.12",
  "feeToken": "U2FsdGVkX18zwuJHC+JzLQLOeFMPozM2diobszws+xbhUjrQ9nmxW0R7FWHWETqc1Z2VFpvftm/pMiQ27CUmbDl7mTNmcPZmZViPc3b7kdZuToWPQl+xuabnnkHCB3WpS4vDP0D/bu9fgOsKswzivs220+CORn1sM44k0eY9CsM=",
  "feeInAmount": true,
  "webhookUrl": "https://merchant.domain/webhooks/withdraw"
}

200Success

{
  "success": true,
  "response": {
    "id": "fb353f4e-9d5e-43d5-b3c2-9c9057236ce8",
    "advancedBalanceId": "1503cf18-597f-447f-b172-112dfe377e1b",
    "addressId": "42a54680-0511-4aa0-ba46-5cf1b7de1fd3",
    "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-26T08:21:33.209Z"
  }
}