Creating Asynchronous withdrawal

The method allows you to create a request to withdraw coins from an address and get the execution result to the specified URL

Creating Asynchronous withdrawal

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

Header parameters

Body

application/json

advancedBalanceId*string

Identifier of the advance balance for writing off commissions

addressId*string

Identifier of the address from which the coins should be withdrawn

address*string

Address for sending coins

tagstringnull

Tag (memo) address (relevant for networks that support the tag, such as Ripple)

amount*string

Withdrawal amount

feeToken*string

Fee token that was not created when requesting /request-fee

webhookUrlstring

URL to send webhook when output status changes

Response

200

Body

application/json

success*boolean

Request success indicator

response*MakeAsyncWithdrawResponse (object)

The body of the response to the request to generate output

Request

JavaScriptCurl

const response = await fetch('https://ocp.onchainpay.io/api-gateway/make-withdrawal-async', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "advancedBalanceId": "3e8eed11-69a6-40d2-8b1f-d5d1b3f1fd72",
      "addressId": "82123f7b-25a7-4e0c-ba10-d611d4fffd86",
      "address": "0x00000005707bf50efa35a2db020ede9ac08ae226",
      "amount": "123.12",
      "feeToken": "U2FsdGVkX18APFEP4nm7PyjfLEnsZEe7IXqjr0l8nNhHjY6MfiQgJGeF+izY/1ELIGNNJXqffu660trtpkcED6scxKZidJrDVZMZHJxwXHTBvM0BHdbuMEkh9mI5kRGsbjtSHuS8TW3EVwiJoNLonzps7xTMqp2EDDYuCycA2k8="
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "response": {
    "id": "ca9f231f-9a3f-4efc-93c1-c1edcf46b182",
    "advancedBalanceId": "3e8eed11-69a6-40d2-8b1f-d5d1b3f1fd72",
    "addressId": "82123f7b-25a7-4e0c-ba10-d611d4fffd86",
    "currency": "USDT",
    "network": "ethereum",
    "tx": "null",
    "status": "pending",
    "address": "0x00000005707bf50efa35a2db020ede9ac08ae226",
    "amount": "123.12",
    "feeCurrency": "0x00000005707Bf50EfA35a2db020eDe9Ac0780b9f",
    "feeSource": "advanced_balance",
    "feeAmount": "1.12",
    "webhookUrl": "https://merchant.domain/webhooks/withdraw",
    "createdAt": "2024-05-07T11:27:25.608Z"
  }
}