Spindle Auth Retail Transaction UML

Spindle specific low-level representation of Retail Transaction produced by Forward Transformation Process within Authorization Process.
During Generation Process, Spindle specific interchange message is generated from this object for authorization. Consequently, all fields of the object are mapped into message segments/elements.

The dollar amount of the transaction in DDDDDDDDDD.CC format. Must include Tip Amount, Tax Amount and Item Amounts.

Returns the address verification result code if the merchant is setup for AVS verification.

The cardholder’s street address. Used for Address Verification (AVS). Not required if using a CardToken.

The cardholder’s city. Used for Address Verification (AVS). Not required if using a CardToken.

The cardholder’s country in 2-letter abbreviation (ex. US = United States). Not required if using a CardToken.

The cardholder’s email address. Not required if using a CardToken.

The cardholder’s contact phone. Not required if using a CardToken. Do not include hyphens or special characters.

The cardholder’s postal/ZIP code. Used for Address Verification (AVS). Not required if using a CardToken.

The cardholder’s state. Used for Address Verification (AVS). Not required if using a CardToken.

Credit card number.

Reference to the entity that represents real-time financial transaction.

Your Spindle CID. This will be assigned to you.

Returns the address verification result code if the merchant is setup for CV verification.

Identifier of the object used for references; auto-incremented integer value.

Your invoice number or identifying number to identify transaction. InvoiceNumber must be passed for all eCommerce or web based transactions.

Code of Merchant Account to which instance of this object is attributed to.
Depending on the context, Merchant Account Code field may contain either Merchant Code or Merchant Account Code.

The field is primarily used for data partitioning and data management, to make it easy to determine the ownership of a record within the database.

The name that is stored with this card in the vault. This is required if TrackData is not sent. Not required if using a CardToken.

The dollar amount that was refunded.

Authorization Code returned from the processing bank.

The receipt number for this SID. This number will increment by 1 for each transaction that is processed from this SID.

The status code of the transaction.
0 = Declined
1 = Approved
2 = Error

Detailed message of the status code sent back through the response.

The TransactionID of this sale request.

Reference to the entity that represents a group of real-time transactions which must be settled together.

Your Spindle SID. This will be assigned to you. SID must be stored internally from the calling web/terminal/mobile device for later use. SID must be passed at all times.

A value respresnting a tax amount. TaxAmount should be included in the Amount listed above. (ex. TipAmount + TaxAmount + ItemAmounts = Amount).

A value representing a tip amount. TipAmount should be included in the Amount listed above (ex. TipAmount + TaxAmount + ItemAmounts = Amount)

Type of held transaction (authorize, sale, capture, void, etc.).