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.
Use this endpoint to retrieve all Onramper Accounts in your SpherePay account. Each Onramper Account represents a virtual bank account assigned to a customer that automatically converts fiat deposits to stablecoins. The response is an array of account objects, each including deposit instructions, destination wallet details, and current status.
Endpoint GET https://api.spherepay.co/v2/virtual-account
Authentication All requests require a Bearer token in the Authorization header.
Authorization: Bearer <token>
-H "Authorization: Bearer $SPHERE_API_KEY "
Response fields The response is an array of Onramper Account objects. Each object contains the following fields:
Unique identifier for the Onramper Account.
ID of the customer who owns this account.
Whether the account is currently accepting deposits.
Bank account details your customer uses to deposit fiat funds. The fiat currency accepted (e.g., "usd").
Name of the receiving bank.
Physical address of the receiving bank.
Virtual bank account number to deposit to.
ABA routing number of the receiving bank.
Name of the beneficiary on the receiving account.
Address of the beneficiary.
IBAN for SEPA deposits (EUR accounts).
BIC/SWIFT code for SEPA deposits (EUR accounts).
The crypto destination where converted funds are sent. The stablecoin funds are converted to (e.g., "usdc").
On-chain wallet address receiving the converted funds.
Blockchain network of the destination wallet.
Fee breakdown applied to each deposit conversion. Total fee in basis points (platform + integrator).
Integrator fee in basis points.
SpherePay platform fee in basis points.
ISO 8601 timestamp of when the account was created.
ISO 8601 timestamp of the most recent update.
{ "id" : "virtualAccount_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6" , "customer" : "customer_b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7" , "active" : true , "depositInstructions" : { "currency" : "usd" , "bankName" : "Lead Bank" , "bankAddress" : "1801 Main St, Kansas City, MO 64108" , "bankAccountNumber" : "9876543210" , "bankRoutingNumber" : 21000089 , "bankBeneficiaryName" : "Bridge Financial Inc." , "bankBeneficiaryAddress" : "123 Finance St, San Francisco, CA 94105" , "iban" : "DE89370400440532013000" , "bic" : "COBADEFFXXX" }, "destination" : { "currency" : "usdc" , "walletAddress" : "0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97" , "network" : "ethereum" }, "fee" : { "totalBpsRate" : "130" , "integratorFee" : { "bpsRate" : "100" }, "platformFee" : { "bpsRate" : "30" } }, "created" : "2025-01-15T10:30:00.000Z" , "updated" : "2025-01-15T12:00:00.000Z" } ]
Error responses Status Code Description 400address/invalidOne or more query parameters are invalid. 404resource/not-foundA referenced resource does not exist. 422validation/failedValidation failed. The response includes a per-field errors array.
