Skip to main content
Vindicia Knowledge Center

Account Data Members

Account Data Members

Account Data Members

The following table lists and describes the data members of the Account object.

Note Some CashBox objects’ data members are CashBox data types that are data structures, which contain multiple data members themselves. These data structures are often listed as Subobjects in the documentation that follows.

Data Members Data Type Description
company string The customer’s company name, if specified.
credit Credit

A read-only data member that holds credit types (tokens, time, currency) available to this Account. CashBox populates this in the Account object returned to you in response to API calls.

Do not directly set the value of this attribute. To manipulate credit available to this Account, use methods such as grantCredit() or revokeCredit().

See the Credit Subobject.

defaultCurrency

string

The three-character ISO 4217 currency code CashBox uses when you pass in a one-time Transaction or AutoBill without specifying a currency. Also, you can request Client Services to define a Global default currency. If you choose neither of these options (and do not specify a currency when you pass in a one-time Transaction or AutoBill) CashBox uses the Vindicia default, which is USD.

When you do not specify a currency, CashBox determines the currency to use by proceeding from the specific to the general, in the following order:

1. Transaction

2. AutoBill

3. Account

4. Global (merchant) default

5. Vindicia default

If you specify a currency for a Transaction or AutoBill, CashBox will always use that code. Defaults are applied only when no currency code is specified.

Because one-time Transactions have no associated AutoBill, if you create a new Transaction without specifying a currency, CashBox uses the defaultCurrency of the Account. If there is none set in Account, CashBox uses the Global default. If no Global default is set, CashBox applies the Vindicia default, which is USD.

emailAddress

string

The email address for this Account object, if specified.

emailTypePreference

EmailPreference

The CashBox enumerated data type that specifies whether to send email to Account as plain text or HTML.

See the EmailPreference Subobject.

entitlements

Entitlement

An array of Entitlements associated with this Account. Note that Account entitlement modifications must be made using Account methods such as grantEntitlement or revokeEntitlement. Entitlement modifications made by other means (i.e., update) will be silently ignored.

See Entitlement Data Members.

merchantAccountId

string

Required. Your unique identifier for this Account object, such as a database ID, a user name, or an email address. Once you have created the object with this ID, you can refer to the Account using the ID for future operations.

parentMerchantAccountId

string

The merchant unique identifier for the parent Account of this Account. If an account has a parent account, the Account object is populated with the MerchantAccountId of the parent account. If the account does not have a parent account, this is null.

name

string

The customer’s name, if specified. This name usually corresponds to the name on the credit card listed for the account.

nameValues

NameValuePair[]

Optional. An array of name–value pairs associated with the customer for later reference.

See The NameValuePair Object.

paymentMethods

PaymentMethod[]

A list of default methods, one of which will be applied to a recurring transaction generated for this Account object if the customer has not explicitly specified a payment method for a subscription (AutoBill). Mark the payment methods active or inactive and sort them in order of preference. The first paymentMethod in the sort order will be used as the default.

See PaymentMethod Data Members.

preferredLanguage

string

The customer’s preferred language for communications. This preference is set in the customer account and must adhere to the W3C IANA Language Subtag Registry standard. Even though CashBox also supports the ISO-639.2 standard, the IANA Language Subtag Registry is the most recent and complete standard and is preferred.

If you use the CashBox email notification feature, and have uploaded an email template in the preferred language to CashBox, CashBox notifies the customer in this language.

shippingAddress

Address

The customer’s shipping address. This field is optional if, for example, it is the same as billingAddress. CashBox looks up this address first when calculating a transaction’s sales tax for this Account object.

See Address Data Members.

taxExemptions

TaxExemption[]

An array of default exemptions for the sales tax on this account’s transactions. Multiple tax exemptions may be defined.

See the TaxExemption Subobject.

taxType

string

Account-level code used with external tax system rules for exemption behavior and custom tax handling.

tokenBalances

TokenAmount[]

An array of TokenAmount objects that describes the account balance of various Token types. Each object in the array specifies the quantity of a specific type of Token. This is a read-only attribute, returned in the Account object in response to an update call.

See the TokenAmount Subobject.

VID

string

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

warnBeforeAutoBilling

Boolean

A Boolean flag that, if set to true, and if you are using the CashBox email notification feature, triggers an email notification to the customer before every recurring billing.

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top