TwurpleAuthenticationGetting dataExamplesFAQMigration

Main classes

HelixCharityCampaignAmount

An object representing monetary amount and currency information for charity donations/goals.

Overview

Properties

currency

Type: string

The ISO-4217 three-letter currency code that identifies the type of currency in value.

decimalPlaces

Type: number

The number of decimal places used by the currency. For example, USD uses two decimal places. Use this number to translate value from minor units to major units by using the formula:

value / 10^decimalPlaces

localizedValue

Type: number

The localized monetary amount based on the value and the decimal places of the currency. For example, the minor units for USD is cents which uses two decimal places, so if value is 550, localizedValue is set to 5.50.

value

Type: number

The monetary amount. The amount is specified in the currency’s minor unit. For example, the minor units for USD is cents, so if the amount is $5.50 USD, value is set to 550.