> ## Documentation Index
> Fetch the complete documentation index at: https://docs.finsei.com/llms.txt
> Use this file to discover all available pages before exploring further.

# GET /v1/wallet/{walletId}/deposit/bank/intent

> Returns Open Banking deposit intents for a wallet accessible to the authenticated user, including closed wallets. Results are paginated and sorted by creation time descending by default. Intents with the same creation time are ordered by ID in the same direction. Returns an empty array when no intents match.



## OpenAPI

````yaml GET /v1/wallet/{walletId}/deposit/bank/intent
openapi: 3.1.0
info:
  title: Finsei API
  description: API documentation for Finsei
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.sandbox.finsei.com
security:
  - bearerAuth: []
paths:
  /v1/wallet/{walletId}/deposit/bank/intent:
    get:
      tags:
        - wallet
      summary: List bank deposit intents
      description: >-
        Returns Open Banking deposit intents for a wallet accessible to the
        authenticated user, including closed wallets. Results are paginated and
        sorted by creation time descending by default. Intents with the same
        creation time are ordered by ID in the same direction. Returns an empty
        array when no intents match.
      parameters:
        - name: walletId
          in: path
          required: true
          description: Wallet UUID or numeric wallet ID (up to 9 digits).
          schema:
            type: string
        - name: createdFrom
          in: query
          description: >-
            Inclusive lower bound for creation time. Unix timestamp in
            milliseconds; normalized to whole seconds before filtering.
          schema:
            type: integer
            format: int64
        - name: createdTo
          in: query
          description: >-
            Inclusive upper bound for creation time. Unix timestamp in
            milliseconds; normalized to whole seconds before filtering. Must be
            greater than or equal to createdFrom after normalization.
          schema:
            type: integer
            format: int64
        - name: page
          in: query
          description: Page number, starting from 1.
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: per-page
          in: query
          description: Number of items per page.
          schema:
            type: integer
            minimum: 1
            maximum: 50
            default: 20
        - name: sort
          in: query
          description: >-
            Sort by creation time: createdAt for ascending order, -createdAt for
            descending order.
          schema:
            type: string
            enum:
              - createdAt
              - '-createdAt'
            default: '-createdAt'
      responses:
        '200':
          description: >-
            Deposit intents. Pagination metadata is returned in response
            headers.
          headers:
            X-Pagination-Current-Page:
              description: Current page number, starting from 1.
              schema:
                type: integer
                minimum: 1
                example: 1
            X-Pagination-Page-Count:
              description: Total number of pages.
              schema:
                type: integer
                minimum: 0
                example: 3
            X-Pagination-Per-Page:
              description: Page size.
              schema:
                type: integer
                minimum: 1
                maximum: 50
                example: 20
            X-Pagination-Total-Count:
              description: Total number of matching deposit intents.
              schema:
                type: integer
                minimum: 0
                example: 53
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/WalletDepositBankIntent'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
        - bearerAuth: []
components:
  schemas:
    WalletDepositBankIntent:
      type: object
      description: An Open Banking wallet deposit intent.
      properties:
        id:
          type: string
          format: uuid
          description: Deposit intent ID.
          example: 01a13aa3-cc15-709b-a6e0-7cb9cc3a2385
        walletId:
          type: string
          format: uuid
          description: Wallet UUID.
          example: 019ff097-fc59-7310-aa41-3187cbe6c158
        payerId:
          type: string
          format: uuid
          description: Payer ID.
          example: 01a1547d-9495-71ae-b747-dd593df7e32a
        status:
          type: string
          description: Deposit intent status.
          enum:
            - NEW
            - PENDING_USER_ACTION
            - PENDING_CREDIT
            - PAYMENT_RECEIVED
            - PAYMENT_COMPLIANCE
            - PAYMENT_PROCESS
            - PAYMENT_FAILED
            - SETTLED
            - EXPIRED
            - FAILED
        amount:
          type: number
          description: >-
            Top-up amount in major currency units, using the currency's decimal
            precision.
          example: 100.25
        intentFee:
          type: number
          description: >-
            Open Banking fee in major currency units, excluding the incoming
            payment fee.
          example: 0.75
        paymentFee:
          type:
            - number
            - 'null'
          description: >-
            Incoming payment fee in major currency units, excluding the Open
            Banking fee. Null when no linked credit payment is found.
          example: 0.75
        currencyId:
          type: string
          description: Wallet currency code.
          example: GBP
        reference:
          type: string
          description: Payment reference.
          example: G6MGTR6G0R4WW2YP25
        paymentId:
          type:
            - string
            - 'null'
          format: uuid
          description: Linked credit payment UUID; null before a payment is linked.
          example: 01a1547d-aa2e-709e-878a-e61d83157acc
        expiresAt:
          type:
            - integer
            - 'null'
          format: int64
          description: Expiration Unix timestamp in milliseconds; null when not set.
          example: 1792166400000
        createdAt:
          type: integer
          format: int64
          description: Creation Unix timestamp in milliseconds.
          example: 1792162800000
        updatedAt:
          type: integer
          format: int64
          description: Last update Unix timestamp in milliseconds.
          example: 1792162860000
      required:
        - id
        - walletId
        - payerId
        - status
        - amount
        - intentFee
        - paymentFee
        - currencyId
        - reference
        - paymentId
        - expiresAt
        - createdAt
        - updatedAt
  responses:
    BadRequest:
      description: Bad Request
      content:
        application/json:
          schema:
            type: object
            properties:
              name:
                type: string
                example: Bad Request
              message:
                type: string
              status:
                type: integer
                example: 400
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            type: object
            properties:
              name:
                type: string
                example: Unauthorized
              message:
                type: string
                example: Your request was made with invalid credentials.
              status:
                type: integer
                example: 401
    NotFound:
      description: Not Found
      content:
        application/json:
          schema:
            type: object
            properties:
              name:
                type: string
                example: Not Found
              message:
                type: string
                example: The requested resource could not be found.
              status:
                type: integer
                example: 404
          example:
            status: ERROR
            error:
              code: 404
              message: Not Found
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

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