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

# Get notifications

> This endpoint allows you to retrieve notifications by type for a wallet.



## OpenAPI

````yaml openapi.json get /notifications
openapi: 3.0.3
info:
  title: Bread API
  description: >-
    The Bread provides comprehensive cryptocurrency wallet management
    capabilities including wallet creation, balance monitoring, and asset
    transfers.
  version: 2.0.0
servers:
  - url: https://processor-prod.up.railway.app
    description: Production server
security: []
paths:
  /notifications:
    get:
      tags:
        - Notifications
      summary: Get notifications
      description: This endpoint allows you to retrieve notifications by type for a wallet.
      operationId: getNotifications
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            description: >-
              This is the current page being requested relative to size of a
              page
            default: 1
        - name: type
          in: query
          description: The type of notifications to retrieve
          schema:
            type: string
            enum:
              - transfer
              - deposit
              - offramp
              - onramp
              - swap
            example: offramp
        - name: wallet_id
          in: query
          description: The wallet ID to get notifications for
          schema:
            type: string
            example: 68c67578e4b64749538d1326
        - name: reference
          in: query
          description: The reference of the specific transaction
          schema:
            type: string
            example: a6zhamo1neisjcxncmas
      responses:
        '200':
          description: Notifications fetched successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationsResponse'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    NotificationsResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
        status:
          type: integer
          example: 200
        message:
          type: string
          example: Notifications fetched successfully
        timestamp:
          type: string
          format: date-time
          example: '2025-09-17T00:07:13.436Z'
        data:
          type: object
          properties:
            notifications:
              type: array
              items:
                $ref: '#/components/schemas/NotificationItem'
            total:
              type: integer
              example: 9
            page:
              type: integer
              example: 1
            previous:
              type: string
              nullable: true
              example: null
            next:
              type: string
              nullable: true
              example: null
            limit:
              type: integer
              example: 10
    NotificationItem:
      type: object
      properties:
        asset:
          type: string
          description: Asset identifier
          example: bsc:usdt
        id:
          type: string
          description: Unique identifier for the notification
          example: 68c9b988196a18d7bd2161cd
        reference:
          type: string
          description: Reference identifier for the transaction
          example: s7s2ewm5qduwgwz23zpw
        wallet:
          type: string
          description: Wallet ID associated with the notification
          example: 68c67578e4b64749538d1326
        hash:
          type: string
          description: Transaction hash on the blockchain
          example: '0x2a592a8f253e9f404676190d6ee564afa307739549f15175c414ae16030076c6'
        sender:
          type: string
          description: Sender address
          example: '0xb8fbc060136580db4732c8e89af6bfc03f4ea229'
        beneficiary:
          type: string
          description: Beneficiary ID for offramp transactions
          example: 68c67578196a18d7bd1e4e9b
        currency:
          type: string
          description: Currency code for offramp transactions
          example: NGN
        rate:
          type: number
          description: Exchange rate used
          example: 1504.98
        direction:
          type: string
          enum:
            - incoming
            - outgoing
          description: Direction of the transaction
          example: outgoing
        receiver:
          type: string
          description: Receiver address
          example: '0xb8fbc060136580db4732c8e89af6bfc03f4ea229'
        amount:
          type: number
          description: Transaction amount
          example: 70
        fee:
          type: number
          description: Transaction fee
          example: 0.35
        token:
          type: string
          description: Token contract address
          example: '0x55d398326f99059ff775485246999027b3197955'
        blockchain:
          type: integer
          description: Blockchain identifier
          example: 56
        status:
          type: string
          enum:
            - completed
            - pending
            - failed
          description: Transaction status
          example: completed
        type:
          type: string
          enum:
            - transfer
            - deposit
            - offramp
            - onramp
            - swap
          description: Type of transaction
          example: offramp
        timestamp:
          type: string
          format: date-time
          description: Transaction timestamp
          example: '2025-09-16T19:24:56.425Z'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-service-key

````