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

# Get all deposits

> List all deposits for the authenticated user.

Use this endpoint to monitor incoming payments that have been reconciled as deposits for the
authenticated user. You can optionally filter by:

* **`status`** – restrict the response to deposits in a specific lifecycle state (e.g. `pending`,
  `completed`).
* **`bankReference`** – match the exact payment reference that was supplied when sending funds to the
  Wealthyhood wallet IBAN. This is useful when you create a unique identifier for each payment
  instruction and want to confirm that it has been received.

The response returns the most recent deposits first. Combine the filters to zero-in on the exact
payment instance you are tracking.


## OpenAPI

````yaml GET /deposits
openapi: 3.0.3
info:
  title: Wealthyhood Deposits API
  version: 1.0.0
  description: |
    Endpoints to retrieve user deposit activity.

    All requests require a bearer token and the `x-user-id` header.
servers:
  - url: https://{host}
    variables:
      host:
        default: api.wealthyhood.com
        description: Wealthyhood API host name.
security:
  - bearerAuth: []
tags:
  - name: Deposits
    description: Retrieve deposit history for user payments.
paths:
  /deposits:
    get:
      tags:
        - Deposits
      summary: Get all deposits
      description: >
        List all deposits for the authenticated user.


        Filter by deposit status or by the bank reference used when funding the
        account to locate

        specific payment events.
      parameters:
        - $ref: '#/components/parameters/ExternalUserId'
        - name: status
          in: query
          description: Optional status filter
          required: false
          schema:
            $ref: '#/components/schemas/DepositStatus'
        - name: bankReference
          in: query
          description: >-
            Filter deposits that were received with a specific bank payment
            reference.
          required: false
          schema:
            type: string
            example: wallet-topup-5f91ce
      responses:
        '200':
          description: List of deposits
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Deposit'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
components:
  parameters:
    ExternalUserId:
      name: x-user-id
      in: header
      description: The external user identifier of the acting customer.
      required: true
      schema:
        type: string
        example: bank-user-12345
  schemas:
    DepositStatus:
      type: string
      description: Status of the deposit
      enum:
        - pending
        - completed
        - failed
      example: pending
    Deposit:
      type: object
      required:
        - id
        - ownerId
        - bankAccountId
        - amount
        - currency
        - status
      properties:
        id:
          type: string
          example: dep_64f0c51e7fb3fc001234abcd
        ownerId:
          type: string
          example: bank-user-12345
        bankAccountId:
          type: string
          example: ba_64f0c51e7fb3fc001234abcd
        amount:
          type: number
          description: Deposit amount as a number
          example: 100
          minimum: 0.01
        currency:
          type: string
          description: ISO 4217 currency code
          example: EUR
          enum:
            - GBP
            - EUR
            - USD
        consideration:
          type: object
          description: Deposit consideration with currency and amount
          properties:
            currency:
              type: string
              description: ISO 4217 currency code
              example: EUR
              enum:
                - GBP
                - EUR
                - USD
            amount:
              type: number
              description: Deposit amount in major units
              example: 100
              minimum: 0
        reference:
          type: string
          example: Top-up for trading
        status:
          $ref: '#/components/schemas/DepositStatus'
        createdAt:
          type: string
          format: date-time
    Error:
      type: object
      required:
        - message
        - code
      properties:
        message:
          type: string
          example: Invalid amount
        code:
          type: string
          example: INVALID_AMOUNT
  responses:
    UnauthorizedError:
      description: Unauthorized – missing or invalid bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            message: Authentication required
            code: UNAUTHORIZED
    ForbiddenError:
      description: Forbidden – valid credentials but insufficient permissions.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            message: Access denied
            code: FORBIDDEN
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````