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

# List ACH debit returns

> Returns ACH debit returns scoped to the authenticated integrator.



## OpenAPI

````yaml https://platform.spritz.finance/openapi.json get /v1/integrator/ach-debit/returns
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/integrator/ach-debit/returns:
    get:
      tags:
        - Integrator
      summary: List ACH debit returns
      description: Returns ACH debit returns scoped to the authenticated integrator.
      operationId: getV1IntegratorAch-debitReturns
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            description: Maximum number of results to return
            default: 50
            minimum: 1
            maximum: 100
            type: number
        - name: cursor
          in: query
          required: false
          schema:
            description: Opaque cursor from the previous response's `nextCursor` value
            type: string
        - name: userId
          in: query
          required: false
          schema:
            description: Filter to one Spritz user ID
            type: string
            example: 6a749a054c3b8fc5da595d1b
        - name: userIds
          in: query
          required: false
          schema:
            description: Comma-separated Spritz user IDs to include
            type: string
        - name: search
          in: query
          required: false
          schema:
            description: >-
              Search by user ID, deposit ID, on-ramp ID, return ID, or return
              code
            type: string
        - name: returnCode
          in: query
          required: false
          schema:
            description: ACH return code
            type: string
            example: R10
        - name: returnBucket
          in: query
          required: false
          schema:
            type: string
            enum:
              - unauthorized
              - administrative
              - other
        - name: cryptoStateAtReturn
          in: query
          required: false
          schema:
            type: string
            enum:
              - not_released
              - in_flight
              - partially_confirmed
              - fully_confirmed
        - name: lossOnly
          in: query
          required: false
          schema:
            type: string
            enum:
              - 'true'
              - 'false'
        - name: userAction
          in: query
          required: false
          schema:
            type: string
            enum:
              - none
              - review_required
              - restricted
              - disabled
        - name: occurredAfter
          in: query
          required: false
          schema:
            format: date-time
            type: string
        - name: occurredBefore
          in: query
          required: false
          schema:
            format: date-time
            type: string
      responses:
        '200':
          description: Response for status 200
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          description: Opaque public ACH debit return identifier
                          type: string
                          example: dr_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
                        depositId:
                          description: Opaque public ACH debit deposit identifier
                          type: string
                          example: dep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
                        userId:
                          description: Spritz user ID associated with the returned deposit
                          type: string
                          example: 6a749a054c3b8fc5da595d1c
                        sourceId:
                          description: Opaque public funding source identifier
                          type: string
                          example: fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
                        onRampId:
                          type: string
                          nullable: true
                        amountUsd:
                          type: string
                        currency:
                          type: string
                        returnCode:
                          type: string
                          nullable: true
                        returnReason:
                          type: string
                          nullable: true
                        occurredAt:
                          format: date-time
                          type: string
                        cryptoStateAtReturn:
                          type: string
                          enum:
                            - not_released
                            - in_flight
                            - partially_confirmed
                            - fully_confirmed
                        lossAmountUsd:
                          type: string
                        atRiskAmountUsd:
                          type: string
                        sourceAction:
                          type: string
                          enum:
                            - disabled
                        userAction:
                          type: string
                          enum:
                            - none
                            - review_required
                            - restricted
                            - disabled
                        reportingBucket:
                          type: string
                          enum:
                            - unauthorized
                            - administrative
                            - other
                      required:
                        - id
                        - depositId
                        - userId
                        - sourceId
                        - onRampId
                        - amountUsd
                        - currency
                        - returnCode
                        - returnReason
                        - occurredAt
                        - cryptoStateAtReturn
                        - lossAmountUsd
                        - atRiskAmountUsd
                        - sourceAction
                        - userAction
                        - reportingBucket
                  hasMore:
                    description: Whether there are more results
                    type: boolean
                    example: true
                  nextCursor:
                    type: string
                    nullable: true
                required:
                  - data
                  - hasMore
                  - nextCursor
        '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:
        - hmacAuth: []
          integratorKey: []
          timestamp: []
components:
  securitySchemes:
    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.

````