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 update the destination configuration of an existing Onramper Account. You can change the destination stablecoin, blockchain network, wallet address, and integrator fee. All fields in the request body are optional — include only the fields you want to change. Future deposits will use the updated destination configuration immediately after the update.

​
Endpoint

PATCH 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 to update (e.g., "virtualAccount_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6").

​
Request parameters

​
destinationCurrency
string
The stablecoin that deposited fiat is converted into. Must be one of "usdc", "usdt", or "eurc". Must be compatible with the chosen network.
​
network
string
The blockchain network the destination wallet is on. Must be one of "arbitrum", "avalanche", "base", "ethereum", "polygon", "sol", or "tron".
​
walletAddress
string
The updated on-chain wallet address where converted stablecoins are delivered. Must be a valid address format for the specified network.
​
integratorFeeBps
string
Updated integrator fee in basis points (1 bps = 0.01%). Set to "0" to remove the integrator fee.
  -H "Authorization: Bearer $SPHERE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "destinationCurrency": "usdc",
    "network": "base",
    "walletAddress": "0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97"
  }'

​
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.
​
depositInstructions
object
Bank account details for depositing fiat. These do not change when you update the destination.
​
destination
object
The updated crypto destination.
​
fee
object
Updated fee breakdown.
​
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": "base"
  },
  "fee": {
    "totalBpsRate": "130",
    "integratorFee": {
      "bpsRate": "100"
    },
    "platformFee": {
      "bpsRate": "30"
    }
  },
  "created": "2025-01-15T10:30:00.000Z",
  "updated": "2025-01-16T08:45:00.000Z"
}

​
Error responses

StatusCodeDescription
400address/invalidOne or more request parameters are 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