> ## 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. # Simulate a deposit into an auto-ramp account (sandbox only) > Simulates a fiat deposit arriving in this auto-ramp account and settling to crypto. **Only available in sandbox environments** — returns 403 in production. There is no other way to make an auto-ramp settle in sandbox: the provider's own sandbox cannot credit a virtual account. This drives the same ingestion path a real deposit takes, so the on-ramp it produces is an ordinary on-ramp — it appears in `GET /v1/on-ramps`, fires the same `onramp.*` webhooks, and carries the same fee breakdown. The fee is the account's own percentage and the conversion is priced off the live rate, so the figures should agree with `GET /v1/auto-ramp-accounts/{id}/estimate` for the same amount, up to the network fee — which no estimate can know in advance and which you set here yourself. Poll `onRampId` at `GET /v1/on-ramps/{id}`. ## OpenAPI ````yaml https://platform.spritz.finance/openapi.json post /v1/sandbox/auto-ramp-accounts/{id}/deposit 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/sandbox/auto-ramp-accounts/{id}/deposit: post: tags: - Sandbox summary: Simulate a deposit into an auto-ramp account (sandbox only) description: >- Simulates a fiat deposit arriving in this auto-ramp account and settling to crypto. **Only available in sandbox environments** — returns 403 in production. There is no other way to make an auto-ramp settle in sandbox: the provider's own sandbox cannot credit a virtual account. This drives the same ingestion path a real deposit takes, so the on-ramp it produces is an ordinary on-ramp — it appears in `GET /v1/on-ramps`, fires the same `onramp.*` webhooks, and carries the same fee breakdown. The fee is the account's own percentage and the conversion is priced off the live rate, so the figures should agree with `GET /v1/auto-ramp-accounts/{id}/estimate` for the same amount, up to the network fee — which no estimate can know in advance and which you set here yourself. Poll `onRampId` at `GET /v1/on-ramps/{id}`. operationId: postV1SandboxAuto-ramp-accountsByIdDeposit parameters: - name: id in: path required: true schema: minLength: 1 description: The auto-ramp account ID to deposit into type: string requestBody: required: true content: application/json: schema: type: object properties: amount: description: >- Fiat amount to deposit, in the account's `currency`. Decimal string, same format as the estimate endpoint's `amount`. Up to 12 digits before the decimal point. pattern: ^\d{1,12}(\.\d{1,2})?$ type: string example: '2525.00' gasFee: description: >- On-chain settlement cost the provider should report. Defaults to `0.00`, which is what a Solana deposit really costs. Set it to give an Ethereum deposit a realistic network fee — this is also the only way to give the estimate endpoint's `network` figure a settled sample to read. pattern: ^\d{1,12}(\.\d{1,2})?$ type: string example: '4.20' exchangeFee: description: >- Conversion cost the provider should itemise. Derived from the provider's live bid/ask spread when omitted. pattern: ^\d{1,12}(\.\d{1,2})?$ type: string example: '2.53' settle: description: >- Set `false` to leave the deposit at `processing` instead of delivering the crypto, for testing an on-ramp that has not settled yet. Defaults to `true`. type: boolean example: true depositId: minLength: 1 maxLength: 128 description: >- Reuse the `depositId` of an earlier simulated deposit to advance that on-ramp instead of creating a new one. Fresh and unique when omitted. type: string required: - amount application/x-www-form-urlencoded: schema: type: object properties: amount: description: >- Fiat amount to deposit, in the account's `currency`. Decimal string, same format as the estimate endpoint's `amount`. Up to 12 digits before the decimal point. pattern: ^\d{1,12}(\.\d{1,2})?$ type: string example: '2525.00' gasFee: description: >- On-chain settlement cost the provider should report. Defaults to `0.00`, which is what a Solana deposit really costs. Set it to give an Ethereum deposit a realistic network fee — this is also the only way to give the estimate endpoint's `network` figure a settled sample to read. pattern: ^\d{1,12}(\.\d{1,2})?$ type: string example: '4.20' exchangeFee: description: >- Conversion cost the provider should itemise. Derived from the provider's live bid/ask spread when omitted. pattern: ^\d{1,12}(\.\d{1,2})?$ type: string example: '2.53' settle: description: >- Set `false` to leave the deposit at `processing` instead of delivering the crypto, for testing an on-ramp that has not settled yet. Defaults to `true`. type: boolean example: true depositId: minLength: 1 maxLength: 128 description: >- Reuse the `depositId` of an earlier simulated deposit to advance that on-ramp instead of creating a new one. Fresh and unique when omitted. type: string required: - amount multipart/form-data: schema: type: object properties: amount: description: >- Fiat amount to deposit, in the account's `currency`. Decimal string, same format as the estimate endpoint's `amount`. Up to 12 digits before the decimal point. pattern: ^\d{1,12}(\.\d{1,2})?$ type: string example: '2525.00' gasFee: description: >- On-chain settlement cost the provider should report. Defaults to `0.00`, which is what a Solana deposit really costs. Set it to give an Ethereum deposit a realistic network fee — this is also the only way to give the estimate endpoint's `network` figure a settled sample to read. pattern: ^\d{1,12}(\.\d{1,2})?$ type: string example: '4.20' exchangeFee: description: >- Conversion cost the provider should itemise. Derived from the provider's live bid/ask spread when omitted. pattern: ^\d{1,12}(\.\d{1,2})?$ type: string example: '2.53' settle: description: >- Set `false` to leave the deposit at `processing` instead of delivering the crypto, for testing an on-ramp that has not settled yet. Defaults to `true`. type: boolean example: true depositId: minLength: 1 maxLength: 128 description: >- Reuse the `depositId` of an earlier simulated deposit to advance that on-ramp instead of creating a new one. Fresh and unique when omitted. type: string required: - amount responses: '200': description: >- The result of a simulated deposit. Everything here also reaches the ordinary on-ramp endpoints. content: application/json: schema: description: >- The result of a simulated deposit. Everything here also reaches the ordinary on-ramp endpoints. type: object properties: onRampId: description: >- The on-ramp the deposit produced. Poll it at `GET /v1/on-ramps/{id}` — it is an ordinary on-ramp in every respect. type: string example: 507f1f77bcf86cd799439011 depositId: description: >- The provider-side deposit identifier. Pass it back to advance this same on-ramp. type: string example: 3f1a9c02-6c1c-4f0e-9a6a-2f9c8f6f4b21 status: type: string enum: - awaiting_payment - processing - partially_delivered - completed - cancelled - failed - reversed - refunded - in_review input: type: object properties: amount: description: Fiat deposited, before fees type: string example: '2525.00' currency: description: >- Fiat currency the on-ramp was booked in. Taken from the account, not the request. type: string example: EUR required: - amount - currency fees: type: object properties: total: description: Every fee charged on the deposit, in `input.currency`. type: string example: '27.78' currency: description: Currency of every figure under `fees` type: string example: EUR breakdown: description: >- Every fee the user paid, split by role, in source currency. Omitted on on-ramps created before pass-through fees were recorded — absent means unknown, not zero. type: object properties: platform: description: Spritz's own fee. type: string example: '57.07' exchange: description: >- Total currency-conversion cost passed through to the user, whether the provider charged it as a fee or took it inside the exchange rate. `0.00` only when no conversion took place. type: string example: '2.53' network: description: >- On-chain settlement cost passed through to the user. `0.00` on networks that do not charge it — and, on an estimate, also where too few deposits have settled for us to have measured one. `fees.networkFeeSamples` separates the two there; on a settled on-ramp this is always the cost actually charged. type: string example: '0.00' required: - platform - exchange - network required: - total - currency - breakdown output: type: object properties: amount: description: >- Crypto delivered, in whole token units. Still an expectation rather than a delivery when `settle` was false, matching what the on-ramp reports at that point. type: string example: '2497.22' token: description: Token the deposit was converted to type: string example: USDC required: - amount - token required: - onRampId - depositId - status - input - fees - output '400': description: Response for status 400 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 '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 '403': description: Response for status 403 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 '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 '503': description: Response for status 503 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. ````