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

/api-gateway/make-withdrawal-async

Header parameters

x-api-public-keystring

Public API-key

x-api-signaturestring

Signing the request body with a private API-key

Content-typestring

Request content type

Example: application/json

Body

advancedBalanceIdstringrequired

Identifier of the advance balance for writing off commissions

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

addressIdstringrequired

Identifier of the address from which the coins should be withdrawn

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

addressstringrequired

Address for sending coins

Example: 0x00000005707bf50efa35a2db020ede9ac08ae226

amountstringrequired

Withdrawal amount

Example: 123.12

feeTokenstringrequired

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

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

feeInAmountboolean

(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.

webhookUrlstring

URL to send webhook when output status changes

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

tagstring | null

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

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",
    "amount": "123.12",
    "feeToken": "U2FsdGVkX1/fsfcOPrJfWjnWJzv8nmBtZ+MHUpdi+iULCeBshfstQzDn95ono5lKkbcIh8/yQL2hEhHFHOGphN5hEaXMsKLv8TdkRJpGe1B4BqWCXGBRR+Quv++10n3bkV+IRiwp5ep2GhxnlhkzTmldH+2O8QKM2i0YiWR5wNA=",
    "feeInAmount": true,
    "webhookUrl": "https://merchant.domain/webhooks/withdraw",
    "tag": null
  }'

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",
    "address": "0x00000005707bf50efa35a2db020ede9ac08ae226",
    "amount": "123.12",
    "feeCurrency": "0x00000005707Bf50EfA35a2db020eDe9Ac0780b9f",
    "feeAmount": "1.12",
    "webhookUrl": "https://merchant.domain/webhooks/withdraw",
    "createdAt": "2024-12-26T08:21:53.352Z",
    "tx": "null",
    "status": "pending",
    "tag": null,
    "feeSource": "advanced_balance"
  }
}