Money

June 5, 2026 ยท View on GitHub

The currency and amount for a financial transaction, such as a balance or payment due.

Structure

Money

Fields

NameTypeTagsDescriptionGetterSetter
CurrencyCodeStringRequiredThe three-character ISO-4217 currency code that identifies the currency.

Constraints: Minimum Length: 3, Maximum Length: 3
String getCurrencyCode()setCurrencyCode(String currencyCode)
ValueStringRequiredThe value, which might be: An integer for currencies like JPY that are not typically fractional. A decimal fraction for currencies like TND that are subdivided into thousandths. For the required number of decimal places for a currency code, see Currency Codes.

Constraints: Maximum Length: 32, Pattern: ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$
String getValue()setValue(String value)

Example (as JSON)

{
  "currency_code": "currency_code6",
  "value": "value2"
}