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

# Retrieve Transactions

> Retrieving existing Transaction(s)

By calling this API, you will be able to retrieve all the transitions that were uploaded into Athena.

**If there are more than 10 transactions available, the records provided in the response will be paginated by 10 transactions per page.**


## OpenAPI

````yaml get /api/transactions
openapi: 3.0.3
info:
  title: Athena API
  version: v3
  x-logo:
    url: https://cynopsis.co/wp-content/uploads/2021/03/logo-2.png
    altText: Cynopsis Solutions
  description: >-
    ATHENA is an advanced real-time transaction monitoring solution designed to
    detect and prevent money laundering, fraud, and terrorism financing. Powered
    by proprietary AML rules, ATHENA analyzes transactions in real time,
    providing clear, intuitive visual insights to streamline compliance
    processes.
        
        ✅ Real-Time Monitoring – Instantly analyzes transaction data to detect anomalies and potential compliance risks.
        ✅ Visualized Insights – Converts complex data into easy-to-understand charts, aiding faster decision-making.
        ✅ Seamless Integration – Easily integrates with existing financial and compliance systems.
        
        Ideal for financial institutions, fintech companies, and regulated businesses, ATHENA enhances risk management and ensures regulatory compliance with ease.
  contact:
    email: tech@cynopsis.co
servers:
  - url: http://localhost/api
    description: Local development server
security: []
paths:
  /api/transactions:
    get:
      tags:
        - Transactions
      summary: List all transactions
      operationId: transaction_list
      parameters:
        - in: query
          name: client_subject_id
          schema:
            type: string
        - in: query
          name: client_transaction_id
          schema:
            type: string
        - in: query
          name: country
          schema:
            type: string
        - name: limit
          required: false
          in: query
          description: Number of results to return per page.
          schema:
            type: integer
        - in: query
          name: max_date
          schema:
            type: string
            format: date-time
        - in: query
          name: min_date
          schema:
            type: string
            format: date-time
        - name: offset
          required: false
          in: query
          description: The initial index from which to return the results.
          schema:
            type: integer
        - in: query
          name: transaction_type
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedTransactionList'
          description: ''
      security:
        - CustomAuthentication: []
        - cookieAuth: []
        - BearerAuth: []
components:
  schemas:
    PaginatedTransactionList:
      type: object
      required:
        - count
        - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?offset=400&limit=100
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?offset=200&limit=100
        results:
          type: array
          items:
            $ref: '#/components/schemas/Transaction'
    Transaction:
      type: object
      description: |-
        A ModelSerializer that takes an additional `fields` argument that
        controls which fields should be displayed.
      properties:
        id:
          type: integer
          readOnly: true
        bucket_loading_status:
          type: string
          readOnly: true
          default: Transaction loaded into [ORDINARY] and requested buckets
        cp_a:
          allOf:
            - $ref: '#/components/schemas/Subject'
          readOnly: true
        cp_b:
          allOf:
            - $ref: '#/components/schemas/Subject'
          readOnly: true
        transaction_currency:
          allOf:
            - $ref: '#/components/schemas/Currency'
          readOnly: true
        alt_currency:
          allOf:
            - $ref: '#/components/schemas/Currency'
          readOnly: true
        modified_by:
          allOf:
            - $ref: '#/components/schemas/UserSimpleList'
          readOnly: true
        created_by:
          allOf:
            - $ref: '#/components/schemas/UserSimpleList'
          readOnly: true
        client_transaction_id:
          type: string
          maxLength: 255
        transaction_type:
          type: string
          maxLength: 255
        cp_a_country:
          type: string
          maxLength: 60
        cp_b_country:
          type: string
          maxLength: 60
        transaction_timestamp:
          type: string
          format: date-time
        amount:
          type: number
          format: double
        cp_a_bank:
          type: string
          maxLength: 255
        cp_b_bank:
          type: string
          maxLength: 255
        amount_in_alt_currency:
          type: number
          format: double
          nullable: true
        payment_mode:
          type: string
          maxLength: 255
        purpose_of_transfer:
          type: string
          maxLength: 255
        notes:
          type: string
          maxLength: 255
      required:
        - alt_currency
        - amount
        - bucket_loading_status
        - client_transaction_id
        - cp_a
        - cp_b
        - created_by
        - id
        - modified_by
        - transaction_currency
        - transaction_timestamp
        - transaction_type
    Subject:
      type: object
      properties:
        client_subject_id:
          type: string
          maxLength: 255
        subject_name:
          type: string
          maxLength: 255
        unique_identification_number:
          type: string
          maxLength: 255
        account_holder:
          type: boolean
          nullable: true
        address:
          type: string
          maxLength: 255
        customer_segment:
          type: string
          maxLength: 255
        date_and_place_of_birth:
          type: string
          maxLength: 255
        country_of_birth_or_incorporation:
          type: string
          maxLength: 255
        nationality:
          type: string
          maxLength: 60
        account_type:
          type: string
          maxLength: 255
        account_type_ii:
          type: string
          maxLength: 255
        account_opening_date:
          type: string
          maxLength: 255
        account_opening_date_ii:
          type: string
          maxLength: 255
        customer_aml_risk_rating:
          type: string
          maxLength: 255
        customer_account:
          type: string
          maxLength: 255
        customer_account_ii:
          type: string
          maxLength: 255
        customer_opening_date:
          type: string
          maxLength: 255
        source_of_funds:
          type: string
          maxLength: 255
        average_monthly_income:
          type: string
          maxLength: 255
        cif_status:
          type: string
          maxLength: 255
        occupation:
          type: string
          maxLength: 255
        industry:
          type: string
          maxLength: 255
        purpose_of_account:
          type: string
          maxLength: 255
        contact_number:
          type: string
          maxLength: 255
        email_address:
          type: string
          maxLength: 255
        risk_assessment_score:
          type: string
          format: decimal
          pattern: ^-?\d{0,3}(?:\.\d{0,2})?$
        created_by:
          type: integer
          nullable: true
        modified_by:
          type: integer
          nullable: true
      required:
        - client_subject_id
        - subject_name
    Currency:
      type: object
      properties:
        currency:
          type: string
          maxLength: 65
        alphabetic_code:
          type: string
          maxLength: 3
        numeric_code:
          type: string
          maxLength: 3
        active_indicator:
          type: boolean
          readOnly: true
      required:
        - active_indicator
        - alphabetic_code
        - currency
    UserSimpleList:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
      required:
        - id
  securitySchemes:
    CustomAuthentication:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT token obtained from AWS Cognito or custom authentication service
    cookieAuth:
      type: apiKey
      in: cookie
      name: sessionid

````