Create a Quote

Authorization

bearer

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

amount*string

The quote amount (denominated in source currency).

Match^\d+(\.\d{2})?$

customerId*string

The customer's ID.

Match^customer_[a-z0-9]+$

source*

The source currency and network for the quote.

destination*

The destination currency and network for the quote.

quoteDurationSeconds?number

The duration in seconds for which the quote rate is locked. Defaults to 60.

Default60

Value in30 | 60 | 300

integratorBpsFeeRate?string

The integrator BPS fee rate. The BPS rate should be an integer represented as a string.

Response Body

`application/json`

curl -X POST "https://api.spherepay.co/v2/quote" \  -H "Content-Type: application/json" \  -d '{    "amount": "100.00",    "customerId": "customer_3faa484998f44cfead9668608b9ee1f5",    "source": {      "currency": "usdc",      "network": "polygon"    },    "destination": {      "currency": "brl",      "network": "pix"    }  }'

{
  "id": "quote_d243ab2b1de4447d8a046d87fefe58cf",
  "type": "off_ramp",
  "customerId": "customer_d243ab2b1de4447d8a046d87fefe58cf",
  "fees": {
    "integratorFee": {
      "fixedAmount": "0.00",
      "bpsRate": "0",
      "totalAmount": "0.00",
      "currency": "usdc"
    },
    "platformFee": {
      "fixedAmount": "0.00",
      "bpsRate": "20",
      "totalAmount": "2.00",
      "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"
}

{
  "status": 400,
  "detail": "Invalid request parameters",
  "code": "address/invalid",
  "correlationId": "28c61e885c6e5eaa78c1a2183a9b883c"
}

{
  "status": 404,
  "detail": "Resource not found",
  "code": "resource/not-found",
  "correlationId": "28c61e885c6e5eaa78c1a2183a9b883c"
}

{
  "status": 422,
  "detail": "Validation failed",
  "code": "validation/failed",
  "correlationId": "28c61e885c6e5eaa78c1a2183a9b883c",
  "errors": [
    {
      "detail": "Invalid email format",
      "pointer": "/email"
    },
    {
      "detail": "Name is required",
      "pointer": "/name"
    }
  ]
}

Authorization

Request Body

Response Body

201application/json

400application/json

404application/json

422application/json

`application/json`

`application/json`

`application/json`

`application/json`