Skip to main content
GET
/
v2
/
amplify
/
withdraw
Prepare withdrawal transaction
curl --request GET \
  --url https://api.example.com/v2/amplify/withdraw \
  --header 'x-api-key: <api-key>'
{
  "transaction": {
    "to": "0xabcdef1234567890abcdef1234567890abcdef12",
    "value": "0",
    "data": "0x47e7ef24...",
    "abi": [
      "<string>"
    ],
    "functionName": "deposit",
    "args": [
      "<string>"
    ]
  }
}

Authorizations

​
x-api-key
string
header
required

API key in format: pxl_<public_id>_

Query Parameters

​
vaultAddress
string
required

BoringVault contract address (0x + 40 hex chars)

Example:

"0xbbbb000000000000000000000000000000000001"

​
wantAsset
string
required

ERC-20 token address to receive upon withdrawal

Example:

"0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"

​
shareAmount
string
required

Vault share amount to redeem, in share token base units (decimal string)

Example:

"1000000000000000000"

​
userAddress
string
required

User wallet address — submits the withdrawal order. Also used as the default intendedDepositor, receiver, and refundReceiver when those optional params are omitted.

Example:

"0x1234567890abcdef1234567890abcdef12345678"

​
intendedDepositor
string

Address treated as the depositor of record for the withdrawn shares (on-chain SubmitOrderParams.intendedDepositor). Defaults to userAddress when omitted.

Example:

"0x1234567890abcdef1234567890abcdef12345678"

​
receiver
string

Address that receives the withdrawn wantAsset on settlement (on-chain SubmitOrderParams.receiver). Defaults to userAddress when omitted.

Example:

"0x1234567890abcdef1234567890abcdef12345678"

​
refundReceiver
string

Address that receives refunded shares if the order is cancelled (on-chain SubmitOrderParams.refundReceiver). Defaults to userAddress when omitted.

Example:

"0x1234567890abcdef1234567890abcdef12345678"

​
chainId
number
required

EVM chain ID

Example:

1

​
responseFormat
enum<string>

Controls response fields. "encoded" (default): ABI-encoded calldata only. "full": calldata + ABI fragment, function name, args. "structured": ABI fragment, function name, args only.

Available options:
encoded,
full,
structured

Response

​
transaction
object
required