Skip to main content

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 a single Onramper Account by its ID. The response includes the deposit instructions you need to share with your customer, the destination wallet address where converted stablecoins are delivered, the active/inactive status, and the fee configuration.

Endpoint

GET https://api.spherepay.co/v2/virtual-account/{id}

Authentication

All requests require a Bearer token in the Authorization header.
Authorization: Bearer <token>

Path parameters

id
string
required
The Onramper Account ID returned when the account was created (e.g., "virtualAccount_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6").
  -H "Authorization: Bearer $SPHERE_API_KEY"

Response fields

id
string
Unique identifier for the Onramper Account.
customer
string
ID of the customer who owns this account.
active
boolean
Whether the account is currently accepting deposits. Deactivated accounts return false.
depositInstructions
object
Bank account details your customer uses to deposit fiat funds.
destination
object
The crypto destination where converted funds are sent.
fee
object
Fee breakdown applied to each deposit conversion.
created
string
ISO 8601 timestamp of when the account was created.
updated
string
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

StatusCodeDescription
400address/invalidThe request is malformed or the ID format is invalid.
404resource/not-foundNo Onramper Account with the specified ID exists.
422validation/failedValidation failed. The response includes a per-field errors array.
Last modified on May 12, 2026