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 the list of transfers processed through a specific Onramper Account. Each transfer represents a fiat deposit that was automatically converted to stablecoins and forwarded to the destination wallet. Use this endpoint to reconcile incoming deposits, verify conversion amounts, and attribute payments to individual customers.
Each Onramper Account should belong to a single customer. If multiple customers share a virtual account, matching deposits to customers requires manually correlating by amount and timing — which is error-prone. Always create one Onramper Account per customer.

Endpoint

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

Authentication

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

Path parameters

id
string
required
The Onramper Account ID whose transfers you want to list (e.g., "virtualAccount_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6").
  -H "Authorization: Bearer $SPHERE_API_KEY"

Response fields

The response is an array of transfer objects. Each object represents one fiat-to-crypto conversion processed through the account.
id
string
Unique identifier for the transfer.
status
string
Current status of the transfer (e.g., "completed", "pending", "failed").
sourceAmount
string
The fiat amount received, as a string decimal.
sourceCurrency
string
The fiat currency of the deposit (e.g., "usd").
destinationAmount
string
The stablecoin amount delivered after conversion and fees.
destinationCurrency
string
The stablecoin the deposit was converted into (e.g., "usdc").
network
string
The blockchain network the stablecoins were delivered on.
walletAddress
string
The on-chain wallet address that received the converted funds.
created
string
ISO 8601 timestamp of when the transfer was initiated.
updated
string
ISO 8601 timestamp of the most recent status update.
  {
    "id": "transfer_f1e2d3c4b5a6f7e8d9c0b1a2f3e4d5c6",
    "status": "completed",
    "sourceAmount": "500.00",
    "sourceCurrency": "usd",
    "destinationAmount": "499.35",
    "destinationCurrency": "usdc",
    "network": "ethereum",
    "walletAddress": "0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97",
    "created": "2025-01-20T14:00:00.000Z",
    "updated": "2025-01-20T14:05: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