Description

Overview

The currencies package provides functionality for managing supported currencies, exchange rates, and currency conversion operations. It supports ISO 4217 currency codes and maintains real-time exchange rates.

API Methods

Get All Currencies

GET /v1/currencies

Retrieves a list of all supported currencies with their details.

Query Parameters

• active - Filter by active status (boolean)
• region - Filter by region (string)
• page - Page number for pagination (default: 1)
• per_page - Items per page (default: 20)

Response

{
  "currencies": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "code": "EUR",
      "numeric_code": "978",
      "name": "Euro",
      "symbol": "€",
      "decimal_places": 2,
      "precision": 6,
      "is_fiat": true,
      "is_base": false,
      "format": "€#,##0.00",
      "display_priority": 1,
      "icon_url": "/data/currencies/eur.svg",
      "active": true,
      "metadata": {},
      "created_at": "2024-03-20T10:00:00Z",
      "updated_at": "2024-03-20T10:00:00Z"
    }
  ],
  "total": 162,
  "page": 1,
  "per_page": 20
}

Get Currency by ID

GET /v1/currencies/{id}

Retrieves detailed information about a specific currency by its UUID.

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "code": "EUR",
  "numeric_code": "978",
  "name": "Euro",
  "symbol": "€",
  "decimal_places": 2,
  "precision": 6,
  "is_fiat": true,
  "is_base": false,
  "format": "€#,##0.00",
  "display_priority": 1,
  "icon_url": "/data/currencies/eur.svg",
  "active": true,
  "metadata": {},
  "created_at": "2024-03-20T10:00:00Z",
  "updated_at": "2024-03-20T10:00:00Z"
}

Create Currency

POST /v1/currencies

Creates a new currency record.

Update Currency

PUT /v1/currencies/{id}

Updates currency details by ID.

Delete Currency

DELETE /v1/currencies/{id}

Deletes (deactivates) a currency.

Amount & Currency Handling

Design Principles

All monetary amounts in the system are represented as string integers in minor/atomic units. Floating-point numbers are never used for money values.

Why:

• Prevents rounding drift and settlement mismatches
• Deterministic accounting and easy reconciliation
• Regulatory audit safety (traceable, reversible calculations)

Internal Ledger Representation

API Amount Format

Two Go structs represent amounts across the API:

CcyAmt — used in request bodies (POST / PUT / PATCH):

{
  "amount": "123456",
  "currency": "EUR"
}

CcyAmtWithPrecision — used in all GET responses:

{
  "amount": "123456",
  "currency": "EUR",
  "precision": 2
}

Rules

• amount is always a string integer in minor/atomic units — never a float.
• currency is always present (ISO 4217 for fiat, asset code for crypto).
• precision is the number of decimal places the minor unit represents.
• precision is server-provided and read-only — the server owns the currency → precision mapping.

GET responses (read)

• Must always include precision alongside amount and currency.
• Every amount returned by the API is fully self-describing.

POST / PUT / PATCH requests (write)

• Clients send amount and currency only.
• precision is not accepted in request bodies — the server resolves it from the currency.

FX Rate Format

{
  "base": "EUR",
  "quote": "USD",
  "rate": "1.08532",
  "timestamp": "2026-01-01T00:00:00Z"
}

• Rate is a decimal string.
• Base currency normalized to 1.
• Stored internally with high precision.

Fees / Tariffs Format

Percentage fees — decimal string:

{
  "fee_rate": "0.015"
}

Fixed fees — minor-unit integer with precision:

{
  "fixed_fee": {
    "amount": "30",
    "currency": "EUR",
    "precision": 2
  }
}

Common Pitfalls

Precision Mismatch

Crypto assets support up to 18 decimals while fiat typically uses 2. Always convert via atomic units. The explicit precision field eliminates ambiguity during conversions.

FX Conversion Loss

Avoid chained conversions (BTC → EUR → USD). Prefer: atomic ledger → base currency → quote currency.

Regulatory Expectations

Auditors expect deterministic rounding, traceable calculations, and reversible accounting logic. Integer atomic units greatly simplify compliance.

Error Codes

Dependencies

• common/errs - Error handling
• common/auth - Authentication
• common/logger - Logging functionality
• common/config - Configuration management
• modules/countries - Country-specific currency data