Documentation Index Fetch the complete documentation index at: https://docs.spherepay.co/llms.txt
Use this file to discover all available pages before exploring further.
Retrieve a paginated list of all Offloader Wallets in your account. Use the customerId query parameter to narrow results to a single customer. This endpoint is useful for auditing wallet configurations, reconciling on-chain addresses to bank account destinations, or building a customer-facing wallet management interface.
Endpoint GET https://api.spherepay.co/v2/offloader-wallet
Authentication All requests must include a Bearer token in the Authorization header.
Authorization: Bearer < toke n>
Query parameters Number of results per page.
Filter results to wallets belonging to a specific customer.
-H "Authorization: Bearer <token>"
Response fields Array of offloader wallet objects. Unique identifier for the offloader wallet.
The ID of the customer who owns this wallet.
The on-chain wallet address where the customer sends stablecoins.
The stablecoin this wallet accepts (e.g., "usdc").
The blockchain network this wallet is deployed on (e.g., "ethereum").
The bank account destination configuration, including bankAccountId, currency, network, and any rail-specific reference field.
Integrator and platform fee configuration.
The on-chain address used for returning funds on failed transactions.
ISO 8601 timestamp of when the wallet was created.
ISO 8601 timestamp of the last update to the wallet.
Number of items per page.
Total number of wallets matching the query.
Whether a next page exists.
Whether a previous page exists.
{ "data" : [ { "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" } ], "pagination" : { "page" : 1 , "limit" : 10 , "total" : 1 , "totalPages" : 1 , "hasNext" : false , "hasPrevious" : false } }
