Skip to main content
PATCH
/
api
/
currency
/
{alphabetic_code}
Activate/Deactivate a currency
curl --request PATCH \
  --url http://localhost/api/api/currency/{alphabetic_code} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "activate_currency": true,
  "currency": "<string>",
  "alphabetic_code": "<string>",
  "numeric_code": "<string>"
}
'
{
  "currency": "<string>",
  "alphabetic_code": "<string>",
  "active_indicator": true,
  "numeric_code": "<string>"
}

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.

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 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 To select the currency code to be used, perform a one-time call to the following API

Authorizations

​
Authorization
string
header
required

JWT token obtained from AWS Cognito or custom authentication service

Path Parameters

​
alphabetic_code
string
required

Body

​
activate_currency
boolean
write-only
​
currency
string
Required string length: 1 - 65
​
alphabetic_code
string
Required string length: 1 - 3
​
numeric_code
string
Maximum string length: 3

Response

200 - application/json
​
currency
string
required
Maximum string length: 65
​
alphabetic_code
string
required
Maximum string length: 3
​
active_indicator
boolean
required
read-only
​
numeric_code
string
Maximum string length: 3