Sync withdraw

The method allows you to create a request to withdraw coins from an address

Sync withdraw

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

Withdrawal request body

advancedBalanceIdstringRequired

Identifier of the advance balance for writing off commissions

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

addressIdstringRequired

Identifier of the address from which the coins should be withdrawn

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

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: U2FsdGVkX18zwuJHC+JzLQLOeFMPozM2diobszws+xbhUjrQ9nmxW0R7FWHWETqc1Z2VFpvftm/pMiQ27CUmbDl7mTNmcPZmZViPc3b7kdZuToWPQl+xuabnnkHCB3WpS4vDP0D/bu9fgOsKswzivs220+CORn1sM44k0eY9CsM=

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.

Responses

post

HTTPcURLJavaScriptPython

POST /api-gateway/make-withdrawal HTTP/1.1
Host: ocp.onchainpay.io
Content-Type: application/json
Accept: */*
Content-Length: 400

{
  "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
}

200Success

{
  "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"
  }
}