Create a smart deposit address for a user.

curl --request POST \
  --url https://api.paxoslabs.com/v2/amplify/smartDepositAddresses \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "userDestinationAddress": "0x0000000000000000000000000000000000000123",
  "vaultAddress": "0x1234567890abcdef1234567890abcdef12345678",
  "inputToken": "0xf08a50178dfcde18524640ea6618a1f965821715",
  "chainId": 1,
  "customerId": "user_123"
}
'

import requests

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

payload = {
    "userDestinationAddress": "0x0000000000000000000000000000000000000123",
    "vaultAddress": "0x1234567890abcdef1234567890abcdef12345678",
    "inputToken": "0xf08a50178dfcde18524640ea6618a1f965821715",
    "chainId": 1,
    "customerId": "user_123"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    userDestinationAddress: '0x0000000000000000000000000000000000000123',
    vaultAddress: '0x1234567890abcdef1234567890abcdef12345678',
    inputToken: '0xf08a50178dfcde18524640ea6618a1f965821715',
    chainId: 1,
    customerId: 'user_123'
  })
};

fetch('https://api.paxoslabs.com/v2/amplify/smartDepositAddresses', 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/smartDepositAddresses",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'userDestinationAddress' => '0x0000000000000000000000000000000000000123',
    'vaultAddress' => '0x1234567890abcdef1234567890abcdef12345678',
    'inputToken' => '0xf08a50178dfcde18524640ea6618a1f965821715',
    'chainId' => 1,
    'customerId' => 'user_123'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"userDestinationAddress\": \"0x0000000000000000000000000000000000000123\",\n  \"vaultAddress\": \"0x1234567890abcdef1234567890abcdef12345678\",\n  \"inputToken\": \"0xf08a50178dfcde18524640ea6618a1f965821715\",\n  \"chainId\": 1,\n  \"customerId\": \"user_123\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.paxoslabs.com/v2/amplify/smartDepositAddresses")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"userDestinationAddress\": \"0x0000000000000000000000000000000000000123\",\n  \"vaultAddress\": \"0x1234567890abcdef1234567890abcdef12345678\",\n  \"inputToken\": \"0xf08a50178dfcde18524640ea6618a1f965821715\",\n  \"chainId\": 1,\n  \"customerId\": \"user_123\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"userDestinationAddress\": \"0x0000000000000000000000000000000000000123\",\n  \"vaultAddress\": \"0x1234567890abcdef1234567890abcdef12345678\",\n  \"inputToken\": \"0xf08a50178dfcde18524640ea6618a1f965821715\",\n  \"chainId\": 1,\n  \"customerId\": \"user_123\"\n}"

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

{
  "smartDepositAddress": "0xabcdef1234567890abcdef1234567890abcdef12"
}

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

POST

amplify

smartDepositAddresses

Create a smart deposit address for a user.

curl --request POST \
  --url https://api.paxoslabs.com/v2/amplify/smartDepositAddresses \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "userDestinationAddress": "0x0000000000000000000000000000000000000123",
  "vaultAddress": "0x1234567890abcdef1234567890abcdef12345678",
  "inputToken": "0xf08a50178dfcde18524640ea6618a1f965821715",
  "chainId": 1,
  "customerId": "user_123"
}
'

import requests

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

payload = {
    "userDestinationAddress": "0x0000000000000000000000000000000000000123",
    "vaultAddress": "0x1234567890abcdef1234567890abcdef12345678",
    "inputToken": "0xf08a50178dfcde18524640ea6618a1f965821715",
    "chainId": 1,
    "customerId": "user_123"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    userDestinationAddress: '0x0000000000000000000000000000000000000123',
    vaultAddress: '0x1234567890abcdef1234567890abcdef12345678',
    inputToken: '0xf08a50178dfcde18524640ea6618a1f965821715',
    chainId: 1,
    customerId: 'user_123'
  })
};

fetch('https://api.paxoslabs.com/v2/amplify/smartDepositAddresses', 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/smartDepositAddresses",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'userDestinationAddress' => '0x0000000000000000000000000000000000000123',
    'vaultAddress' => '0x1234567890abcdef1234567890abcdef12345678',
    'inputToken' => '0xf08a50178dfcde18524640ea6618a1f965821715',
    'chainId' => 1,
    'customerId' => 'user_123'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"userDestinationAddress\": \"0x0000000000000000000000000000000000000123\",\n  \"vaultAddress\": \"0x1234567890abcdef1234567890abcdef12345678\",\n  \"inputToken\": \"0xf08a50178dfcde18524640ea6618a1f965821715\",\n  \"chainId\": 1,\n  \"customerId\": \"user_123\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.paxoslabs.com/v2/amplify/smartDepositAddresses")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"userDestinationAddress\": \"0x0000000000000000000000000000000000000123\",\n  \"vaultAddress\": \"0x1234567890abcdef1234567890abcdef12345678\",\n  \"inputToken\": \"0xf08a50178dfcde18524640ea6618a1f965821715\",\n  \"chainId\": 1,\n  \"customerId\": \"user_123\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"userDestinationAddress\": \"0x0000000000000000000000000000000000000123\",\n  \"vaultAddress\": \"0x1234567890abcdef1234567890abcdef12345678\",\n  \"inputToken\": \"0xf08a50178dfcde18524640ea6618a1f965821715\",\n  \"chainId\": 1,\n  \"customerId\": \"user_123\"\n}"

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

{
  "smartDepositAddress": "0xabcdef1234567890abcdef1234567890abcdef12"
}

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

Body

application/json

userDestinationAddress

string

required

Address of end user who we are depositing funds on behalf of

Example:

"0x0000000000000000000000000000000000000123"

vaultAddress

string

required

Vault contract address

Example:

"0x1234567890abcdef1234567890abcdef12345678"

inputToken

string

required

Underlying token address to deposit into the vault

Example:

"0xf08a50178dfcde18524640ea6618a1f965821715"

chainId

number

required

Chain ID where the vault exists

Example:

1

customerId

string

Optional customer identifier for generating unique deposit addresses. When provided, each unique customerId produces a distinct address even when other parameters are identical.

Required string length: 1 - 256

Pattern: ^[a-zA-Z0-9_-]+$

Example:

"user_123"

Response

Smart Deposit address

smartDepositAddress

string

required

The smart deposit address for the given user

Example:

"0xabcdef1234567890abcdef1234567890abcdef12"

⌘I