> ## 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. # Prepare a sandbox deposit under a program-control state > Evaluates a deterministic sandbox-only program halt or new-user pause through the normal ACH debit policy gate. Blocking simulations return the same 409 problem response an integrator must handle in production and do not create a preparation. ## OpenAPI ````yaml https://platform.spritz.finance/openapi.json post /v1/sandbox/deposits/direct/prepare 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/deposits/direct/prepare: post: tags: - Sandbox summary: Prepare a sandbox deposit under a program-control state description: >- Evaluates a deterministic sandbox-only program halt or new-user pause through the normal ACH debit policy gate. Blocking simulations return the same 409 problem response an integrator must handle in production and do not create a preparation. operationId: postV1SandboxDepositsDirectPrepare requestBody: required: true content: application/json: schema: type: object properties: sourceId: description: Opaque public funding source identifier type: string example: fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X address: description: >- Destination wallet address to deposit into. Validated but not proven via wallet signature; authorization is derived from the verified ACH funding source. type: string example: 9n4nbM75f5Ui33ZbPYXn59EwSb9Y1zdyu3x2b1f8jQRY network: type: string enum: - solana - ethereum - polygon - base - avalanche - arbitrum asset: description: Asset sent to the deposit destination type: string example: USDC enum: - USDC quoteType: type: string enum: - exact_input - exact_output amountUsd: description: Requested USD amount as a decimal string type: string example: '100.00' priority: type: string enum: - normal - high feeSubsidy: type: object properties: percentage: minimum: 0 maximum: 100 type: number maxAmountUsd: minLength: 1 type: string required: - percentage programControlSimulation: type: object properties: state: default: new_user_paused description: >- Sandbox-only program state to evaluate through the normal deposit policy gate. type: string enum: - new_user_paused - halted example: halted required: - state required: - sourceId - address - network - asset - quoteType - amountUsd - priority - programControlSimulation application/x-www-form-urlencoded: schema: type: object properties: sourceId: description: Opaque public funding source identifier type: string example: fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X address: description: >- Destination wallet address to deposit into. Validated but not proven via wallet signature; authorization is derived from the verified ACH funding source. type: string example: 9n4nbM75f5Ui33ZbPYXn59EwSb9Y1zdyu3x2b1f8jQRY network: type: string enum: - solana - ethereum - polygon - base - avalanche - arbitrum asset: description: Asset sent to the deposit destination type: string example: USDC enum: - USDC quoteType: type: string enum: - exact_input - exact_output amountUsd: description: Requested USD amount as a decimal string type: string example: '100.00' priority: type: string enum: - normal - high feeSubsidy: type: object properties: percentage: minimum: 0 maximum: 100 type: number maxAmountUsd: minLength: 1 type: string required: - percentage programControlSimulation: type: object properties: state: default: new_user_paused description: >- Sandbox-only program state to evaluate through the normal deposit policy gate. type: string enum: - new_user_paused - halted example: halted required: - state required: - sourceId - address - network - asset - quoteType - amountUsd - priority - programControlSimulation multipart/form-data: schema: type: object properties: sourceId: description: Opaque public funding source identifier type: string example: fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X address: description: >- Destination wallet address to deposit into. Validated but not proven via wallet signature; authorization is derived from the verified ACH funding source. type: string example: 9n4nbM75f5Ui33ZbPYXn59EwSb9Y1zdyu3x2b1f8jQRY network: type: string enum: - solana - ethereum - polygon - base - avalanche - arbitrum asset: description: Asset sent to the deposit destination type: string example: USDC enum: - USDC quoteType: type: string enum: - exact_input - exact_output amountUsd: description: Requested USD amount as a decimal string type: string example: '100.00' priority: type: string enum: - normal - high feeSubsidy: type: object properties: percentage: minimum: 0 maximum: 100 type: number maxAmountUsd: minLength: 1 type: string required: - percentage programControlSimulation: type: object properties: state: default: new_user_paused description: >- Sandbox-only program state to evaluate through the normal deposit policy gate. type: string enum: - new_user_paused - halted example: halted required: - state required: - sourceId - address - network - asset - quoteType - amountUsd - priority - programControlSimulation responses: '200': description: Response for status 200 content: application/json: schema: type: object properties: preparationId: description: Opaque public preparation identifier type: string example: prep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X kind: type: string enum: - deposit_authorization expiresAt: format: date-time type: string messageVersion: type: string enum: - v1 message: description: Display-ready ACH authorization message type: string summary: type: object properties: quoteType: type: string enum: - exact_input - exact_output requestedAmountUsd: type: string requestedPriority: type: string enum: - normal - high priority: type: string enum: - normal - high releaseDecisionMode: type: string enum: - after_settlement - early_full - early_partial feeRateBps: type: number principalAmountUsd: type: string instantPortionUsd: type: string settlementPortionUsd: type: string expectedAssetAmount: type: string grossFeeUsd: type: string publishedFeeUsd: type: string regularPublishedFeeUsd: type: string instantPublishedFeeUsd: type: string feeSubsidyUsd: type: string userFeeUsd: type: string totalDebitAmountUsd: type: string feeSubsidy: type: object properties: percentage: type: number percentageBps: type: number maxAmountUsd: type: string nullable: true appliedAmountUsd: type: string required: - percentage - percentageBps - maxAmountUsd - appliedAmountUsd nullable: true network: type: string enum: - solana - ethereum - polygon - base - avalanche - arbitrum asset: description: Asset sent to the deposit destination type: string example: USDC enum: - USDC assetAddress: type: string destinationAddress: type: string required: - quoteType - requestedAmountUsd - requestedPriority - priority - releaseDecisionMode - feeRateBps - principalAmountUsd - instantPortionUsd - settlementPortionUsd - expectedAssetAmount - grossFeeUsd - publishedFeeUsd - regularPublishedFeeUsd - instantPublishedFeeUsd - feeSubsidyUsd - userFeeUsd - totalDebitAmountUsd - feeSubsidy - network - asset - assetAddress - destinationAddress required: - preparationId - kind - expiresAt - messageVersion - message - summary '400': description: Response for status 400 content: application/problem+json: schema: type: object allOf: - additionalProperties: true 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 retryAfter: description: >- Seconds to wait before retrying, present alongside `retryable: true`. Mirrors the `Retry-After` response header and is meant for short backoffs the server chose (load shedding); for a condition that clears on its own schedule, `clearsAt` carries the absolute time instead. type: number example: 5 suggestedAction: type: string enum: - auto_ramp - wait_for_settlement description: >- Safe next action when the failing product policy can provide one. clearsAt: format: date-time type: string description: >- Earliest known time the current temporary condition may clear. nullable: true availableAt: format: date-time type: string description: >- When a temporarily ineligible funding source may become available again. nullable: true permanent: description: >- Whether the current funding-source restriction will not clear automatically. type: boolean required: - title - status - type: object properties: errors: description: >- Every cause. A single-cause failure also reports it via top-level `code`/`field`/`detail`; a multi-field failure is described only here. type: array items: type: object properties: field: type: string message: type: string code: type: string required: - field - message '401': description: Response for status 401 content: application/problem+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/problem+json: schema: additionalProperties: true 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 retryAfter: description: >- Seconds to wait before retrying, present alongside `retryable: true`. Mirrors the `Retry-After` response header and is meant for short backoffs the server chose (load shedding); for a condition that clears on its own schedule, `clearsAt` carries the absolute time instead. type: number example: 5 suggestedAction: type: string enum: - auto_ramp - wait_for_settlement clearsAt: format: date-time type: string description: >- Earliest known time the current temporary condition may clear. nullable: true availableAt: format: date-time type: string description: >- When a temporarily ineligible funding source may become available again. nullable: true permanent: description: >- Whether the current funding-source restriction will not clear automatically. type: boolean required: - title - status '404': description: Response for status 404 content: application/problem+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 '409': description: Response for status 409 content: application/problem+json: schema: additionalProperties: true 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 retryAfter: description: >- Seconds to wait before retrying, present alongside `retryable: true`. Mirrors the `Retry-After` response header and is meant for short backoffs the server chose (load shedding); for a condition that clears on its own schedule, `clearsAt` carries the absolute time instead. type: number example: 5 suggestedAction: type: string enum: - auto_ramp - wait_for_settlement clearsAt: format: date-time type: string description: >- Earliest known time the current temporary condition may clear. nullable: true availableAt: format: date-time type: string description: >- When a temporarily ineligible funding source may become available again. nullable: true permanent: description: >- Whether the current funding-source restriction will not clear automatically. type: boolean required: - title - status '500': description: Response for status 500 content: application/problem+json: schema: additionalProperties: true 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 retryAfter: description: >- Seconds to wait before retrying, present alongside `retryable: true`. Mirrors the `Retry-After` response header and is meant for short backoffs the server chose (load shedding); for a condition that clears on its own schedule, `clearsAt` carries the absolute time instead. type: number example: 5 suggestedAction: type: string enum: - auto_ramp - wait_for_settlement clearsAt: format: date-time type: string description: >- Earliest known time the current temporary condition may clear. nullable: true availableAt: format: date-time type: string description: >- When a temporarily ineligible funding source may become available again. nullable: true permanent: description: >- Whether the current funding-source restriction will not clear automatically. type: boolean required: - title - status '503': description: Response for status 503 content: application/problem+json: schema: additionalProperties: true 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 retryAfter: description: >- Seconds to wait before retrying, present alongside `retryable: true`. Mirrors the `Retry-After` response header and is meant for short backoffs the server chose (load shedding); for a condition that clears on its own schedule, `clearsAt` carries the absolute time instead. type: number example: 5 suggestedAction: type: string enum: - auto_ramp - wait_for_settlement clearsAt: format: date-time type: string description: >- Earliest known time the current temporary condition may clear. nullable: true availableAt: format: date-time type: string description: >- When a temporarily ineligible funding source may become available again. nullable: true permanent: description: >- Whether the current funding-source restriction will not clear automatically. type: boolean required: - title - status security: - bearerAuth: [] - integratorJwt: [] - bearerAuth: [] hmacAuth: [] integratorKey: [] timestamp: [] components: securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT or ak_ user API key description: >- User bearer credential: either a Cognito JWT or an ak_ user API key. Backend integrators using HMAC must include the user API key alongside the three HMAC headers on user-scoped endpoints. 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: ik_...) - 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: ik_...) used with HMAC authentication' timestamp: type: apiKey in: header name: X-Timestamp description: >- Unix timestamp in milliseconds for request freshness. Must be within 5 minutes of server time. The timestamp alone bounds but does not prevent an exact replay within that window. Use Idempotency-Key on supported mutations. ````