Skip to main content
GET
/
v2
/
amplify
/
withdraw
/
cancel
Prepare cancel withdrawal transaction
curl --request GET \
  --url https://api.example.com/v2/amplify/withdraw/cancel \
  --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"

​
orderIndex
string
required

Index of the withdrawal order to cancel, in WithdrawQueue order-index units (decimal string). To retrieve a specific order index, call GET /v2/amplify/withdrawalRequests filtered by userAddress and vaultAddress — each returned item includes its orderIndex.

Example:

"42"

​
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