Criar uma Offloader Wallet para Pagamentos em Cripto

Create an offloader wallet

curl --request POST \
  --url https://api.spherepay.co/v2/offloader-wallet \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customerId": "customer_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
  "currency": "usdc",
  "network": "ethereum",
  "destination": {
    "bankAccountId": "bankAccount_6221e8d4299f4a889bd882255e92f581",
    "currency": "usd",
    "network": "ach",
    "achReference": "REF123"
  },
  "integratorBpsFeeRate": "100",
  "returnAddress": "0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97"
}
'

import requests

url = "https://api.spherepay.co/v2/offloader-wallet"

payload = {
    "customerId": "customer_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
    "currency": "usdc",
    "network": "ethereum",
    "destination": {
        "bankAccountId": "bankAccount_6221e8d4299f4a889bd882255e92f581",
        "currency": "usd",
        "network": "ach",
        "achReference": "REF123"
    },
    "integratorBpsFeeRate": "100",
    "returnAddress": "0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97"
}
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({
    customerId: 'customer_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6',
    currency: 'usdc',
    network: 'ethereum',
    destination: {
      bankAccountId: 'bankAccount_6221e8d4299f4a889bd882255e92f581',
      currency: 'usd',
      network: 'ach',
      achReference: 'REF123'
    },
    integratorBpsFeeRate: '100',
    returnAddress: '0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97'
  })
};

fetch('https://api.spherepay.co/v2/offloader-wallet', 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.spherepay.co/v2/offloader-wallet",
  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([
    'customerId' => 'customer_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6',
    'currency' => 'usdc',
    'network' => 'ethereum',
    'destination' => [
        'bankAccountId' => 'bankAccount_6221e8d4299f4a889bd882255e92f581',
        'currency' => 'usd',
        'network' => 'ach',
        'achReference' => 'REF123'
    ],
    'integratorBpsFeeRate' => '100',
    'returnAddress' => '0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97'
  ]),
  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.spherepay.co/v2/offloader-wallet"

	payload := strings.NewReader("{\n  \"customerId\": \"customer_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6\",\n  \"currency\": \"usdc\",\n  \"network\": \"ethereum\",\n  \"destination\": {\n    \"bankAccountId\": \"bankAccount_6221e8d4299f4a889bd882255e92f581\",\n    \"currency\": \"usd\",\n    \"network\": \"ach\",\n    \"achReference\": \"REF123\"\n  },\n  \"integratorBpsFeeRate\": \"100\",\n  \"returnAddress\": \"0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97\"\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.spherepay.co/v2/offloader-wallet")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customerId\": \"customer_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6\",\n  \"currency\": \"usdc\",\n  \"network\": \"ethereum\",\n  \"destination\": {\n    \"bankAccountId\": \"bankAccount_6221e8d4299f4a889bd882255e92f581\",\n    \"currency\": \"usd\",\n    \"network\": \"ach\",\n    \"achReference\": \"REF123\"\n  },\n  \"integratorBpsFeeRate\": \"100\",\n  \"returnAddress\": \"0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.spherepay.co/v2/offloader-wallet")

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  \"customerId\": \"customer_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6\",\n  \"currency\": \"usdc\",\n  \"network\": \"ethereum\",\n  \"destination\": {\n    \"bankAccountId\": \"bankAccount_6221e8d4299f4a889bd882255e92f581\",\n    \"currency\": \"usd\",\n    \"network\": \"ach\",\n    \"achReference\": \"REF123\"\n  },\n  \"integratorBpsFeeRate\": \"100\",\n  \"returnAddress\": \"0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97\"\n}"

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

{
  "id": "wallet_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
  "customerId": "customer_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
  "address": "0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97",
  "currency": "usdc",
  "network": "ethereum",
  "status": "active",
  "destination": {
    "bankAccountId": "bankAccount_6221e8d4299f4a889bd882255e92f581",
    "currency": "usd",
    "network": "ach",
    "achReference": "REF123"
  },
  "fees": {
    "integratorFee": {
      "bpsRate": "100",
      "currency": "usdc"
    },
    "platformFee": {
      "bpsRate": "30",
      "currency": "usdc"
    }
  },
  "created": "2024-06-15T10:30:00.000Z",
  "updated": "2024-06-15T12:00:00.000Z",
  "returnAddress": "0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97"
}

{
  "status": 400,
  "detail": "Invalid request parameters",
  "code": "address/invalid",
  "correlationId": "28c61e885c6e5eaa78c1a2183a9b883c"
}

{
  "status": 404,
  "detail": "Resource not found",
  "code": "resource/not-found",
  "correlationId": "28c61e885c6e5eaa78c1a2183a9b883c"
}

{
  "status": 422,
  "detail": "Validation failed",
  "code": "validation/failed",
  "correlationId": "28c61e885c6e5eaa78c1a2183a9b883c",
  "errors": [
    {
      "detail": "Invalid email format",
      "pointer": "/email"
    },
    {
      "detail": "Name is required",
      "pointer": "/name"
    }
  ]
}

Create an offloader wallet

curl --request POST \
  --url https://api.spherepay.co/v2/offloader-wallet \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customerId": "customer_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
  "currency": "usdc",
  "network": "ethereum",
  "destination": {
    "bankAccountId": "bankAccount_6221e8d4299f4a889bd882255e92f581",
    "currency": "usd",
    "network": "ach",
    "achReference": "REF123"
  },
  "integratorBpsFeeRate": "100",
  "returnAddress": "0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97"
}
'

import requests

url = "https://api.spherepay.co/v2/offloader-wallet"

payload = {
    "customerId": "customer_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
    "currency": "usdc",
    "network": "ethereum",
    "destination": {
        "bankAccountId": "bankAccount_6221e8d4299f4a889bd882255e92f581",
        "currency": "usd",
        "network": "ach",
        "achReference": "REF123"
    },
    "integratorBpsFeeRate": "100",
    "returnAddress": "0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97"
}
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({
    customerId: 'customer_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6',
    currency: 'usdc',
    network: 'ethereum',
    destination: {
      bankAccountId: 'bankAccount_6221e8d4299f4a889bd882255e92f581',
      currency: 'usd',
      network: 'ach',
      achReference: 'REF123'
    },
    integratorBpsFeeRate: '100',
    returnAddress: '0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97'
  })
};

fetch('https://api.spherepay.co/v2/offloader-wallet', 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.spherepay.co/v2/offloader-wallet",
  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([
    'customerId' => 'customer_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6',
    'currency' => 'usdc',
    'network' => 'ethereum',
    'destination' => [
        'bankAccountId' => 'bankAccount_6221e8d4299f4a889bd882255e92f581',
        'currency' => 'usd',
        'network' => 'ach',
        'achReference' => 'REF123'
    ],
    'integratorBpsFeeRate' => '100',
    'returnAddress' => '0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97'
  ]),
  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.spherepay.co/v2/offloader-wallet"

	payload := strings.NewReader("{\n  \"customerId\": \"customer_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6\",\n  \"currency\": \"usdc\",\n  \"network\": \"ethereum\",\n  \"destination\": {\n    \"bankAccountId\": \"bankAccount_6221e8d4299f4a889bd882255e92f581\",\n    \"currency\": \"usd\",\n    \"network\": \"ach\",\n    \"achReference\": \"REF123\"\n  },\n  \"integratorBpsFeeRate\": \"100\",\n  \"returnAddress\": \"0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97\"\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.spherepay.co/v2/offloader-wallet")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customerId\": \"customer_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6\",\n  \"currency\": \"usdc\",\n  \"network\": \"ethereum\",\n  \"destination\": {\n    \"bankAccountId\": \"bankAccount_6221e8d4299f4a889bd882255e92f581\",\n    \"currency\": \"usd\",\n    \"network\": \"ach\",\n    \"achReference\": \"REF123\"\n  },\n  \"integratorBpsFeeRate\": \"100\",\n  \"returnAddress\": \"0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.spherepay.co/v2/offloader-wallet")

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  \"customerId\": \"customer_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6\",\n  \"currency\": \"usdc\",\n  \"network\": \"ethereum\",\n  \"destination\": {\n    \"bankAccountId\": \"bankAccount_6221e8d4299f4a889bd882255e92f581\",\n    \"currency\": \"usd\",\n    \"network\": \"ach\",\n    \"achReference\": \"REF123\"\n  },\n  \"integratorBpsFeeRate\": \"100\",\n  \"returnAddress\": \"0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97\"\n}"

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

{
  "id": "wallet_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
  "customerId": "customer_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
  "address": "0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97",
  "currency": "usdc",
  "network": "ethereum",
  "status": "active",
  "destination": {
    "bankAccountId": "bankAccount_6221e8d4299f4a889bd882255e92f581",
    "currency": "usd",
    "network": "ach",
    "achReference": "REF123"
  },
  "fees": {
    "integratorFee": {
      "bpsRate": "100",
      "currency": "usdc"
    },
    "platformFee": {
      "bpsRate": "30",
      "currency": "usdc"
    }
  },
  "created": "2024-06-15T10:30:00.000Z",
  "updated": "2024-06-15T12:00:00.000Z",
  "returnAddress": "0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97"
}

{
  "status": 400,
  "detail": "Invalid request parameters",
  "code": "address/invalid",
  "correlationId": "28c61e885c6e5eaa78c1a2183a9b883c"
}

{
  "status": 404,
  "detail": "Resource not found",
  "code": "resource/not-found",
  "correlationId": "28c61e885c6e5eaa78c1a2183a9b883c"
}

{
  "status": 422,
  "detail": "Validation failed",
  "code": "validation/failed",
  "correlationId": "28c61e885c6e5eaa78c1a2183a9b883c",
  "errors": [
    {
      "detail": "Invalid email format",
      "pointer": "/email"
    },
    {
      "detail": "Name is required",
      "pointer": "/name"
    }
  ]
}

Crie uma Offloader Wallet para dar a um cliente (customer) um endereço on-chain dedicado vinculado a uma conta bancária (bank_account) específica. Qualquer stablecoin enviada para esse endereço é automaticamente convertida para a moeda fiat vinculada e encaminhada — nenhuma chamada de API por transferência é necessária. Cada cliente deve ter sua própria carteira; compartilhar um endereço entre clientes torna a atribuição de depósitos não confiável.

Autorizações

Authorization

string

header

obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Corpo

application/json

customerId

string

obrigatório

The customer who owns the destination bank account.

Exemplo:

"customer_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"

currency

enum<string>

obrigatório

The crypto currency the offloader wallet accepts for deposits. See Supported Rails & Currencies.

Opções disponíveis:

usdc,

usdt,

eurc

Exemplo:

"usdc"

network

enum<string>

obrigatório

The blockchain network the offloader wallet is on. See Supported Rails & Currencies.

Opções disponíveis:

sol,

ethereum,

arbitrum,

polygon,

base,

avalanche,

tron

Exemplo:

"ethereum"

destination

ACH · object

obrigatório

The bank account destination where converted funds are sent. See Bank Accounts guide.

ACH
Wire
SEPA

Show child attributes

Exemplo:

{
  "bankAccountId": "bankAccount_6221e8d4299f4a889bd882255e92f581",
  "currency": "usd",
  "network": "ach",
  "achReference": "REF123"
}

integratorBpsFeeRate

string

Integrator fee in basis points (0-1000).

Exemplo:

"100"

returnAddress

string

Crypto address where funds are returned on failed transactions. Must be valid for the selected network.

Exemplo:

"0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97"

Resposta

string

obrigatório

Unique identifier for the offloader wallet.

Exemplo:

"wallet_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"

customerId

string

obrigatório

The customer who owns the offloader wallet.

Exemplo:

"customer_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"

address

string

obrigatório

The on-chain deposit address for the offloader wallet. Send crypto to this address to trigger automatic conversion.

Exemplo:

"0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97"

currency

enum<string>

obrigatório

The crypto currency the offloader wallet accepts for deposits. See Supported Rails & Currencies.

Opções disponíveis:

usdc,

usdt,

eurc

Exemplo:

"usdc"

network

enum<string>

obrigatório

The blockchain network the offloader wallet is on. See Supported Rails & Currencies.

Opções disponíveis:

sol,

ethereum,

arbitrum,

polygon,

base,

avalanche,

tron

Exemplo:

"ethereum"

status

enum<string>

obrigatório

Lifecycle status of the offloader wallet. active accepts deposits and settles; deactivated no longer settles.

Opções disponíveis:

active,

deactivated

Exemplo:

"active"

destination

ACH · object

obrigatório

The bank account destination where converted funds are sent. See Bank Accounts guide.

ACH
Wire
SEPA

Show child attributes

Exemplo:

{
  "bankAccountId": "bankAccount_6221e8d4299f4a889bd882255e92f581",
  "currency": "usd",
  "network": "ach",
  "achReference": "REF123"
}

fees

object

obrigatório

Fee configuration for the offloader wallet, including integrator and platform fees.

Show child attributes

Exemplo:

{
  "integratorFee": { "bpsRate": "100", "currency": "usdc" },
  "platformFee": { "bpsRate": "30", "currency": "usdc" }
}

created

string

obrigatório

Timestamp when the offloader wallet was created (ISO 8601).

Exemplo:

"2024-06-15T10:30:00.000Z"

updated

string

obrigatório

Timestamp when the offloader wallet was last updated (ISO 8601).

Exemplo:

"2024-06-15T12:00:00.000Z"

returnAddress

string

Crypto address where funds are returned on failed transactions. Must be valid for the wallet network. Null if not configured.

Exemplo:

"0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97"

Última modificação em 22 de junho de 2026

Reativar Conta Listar Offloader Wallets

⌘I