Deposits

Resolve a crypto deposit address

Provision (or return the existing) on-chain deposit address for the requested network. A wallet is created only for the requested network. Send USDT/USDC to the returned address; the deposit is credited once it confirms on-chain, provided it meets the per-transfer minimum. A smaller transfer is not credited, does not appear in GET /v1/deposits, and cannot be recovered. EVM addresses are valid across all EVM chains. Pass Zuba-Account-Id to allocate the address to a sub-account: deposits to it settle into that sub-account’s balance, and each sub-account gets its own address.

POST

deposits

crypto-address

curl --request POST \
  --url https://api.example.com/v1/deposits/crypto-address \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "network": "eip155:1",
  "clientRef": "customer-1234"
}
'

import requests

url = "https://api.example.com/v1/deposits/crypto-address"

payload = {
    "network": "eip155:1",
    "clientRef": "customer-1234"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({network: 'eip155:1', clientRef: 'customer-1234'})
};

fetch('https://api.example.com/v1/deposits/crypto-address', 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.example.com/v1/deposits/crypto-address",
  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([
    'network' => 'eip155:1',
    'clientRef' => 'customer-1234'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.example.com/v1/deposits/crypto-address"

	payload := strings.NewReader("{\n  \"network\": \"eip155:1\",\n  \"clientRef\": \"customer-1234\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.example.com/v1/deposits/crypto-address")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"network\": \"eip155:1\",\n  \"clientRef\": \"customer-1234\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/deposits/crypto-address")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"network\": \"eip155:1\",\n  \"clientRef\": \"customer-1234\"\n}"

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

{
  "address": "0x1234567890abcdef1234567890abcdef12345678",
  "network": "eip155:1",
  "clientRef": "customer-1234"
}

{
  "error": "BAD_REQUEST",
  "message": "Bad Request",
  "path": "/v1/resource",
  "statusCode": 400,
  "timestamp": "2024-01-15T10:30:00.000Z"
}

Authorizations

Authorization

string

header

required

Enter Auth0 JWT token

Headers

Zuba-Account-Id

string<uuid>

Optional. Names an owned sub-account (UUID) to act on. Omit to act at the master (tenant) level. Naming an account this key does not own returns 403 not_account_owner.

Body

application/json

network

enum<string>

required

Network to provision a deposit address on, as a CAIP-2 chain id (e.g. "eip155:1" for Ethereum mainnet).

Available options:

eip155:1,

eip155:8453,

solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp,

tron:mainnet,

solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1

Example:

"eip155:1"

clientRef

string

Optional client reference. Omit for your single default address on this network; pass distinct values (e.g. your end-customer id) to get distinct addresses. Must not start with "pool-", a prefix reserved for platform-minted order-funding addresses.

Maximum string length: 100

Example:

"customer-1234"

Response

Deposit address resolved.

address

string

required

On-chain address to send funds to. For EVM, valid on all EVM chains.

Example:

"0x1234567890abcdef1234567890abcdef12345678"

network

enum<string>

required

Available options:

eip155:1,

eip155:8453,

solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp,

tron:mainnet,

solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1

Example:

"eip155:1"

clientRef

string

Echoes the client reference supplied on the request, if any.

Example:

"customer-1234"

Resolve a crypto deposit address

curl --request POST \
  --url https://api.example.com/v1/deposits/crypto-address \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "network": "eip155:1",
  "clientRef": "customer-1234"
}
'

import requests

url = "https://api.example.com/v1/deposits/crypto-address"

payload = {
    "network": "eip155:1",
    "clientRef": "customer-1234"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({network: 'eip155:1', clientRef: 'customer-1234'})
};

fetch('https://api.example.com/v1/deposits/crypto-address', 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.example.com/v1/deposits/crypto-address",
  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([
    'network' => 'eip155:1',
    'clientRef' => 'customer-1234'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.example.com/v1/deposits/crypto-address"

	payload := strings.NewReader("{\n  \"network\": \"eip155:1\",\n  \"clientRef\": \"customer-1234\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.example.com/v1/deposits/crypto-address")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"network\": \"eip155:1\",\n  \"clientRef\": \"customer-1234\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/deposits/crypto-address")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"network\": \"eip155:1\",\n  \"clientRef\": \"customer-1234\"\n}"

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

{
  "address": "0x1234567890abcdef1234567890abcdef12345678",
  "network": "eip155:1",
  "clientRef": "customer-1234"
}

{
  "error": "BAD_REQUEST",
  "message": "Bad Request",
  "path": "/v1/resource",
  "statusCode": 400,
  "timestamp": "2024-01-15T10:30:00.000Z"
}