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

# Defining the Master Currency

The Master Currency can be described as the currency that Athena will be using to perform screening of transactions. Athena identifies currency code using the alphabetic code in accordance to ISO 4217. For more information on ISO 4217, please refer to the link below.

[ISO 4217 Standard](https://iso.org/iso-4217-currency-codes.html)

Please also note that only one currency can be set as the Master Currency. Once the Master Currency is set, the main currency **cannot be changed** by any means. If a mistake was made setting the Master Currency, please send an email to [clientservice@cynopsis.co](mailto:clientservice@cynopsis.co)

To select the currency code to be used, perform a one-time call to the following API


## OpenAPI

````yaml patch /api/currency/{alphabetic_code}
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/currency/{alphabetic_code}:
    patch:
      tags:
        - Currency
      summary: Activate/Deactivate a currency
      operationId: currency_partial_update
      parameters:
        - in: path
          name: alphabetic_code
          schema:
            type: string
          required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedCurrencyRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedCurrencyRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedCurrencyRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Currency'
          description: ''
      security:
        - CustomAuthentication: []
        - cookieAuth: []
        - BearerAuth: []
components:
  schemas:
    PatchedCurrencyRequest:
      type: object
      properties:
        activate_currency:
          type: boolean
          writeOnly: true
        currency:
          type: string
          minLength: 1
          maxLength: 65
        alphabetic_code:
          type: string
          minLength: 1
          maxLength: 3
        numeric_code:
          type: string
          maxLength: 3
    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
  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

````