Create auto-withdrawal

The method create auto-withdrawal request

Amount limits apply to creation:

• the amount must be more than $20 in equivalent

• the amount must be twice the commission of the network of the final coin/network (see the method of obtaining available coins)

Description of the request parameters

Parameter	Type	Required	Description
address	string	yes	Destination address
currency	string	yes	The coin you want to receive
network	string	yes	The network where you want to receive coins
amountFrom	string	no	Outgoing amount
amountTo	string	no	The final amount
feeInAmount	boolean	no	Include the network commission in the swap amount
webhookUrl	string	no	URL for sending notifications when the status changes

It is necessary to send one of the parameters: amountFrom or amountTo When specifying two parameters, the priority will be amountFrom

Include the network's commission in the swap amount

By specifying the feeInAmount parameter in the value true, the specified amount + network commission will be debited from the address

• If you specify amountFrom, the final amount amountTo may slip (it may differ from the one specified after the creation request)

• If you specify amountTo, the estimated amount of the debit from the address will be blocked + a percentage to cover the insurance of slippage. After the exchange is completed, the amount will be corrected to the amount that was spent for the swap. There may be a slight slippage (≈ 0.1%) of the final amount due to the imposition of swap filters on the amount to be received

Additional confirmation

When creating a withdrawal from the payment acceptance widget, a webhook will be sent to the URL specified for withdrawal confirmation when creating the widget.

The webhook body will indicate the user who requested the withdrawal, the requested amount, the requested coins, and the conversion to the coin selected for withdrawal.

You can confirm or reject the withdrawal by sending the corresponding value in the request

Additional fields in the response body:

Name	Description
approveUrl	URL for sending the webhook for confirmation
approveResult	Confirmation data
approveResult.apiKey	API key data
approveResult.apiKey.public	Public part of the API key from which the confirmation came
approveResult.request	Request data
approveResult.request.ip	IP address from which the request came
approveResult.request.userAgent	User-Agent from which the request came
approveResult.approve	Approved or rejected
approveResult.time	Request time
requestedClientId	User ID in the merchant system who requested the withdrawal
requestedCurrency	Requested coin when creating the withdrawal
requestedAmount	Requested amount when creating the withdrawal

Create auto-withdrawal

POSThttps://app.apollopayment.io/api-gateway/auto-withdrawals/create

Header parameters

Body

application/json

address*string

The address to receive

Example: "1CGuTUAx7icKniPVKGiyiT7QLycpkxULLP"

currency*string

The coin you want to receive

Example: "BTC"

network*string

The network where you want to receive coins

Example: "bitcoin"

amountFromstring

Outgoing amount

Example: "1000"

amountTostring

The final amount

Example: "0.1"

feeInAmountboolean

To include the network commission in the amount to swap, when specifying this parameter, the amountTo will be equal to the amount that the address will receive

webhookUrlstring

URL for sending a status change notification

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

Response

200

Body

application/json

success*boolean

Request success indicator

response*AutoWithdrawal (object)

Request

JavaScriptCurlPython

const response = await fetch('https://app.apollopayment.io/api-gateway/auto-withdrawals/create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "address": "1CGuTUAx7icKniPVKGiyiT7QLycpkxULLP",
      "currency": "BTC",
      "network": "bitcoin"
    }),
});
const data = await response.json();

Response

200

{
  "success": false,
  "response": {
    "id": "6f44a2bf-e76d-4516-af3a-742ebb0db78b",
    "organizationId": "ab0edbe4-fe3c-4492-9ff7-18ba6ee139e7",
    "type": "WITHDRAWAL",
    "status": "PENDING",
    "message": null,
    "addressRiskLevel": "Low",
    "currencyFrom": "USDT",
    "networkFrom": "bsc",
    "currencyTo": "BTC",
    "networkTo": "bitcoin",
    "addressFromId": "25a8de42-a359-47f1-bb82-bc9f6c20f1b9",
    "addressFrom": "0xD65D24ABCd85165a243C33Cf8133ffBaaa98255D",
    "addressTo": "0x22aECc7ff5b435E38be5457C8538256918783F67",
    "amountFrom": "1000",
    "amountFromUSD": "1000",
    "amountTo": "0.1",
    "amountToUSD": "990",
    "amountToReceive": "0.999",
    "rate": "10000",
    "blockchainFeeFrom": "0.34",
    "blockchainFeeFromUSD": "0.34",
    "blockchainFeeToSource": "ADVANCED",
    "blockchainFeeTo": "0.001",
    "blockchainFeeToUSD": "10",
    "serviceFee": "10",
    "txId": "0xadcc95b8bcd123e41612c46b057df889e32a73297e973c21e8b38046ac04130a",
    "webhookUrl": "https://merchant.domain/webhooks/...",
    "approveUrl": "https://merchant.domain/webhooks/...",
    "approveResult": {
      "apiKey": {
        "id": "9c7158fe-139f-402b-92bd-c5ff62c34b10",
        "public": "c9jeO7OJcJb7cnBTVXrgtRzazf60W4Lbsz3/wOYM1m2EsJyZz5wGfbIIuoJ4Ugs6HMowQj8zlv2jf8Vt1ra4Fw=="
      },
      "request": {
        "ip": "123.231.123.100",
        "userAgent": "axios/1.6.0"
      },
      "approve": false,
      "time": "2024-11-07T12:42:22.630Z"
    },
    "requestedClientId": "f2ce4fca-91a0-4403-8411-9089bb2b1fa6",
    "requestedCurrency": "EUR",
    "requestedAmount": "5500",
    "createdAt": "2024-11-07T12:42:22.630Z",
    "updatedAt": "2024-11-07T12:42:22.630Z"
  }
}