> ## 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.

# Cancel a deposit

> Cancels an ACH debit deposit owned by the authenticated user. Allowed only while the deposit's `cancellable` is true: before the bank debit is transmitted and before any crypto is released. 200 returns the deposit with status `cancelled`. 202 means the cancellation was requested but the bank has not confirmed it yet; the deposit's payout is held until it resolves, so poll the deposit for status `cancelled`. 409 with code `deposit_not_cancellable` means it is too late to cancel; `reason` is `crypto_released`, `debit_in_progress` or `deposit_closed`. Repeating the call on a cancelled deposit returns it unchanged. When the user cancels their three latest deposits within 24 hours, new deposits are refused for 24 hours after the latest cancel with 409 code `ach_debit_cancel_cooldown` and `availableAt` set to when they open again.



## OpenAPI

````yaml https://platform.spritz.finance/openapi.json post /v1/deposits/{depositId}/cancel
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: ACH Debit
    description: ACH debit eligibility and deposit 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/deposits/{depositId}/cancel:
    post:
      tags:
        - Deposits
      summary: Cancel a deposit
      description: >-
        Cancels an ACH debit deposit owned by the authenticated user. Allowed
        only while the deposit's `cancellable` is true: before the bank debit is
        transmitted and before any crypto is released. 200 returns the deposit
        with status `cancelled`. 202 means the cancellation was requested but
        the bank has not confirmed it yet; the deposit's payout is held until it
        resolves, so poll the deposit for status `cancelled`. 409 with code
        `deposit_not_cancellable` means it is too late to cancel; `reason` is
        `crypto_released`, `debit_in_progress` or `deposit_closed`. Repeating
        the call on a cancelled deposit returns it unchanged. When the user
        cancels their three latest deposits within 24 hours, new deposits are
        refused for 24 hours after the latest cancel with 409 code
        `ach_debit_cancel_cooldown` and `availableAt` set to when they open
        again.
      operationId: postV1DepositsByDepositIdCancel
      parameters:
        - name: depositId
          in: path
          required: true
          schema:
            description: Opaque public deposit identifier
            type: string
            example: dep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
      responses:
        '200':
          description: >-
            An ACH debit deposit authorized by the user and processed
            asynchronously through debit and crypto release lifecycles.
          content:
            application/json:
              schema:
                description: >-
                  An ACH debit deposit authorized by the user and processed
                  asynchronously through debit and crypto release lifecycles.
                type: object
                properties:
                  id:
                    description: Opaque public deposit identifier
                    type: string
                    example: dep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
                  sourceId:
                    description: Opaque public funding source identifier
                    type: string
                    example: fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
                  onRampId:
                    type: string
                    description: >-
                      Identifier of the on-ramp created for this deposit, or
                      null until the on-ramp record exists.
                    nullable: true
                    example: 6aeeb7b3d7558672d5262d1b
                  status:
                    type: string
                    enum:
                      - authorized
                      - processing
                      - partially_released
                      - completed
                      - returned
                      - refunded
                      - failed
                      - cancelled
                  quoteType:
                    type: string
                    enum:
                      - exact_input
                      - exact_output
                  requestedPriority:
                    type: string
                    enum:
                      - normal
                      - high
                  priority:
                    type: string
                    enum:
                      - normal
                      - high
                  feeRateBps:
                    type: number
                  principalAmountUsd:
                    type: string
                  instantPortionUsd:
                    type: string
                  instantUnavailableReason:
                    type: string
                    enum:
                      - bank_relink_required
                      - null
                    description: >-
                      Why the requested instant portion was dropped entirely,
                      when the person can fix it: `bank_relink_required` means
                      Spritz could not read the account's balance because the
                      bank connection needs relinking. Remove the bank and link
                      it again to get instant on later deposits. Null when
                      instant was granted, not requested, or dropped for any
                      other reason.
                    nullable: true
                    example: null
                  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
                  address:
                    description: Destination wallet address for the crypto release
                    type: string
                  debitStatus:
                    type: string
                    enum:
                      - authorized
                      - submitting
                      - submitted
                      - settled
                      - returned
                      - failed
                  releaseStatus:
                    type: string
                    enum:
                      - not_started
                      - queued
                      - partial
                      - completed
                      - failed
                  releaseDecisionMode:
                    type: string
                    enum:
                      - after_settlement
                      - early_full
                      - early_partial
                  releasedAmountUsd:
                    type: string
                  confirmedReleasedAmountUsd:
                    type: string
                  authorizedAt:
                    format: date-time
                    type: string
                  createdAt:
                    format: date-time
                    type: string
                  settledAt:
                    format: date-time
                    type: string
                    nullable: true
                  returnedAt:
                    format: date-time
                    type: string
                    nullable: true
                  completedAt:
                    format: date-time
                    type: string
                    nullable: true
                  returnCode:
                    type: string
                    nullable: true
                  returnReason:
                    type: string
                    nullable: true
                  debitFailureCode:
                    type: string
                    nullable: true
                  debitFailureReason:
                    type: string
                    nullable: true
                  releaseFailureCode:
                    type: string
                    nullable: true
                  releaseFailureReason:
                    type: string
                    nullable: true
                  payoutTxHash:
                    type: string
                    nullable: true
                  cancellable:
                    description: >-
                      Whether the user can cancel this deposit now via POST
                      /v1/deposits/{depositId}/cancel. True only before the bank
                      debit is transmitted and before any crypto is released.
                      Advisory: the cancel call re-checks and may still refuse.
                    type: boolean
                  cancellableUntil:
                    format: date-time
                    type: string
                    description: >-
                      Protected cancellation deadline. A cancellation durably
                      recorded before this time prevents bank submission. The
                      window starts after server acceptance: one hour in
                      production, one minute in staging. Null for deposits
                      without a protected window. Cancellation may remain
                      possible afterward; consult cancellable.
                    nullable: true
                  cancelledAt:
                    format: date-time
                    type: string
                    description: When the user's cancellation was confirmed
                    nullable: true
                required:
                  - id
                  - sourceId
                  - onRampId
                  - status
                  - quoteType
                  - requestedPriority
                  - priority
                  - feeRateBps
                  - principalAmountUsd
                  - instantPortionUsd
                  - instantUnavailableReason
                  - settlementPortionUsd
                  - expectedAssetAmount
                  - grossFeeUsd
                  - publishedFeeUsd
                  - regularPublishedFeeUsd
                  - instantPublishedFeeUsd
                  - feeSubsidyUsd
                  - userFeeUsd
                  - totalDebitAmountUsd
                  - feeSubsidy
                  - network
                  - asset
                  - assetAddress
                  - address
                  - debitStatus
                  - releaseStatus
                  - releaseDecisionMode
                  - releasedAmountUsd
                  - confirmedReleasedAmountUsd
                  - authorizedAt
                  - createdAt
                  - settledAt
                  - returnedAt
                  - completedAt
                  - returnCode
                  - returnReason
                  - debitFailureCode
                  - debitFailureReason
                  - releaseFailureCode
                  - releaseFailureReason
                  - payoutTxHash
                  - cancellable
                  - cancellableUntil
                  - cancelledAt
                additionalProperties: false
        '202':
          description: >-
            An ACH debit deposit authorized by the user and processed
            asynchronously through debit and crypto release lifecycles.
          content:
            application/json:
              schema:
                description: >-
                  An ACH debit deposit authorized by the user and processed
                  asynchronously through debit and crypto release lifecycles.
                type: object
                properties:
                  id:
                    description: Opaque public deposit identifier
                    type: string
                    example: dep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
                  sourceId:
                    description: Opaque public funding source identifier
                    type: string
                    example: fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
                  onRampId:
                    type: string
                    description: >-
                      Identifier of the on-ramp created for this deposit, or
                      null until the on-ramp record exists.
                    nullable: true
                    example: 6aeeb7b3d7558672d5262d1b
                  status:
                    type: string
                    enum:
                      - authorized
                      - processing
                      - partially_released
                      - completed
                      - returned
                      - refunded
                      - failed
                      - cancelled
                  quoteType:
                    type: string
                    enum:
                      - exact_input
                      - exact_output
                  requestedPriority:
                    type: string
                    enum:
                      - normal
                      - high
                  priority:
                    type: string
                    enum:
                      - normal
                      - high
                  feeRateBps:
                    type: number
                  principalAmountUsd:
                    type: string
                  instantPortionUsd:
                    type: string
                  instantUnavailableReason:
                    type: string
                    enum:
                      - bank_relink_required
                      - null
                    description: >-
                      Why the requested instant portion was dropped entirely,
                      when the person can fix it: `bank_relink_required` means
                      Spritz could not read the account's balance because the
                      bank connection needs relinking. Remove the bank and link
                      it again to get instant on later deposits. Null when
                      instant was granted, not requested, or dropped for any
                      other reason.
                    nullable: true
                    example: null
                  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
                  address:
                    description: Destination wallet address for the crypto release
                    type: string
                  debitStatus:
                    type: string
                    enum:
                      - authorized
                      - submitting
                      - submitted
                      - settled
                      - returned
                      - failed
                  releaseStatus:
                    type: string
                    enum:
                      - not_started
                      - queued
                      - partial
                      - completed
                      - failed
                  releaseDecisionMode:
                    type: string
                    enum:
                      - after_settlement
                      - early_full
                      - early_partial
                  releasedAmountUsd:
                    type: string
                  confirmedReleasedAmountUsd:
                    type: string
                  authorizedAt:
                    format: date-time
                    type: string
                  createdAt:
                    format: date-time
                    type: string
                  settledAt:
                    format: date-time
                    type: string
                    nullable: true
                  returnedAt:
                    format: date-time
                    type: string
                    nullable: true
                  completedAt:
                    format: date-time
                    type: string
                    nullable: true
                  returnCode:
                    type: string
                    nullable: true
                  returnReason:
                    type: string
                    nullable: true
                  debitFailureCode:
                    type: string
                    nullable: true
                  debitFailureReason:
                    type: string
                    nullable: true
                  releaseFailureCode:
                    type: string
                    nullable: true
                  releaseFailureReason:
                    type: string
                    nullable: true
                  payoutTxHash:
                    type: string
                    nullable: true
                  cancellable:
                    description: >-
                      Whether the user can cancel this deposit now via POST
                      /v1/deposits/{depositId}/cancel. True only before the bank
                      debit is transmitted and before any crypto is released.
                      Advisory: the cancel call re-checks and may still refuse.
                    type: boolean
                  cancellableUntil:
                    format: date-time
                    type: string
                    description: >-
                      Protected cancellation deadline. A cancellation durably
                      recorded before this time prevents bank submission. The
                      window starts after server acceptance: one hour in
                      production, one minute in staging. Null for deposits
                      without a protected window. Cancellation may remain
                      possible afterward; consult cancellable.
                    nullable: true
                  cancelledAt:
                    format: date-time
                    type: string
                    description: When the user's cancellation was confirmed
                    nullable: true
                required:
                  - id
                  - sourceId
                  - onRampId
                  - status
                  - quoteType
                  - requestedPriority
                  - priority
                  - feeRateBps
                  - principalAmountUsd
                  - instantPortionUsd
                  - instantUnavailableReason
                  - settlementPortionUsd
                  - expectedAssetAmount
                  - grossFeeUsd
                  - publishedFeeUsd
                  - regularPublishedFeeUsd
                  - instantPublishedFeeUsd
                  - feeSubsidyUsd
                  - userFeeUsd
                  - totalDebitAmountUsd
                  - feeSubsidy
                  - network
                  - asset
                  - assetAddress
                  - address
                  - debitStatus
                  - releaseStatus
                  - releaseDecisionMode
                  - releasedAmountUsd
                  - confirmedReleasedAmountUsd
                  - authorizedAt
                  - createdAt
                  - settledAt
                  - returnedAt
                  - completedAt
                  - returnCode
                  - returnReason
                  - debitFailureCode
                  - debitFailureReason
                  - releaseFailureCode
                  - releaseFailureReason
                  - payoutTxHash
                  - cancellable
                  - cancellableUntil
                  - cancelledAt
                additionalProperties: false
        '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 temporary block lifts: a temporarily ineligible
                      funding source, or new deposits paused after repeated
                      cancellations (`ach_debit_cancel_cooldown`).
                    nullable: true
                  permanent:
                    description: >-
                      Whether the current funding-source restriction will not
                      clear automatically.
                    type: boolean
                  reason:
                    type: string
                    enum:
                      - crypto_released
                      - debit_in_progress
                      - deposit_closed
                      - bank_relink_required
                      - temporarily_unavailable
                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 temporary block lifts: a temporarily ineligible
                      funding source, or new deposits paused after repeated
                      cancellations (`ach_debit_cancel_cooldown`).
                    nullable: true
                  permanent:
                    description: >-
                      Whether the current funding-source restriction will not
                      clear automatically.
                    type: boolean
                  reason:
                    type: string
                    enum:
                      - crypto_released
                      - debit_in_progress
                      - deposit_closed
                      - bank_relink_required
                      - temporarily_unavailable
                required:
                  - title
                  - status
        '429':
          description: Response for status 429
          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 temporary block lifts: a temporarily ineligible
                      funding source, or new deposits paused after repeated
                      cancellations (`ach_debit_cancel_cooldown`).
                    nullable: true
                  permanent:
                    description: >-
                      Whether the current funding-source restriction will not
                      clear automatically.
                    type: boolean
                  reason:
                    type: string
                    enum:
                      - crypto_released
                      - debit_in_progress
                      - deposit_closed
                      - bank_relink_required
                      - temporarily_unavailable
                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 temporary block lifts: a temporarily ineligible
                      funding source, or new deposits paused after repeated
                      cancellations (`ach_debit_cancel_cooldown`).
                    nullable: true
                  permanent:
                    description: >-
                      Whether the current funding-source restriction will not
                      clear automatically.
                    type: boolean
                  reason:
                    type: string
                    enum:
                      - crypto_released
                      - debit_in_progress
                      - deposit_closed
                      - bank_relink_required
                      - temporarily_unavailable
                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.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.