Retrieve an Offloader Wallet by ID

Retrieve the full configuration of a single Offloader Wallet by its ID. The response includes the on-chain address to share with the customer, the linked bank account destination, the blockchain network, and the current fee structure. Use this endpoint to verify a wallet’s setup or to look up an address before directing a customer to deposit funds.

Endpoint

GET https://api.spherepay.co/v2/offloader-wallet/{id}

Authentication

All requests must include a Bearer token in the Authorization header.

Authorization: Bearer <token>

Path parameters

string

required

The ID of the offloader wallet to retrieve.

  -H "Authorization: Bearer <token>"

Response fields

string

Unique identifier for the offloader wallet.

customerId

string

The ID of the customer who owns this wallet.

address

string

The on-chain wallet address where the customer sends stablecoins.

currency

string

The stablecoin this wallet accepts (e.g., "usdc").

network

string

The blockchain network this wallet is deployed on (e.g., "ethereum").

destination

object

The bank account destination configuration.

Show properties

bankAccountId

string

The ID of the linked bank account.

currency

string

The fiat currency funds are converted into (e.g., "usd").

network

string

The banking rail used for payouts (e.g., "ach", "wire", "sepa").

achReference

string

ACH reference string, if applicable.

fees

object

Show properties

integratorFee

object

Your integrator fee, including bpsRate and currency.

platformFee

object

SpherePay’s platform fee, including bpsRate and currency.

returnAddress

string

The on-chain address funds are returned to on failed transactions.

created

string

ISO 8601 timestamp of when the wallet was created.

updated

string

ISO 8601 timestamp of the last update to the wallet.

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

Documentation Index

​Endpoint

​Authentication

​Path parameters

​Response fields

Endpoint

Authentication

Path parameters

Response fields