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 '
{
"currency": "usdc",
"customerId": "customer_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
"destination": {
"achReference": "REF123",
"bankAccountId": "bankAccount_6221e8d4299f4a889bd882255e92f581",
"currency": "usd",
"network": "ach"
},
"network": "ethereum",
"integratorBpsFeeRate": "100",
"returnAddress": "0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97"
}
'import requests
url = "https://api.spherepay.co/v2/offloader-wallet"
payload = {
"currency": "usdc",
"customerId": "customer_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
"destination": {
"achReference": "REF123",
"bankAccountId": "bankAccount_6221e8d4299f4a889bd882255e92f581",
"currency": "usd",
"network": "ach"
},
"network": "ethereum",
"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({
currency: 'usdc',
customerId: 'customer_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6',
destination: {
achReference: 'REF123',
bankAccountId: 'bankAccount_6221e8d4299f4a889bd882255e92f581',
currency: 'usd',
network: 'ach'
},
network: 'ethereum',
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([
'currency' => 'usdc',
'customerId' => 'customer_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6',
'destination' => [
'achReference' => 'REF123',
'bankAccountId' => 'bankAccount_6221e8d4299f4a889bd882255e92f581',
'currency' => 'usd',
'network' => 'ach'
],
'network' => 'ethereum',
'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 \"currency\": \"usdc\",\n \"customerId\": \"customer_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6\",\n \"destination\": {\n \"achReference\": \"REF123\",\n \"bankAccountId\": \"bankAccount_6221e8d4299f4a889bd882255e92f581\",\n \"currency\": \"usd\",\n \"network\": \"ach\"\n },\n \"network\": \"ethereum\",\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 \"currency\": \"usdc\",\n \"customerId\": \"customer_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6\",\n \"destination\": {\n \"achReference\": \"REF123\",\n \"bankAccountId\": \"bankAccount_6221e8d4299f4a889bd882255e92f581\",\n \"currency\": \"usd\",\n \"network\": \"ach\"\n },\n \"network\": \"ethereum\",\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 \"currency\": \"usdc\",\n \"customerId\": \"customer_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6\",\n \"destination\": {\n \"achReference\": \"REF123\",\n \"bankAccountId\": \"bankAccount_6221e8d4299f4a889bd882255e92f581\",\n \"currency\": \"usd\",\n \"network\": \"ach\"\n },\n \"network\": \"ethereum\",\n \"integratorBpsFeeRate\": \"100\",\n \"returnAddress\": \"0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97\"\n}"
response = http.request(request)
puts response.read_body{
"address": "0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97",
"created": "2024-06-15T10:30:00.000Z",
"currency": "usdc",
"customerId": "customer_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
"destination": {
"achReference": "REF123",
"bankAccountId": "bankAccount_6221e8d4299f4a889bd882255e92f581",
"currency": "usd",
"network": "ach"
},
"fees": {
"integratorFee": {
"bpsRate": "100",
"currency": "usdc"
},
"platformFee": {
"bpsRate": "30",
"currency": "usdc"
}
},
"id": "wallet_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
"network": "ethereum",
"status": "active",
"updated": "2024-06-15T12:00:00.000Z",
"returnAddress": "0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97"
}{
"code": "address/invalid",
"correlationId": "28c61e885c6e5eaa78c1a2183a9b883c",
"detail": "Invalid request parameters",
"status": 400
}{
"code": "resource/not-found",
"correlationId": "28c61e885c6e5eaa78c1a2183a9b883c",
"detail": "Resource not found",
"status": 404
}{
"code": "validation/failed",
"correlationId": "28c61e885c6e5eaa78c1a2183a9b883c",
"detail": "Validation failed",
"errors": [
{
"detail": "Invalid email format",
"pointer": "/email"
},
{
"detail": "Name is required",
"pointer": "/name"
}
],
"status": 422
}Offloader Wallets
Create an Offloader Wallet for Crypto Payouts
Create a new offloader wallet.
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 '
{
"currency": "usdc",
"customerId": "customer_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
"destination": {
"achReference": "REF123",
"bankAccountId": "bankAccount_6221e8d4299f4a889bd882255e92f581",
"currency": "usd",
"network": "ach"
},
"network": "ethereum",
"integratorBpsFeeRate": "100",
"returnAddress": "0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97"
}
'import requests
url = "https://api.spherepay.co/v2/offloader-wallet"
payload = {
"currency": "usdc",
"customerId": "customer_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
"destination": {
"achReference": "REF123",
"bankAccountId": "bankAccount_6221e8d4299f4a889bd882255e92f581",
"currency": "usd",
"network": "ach"
},
"network": "ethereum",
"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({
currency: 'usdc',
customerId: 'customer_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6',
destination: {
achReference: 'REF123',
bankAccountId: 'bankAccount_6221e8d4299f4a889bd882255e92f581',
currency: 'usd',
network: 'ach'
},
network: 'ethereum',
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([
'currency' => 'usdc',
'customerId' => 'customer_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6',
'destination' => [
'achReference' => 'REF123',
'bankAccountId' => 'bankAccount_6221e8d4299f4a889bd882255e92f581',
'currency' => 'usd',
'network' => 'ach'
],
'network' => 'ethereum',
'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 \"currency\": \"usdc\",\n \"customerId\": \"customer_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6\",\n \"destination\": {\n \"achReference\": \"REF123\",\n \"bankAccountId\": \"bankAccount_6221e8d4299f4a889bd882255e92f581\",\n \"currency\": \"usd\",\n \"network\": \"ach\"\n },\n \"network\": \"ethereum\",\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 \"currency\": \"usdc\",\n \"customerId\": \"customer_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6\",\n \"destination\": {\n \"achReference\": \"REF123\",\n \"bankAccountId\": \"bankAccount_6221e8d4299f4a889bd882255e92f581\",\n \"currency\": \"usd\",\n \"network\": \"ach\"\n },\n \"network\": \"ethereum\",\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 \"currency\": \"usdc\",\n \"customerId\": \"customer_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6\",\n \"destination\": {\n \"achReference\": \"REF123\",\n \"bankAccountId\": \"bankAccount_6221e8d4299f4a889bd882255e92f581\",\n \"currency\": \"usd\",\n \"network\": \"ach\"\n },\n \"network\": \"ethereum\",\n \"integratorBpsFeeRate\": \"100\",\n \"returnAddress\": \"0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97\"\n}"
response = http.request(request)
puts response.read_body{
"address": "0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97",
"created": "2024-06-15T10:30:00.000Z",
"currency": "usdc",
"customerId": "customer_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
"destination": {
"achReference": "REF123",
"bankAccountId": "bankAccount_6221e8d4299f4a889bd882255e92f581",
"currency": "usd",
"network": "ach"
},
"fees": {
"integratorFee": {
"bpsRate": "100",
"currency": "usdc"
},
"platformFee": {
"bpsRate": "30",
"currency": "usdc"
}
},
"id": "wallet_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
"network": "ethereum",
"status": "active",
"updated": "2024-06-15T12:00:00.000Z",
"returnAddress": "0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97"
}{
"code": "address/invalid",
"correlationId": "28c61e885c6e5eaa78c1a2183a9b883c",
"detail": "Invalid request parameters",
"status": 400
}{
"code": "resource/not-found",
"correlationId": "28c61e885c6e5eaa78c1a2183a9b883c",
"detail": "Resource not found",
"status": 404
}{
"code": "validation/failed",
"correlationId": "28c61e885c6e5eaa78c1a2183a9b883c",
"detail": "Validation failed",
"errors": [
{
"detail": "Invalid email format",
"pointer": "/email"
},
{
"detail": "Name is required",
"pointer": "/name"
}
],
"status": 422
}Create an Offloader Wallet to give a customer a dedicated on-chain address tied to a specific bank account. Any stablecoin sent to that address is automatically converted to the linked fiat currency and forwarded — no per-transfer API call required. Each customer should have their own wallet; sharing an address across customers makes deposit attribution unreliable.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
The crypto currency the offloader wallet accepts for deposits. See Supported Rails & Currencies.
Available options:
usdc, usdt, eurc Example:
"usdc"
The customer who owns the destination bank account.
Example:
"customer_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"
The bank account destination where converted funds are sent. See Bank Accounts guide.
- ACH
- Wire
- SEPA
Show child attributes
Show child attributes
Example:
{
"achReference": "REF123",
"bankAccountId": "bankAccount_6221e8d4299f4a889bd882255e92f581",
"currency": "usd",
"network": "ach"
}
The blockchain network the offloader wallet is on. See Supported Rails & Currencies.
Available options:
sol, ethereum, arbitrum, polygon, base, avalanche, tron Example:
"ethereum"
Integrator fee in basis points (0-1000).
Example:
"100"
Crypto address where funds are returned on failed transactions. Must be valid for the selected network.
Example:
"0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97"
Response
The on-chain deposit address for the offloader wallet. Send crypto to this address to trigger automatic conversion.
Example:
"0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97"
Timestamp when the offloader wallet was created (ISO 8601).
Example:
"2024-06-15T10:30:00.000Z"
The crypto currency the offloader wallet accepts for deposits. See Supported Rails & Currencies.
Available options:
usdc, usdt, eurc Example:
"usdc"
The customer who owns the offloader wallet.
Example:
"customer_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"
The bank account destination where converted funds are sent. See Bank Accounts guide.
- ACH
- Wire
- SEPA
Show child attributes
Show child attributes
Example:
{
"achReference": "REF123",
"bankAccountId": "bankAccount_6221e8d4299f4a889bd882255e92f581",
"currency": "usd",
"network": "ach"
}
Fee configuration for the offloader wallet, including integrator and platform fees.
Show child attributes
Show child attributes
Example:
{
"integratorFee": { "bpsRate": "100", "currency": "usdc" },
"platformFee": { "bpsRate": "30", "currency": "usdc" }
}
Unique identifier for the offloader wallet.
Example:
"wallet_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"
The blockchain network the offloader wallet is on. See Supported Rails & Currencies.
Available options:
sol, ethereum, arbitrum, polygon, base, avalanche, tron Example:
"ethereum"
Lifecycle status of the offloader wallet. active accepts deposits and settles; deactivated no longer settles.
Available options:
active, deactivated Example:
"active"
Timestamp when the offloader wallet was last updated (ISO 8601).
Example:
"2024-06-15T12:00:00.000Z"
Crypto address where funds are returned on failed transactions. Must be valid for the wallet network. Null if not configured.
Example:
"0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97"
Last modified on June 18, 2026