Skip to main content
Vindicia Knowledge Center

Account Details

Account Details

The Account Details page displays detailed information about the selected Account, divided into panes. The top pane lists general Account information, including the customer’s name, contact information, language, and pre-billing warning preferences. The next pane lists the Payment Methods associated with the Account. Information displayed will vary depending on the payment type described. For example, a Credit Card Payment Method will list the customer’s credit card number, type, and expiration date, while a Token Payment Method will list the Token Type, Description, and Balance.

Account Details Page (CreditCard Payment Method)

Account Details Page (Token Payment Method)

  • Click Create AutoBill to open the Create New AutoBill page, and create an AutoBill for the Account.
  • Click Edit Account to open the Edit Customer Account page, and edit customer or payment method information for the Account.
  • Click Make Payment to open the Record Payment page, and make a payment to the account (to record a payment against an Invoice).
  • Click on highlighted text to launch the Details window for the selected item.

Subsequent panes list AutoBills associated with the Account, Invoice History, Payment History, scheduled Future Transactions, Account Activity History, Rated Unit Event History, Token Activity and Balance, available Credit, and Children Accounts.

The following table lists and describes the fields available to Accounts.

Field

Description

Customer ID

Displays your unique identifier for the customer associated with the Account.

Customer Name

Displays the customer’s full name. This name typically corresponds to the name associated with the payment method‘s Account holder, but it is not required.

Parent Account

Displays the Parent for the Account, when applicable.

Company

Displays the name of the company the customer is associated with.

Email

Optional. Displays the email address associated with the Account. If provided, the email address is used by CashBox to send billing notifications. While providing a value in this field is optional in CashBox, you may require it for your records.

Email Style

Identifies the format of email notifications sent to the customer.

  • Text/html. Email is sent in HTML format
  • Text/plain. Text is sent as plain text
  • UNDEF. Email preference is undefined. In these cases, CashBox sends notifications as text/html.

Language

Lists the two- or three-character IANA sub-tag registry standard language code corresponding to languages that have been loaded by the merchant into the system. CashBox uses this setting to determine which of its email templates to use when sending notification message to the customer.

CashBox supports ISO 639 language codes, but recommends the IANA codes.

Currency

Specifies the ISO-4217 three-letter format for the default currency used in customer Transactions. Currency code, _VT represents CashBox Tokens.

The currency you specify here becomes the default currency 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 without specifying a currency) 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 defaultCurrencyof 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.

Send Email before Billing

Indicates whether pre-billing notifications are sent to the customer prior to automatic subscription-period renewal.

  • Yes generates pre-billing notification.
  • No does not generate pre-billing notifications.

This setting only affects pre-billing notifications in CashBox. Other notifications (for example, success, expiration, and failure messages) are independent of this setting.

Shipping Address

Displays the Name, Address lines, City, State/Province, Country, and Postal Code used for shipping a Product to the customer. This address is not required, but some merchants may require portions of this address for payment processing . This address (full or portions) may also be used in the calculation of applicable taxes. Merchants who charge taxes typically use the Shipping Address as the first choice, because that is the location where the product will most likely be used.

If Shipping Address not provided, the Billing Address associated with the Payment Method is used for tax calculations.

Tax Type

Optional. Displays the customer account-level tax exemption code, which overrides any individual exemptions defined for the account and instructs the tax engine to tax according to the matching predefined taxability profile (usually fully or partially tax exempt).

Merchant Data

Displays custom information associated with the Account.

Tax Exemptions

Displays tax exemptions applied to the Account.

This field will be displayed only for those Accounts with a Tax Exemption filed against them.

Payment Methods

Lists the Payment Methods associated with the Account. Each Payment Method associated with the Account is displayed in its own pane.

For more information on Payment Method parameters, see CashBox Payment Method Parameters.

AutoBills

Displays a tabular summary of the AutoBills associated with the Account. For more information, see CashBox AutoBill Parameters.

Payment History

Displays a tabular summary of the Payments made against the Account.

Invoice History

Displays a tabular summary of the Invoices generated for the Account. For more information, see Working with Invoices.

This field will be displayed only for those Accounts with Pay By Invoice as an enabled Payment Type.

Future Transactions

Displays a tabular summary of future scheduled billings for the Account. For more information, see Editing Accounts.

Activity History

Displays a tabular summary of the activity history for this Account. Activity information reported includes:

  • Activity type
  • Date and time of activity
  • Activity details, if any

Billing events are either reported by the merchant, or generated by an AutoBill. Pre-defined event activities include: Login, Logout, Email, Call, URI access, Product delivery/Fulfillment, Service usage, Cancellation events, and Notes.

Merchants may also define their own activity events to display in this field.

For more information, see Editing Accounts.

Event History

Lists unbilled Rated Unit Events for the Account.

Token Activity and Balance

Displays a tabular summary of the Token activity and balance for this Account, if any. Token information reported includes:

  • Date and time of activity
  • Transaction ID
  • Description, which describes type of token activity.
  • Amount
  • Token ID
  • Token Type
  • Balance

By default, Token Activity is listed from most recent activity to oldest.

Credits

Displays a tabular summary of the Credit available to the Account. This may include Token, Time, or Currency credits.

Children Accounts

Lists all Accounts identified as Children to this Account. (Children Accounts may use their Parent Account’s Payment Method to pay for their AutoBills.)

 

Sales Tax Exemptions

Sales Tax Exemptions list the exemptions associated with the Account. CashBox considers exemptions when calculating bills for taxable goods. If your Customer provides you with their tax exemption information, include it here.

For more information, see Adding and Editing Sales Tax Exemptions.

Payment Methods

Payment Methods define the means by which an Account pays for its Transactions. Payment Methods are listed in the order of their preferred use. Payment Method #1 serves as the default for the Account.

Click the Payment Type link to open the Transactions List page for that Payment Method.

For more information, see Adding and Editing Payment Methods.

AutoBills

The AutoBills table lists details for all AutoBills associated with the Account.

CashBox Accounts include information about payment methods; CashBox AutoBills define recurring billing events. The AutoBills section of the Account Details page displays tabular information about all AutoBills for the Account. For more information on these fields, see CashBox AutoBill Parameters.

Note The CURRENCY and BILL DAY columns have been removed from the AutoBills section of the Account Detail page. This information is still available in the AutoBill detail pages.

To view detailed information about an AutoBill associated with the selected Account, click the Product or Serial Number field in the AutoBills table to open the AutoBill Details page. For more information, see AutoBill Details.

Payment History

The Payment History table lists details for all Payments made toward the Account.

This table provides an overview of payment events that have already occurred. To view more detailed information about the listed transactions, click the Transaction ID of the event to open the Transaction Details page for the selected event. To sort by date or status (ascending or descending), click the DATE or STATUS column heads.

The Payment History table displays only those Transactions conducted in currency, and not those processed in Tokens.

The following table describes the listed fields.

Field

Description

Date

Indicates the date of Transaction.

Transaction ID

Displays the Transaction ID associated with the payment request sent to the payment processor.

Product

Specifies the Product associated with the Transaction.

Amount

The Amount collected.

Refund

The amount of the refund. If the Refund field is the same as the Amount field, the Transaction was fully refunded; if Refund is less than Amount, the Transaction was only partially refunded.

Status

Indicates the Transaction status of the payment transaction:

  • Captured: Payment processor successfully captured the Transaction.
  • Cancelled: Payment processor response indicated that the Transaction failed.
  • Refunded: The Transaction was successfully refunded, either fully or partially.
  • New: Transaction is created, but not yet submitted for payment.
  • Authorized: Transaction is successfully authorized and awaiting capture.
  • Auth Expired: Transaction was authorized, but no capture was made within the payment processor’s authorization time frame, and the authorization has therefore expired.
  • Authorized for Validation: Transaction is successfully authorized for the Account.
  • Deposit Retry Pending: Transaction is being retried within the payment processor system (ECP Transactions only).
  • Authorized Pending: Transaction passed authorization with the payment processor, and the capture of funds is pending.
  • Undefined: Transaction has not yet been submitted to payment processor. This may be because the Transaction is currently in the middle of processing when viewed.

For more information about Transaction details, see CashBox Transaction Parameters.

Future Transactions

The Future Transactions table lists all pending Transactions for the Account. Future Transactions fields are listed below.

 

Field

Description

Date

Indicates the scheduled date of a future Transaction.

Product

Specifies the Product ID of the Product or service for which billing will occur.

Amount

Lists the total amount to be billed, and the currency code for the Transaction

Activity History

The Activity History table lists all Activity for the Account, including payments made, email notifications sent, changes to the Account or its AutoBills, or Notes entered against the Account.

This table provides an overview of activities that have already occurred, either because of customer purchase, Product or service access, or customer service interaction. Use the links to generate a printer-friendly view of this table, or add a note to the activity history.

Click on an Activity Type to open the Activity Details page for the item.

The following table describes the listed fields.

Field

Description

Timestamp

Indicates the date and time of the activity’s occurrence.

Type

Specifies the type of activity recorded. Type is either a predefined type, or a custom merchant-defined activity added or created through the CashBox API.

Predefined activity types are:

  • Login
  • Logout
  • Email
  • Call
  • URL access
  • Product Delivery/Fulfillment
  • Service Usage
  • Cancellation Event
  • Note

IP Address

Lists the IP address from which the customer initiated activity, if applicable.

Details

Specifies information relevant to the activity type. (For example, type of email notification sent, Serial Number of Product, template name, or template version and language.)

 

The Activity Details page lists the customer ID, customer name, the name of the merchant authorized user, if any, involved in the activity, and an customer email address, if any.

Click on the Customer ID to open the Account Details page.

Adding Notes to the Account’s Activity History

1.  Click Add Note in the Activity History header to open the Create New Activity: Note page.

2.  Enter the text for your note in the Note... text window. Notes are limited to 4000 characters. The number of characters remaining is displayed under the Note... window.

3.  Click Submit to add your note to the Activity History for the Account, and return to theAccount Details page, or click Cancel to discard your note.

For example, the note entered in the New Activity Note page is displayed at the bottom on the Activity History list, as shown below.

 

Event History

The Event History table lists unbilled Rated Unit Events for the Account. Event History fields are listed below.

 

Field

Description

Event Timestamp

The time at which the Event took place.

Product

The billed Product’s name.

Rate Plan

The Rate Plan under which the Event occurred.

AutoBill

The AutoBill with which the Event is associated.

Amount

The number of Rated Unit Events consumed.

Token Activity and Balance

The Token Activity and Balance table lists all Token Activity against the Account, including Token grants, credits, and payments.

When an Account involves the use of Tokens, the Account Details page displays information about the Token Activity and Token Balance(s) associated with the Account. Token Activity and Balance Parameters are listed below.

 

Field

Description

Date

The date and time the activity occurred.

Transaction ID

The IDs of Transactions for a Product that granted tokens, refunded tokens, or that was transacted in tokens.

Description

Describes the Token activity. Possible values are:

  • Decrement
  • Purchase
  • Grant
  • Refund

Amount

The number of Tokens exchanged for the listed Activity.

Token ID

The Token ID.

Token Type

The Token Type.

Balance

Lists the current balance of the specified token type in the customer Account.

Note

Lists the Note associated with the Token Activity.

Granting Tokens to an Account

1. Click Grant Tokens in the header for the Token Activity & Balance pane to open the Grant Tokens page.

Grant Tokens Page

2. Select the type of Token to grant from the Token Type dropdown list.

3. Specify the number of Tokens to grant in the Amount box.

4. Enter a short description of the grant activity in the Description box.

5. Click Submit to grant, or Cancel to exit without granting.

If the grant is successful, CashBox displays a success message. Click OK to return to the Account Details page with an updated Token Activity and Balance table, listing the latest grant activity.

When you manually grant tokens, there is no corresponding Transaction, and therefore no Transaction ID is displayed in the table.

Credits

The Credit table lists all Credit grants available to the Account. Credit grants may be Token or Currency based.

For more information, see Credits.

Granting Credit to an Account

Click Grant Credit to open the Grant Credit page, and add Credit to the Account.

Credits may be granted to an Account as a result of a Customer Service Call, a Customer Anniversary, or other offline activity. Accounts may be granted Token or Currency Credits, but may not be granted Time Credits. Once granted to the Account, these credits may be used toward AutoBills or One-Time Transactions.

Children Accounts

The Children Accounts table lists all Children to the Account.

Adding Children to an Account

To add a child to an Account, click Add Children to open the Add Child to Account page.

The top part of the page lists existing children to the Account.

  1. Click the Customer ID to open the Account Details page for the Account.
  2. Click Remove to remove the child from the account.

The bottom part of the page allows you to add new children to the Account.

1. Enter the name of the Account you wish to add as a Child in the Add Child field.

2. Select a Force condition:

  • True replaces any parents that this child may already have with the selected account.
  • False does not replace any existing parents, and will issue a warning if any exist.

3. Select a Behavior:

  • ReplaceOnAllAutoBills makes the Parent’s Payment Method the payer for all of the child’s AutoBills.
  • ReplaceOnlyFutureAutoBills places the parent's payment method on all new AutoBills created for the child account. The child Account continues to pay for existing AutoBills, but the parent Account will pay for all of the Child’s AutoBills created from this point forward.

4. Click Submit to add the child to the parent Account.

5. Repeat to add more children.

Cashbox Features

Learn More
Cashbox Features

For Developers

Learn More
For Developers
Back to Top