Skip to content

Latest commit

 

History

History
29 lines (21 loc) · 1.13 KB

money.md

File metadata and controls

29 lines (21 loc) · 1.13 KB

Money

Represents an amount of money. Money fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See Working with Monetary Amounts for more information.

Structure

Money

Fields

Name Type Tags Description
Amount long? Optional The amount of money, in the smallest denomination of the currency
indicated by currency. For example, when currency is USD, amount is
in cents. Monetary amounts can be positive or negative. See the specific
field description to determine the meaning of the sign in a particular case.
Currency string Optional Indicates the associated currency for an amount of money. Values correspond
to ISO 4217.

Example (as JSON)

{
  "amount": null,
  "currency": null
}