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

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

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

post

/api-gateway/make-withdrawal-async

Header parameters

x-api-public-keystring

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

x-api-signaturestring

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

Content-typestring

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

Example: application/json

Body

advancedBalanceIdstringrequired

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

Example: f9565f73-eb15-4246-9954-169eeb9475fc

addressIdstringrequired

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

Example: 21d8a948-5b69-45b9-8a4d-898be4df18e6

addressstringrequired

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

Example: 0x00000005707bf50efa35a2db020ede9ac08ae226

tagstring | null

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

amountstringrequired

Сумма вывода

Example: 123.12

feeTokenstringrequired

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

Example: U2FsdGVkX1/fsfcOPrJfWjnWJzv8nmBtZ+MHUpdi+iULCeBshfstQzDn95ono5lKkbcIh8/yQL2hEhHFHOGphN5hEaXMsKLv8TdkRJpGe1B4BqWCXGBRR+Quv++10n3bkV+IRiwp5ep2GhxnlhkzTmldH+2O8QKM2i0YiWR5wNA=

feeInAmountboolean

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

webhookUrlstring

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

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.apollopayment.io/api-gateway/make-withdrawal-async' \
  --header 'Content-Type: application/json' \
  --data '{
    "advancedBalanceId": "f9565f73-eb15-4246-9954-169eeb9475fc",
    "addressId": "21d8a948-5b69-45b9-8a4d-898be4df18e6",
    "address": "0x00000005707bf50efa35a2db020ede9ac08ae226",
    "tag": null,
    "amount": "123.12",
    "feeToken": "U2FsdGVkX1/fsfcOPrJfWjnWJzv8nmBtZ+MHUpdi+iULCeBshfstQzDn95ono5lKkbcIh8/yQL2hEhHFHOGphN5hEaXMsKLv8TdkRJpGe1B4BqWCXGBRR+Quv++10n3bkV+IRiwp5ep2GhxnlhkzTmldH+2O8QKM2i0YiWR5wNA=",
    "feeInAmount": true,
    "webhookUrl": "https://merchant.domain/webhooks/withdraw"
  }'

200

200

{
  "success": true,
  "response": {
    "id": "9ce8221b-ab36-41a2-a6b4-ce37c9ab0333",
    "advancedBalanceId": "f9565f73-eb15-4246-9954-169eeb9475fc",
    "addressId": "21d8a948-5b69-45b9-8a4d-898be4df18e6",
    "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:53.352Z"
  }
}