Синхронный вывод

Метод позволяет создать запрос на вывод монет с адреса

Синхронный вывод

post

/api-gateway/make-withdrawal

Header parameters

x-api-public-keystring

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

x-api-signaturestring

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

Content-typestring

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

Example: application/json

Body

advancedBalanceIdstringrequired

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

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

addressIdstringrequired

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

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

addressstringrequired

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

Example: 0x00000005707bf50efa35a2db020ede9ac08ae226

tagstring | null

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

amountstringrequired

Сумма вывода

Example: 123.12

feeTokenstringrequired

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

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

feeInAmountboolean

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://ocp.onchainpay.io/api-gateway/make-withdrawal' \
  --header 'Content-Type: application/json' \
  --data '{
    "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
  }'

200

200

{
  "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": "0xb502e6ba8745a99f3484d75c027c55cacc26d6342b3a129f97d802899435ef12",
    "status": "pending",
    "address": "0x00000005707bf50efa35a2db020ede9ac08ae226",
    "tag": null,
    "amount": "123.12",
    "feeCurrency": "0x00000005707Bf50EfA35a2db020eDe9Ac0780b9f",
    "feeSource": "advanced_balance",
    "feeAmount": "1.12",
    "createdAt": "2024-12-26T08:21:33.209Z"
  }
}