Currencies

Currencies are maintained with their code, name, precision and threshold values to support multi-currency transactions and ensures accurate financial calculations across revenue applications.

Get Currency Policy

get

/apis/policy-sets/v1/policy/currency

Retrieves the currency details associated with a specific RightRev tenant.

Responses

200

Get Currency Policy

application/json

compliance_idstringOptional

A system-generated compliance ID to retrieve the currencies.

compliance_namestringOptional

Name of the policy fetched by the system.

created_bystringOptional

ID of the user who created the policy.

created_onintegerOptional

Timestamp of the policy created by the user. This is a unix Epoch timestamp format.

last_modified_bystringOptional

ID of the user last modified by.

last_modified_onintegerOptional

Timestamp of the policy last modified on. This is a unix Epoch timestamp format.

policy_typestringOptional

Represents the type of policy.

statusstringOptional

Represents the status of the policy.

unique_keystringOptional

Unique currency code generated by the system.

version_idstringOptional

Represents the latest version of the policy.

get/apis/policy-sets/v1/policy/currency

GET /apis/policy-sets/v1/policy/currency HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*

200

Get Currency Policy

[
  {
    "compliance_id": "8bf8ab8b-ec58-40a0-9c89-fdbee4f7800e",
    "compliance_name": "currency",
    "compliance_spec": [
      {
        "active": true,
        "can_delete": false,
        "code": "USD",
        "created_at": 1758630289,
        "created_by": "RIGHTREV",
        "currency_name": "US Dollar",
        "is_user_defined": false,
        "precision": 2,
        "threshold": 0.5,
        "updated_at": 1758630289,
        "updated_by": "RIGHTREV"
      }
    ],
    "created_by": "rightrev",
    "created_on": 1759217461,
    "last_modified_by": "rightrev",
    "last_modified_on": 1759217461,
    "policy_type": "currency",
    "status": "Active",
    "unique_key": "code",
    "version_id": "e402807e-7f4e-457d-8937-7a364c4af105"
  }
]

Patch Currency Policy

patch

/apis/policy-sets/v1/policy/currency/{compliance_id}

Update multiple currency precision and threshold for currencies.

Path parameters

compliance_idstringRequired

User has to provide a compliance id to update currency precision / threshold or both. This compliance id can be fetched from the response of the Currency Policy - GET API.

Body

compliance_namestringRequired

Name of the policy.

unique_keystringRequired

Unique currency code.

format_typestringRequired

format of the payload. For e.g. JSON

Responses

200

Update Currency Policy

application/json

compliance_idstringOptional

A system-generated compliance ID to update currencies.

errorarrayOptional

Displays information about problems that occurred while handling the request. Commonly used to report validation errors, missing or invalid parameters, or other issues related to API processing.

patch/apis/policy-sets/v1/policy/currency/{compliance_id}

PATCH /apis/policy-sets/v1/policy/currency/{compliance_id} HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Content-Type: application/json
Accept: */*
Content-Length: 242

{
  "compliance_name": "Currency and Precision Policy",
  "unique_key": "code",
  "format_type": "json",
  "compliance_spec": [
    {
      "code": "AFN",
      "currency_name": "Afghani",
      "precision": 3.5,
      "threshold": 4.5,
      "is_user_defined": false,
      "can_delete": false,
      "active": true
    }
  ]
}

200

Update Currency Policy

{
  "compliance_details": [
    {
      "error": [],
      "message": "updated successfully",
      "unique_key": "USD"
    }
  ],
  "compliance_id": "7cadf7ec-40a9-41e7-9040-51aecc639421",
  "error": []
}