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.

Manually transition a quote out of the active state. Most quote transitions happen automatically — a quote becomes used when redeemed by Create Transfer, and becomes expired when its expiresAt timestamp passes. Use this endpoint when you need to explicitly void a quote (e.g. customer abandoned the flow) or mark it consumed by a downstream system that doesn’t redeem through /v2/transfer.
Only quotes with status active can be updated. Attempting to update a quote that’s already used or expired returns a 422 validation error.

​
Endpoint

PUT 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]+$.

​
Request body

​
status
string
required
The new status. One of used or expired. You cannot set status back to active.

​
Response fields

Returns the updated quote object. Same shape as Get Quote, with status reflecting the new value and updated set to the current timestamp. 
curl -X PUT "https://api.spherepay.co/v2/quote/quote_d243ab2b1de4447d8a046d87fefe58cf" \
  -H "Authorization: Bearer $SPHEREPAY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "status": "used" }'

{
  "id": "quote_d243ab2b1de4447d8a046d87fefe58cf",
  "status": "used",
  "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:30.000Z"
}

​
Error codes

StatusCodeDescription
404resource/not-foundNo quote exists with the supplied ID.
422validation/failedThe quote is no longer active, or status is not one of used / expired.
Last modified on May 20, 2026