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.

Fetch the current state of a single quote. Useful when polling for status changes (active → used or active → expired) before triggering downstream logic in your application.

​
Endpoint

GET https://api.spherepay.co/v2/quote/{id}

​
Authentication

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

​
Path parameter

​
id
string
required
The quote ID. Matches ^quote_[a-z0-9]+$.

​
Response fields

​
id
string
Unique quote identifier.
​
status
string
Current quote status. One of active, used, or expired.
​
type
string
Transfer direction the quote is for: on_ramp or off_ramp.
​
customerId
string
The customer ID the quote belongs to.
​
fees
object
Full fee breakdown. See Create Quote for the field-level definition.
​
source
object
Source side of the quote: currency, network, amount.
​
destination
object
Destination side of the quote: currency, network, amount, exchangeRate.
​
expiresAt
string
ISO 8601 timestamp when this quote expires.
​
created
string
ISO 8601 creation timestamp.
​
updated
string
ISO 8601 timestamp of the most recent status change.
curl "https://api.spherepay.co/v2/quote/quote_d243ab2b1de4447d8a046d87fefe58cf" \
  -H "Authorization: Bearer $SPHEREPAY_API_KEY"

{
  "id": "quote_d243ab2b1de4447d8a046d87fefe58cf",
  "status": "active",
  "type": "off_ramp",
  "customerId": "customer_3faa484998f44cfead9668608b9ee1f5",
  "fees": {
    "integratorFee": {
      "fixedAmount": "0.00",
      "bpsRate": "20",
      "bpsAmount": "0.20",
      "totalAmount": "0.20",
      "currency": "usdc"
    },
    "platformFee": {
      "fixedAmount": "0.00",
      "bpsRate": "20",
      "bpsAmount": "0.20",
      "totalAmount": "0.20",
      "currency": "usdc"
    }
  },
  "source": {
    "currency": "usdc",
    "network": "polygon",
    "amount": "100.00"
  },
  "destination": {
    "currency": "brl",
    "network": "pix",
    "amount": "545.50",
    "exchangeRate": "5.455"
  },
  "expiresAt": "2025-01-01T00:01:00.000Z",
  "created": "2025-01-01T00:00:00.000Z",
  "updated": "2025-01-01T00:00:00.000Z"
}

​
Error codes

StatusCodeDescription
404resource/not-foundNo quote exists with the supplied ID.
422validation/failedThe id path parameter is malformed.
Last modified on May 20, 2026