amount

decimal

The amount of currency granted. Must be a positive value.

currency

string

The ISO 4217 currency code used for the currency amount. Default is USD.

description

string

A description of the currency grant.

nameValues

NameValuePair

An optional array of name-value pairs to associate with this currency credit.

See The NameValuePair Object.

reason

string

The reason for the currency credit.

source

string

A read-only field indicating the source of the corresponding credit. Possible values include:

• Account
• AutoBill
• Unknown—indicates the credit is free-floating and not associated at the Account or AutoBill level.

sortValue

integer

Used to determine the order in which Credit is redeemed.

VID

string

Vindicia's Globally Unique Identifier (GUID) for this object. When creating a new CurrencyAmount object, leave this field blank; it will be automatically populated by CashBox.