> ## Documentation Index > Fetch the complete documentation index at: https://docs.spritz.finance/llms.txt > Use this file to discover all available pages before exploring further. # Create an off-ramp quote > Creates a quote to convert crypto to fiat. Check `fulfillment` to determine the next step: - `sign_transaction`: Call `POST /off-ramp-quotes/{id}/transaction` for calldata, sign, and submit on-chain. - `send_to_address`: Send crypto to `sendTo.address` before `sendTo.expiresAt`. **Amount modes:** `output` (default) fixes the destination fiat amount and remains supported for USD destinations. EUR destinations require `input`: `amount` is the exact USD value Spritz collects, while quote output is an estimate. Actual settlement is reported by the off-ramp resource. ## OpenAPI ````yaml https://platform.spritz.finance/openapi.json post /v1/off-ramp-quotes/ openapi: 3.0.3 info: title: Spritz Finance API version: 1.0.0 description: API for the Spritz Finance platform with RFC 9457 error handling servers: - url: https://platform.spritz.finance description: Production - url: https://sandbox.spritz.finance description: Sandbox security: [] tags: - name: Users description: User management endpoints - name: Bank Accounts description: Manage bank accounts for off-ramp destinations - name: Bills description: Manage bill pay accounts - name: Cards description: Spritz-issued debit cards - name: Auto-Ramp Accounts description: Virtual bank accounts that automatically convert fiat deposits to crypto - name: Spritz App description: >- Endpoints used by the Spritz app and internal SDKs. Excluded from the public partner spec. paths: /v1/off-ramp-quotes/: post: tags: - Off-Ramp Quotes summary: Create an off-ramp quote description: >- Creates a quote to convert crypto to fiat. Check `fulfillment` to determine the next step: - `sign_transaction`: Call `POST /off-ramp-quotes/{id}/transaction` for calldata, sign, and submit on-chain. - `send_to_address`: Send crypto to `sendTo.address` before `sendTo.expiresAt`. **Amount modes:** `output` (default) fixes the destination fiat amount and remains supported for USD destinations. EUR destinations require `input`: `amount` is the exact USD value Spritz collects, while quote output is an estimate. Actual settlement is reported by the off-ramp resource. operationId: postV1Off-ramp-quotes requestBody: required: true content: application/json: schema: type: object properties: accountId: description: Destination account ID pattern: ^[0-9a-fA-F]{24}$ type: string example: 6a749a054c3b8fc5da595d12 amount: description: >- Amount in the unit selected by amountMode: destination fiat for output, or USD for input. type: string example: '100.00' amountMode: type: string enum: - output - input rail: type: string enum: - ach_standard - ach_same_day - rtp - wire - eft - sepa - faster_payments - push_to_card - bill_pay - card_deposit chain: type: string enum: - ethereum - polygon - arbitrum - base - optimism - avalanche - binance-smart-chain - solana - bitcoin - dash - tron - sui - hyperevm - monad - sonic - unichain tokenAddress: description: >- Token contract address. **Required on every chain except Bitcoin, Dash and XRP**, which have no token layer — there is no native-token fallback, and omitting it is rejected. Different tokens carry different fee tiers (e.g. USDC is cheapest). Must be a valid address for the chain: `0x` + 40 hex on EVM, base58 on Solana; Tron and Sui accept one specific token each. type: string example: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48' memo: description: Payment note (bank account payments only) type: string example: 'Invoice #1234' required: - accountId - amount - chain application/x-www-form-urlencoded: schema: type: object properties: accountId: description: Destination account ID pattern: ^[0-9a-fA-F]{24}$ type: string example: 6a749a054c3b8fc5da595d12 amount: description: >- Amount in the unit selected by amountMode: destination fiat for output, or USD for input. type: string example: '100.00' amountMode: type: string enum: - output - input rail: type: string enum: - ach_standard - ach_same_day - rtp - wire - eft - sepa - faster_payments - push_to_card - bill_pay - card_deposit chain: type: string enum: - ethereum - polygon - arbitrum - base - optimism - avalanche - binance-smart-chain - solana - bitcoin - dash - tron - sui - hyperevm - monad - sonic - unichain tokenAddress: description: >- Token contract address. **Required on every chain except Bitcoin, Dash and XRP**, which have no token layer — there is no native-token fallback, and omitting it is rejected. Different tokens carry different fee tiers (e.g. USDC is cheapest). Must be a valid address for the chain: `0x` + 40 hex on EVM, base58 on Solana; Tron and Sui accept one specific token each. type: string example: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48' memo: description: Payment note (bank account payments only) type: string example: 'Invoice #1234' required: - accountId - amount - chain multipart/form-data: schema: type: object properties: accountId: description: Destination account ID pattern: ^[0-9a-fA-F]{24}$ type: string example: 6a749a054c3b8fc5da595d12 amount: description: >- Amount in the unit selected by amountMode: destination fiat for output, or USD for input. type: string example: '100.00' amountMode: type: string enum: - output - input rail: type: string enum: - ach_standard - ach_same_day - rtp - wire - eft - sepa - faster_payments - push_to_card - bill_pay - card_deposit chain: type: string enum: - ethereum - polygon - arbitrum - base - optimism - avalanche - binance-smart-chain - solana - bitcoin - dash - tron - sui - hyperevm - monad - sonic - unichain tokenAddress: description: >- Token contract address. **Required on every chain except Bitcoin, Dash and XRP**, which have no token layer — there is no native-token fallback, and omitting it is rejected. Different tokens carry different fee tiers (e.g. USDC is cheapest). Must be a valid address for the chain: `0x` + 40 hex on EVM, base58 on Solana; Tron and Sui accept one specific token each. type: string example: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48' memo: description: Payment note (bank account payments only) type: string example: 'Invoice #1234' required: - accountId - amount - chain responses: '201': description: Response for status 201 content: application/json: schema: type: object properties: id: description: Quote ID type: string example: quote_abc123 fulfillment: type: string enum: - sign_transaction - send_to_address status: type: string enum: - created - transaction_pending - transaction_failed - insufficient_funds - confirmed - completed - expired - failed - refunded createdAt: description: When the quote was created format: date-time type: string example: '2026-08-06T14:28:21.709Z' input: description: >- Exact USD value collected by Spritz and the token route used to fund it. The exact token quantity is returned by the transaction endpoint. type: object properties: amount: description: >- Exact total USD value Spritz collects, including the Spritz service fee and excluding blockchain gas. type: string example: '101.50' currency: description: Always USD type: string enum: - USD tokenAddress: description: >- Contract address (EVM/Solana/Sui/Tron) or asset symbol (BTC, DASH) for UTXO chains type: string example: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48' chain: type: string enum: - ethereum - polygon - arbitrum - base - optimism - avalanche - binance-smart-chain - solana - bitcoin - dash - tron - sui - hyperevm - monad - sonic - unichain required: - amount - currency - tokenAddress - chain output: description: >- Destination amount. Exact for supported exact-output quotes; estimated for EUR exact-input quotes. type: object properties: amount: description: >- Fiat amount delivered or estimated for the destination. type: string example: '89.25' currency: description: Destination fiat currency. type: string example: EUR rail: type: string enum: - ach_standard - ach_same_day - rtp - wire - eft - sepa - faster_payments - push_to_card - bill_pay - card_deposit accountId: description: Destination account ID type: string example: 6a749a054c3b8fc5da595d13 estimated: description: >- True when this quote does not lock the destination amount. EUR quotes remain estimates; actual settlement is reported by the off-ramp resource. type: boolean exchangeRate: type: object properties: baseCurrency: description: Currency one unit of the rate is based on. type: string enum: - USD quoteCurrency: description: Destination fiat currency. type: string example: EUR rate: description: >- Indicative destination-currency units per USD at quote creation. type: string example: '0.92010309' required: - baseCurrency - quoteCurrency - rate nullable: true required: - amount - currency - rail - accountId - estimated - exchangeRate fees: description: >- Known Spritz fee. Provider FX movement and blockchain gas are not included. type: object properties: amount: description: Spritz service fee included in input.amount. type: string example: '1.25' currency: description: Service fees are USD-denominated. type: string enum: - USD required: - amount - currency sendTo: description: >- Present when `fulfillment` is `send_to_address`. Send exactly `amount` of `token` to `address` before `expiresAt`. type: object properties: address: description: Blockchain address to send crypto to type: string example: bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh amount: description: Exact crypto amount to send type: string example: '0.00094877' token: description: Token symbol to send type: string example: BTC expiresAt: description: >- Deadline to send crypto. Quote expires after this time. format: date-time type: string required: - address - amount - token - expiresAt nullable: true confirmation: description: Present after on-chain transaction is detected. type: object properties: transactionHash: description: On-chain transaction hash type: string example: 0xabc123... explorerUrl: description: Block explorer URL type: string example: https://etherscan.io/tx/0xabc123... required: - transactionHash - explorerUrl nullable: true required: - id - fulfillment - status - createdAt - input - output - fees - sendTo - confirmation '401': description: Response for status 401 content: application/json: schema: type: object properties: type: default: about:blank description: A URI reference that identifies the problem type type: string example: urn:problem-type:auth:unauthorized title: description: A short, human-readable summary of the problem type type: string example: Unauthorized status: description: The HTTP status code type: number example: 401 detail: description: A human-readable explanation specific to this occurrence type: string example: Bearer token required instance: description: A URI reference that identifies the specific occurrence type: string realm: description: The authentication realm type: string example: API scope: description: The required scope for this resource type: string example: read:users required: - title - status additionalProperties: false '404': description: Response for status 404 content: application/json: schema: type: object properties: type: default: about:blank description: A URI reference that identifies the problem type type: string title: description: A short, human-readable summary of the problem type type: string status: description: The HTTP status code type: number example: 404 detail: description: A human-readable explanation specific to this occurrence type: string instance: description: A URI reference that identifies the specific occurrence type: string resourceType: description: The type of resource that was not found type: string example: user resourceId: description: The identifier of the resource that was not found type: string required: - title - status - resourceType - resourceId additionalProperties: false '500': description: Response for status 500 content: application/json: schema: type: object properties: type: default: about:blank description: A URI reference that identifies the problem type type: string example: urn:problem-type:auth:unauthorized title: description: A short, human-readable summary of the problem type type: string example: Unauthorized status: description: The HTTP status code type: number example: 400 detail: description: A human-readable explanation specific to this occurrence type: string instance: description: A URI reference that identifies the specific occurrence type: string example: /errors/1234567890 code: description: >- Machine-readable cause, present when exactly one thing failed. Branch on this, never on `detail`, which is human-facing copy and may change. For deposit limits the vocabulary matches the `reason` values the limits API returns pre-flight. type: string example: transaction_limit field: description: The offending request field, present alongside `code`. type: string example: amountUsd retryable: description: >- Whether retrying the same request later may succeed without changing its inputs. type: boolean example: true required: - title - status additionalProperties: false security: - bearerAuth: [] - integratorJwt: [] - hmacAuth: [] integratorKey: [] timestamp: [] components: securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: Cognito JWT token for regular user authentication integratorJwt: type: http scheme: bearer bearerFormat: JWT description: >- Integrator JWT token (prefix: spr_) for frontend integrator authentication. Obtained via token exchange endpoint. hmacAuth: type: apiKey in: header name: X-Signature description: >- HMAC signature authentication for backend integrators. **Required Headers:** - X-Integrator-Key: Integrator API key (format: int_...) - X-Signature: HMAC signature (format: sha256={hex}) - X-Timestamp: Unix timestamp in milliseconds - Authorization: Bearer {user-api-key} **Signature Algorithm:** HMAC-SHA256 **Signature Format:** {timestamp}.{METHOD}.{path}.{bodyHash} - timestamp: Unix timestamp in milliseconds - METHOD: HTTP method in UPPERCASE (GET, POST, etc.) - path: Request path (e.g., /v1/transactions) - bodyHash: SHA256 hex digest of request body (empty string if no body) **Timestamp Tolerance:** ±5 minutes (300 seconds) **Example:** For POST /v1/transactions with body {"amount":100} and timestamp 1234567890000: Payload: 1234567890000.POST./v1/transactions.{sha256(body)} Signature: sha256=abc123... integratorKey: type: apiKey in: header name: X-Integrator-Key description: 'Integrator API key (format: int_...) used with HMAC authentication' timestamp: type: apiKey in: header name: X-Timestamp description: >- Unix timestamp in milliseconds for replay attack prevention. Must be within 5 minutes of server time. ````