ISO4217 codes take precendence of digital tokens. Closes #190

Author: kipcole9

CHANGELOG.md

@@ -2,7 +2,15 @@
 
 **Note** `ex_money` 5.17.0 and later is supported on Elixir 1.12 and later versions only.
 
-## Money v5.24.0
+## Money v5.24.1
+
+This is the changelog for Money v5.24.1 released on January 20th, 2026.  For older changelogs please consult the release tag on [GitHub](https://github.com/kipcole9/money/tags)
+
+### Bug Fixes
+
+* Fixes casting a binary currency code that is both a valid ISO4217 currency code and a valid digital currency short code (for example, "TRY"). Precedence is given to returning the ISO4217 code (this was not the case in v5.24.0).
+
+## Money v5.24.0 (deprecated and retired)
 
 This is the changelog for Money v5.24.0 released on January 18th, 2026.  For older changelogs please consult the release tag on [GitHub](https://github.com/kipcole9/money/tags)
 

lib/money.ex

@@ -171,7 +171,7 @@ defmodule Money do
       Money.new(:EUR, "100.30", fractional_digits: 4)
 
       iex> Money.new(:XYZZ, 100)
-      {:error, {Money.UnknownCurrencyError, "The currency :XYZZ is invalid"}}
+      {:error, {Money.UnknownCurrencyError, "The currency :XYZZ is unknown"}}
 
       iex> Money.new("1.000,99", :EUR, locale: "de")
       Money.new(:EUR, "1000.99")
@@ -2375,7 +2375,7 @@ defmodule Money do
 
       iex> Money.to_currency(Money.new(:USD, 100), :AUDD,
       ...>   %{USD: Decimal.new(1), AUD: Decimal.from_float(0.7345)})
-      {:error, {Cldr.UnknownCurrencyError, "The currency :AUDD is invalid"}}
+      {:error, {Cldr.UnknownCurrencyError, "The currency :AUDD is unknown"}}
 
       iex> Money.to_currency(Money.new(:USD, 100), :CHF,
       ...>   %{USD: Decimal.new(1), AUD: Decimal.from_float(0.7345)})
@@ -2793,7 +2793,7 @@ defmodule Money do
       Money.new(:USD, "0")
 
       iex> Money.zero :ZZZ
-      {:error, {Cldr.UnknownCurrencyError, "The currency :ZZZ is invalid"}}
+      {:error, {Cldr.UnknownCurrencyError, "The currency :ZZZ is unknown"}}
 
   """
   @spec zero(Currency.currency_reference() | Money.t()) :: Money.t() | {:error, {module(), binary()}}
@@ -2951,9 +2951,19 @@ defmodule Money do
 
   @doc false
   def validate_currency(currency_code) do
+    case Cldr.Currency.validate_currency(currency_code) do
+      {:ok, currency_code} -> {:ok, currency_code}
+      {:error, error} -> validate_digital_token(currency_code, error)
+    end
+  end
+
+  defp validate_digital_token(currency_code, original_error) do
     case DigitalToken.validate_token(currency_code) do
-      {:ok, token_id} -> {:ok, token_id}
-      {:error, _} -> Cldr.Currency.validate_currency(currency_code)
+      {:ok, token_id} ->
+        {:ok, token_id}
+
+      {:error, {DigitalToken.UnknownTokenError, _}} ->
+        {:error, original_error}
     end
   end
 

lib/money/backend.ex

@@ -85,7 +85,7 @@ defmodule Money.Backend do
             Money.new(:EUR, "100.30")
 
             iex> #{inspect(__MODULE__)}.new(:XYZZ, 100)
-            {:error, {Money.UnknownCurrencyError, "The currency :XYZZ is invalid"}}
+            {:error, {Money.UnknownCurrencyError, "The currency :XYZZ is unknown"}}
 
             iex> #{inspect(__MODULE__)}.new("1.000,99", :EUR, locale: "de")
             Money.new(:EUR, "1000.99")
@@ -1015,7 +1015,7 @@ defmodule Money.Backend do
             {:ok, Money.new(:AUD, "73.4500")}
 
             iex> #{inspect(__MODULE__)}.to_currency Money.new(:USD, 100), :AUDD, %{USD: Decimal.new(1), AUD: Decimal.from_float(0.7345)}
-            {:error, {Cldr.UnknownCurrencyError, "The currency :AUDD is invalid"}}
+            {:error, {Cldr.UnknownCurrencyError, "The currency :AUDD is unknown"}}
 
             iex> #{inspect(__MODULE__)}.to_currency Money.new(:USD, 100), :CHF, %{USD: Decimal.new(1), AUD: Decimal.from_float(0.7345)}
             {:error, {Money.ExchangeRateError, "No exchange rate is available for currency :CHF"}}
@@ -1283,7 +1283,7 @@ defmodule Money.Backend do
             Money.new(:USD, "0")
 
             iex> #{inspect(__MODULE__)}.zero :ZZZ
-            {:error, {Cldr.UnknownCurrencyError, "The currency :ZZZ is invalid"}}
+            {:error, {Cldr.UnknownCurrencyError, "The currency :ZZZ is unknown"}}
 
         """
         @spec zero(Currency.currency_reference() | Money.t()) :: Money.t() | {:error, {module(), binary()}}

lib/money/exception.ex

@@ -6,6 +6,14 @@ defmodule Money.UnknownCurrencyError do
   end
 end
 
+defmodule Money.InvalidCurrencyError do
+  defexception [:message]
+
+  def exception(message) do
+    %__MODULE__{message: message}
+  end
+end
+
 defmodule Money.FormatError do
   defexception [:message]
 

mix.exs

@@ -1,7 +1,7 @@
 defmodule Money.Mixfile do
   use Mix.Project
 
-  @version "5.24.0"
+  @version "5.24.1"
 
   def project do
     [
@@ -91,6 +91,7 @@ defmodule Money.Mixfile do
 
   defp deps do
     [
+      {:ex_cldr, "~> 2.46"},
       {:ex_cldr_numbers, "~> 2.38"},
 
       # Used for Money.Subscription.Plan.to_string/1

mix.lock

@@ -11,12 +11,12 @@
   "elixir_xml_to_map": {:hex, :elixir_xml_to_map, "3.1.0", "4d6260486a8cce59e4bf3575fe2dd2a24766546ceeef9f93fcec6f7c62a2827a", [:mix], [{:erlsom, "~> 1.4", [hex: :erlsom, repo: "hexpm", optional: false]}], "hexpm", "8fe5f2e75f90bab07ee2161120c2dc038ebcae8135554f5582990f1c8c21f911"},
   "erlex": {:hex, :erlex, "0.2.8", "cd8116f20f3c0afe376d1e8d1f0ae2452337729f68be016ea544a72f767d9c12", [:mix], [], "hexpm", "9d66ff9fedf69e49dc3fd12831e12a8a37b76f8651dd21cd45fcf5561a8a7590"},
   "erlsom": {:hex, :erlsom, "1.5.2", "3e47c53a199136fb4d20d5479edb7c9229f31624534c062633951c8d14dcd276", [:rebar3], [], "hexpm", "4e765cc677fb30509f7b628ff2914e124cf4dcc0fac1c0a62ee4dcee24215b5d"},
-  "ex_cldr": {:hex, :ex_cldr, "2.45.1", "e03794a96cecba6a75b0cf409fcf89a40ceadce15a13f8572394c64ee22d1971", [:mix], [{:cldr_utils, "~> 2.28", [hex: :cldr_utils, repo: "hexpm", optional: false]}, {:decimal, "~> 1.6 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: false]}, {:gettext, "~> 0.19 or ~> 1.0", [hex: :gettext, repo: "hexpm", optional: true]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: true]}, {:nimble_parsec, "~> 0.5 or ~> 1.0", [hex: :nimble_parsec, repo: "hexpm", optional: true]}], "hexpm", "32498af496be50d2c94a32166cde7227b3ce54d0e62be783f7445469140cdb26"},
+  "ex_cldr": {:hex, :ex_cldr, "2.46.0", "29b5bb638932ca4fc4339595145e327b797f59963a398c12a6aee1efe5a35b1b", [:mix], [{:cldr_utils, "~> 2.28", [hex: :cldr_utils, repo: "hexpm", optional: false]}, {:decimal, "~> 1.6 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: false]}, {:gettext, "~> 0.19 or ~> 1.0", [hex: :gettext, repo: "hexpm", optional: true]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: true]}, {:nimble_parsec, "~> 0.5 or ~> 1.0", [hex: :nimble_parsec, repo: "hexpm", optional: true]}], "hexpm", "14157ac16694e99c1339ac25a4f10d3df0e0d15cc1a35073b37e195487c1b6cb"},
   "ex_cldr_currencies": {:hex, :ex_cldr_currencies, "2.17.0", "c38d76339dbee413f7dd1aba4cdf05758bd4c0bbfe9c3b1c8602f96082c2890a", [:mix], [{:ex_cldr, "~> 2.38", [hex: :ex_cldr, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: true]}], "hexpm", "9af59bd29407dcca59fa39ded8c1649ae1cf6ec29fd0611576dcad0279bce0db"},
   "ex_cldr_lists": {:hex, :ex_cldr_lists, "2.11.1", "ad18f861d7c5ca82aac6d173469c6a2339645c96790172ab0aa255b64fb7303b", [:mix], [{:ex_cldr_numbers, "~> 2.25", [hex: :ex_cldr_numbers, repo: "hexpm", optional: false]}, {:ex_doc, "~> 0.18", [hex: :ex_doc, repo: "hexpm", optional: true]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: true]}], "hexpm", "00161c04510ccb3f18b19a6b8562e50c21f1e9c15b8ff4c934bea5aad0b4ade2"},
   "ex_cldr_numbers": {:hex, :ex_cldr_numbers, "2.38.0", "b5564b57d3769c85e16689472a9bb65804f71ccd3484144e31998398fda25ad1", [:mix], [{:decimal, "~> 1.6 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: false]}, {:digital_token, "~> 0.3 or ~> 1.0", [hex: :digital_token, repo: "hexpm", optional: false]}, {:ex_cldr, "~> 2.45", [hex: :ex_cldr, repo: "hexpm", optional: false]}, {:ex_cldr_currencies, "~> 2.17", [hex: :ex_cldr_currencies, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: true]}], "hexpm", "b29e4d723c69db5d0a3f3bcef7583a0bc87dda1cd642187c589fec4bfc59a703"},
   "ex_cldr_units": {:hex, :ex_cldr_units, "3.20.1", "b27ec81814a67ed77d1c06c64ef74519b141497b74244ec18e1a1a2f78f8e313", [:mix], [{:decimal, "~> 1.6 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: false]}, {:ex_cldr_lists, "~> 2.10", [hex: :ex_cldr_lists, repo: "hexpm", optional: false]}, {:ex_cldr_numbers, "~> 2.36", [hex: :ex_cldr_numbers, repo: "hexpm", optional: false]}, {:ex_doc, "~> 0.18", [hex: :ex_doc, repo: "hexpm", optional: true]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: true]}], "hexpm", "879af22563b06570f16c28bed3decaadc0c1233906f4516b2d5d28e2bbbadee0"},
-  "ex_doc": {:hex, :ex_doc, "0.39.3", "519c6bc7e84a2918b737aec7ef48b96aa4698342927d080437f61395d361dcee", [:mix], [{:earmark_parser, "~> 1.4.44", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_c, ">= 0.1.0", [hex: :makeup_c, repo: "hexpm", optional: true]}, {:makeup_elixir, "~> 0.14 or ~> 1.0", [hex: :makeup_elixir, repo: "hexpm", optional: false]}, {:makeup_erlang, "~> 0.1 or ~> 1.0", [hex: :makeup_erlang, repo: "hexpm", optional: false]}, {:makeup_html, ">= 0.1.0", [hex: :makeup_html, repo: "hexpm", optional: true]}], "hexpm", "0590955cf7ad3b625780ee1c1ea627c28a78948c6c0a9b0322bd976a079996e1"},
+  "ex_doc": {:hex, :ex_doc, "0.40.0", "2635974389b80fd3ca61b0f993d459dad05b4a8f9b069dcfbbc5f6a8a6aef60e", [:mix], [{:earmark_parser, "~> 1.4.44", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_c, ">= 0.1.0", [hex: :makeup_c, repo: "hexpm", optional: true]}, {:makeup_elixir, "~> 0.14 or ~> 1.0", [hex: :makeup_elixir, repo: "hexpm", optional: false]}, {:makeup_erlang, "~> 0.1 or ~> 1.0", [hex: :makeup_erlang, repo: "hexpm", optional: false]}, {:makeup_html, ">= 0.1.0", [hex: :makeup_html, repo: "hexpm", optional: true]}], "hexpm", "c040735250e2752b6e1102eeb4aa3f1dca74c316db873ae09f955d42136e7e5b"},
   "expo": {:hex, :expo, "1.1.1", "4202e1d2ca6e2b3b63e02f69cfe0a404f77702b041d02b58597c00992b601db5", [:mix], [], "hexpm", "5fb308b9cb359ae200b7e23d37c76978673aa1b06e2b3075d814ce12c5811640"},
   "exprintf": {:hex, :exprintf, "0.2.1", "b7e895dfb00520cfb7fc1671303b63b37dc3897c59be7cbf1ae62f766a8a0314", [:mix], [], "hexpm", "20a0e8c880be90e56a77fcc82533c5d60c643915c7ce0cc8aa1e06ed6001da28"},
   "exprof": {:hex, :exprof, "0.2.4", "13ddc0575a6d24b52e7c6809d2a46e9ad63a4dd179628698cdbb6c1f6e497c98", [:mix], [{:exprintf, "~> 0.2", [hex: :exprintf, repo: "hexpm", optional: false]}], "hexpm", "0884bcb66afc421c75d749156acbb99034cc7db6d3b116c32e36f32551106957"},

test/money_exchange_rates_test.exs

@@ -30,13 +30,13 @@ defmodule Money.ExchangeRates.Test do
   test "Convert from USD to ZZZ should return an error" do
     capture_io(fn ->
       assert Money.to_currency(Money.new(:USD, 100), :ZZZ) ==
-               {:error, {Cldr.UnknownCurrencyError, "The currency :ZZZ is invalid"}}
+               {:error, {Cldr.UnknownCurrencyError, "The currency :ZZZ is unknown"}}
     end)
   end
 
   test "Convert from USD to ZZZ should raise an exception" do
     capture_io(fn ->
-      assert_raise Cldr.UnknownCurrencyError, ~r/The currency :ZZZ is invalid/, fn ->
+      assert_raise Cldr.UnknownCurrencyError, ~r/The currency :ZZZ is unknown/, fn ->
         assert Money.to_currency!(Money.new(:USD, 100), :ZZZ)
       end
     end)

test/money_test.exs

@@ -34,10 +34,10 @@ defmodule MoneyTest do
 
   test "create a new money struct wth a invalid binary currency code and binary amount" do
     money = Money.new("1234", "ZZZ")
-    assert money == {:error, {Money.UnknownCurrencyError, "The currency \"ZZZ\" is invalid"}}
+    assert money == {:error, {Money.UnknownCurrencyError, "The currency \"ZZZ\" is unknown"}}
 
     money = Money.new("ZZZ", "1234")
-    assert money == {:error, {Money.UnknownCurrencyError, "The currency \"ZZZ\" is invalid"}}
+    assert money == {:error, {Money.UnknownCurrencyError, "The currency \"ZZZ\" is unknown"}}
   end
 
   test "create a new! money struct with a binary currency code" do
@@ -154,15 +154,15 @@ defmodule MoneyTest do
   end
 
   test "raise when creating a new money struct from invalid input" do
-    assert_raise Money.UnknownCurrencyError, "The currency \"ABCDE\" is invalid", fn ->
+    assert_raise Money.UnknownCurrencyError, "The currency \"ABCDE\" is unknown", fn ->
       Money.new!("ABCDE", 100)
     end
 
-    assert_raise Money.UnknownCurrencyError, "The currency \"ABCDE\" is invalid", fn ->
+    assert_raise Money.UnknownCurrencyError, "The currency \"ABCDE\" is unknown", fn ->
       Money.new!(Decimal.new(100), "ABCDE")
     end
 
-    assert_raise Money.UnknownCurrencyError, "The currency \"ABCDE\" is invalid", fn ->
+    assert_raise Money.UnknownCurrencyError, "The currency \"ABCDE\" is unknown", fn ->
       Money.new!("ABCDE", Decimal.new(100))
     end
   end
@@ -187,12 +187,20 @@ defmodule MoneyTest do
 
   test "creating a money struct with an invalid atom currency code returns error tuple" do
     assert Money.new(:ZYZ, 100) ==
-             {:error, {Money.UnknownCurrencyError, "The currency :ZYZ is invalid"}}
+             {:error, {Money.UnknownCurrencyError, "The currency :ZYZ is unknown"}}
   end
 
   test "creating a money struct with an invalid binary currency code returns error tuple" do
     assert Money.new("XYZABC", 100) ==
-             {:error, {Money.UnknownCurrencyError, "The currency \"XYZABC\" is invalid"}}
+             {:error, {Money.UnknownCurrencyError, "The currency \"XYZABC\" is unknown"}}
+  end
+
+  test "creating a money struct with a code that is also a digital token short code" do
+    money = Money.new(:TRY, 100)
+    assert :TRY = money.currency
+
+    money = Money.new("TRY", 100)
+    assert :TRY = money.currency
   end
 
   test "string output of money is correctly formatted" do
@@ -206,13 +214,13 @@ defmodule MoneyTest do
   end
 
   # Comment out until the next version that depends on ex_cldr_numbers 2.31.0
-  # test "to_string! raises if there is an error" do
-  #   money = Money.new(1234, :USD)
-  #
-  #   assert_raise Cldr.FormatCompileError, fn ->
-  #     Money.to_string!(money, format: "0#")
-  #   end
-  # end
+  test "to_string! raises if there is an error" do
+    money = Money.new(1234, :USD)
+
+    assert_raise Cldr.FormatCompileError, fn ->
+      Money.to_string!(money, format: "0#")
+    end
+  end
 
   test "abs value of a negative value returns positive value" do
     assert Money.abs(Money.new(:USD, -100)) == Money.new(:USD, 100)
@@ -454,15 +462,15 @@ defmodule MoneyTest do
   end
 
   test "raise when a sigil function has an invalid currency" do
-    assert_raise Money.UnknownCurrencyError, ~r/The currency .* is invalid/, fn ->
+    assert_raise Money.UnknownCurrencyError, ~r/The currency .* is unknown/, fn ->
       Money.Sigil.sigil_M("42", [?A, ?A, ?A])
     end
   end
 
   test "raise when a sigil has an invalid currency" do
     import Money.Sigil
 
-    assert_raise Money.UnknownCurrencyError, ~r/The currency .* is invalid/, fn ->
+    assert_raise Money.UnknownCurrencyError, ~r/The currency .* is unknown/, fn ->
       ~M[42]ABD
     end
   end