Create a settlement quote
POST/checkouts/quoteLock token-specific exchange rates for a fiat-denominated checkout. Pass the returned quote_id when creating a checkout with token-specific signatures.
Headers
| Header | Description | Required |
|---|---|---|
| Authorization | Bearer token with your secret API key | yes |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| amount | integer | yes | Amount in the currency's minor units (5000 is 50.00 USD). At most 9007199254740991. A fiat-settled business has a settlement floor of 1.00 USD, or the provider's higher minimum. |
| currency | string | yes |
Example Request
Request
const response = await fetch('https://checkout-api.exodus.com/checkouts/quote', {
method: 'POST',
headers: {
Authorization: 'Bearer sk_live_xxxxxxxxxxxxxxxx',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"amount": 5000,
"currency": "USD"
}),
});Responses
| Status | Description |
|---|---|
| 200 | A quote with locked token rates. |
| 400 | Validation error |
| 401 | Missing or invalid authentication |
| 403 | API key lacks the required scope |
Response body
| Field | Type | Required | Description |
|---|---|---|---|
| quote_id | string | yes | |
| amount | number | yes | |
| currency | string | yes | |
| tokens | object | yes |
Example Response
{
"quote_id": "quote_1234567890abcdef",
"amount": 5000,
"currency": "USD",
"tokens": {
"USDC": {
"amount": "50000000",
"canonical_amount": "50",
"rate": "1.0",
"expires_at": "2024-01-15T12:05:00Z"
}
}
}Error Response
Error (e.g. 400)
{
"error": {
"type": "validation_error",
"message": "amount must be a positive number",
"param": "amount"
}
}Fiat settlement errors
A fiat-settled business has a settlement floor of 1.00 USD, or the provider’s higher minimum. A USD amount is checked as sent. A non-USD amount is converted at the locked rate for each USDC or USDT token the configured chains can settle. If any one of them is below the floor, the API rejects the request.
| Status | Type | Description |
|---|---|---|
| 422 | invalid_request | amount_below_settlement_minimum: fiat-settled business, the amount is below the settlement floor. error.data carries minimum_usd, the floor that applied (for example "1.00"). |
| 422 | invalid_request | Fiat-settled business with no active payment configuration. The message is “No active payment configuration. Contact support.” and there is no code. |
| 422 | invalid_request | Fiat-settled business whose configured chains cannot settle any token the provider locked a price for. The message is “No price lock for a token the configured chains can settle” and there is no code. |
| 422 | invalid_request | Fiat-settled business whose settlement provider does not settle one-shot payments (today, USD settlement). The message starts with one_shot_not_settleable: and there is no code. The check runs before any price lock, so no quote is issued. |
Last updated on
