What is the standard for formatting currency values in JSON?

I don’t know if it’s the best solution, but what I’m trying now is to just pass values as strings unformatted except for a decimal point, like so:

"amount": "1234.56"

The app could easily parse that (and convert it to double, BigDecimal, int, or whatever method the app developer feels best for floating-point arithmetic). The app would be responsible for formatting the value for display according to locale and currency.

This format could accommodate other currency values, whether highly inflated large numbers, numbers with three digits after the decimal point, numbers with no fractional values at all, etc.

Of course, this would assume the app already knows the locale and currency used (from another call, an app setting, or local device values). If those need to be specified per call, another option would be:

"amount": "1234.56",
"currency": "USD",
"locale": "en_US"

I’m tempted to roll these into one JSON object, but a JSON feed may have multiple amounts for different purposes, and then would only need to specify currency settings once. Of course, if it could vary for each amount listed, then it would be best to encapsulate them together, like so:

{
"amount": "1234.56",
"currency": "USD",
"locale": "en_US"
}

Another debatable approach is for the server to provide the raw amount and the formatted amount. (If so, I would suggest encapsulating it as an object, instead of having multiple properties in a feed that all define the same concept):

{
"displayAmount":"$1,234.56",
"calculationAmount":"1234.56"
}

Here, more of the work is offloaded to the server. It also ensures consistency across different platforms and apps in how the numbers are displayed, while still providing an easily parseable value for conditional testing and the like.

However, it does leave a problem–what if the app needs to perform calculations and then show the results to the user? It will still need to format the number for display. Might as well go with the first example at the top of this answer and give the app control over the formatting.

Those are my thoughts, at least. I’ve been unable to find any solid best practices or research in this area, so I welcome better solutions or potential pitfalls I haven’t pointed out.

Leave a Comment

File not found.