Prepare withdrawal transaction

curl --request GET \
  --url https://api.paxoslabs.com/v2/amplify/withdraw \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.paxoslabs.com/v2/amplify/withdraw', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.paxoslabs.com/v2/amplify/withdraw",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.paxoslabs.com/v2/amplify/withdraw"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.paxoslabs.com/v2/amplify/withdraw")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "transaction": {
    "to": "0xabcdef1234567890abcdef1234567890abcdef12",
    "value": "0",
    "data": "0x47e7ef24...",
    "abi": [
      "<string>"
    ],
    "functionName": "deposit",
    "args": [
      "<string>"
    ]
  }
}

{
  "error": {
    "code": 400,
    "message": "Invalid filter syntax.",
    "status": "INVALID_ARGUMENT",
    "details": [
      {
        "@type": "type.paxoslabs.dev/errors/BadRequest",
        "fieldViolations": [
          {
            "field": "filter",
            "description": "vaultAddress 0x0x is an invalid hex address."
          }
        ]
      }
    ]
  }
}

{
  "error": {
    "code": 400,
    "message": "Invalid filter syntax.",
    "status": "INVALID_ARGUMENT",
    "details": [
      {
        "@type": "type.paxoslabs.dev/errors/BadRequest",
        "fieldViolations": [
          {
            "field": "filter",
            "description": "vaultAddress 0x0x is an invalid hex address."
          }
        ]
      }
    ]
  }
}

GET

amplify

withdraw

Prepare withdrawal transaction

curl --request GET \
  --url https://api.paxoslabs.com/v2/amplify/withdraw \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.paxoslabs.com/v2/amplify/withdraw', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.paxoslabs.com/v2/amplify/withdraw",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.paxoslabs.com/v2/amplify/withdraw"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.paxoslabs.com/v2/amplify/withdraw")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "transaction": {
    "to": "0xabcdef1234567890abcdef1234567890abcdef12",
    "value": "0",
    "data": "0x47e7ef24...",
    "abi": [
      "<string>"
    ],
    "functionName": "deposit",
    "args": [
      "<string>"
    ]
  }
}

{
  "error": {
    "code": 400,
    "message": "Invalid filter syntax.",
    "status": "INVALID_ARGUMENT",
    "details": [
      {
        "@type": "type.paxoslabs.dev/errors/BadRequest",
        "fieldViolations": [
          {
            "field": "filter",
            "description": "vaultAddress 0x0x is an invalid hex address."
          }
        ]
      }
    ]
  }
}

{
  "error": {
    "code": 400,
    "message": "Invalid filter syntax.",
    "status": "INVALID_ARGUMENT",
    "details": [
      {
        "@type": "type.paxoslabs.dev/errors/BadRequest",
        "fieldViolations": [
          {
            "field": "filter",
            "description": "vaultAddress 0x0x is an invalid hex address."
          }
        ]
      }
    ]
  }
}

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"

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

Show child attributes

List withdrawal volumes

Prepare cancel withdrawal transaction

⌘I