Async withdrawal

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

Async withdrawal

post
Header parameters
x-api-public-keystringOptional

Public API-key

x-api-signaturestringOptional

Signing the request body with a private API-key

Content-typestringOptional

Request content type

Example: application/json
Body

Output request body

addressIdstringRequired

Identifier of the address from which the coins should be withdrawn

Example: ed7c4941-a5ab-4f53-afb1-195f3a217a62
addressstringRequired

Address for sending coins

Example: 0x00000005707bf50efa35a2db020ede9ac08ae226
tagstring | nullOptional

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

amountstringRequired

Withdrawal amount

Example: 123.12
feeTokenstringRequired

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

Example: U2FsdGVkX1/Svz+vEVmzbD6FVaREPH+i+qOinAsY84yzj/XDXZyDf5Ag2SFQ4jGun7rQ65Yh0jh0roAaSBU470q/p8Lo4Oi5YVEwbUhFzIqNwhKcwIvRhmp/k+pfTmbiS88XR1z5fzBcgbq8E3oMtgj6rJcUQwGN2ku9Kdi0DXg=
feeInAmountbooleanOptional

(Relevant for withdrawing coins) Deduct the network commission from the withdrawal amount or from the payer's funds. By default, the network commission is deducted from the withdrawal amount.

webhookUrlstringOptional

URL to send webhook when output status changes

Example: https://merchant.domain/webhooks/withdraw
Responses
200Success
application/json
post
POST /api-gateway/make-withdrawal-async HTTP/1.1
Host: ocp.onchainpay.io
Content-Type: application/json
Accept: */*
Content-Length: 398

{
  "addressId": "ed7c4941-a5ab-4f53-afb1-195f3a217a62",
  "address": "0x00000005707bf50efa35a2db020ede9ac08ae226",
  "tag": null,
  "amount": "123.12",
  "feeToken": "U2FsdGVkX1/Svz+vEVmzbD6FVaREPH+i+qOinAsY84yzj/XDXZyDf5Ag2SFQ4jGun7rQ65Yh0jh0roAaSBU470q/p8Lo4Oi5YVEwbUhFzIqNwhKcwIvRhmp/k+pfTmbiS88XR1z5fzBcgbq8E3oMtgj6rJcUQwGN2ku9Kdi0DXg=",
  "feeInAmount": true,
  "webhookUrl": "https://merchant.domain/webhooks/withdraw"
}
200Success
{
  "success": true,
  "response": {
    "id": "a807d48d-d786-4a0d-a2c1-e14656e1b521",
    "addressId": "ed7c4941-a5ab-4f53-afb1-195f3a217a62",
    "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": "2025-07-15T10:50:46.075Z"
  }
}
Previous(DEPRECATED) Sync withdrawNextReceiving withdrawal information

Last updated