v1

latestOpenAPI 3.1.02026-08-0466147138.0 KB

Execution

Start a withdrawal transaction

This is the second and final step in the withdrawal flow. The expected input is the full output of /withdraw/calculate. The selected route should be first, or only, route in the liq.route.routes array. The response of this endpoint will provide the transaction data and relevant metadata to execute the transaction onchain.

Note: if the approval_data field is not empty, the user must first approve the token transfer before executing the transaction.

post/withdraw/start

Request body

Response

$schemastring uri

A URL to the JSON Schema for this object.

datastring required

Data to be sent in the transaction

discount_percentstring required

discount_usdstring required

Optional discount applied to some vaults during a promotion.

methodstring required

Method to be called on the contract. This is for reference only, as method is encoded in the tx data below.

original_fee_usdstring required

tostring required

Address to which the deposit should be made

valuestring required

Value to be sent in the transaction

value_usdstring required

Value to be sent in the transaction in USD

Example response

{
  "$schema": "https://api.superform.xyz/schemas/DepositResponse.json"
}