Charge Transaction UML

Base object for transactions of type Sale. During Sale transaction money is transferred from a customer to a merchant.

When transaction is associated with a credit card, the field contains card's expiration date.
When transaction is associated with a bank account, the field contains account's routing number.

Masked version of the accessory (expiration date or routing number) associated with the transaction.

For expiration date, the mask is produced using last 2 digits (**12), for routing numbers the mask is produced using last 4 digits (****3452).

Updated accessory (expiration date or routing number) for the payment option (credit card or bank account) used in this transaction.

Updated information for credit cards comes from credit card account updater (a service provided by most Providers).

Updated information for bank accounts comes from the Federal Reserve as notices within ACH returns.

Masked version of the updated accessory (expiration date or routing number).

For expiration date, the mask is produced using last 2 digits (**12), for routing numbers the mask is produced using last 4 digits (****3452).

Updated information for credit cards comes from credit card account updater (a service provided by most Providers).

Updated information for bank accounts comes from the Federal Reserve as notices within ACH returns.

Represents the type of the account (e.g. credit card or bank account) associated with the transaction.

Updated account type for the payment option (credit card or bank account) used in this transaction.

Updated information for credit cards comes from credit card account updater (a service provided by most Providers).

Updated information for bank accounts comes from the Federal Reserve as notices within ACH returns.

Changes in account type are extremely rare and this field is kept mostly for consistency and convenience.

Account data assigned to the record represented in encrypted state.

Represents the level of transaction processing that is used.

Setting the value affects the interchange rate for the transaction. Depending on the transaction level, various fields become required.

When Tokenization is not available and encryption is allowed on the server, the field contains encrypted credit card number or bank account number.
When Tokenization is not properly configured and encryption is not allowed on the server, transactions with sensitive data will fail and will not be processed and persisted.

First four digits of the account number. Used to serve as an account identifier, when full account number is not available.

Last four digits of the account number.

Used to serve as an account identifier, when full account number is not available.

Masked version of the account number (credit card or bank account) associated with this transaction. The mask is formed by using the first and last digits of the account.

For example, 4********5655.

When Tokenization is not available and encryption is allowed on the server, the field contains updated account number for the payment option (credit card or bank account) used in this transaction.

Updated information for credit cards comes from credit card account updater (a service provided by most Providers).

Updated information for bank accounts comes from the Federal Reserve as notices within ACH returns.

Note: if encryption is not allowed on the server and tokenization is not properly configured, transactions will fail and will not be either processed or persisted.

Last four digits of the updated account number for the payment option (credit card or bank account) used in this transaction.

Updated information for credit cards comes from credit card account updater (a service provided by most Providers).

Updated information for bank accounts comes from the Federal Reserve as notices within ACH returns.

Masked version of the updated account number (credit card or bank account). The mask is formed by using the first and last digits of the account. For example, 4********5655.

Updated information for credit cards comes from credit card account updater (a service provided by most Providers).

Updated information for bank accounts comes from the Federal Reserve as notices within ACH returns.

Account profile associated with the merchant.

Represents the type of payment, which is used for the transaction.

Address associated with a payment card or bank account holder.
The value is a concatenation of the street, city, state, zipCode, countryCode field values separated by commas (,).

Reference to the entity that represents aggregate transaction.

Total amount of the transactions including discount and tax. The amount element defines the amount of the transaction. Supply the value in cents without a decimal point.

Authorization code returned by a Provider that approved this transaction.

In some instances might also be used to store response code returned by Provider when transaction declines.

The total of assessment fees charged by an association for processing/settlement of the transaction.

Time period during which an unconfirmed authorization is going to survive settlement process. If transaction remains unconfirmed after that period, it will be reversed.

Unique per-transaction value for identifying 3-D secure operation, sometimes referred to as XID. What is it?

Represents current authentication statuse. (Indicates the result of 3D Secure verification process. What is it?).

Reference to the entity that represents authentication of the 3D Secure verification.

Value that is to be validated during the authentication.

Represents code of the currency used in the authorization transaction.

Address verification response code returned by Provider for this transaction based on the billing address supplied for transaction processing.

For credit cards only. If supported by a Provider, contains remaining balance on the credit card returned during the authorization process.

Used primarily for debit cards and gift cards. May not always be available.

Remaining food stamp balance on the EBT card.

Reference to bank info object that provides additional insight into the type of the payment option used in this transaction.

The type of Billing Profile.

For credit cards only, hashed (using SHA1 with salt and 10 iterations), first 6 digits of the account number.

The value is kept to lookup original transaction when a charge-back arrives, as some Providers do not provide any reference number for the original transaction and the look up is done using transaction date, amount and the first 6 digits of the account number.

For credit cards only, hashed (using SHA1 with salt and 10 iterations), first 6 digits of the updated account number.

The value is kept to lookup original transaction when a charge-back arrives, as some Providers do not provide any reference number for the original transaction and the look up is done using transaction date, amount and the first 6 digits of the account number.

Updated information for credit cards comes from credit card account updater (a service provided by most Providers).

Updated information for bank accounts comes from the Federal Reserve as notices within ACH returns.

Represents code of the currency used for capture transactions.

Amount of money, returned to a customer upon "Sale with Cashback" transaction.

Reference to the entity that represent charge transaction addenda.

Reference to the entity that represents charge trasnsaction distribution information.

Reference to the entity that represents charge transaction tag data.

Reference to a chargeback transaction representing either initial chargeback (for credit cards) or ACH return (for bank accounts).

If not chargeback/return came in, the field is not set.

The field is primarily used to quickly identify transactions that have chargebacks/returns.

Reference to the entity that represents various information about check images.

For ACH transactions only. When ACH transaction is produced based on a singed check, the check number can be stored in this field.

City of the billing address.

The host or IP-address of a client that originated the transaction through some action (such as on-line purchase) in the external submitting system (which then issued direct request to the gateway).

Subcomponent of healthcare amount, which indicates the amount of money, spent on hospitalization.

Acquirer designated standardized code that classifies the group of items associated with this order/transaction.

Represents current type of confirmation.

Log of the confirmations.

Country code of the billing address.

Indicates whether current transaction is a sale transaction or a credit transaction.

If false, this is a sale transaction and money is transferred from the customer to the Merchant.

If true, this is a credit transaction and money is transferred from the Merchant to the customer.

CVV2/CSC code of the credit card.

Type of the CVV2/CSC indicator.

CVV2/CSC verification response code.

Represents code of currency used in the transaction.

Value from the transaction submitter's system.

It is used to assign submitter's specific customer (owner) code to the transaction, to identify in the future the ownership of the transaction and to be able to cross reference the value between two systems.

Usually, the value will contain a reference to an record representing an owner of the transaction in the submitter's front-end system.

The internal identifier of customer's account from the submitter.

VAT registration number of the customer responsible for this transaction.

Represents the type of debit account.

Subcomponent of healthcare amount, which indicates the amount of money, spent on dental medical services.

Date when deposit amount was applied.

Represents the type of derivative transaction.

Dynamic description of a transaction. Appears on a statement and can be customized to simplify understanding of charge for a cardholder. The feature is available for selected processors and not supported by all.

Amount of the total discount applied on this order/transaction.

The value is stored in cents.

For example:

100 = $1
1 = 1 cent

The number of the driver license.

State of the driver license.

Unique identifier of the driver.

PIN Debit only. Temporary key that the pin code gets encrypted with. What is it?

Amount of duty (import tax) charged on the order/transaction.

The value is stored in cents.

For example:

100 = $1
1 = 1 cent

Contact email of the account holder.

Specific identifier. Assigned by s processor.

Represents the way the card info is entered to originate a transaction.

Represents current entry medium type.

Represents current entry mode type.

Represents current entry PIN mode type.

For ACH transactions only. Expected effective date of the transaction under normal processing.

Processing fee amount that should be charged to Merchant for processing of this transaction. Process fee amount is included in the total transaction Amount.

Name of the account holder, assosiated with this transaction.

It is also used as first name of the billing address.

Date when funding occurs.

For Gift Cards only. One-sided hash of an account number that can be used for lookup.

Component of total amount of a transaction, which indicates the amount of money, spent on healthcare-related services.

Date of birth of the cardholder.

Name of a payment card or bank account holder.
The value is a concatenation of the firstName and lastName field values separated by a space ( ).

For ACH primarily. New name on the account, based on the results of either Credit Card Account Updater or ACH Notice of Change transaction.

Represents current type of holder verification mode.

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

Represents the type of identity verification.

Value that is to be validated during the identification.

Amount of the incremented value.

Initial authorized amount of the transaction.

The column is calculated using the following formula:

Interchange Percentage Fee 4p + Interchange Flat Fee4p = Interchange Fee Amount4p

Flat fee charged on a transaction by an association for processing of the card.

Percentage fee, charged of a total transaction amount by an association for processing of the card.

The name of the interchange rate that this transaction is qualified.

Indicates whether the account data of the merchant is encrypted.

Indicates whether type of the card is ignored by TidyPay and identification of the card type is made on a processor's side.

Indicates whether the transaction type is aggregate.

Indicates whether AVS verification is enabled.

The field is no longer used and is scheduled for deletion.

Indicates whether the transaction is done on a commercial card.

Indicates whether the transaction is confirmed.

Indicates whether CSC verification is enabled.

Indicates whether this transaction is classified as an interregional transaction and thus will carry a cross-border assessment fee.

Identifies whether the account holder is a person or a corporate entity.

When set to true, the account holder is assumed to be an organization and not an individual.

For credit cards only. Indicates whether partial authorization is allowed on this transaction.

If the value is set to 1/true, the transaction will get approved even if the amount of funds available on the credit card is below than the requested transaction amount.

If the value is set to 0/false, the transaction will get approved only if the exact requested amount is available on the credit card.

Note: not all Provider's support partial authorization feature.

Indicates whether a card used for the transaction is prepaid.

Indicates whether Account Number field contains a real account number or a proxy. For real-time transactions only.

A proxy is a temporary token (see Tokenization) that replaces credit card number during the processing of the transaction. It used for some Providers to avoid tokenization costs for one-time transaction (when account number's persistence is not required).

Indicates whether decline reprocessing mechanism is enabled or not.

Marks transaction as a return. A return transaction is an additional response to a transaction that was previously processed by a Merchant. Generally, the merchant has already processed a response for this transaction and thus return serves as a kind of update to the earlier response.

When value is set to 1/true, the transaction is classified as return and will be sent to the submitter as an update. When value is set to 0/false, the transaction is not considered a return and no additional update action is taken.

Chargebacks, reversals, ACH returns and results of rebill process (approvals or declines) are all classified as returns.

Indicates whether tokenization is enabled.

Indicates whether the IIAS is verified.

Value from the transaction submitter's system.

It is used to assign submitter's specific merchandise code (SKEW#, Bar Code, etc) to the transaction, to identify in the future the reason why this transaction was processed.

Usually, the value will contain a reference to a catalog item for which the payment is collected and is, therefore, only applicable in cases when a payment is collected for a single item.

Content of the keys associated with the record.

Lane number associated with the transaction (when applicable).

Last name of the account holder, for the account used to generated this transaction.

It is also used as last name of the billing address.

Amount of local (city, count, etc) tax charged on the order/transaction.

The value in database is stored in cents.

For example:

$1 = 100

Indicates whether tax information about local tax is provided for this transaction.

Represents the type of lodging charge.

The date of actual or anticipated check-in.

The date of actual or anticipated check-out.

Additional amount charged after cardholder left the hotel. Usually shown in cents.

Indicates length of anticipated, actual, or incremental stay.

Hotel folio number.

Hotel room number.

Daily room rate. Usually shown in cents.

Tax charged on daily rate. Usually shown in cents.

Represents the type of lodging special program.

For system use only; Log of events that occurred in association with this transaction.

Value of the merchant account code.

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.

Amount of national/federal tax charged on the order/transaction.

The value is stored in cents.

For example:

100 = $1
1 = 1 cent

Indicates whether or not tax information about national tax is provided for this transaction.

Net settled amount of the transaction.

Reference to the entity that represents NOC (Notice of Change) transaction.

Odometr reading indicating the distance travelled by a vehicle.

Unique identifier assigned to the order associated with this transaction in submitter's/merchant's front-end/inventory system.

If value is not provided, Transaction Code is used in its place.

Date when the order associated with the transaction was placed. The date might be different from the transaction's request date.

For credit cards only. Original amount of the transaction. In most cases, Original Amount and Amount fields will match.

In case of partial authorizations, however, original amount will contain the originally requested amount of the transaction, while Amount field will contain the amount of money available on the card (usually occurs when debit cards or gift cards are involved).

Original reference number of the provider.

Reference number of the original transaction that this transaction adjusts.

Reference to the retail cycle within which original authorization for this transaction was made.

The value only makes sense within a context of a transaction, which outlives a retail cycle in which it was authorized. It happens when there is a business need to authorize a transaction on day 1, but not settle it until day 2 or later.

The code of the original sub-batch transaction.

Reference to the entity that represents original transaction information.

Amount that remained in the original transaction after the processing.

The network through which the transaction was processed

Payment option selected by a payment card or bank account holder.
The value is based on the accountCl field value.

Flat fee charged on the transaction by the third party processor (gateway owner) for processing of the transaction.

Represents the type of petroleum products provided for the merchant.

Code of the petroleum product.

Quantity of the petroleum product.

Cost amount of the one petroleum unit.

Represents the type of petroleum products provided to the merchant.

Code of the petroleum product.

Quantity of the petroleum product.

Cost amount of the one petroleum unit.

Represents the type of petroleum products provided to the merchant.

Code of the petroleum product.

Quantity of the petroleum product.

Cost amount of the one petroleum unit.

Represents the type of petroleum products provided to the merchant.

Code of the petroleum product.

Quantity of the petroleum product.

Cost amount of the one petroleum unit.

Billing phone or contact phone of the account holder.

For PIN debit transaction only, this field contains encrypted PIN code of the card.

Note: the field is transient and is not present in the database

Subcomponent of healthcare amount, which indicates the amount of money, spent on prescription drugs.

The column is calculated using the following formula:

Interchange Fee Amount4p + Processor Fee Amount4p + Assessments Fee Amount4p = Processing Cost Amount4p

Surcharge that is charged as a percentage of the transaction total by the third party processor (gateway owner) for processing of the transaction.

Code of the processing group.

Reference to the base object representing Provider specific merchant account. Encapsulates all information necessary to identify a merchant in Provider's system. Billing Profile may also contain configuration values defining system's behavior for this specific configuration.

Sub-batch code of the transaction.

Flat fee charged by the processor for processing of a transaction.

Response from the processor of the transaction.

Original provider's AVS Response Code.

Original provider's CSC Response Code.

Represents the type of provider operation, used for the transaction.

Returns reference number of underlying provider.

Response code returns by the underlying processor/bank.

Message returned by Provider in response to this transaction.

Transaction code of the provider.

Reference to a transaction identifier associated with a low-level database table within the gateway.

Identifier of a transaction returned from the processor's system.

Indicates the number of retries that have already been made on this transaction. See Transaction Reprocessing for additional information.

Any additional notes on the receipt.

Reference to the entity that represents refund transaction.

Amount remaining after the transaction.

Date when remittance occurs.

Date when transaction was sent to Provider for processing.

Host address of the request.

Type of the request.

Gateway generated response code.

Date of the response.

Gateway generated response message.

Amount of retry fee applied to this transaction if any. See Transaction Reprocessing for additional information.

For credit cards only. Reference to a chargeback transaction representing reversal of the initial chargeback that was received and processed earlier.

If no reversal came in, the field is not set.

The field is primarily used to quickly identify transactions that have reversals on the previously posted chargebacks.

Amount of the currency that is used for reward calculation.

Amount of reward points on the credit card or bank account.

For credit cards only. Reference to a chargeback transaction representing arbitration chargeback (usually second in the chargeback handling system) that was received and processed earlier.

If no reversal came in, the field is not set.

The field is primarily used to quickly identify transactions that have reversals on the previously posted chargebacks.

For credit cards only. Reference to a chargeback transaction representing reversal of the arbitration chargeback (usually second in the chargeback handling process) that was received and processed earlier.

If no reversal came in, the field is not set.

The field is primarily used to quickly identify transactions that have reversals on the previously posted chargebacks.

For credit cards only, when Installment industry type is used and the transaction is one of a series of recurring transactions, the field contains the total number of payments that the card holder has to make.

For example, if a customer has to make 12 payments for his membership dues, the value should be 12.

Setting the value affects the interchange rate for the transaction.

For credit cards only, when Recurring or Installment industry type is used and the transaction is one of a series of recurring transactions, the field contains the sequence number of the transaction.

For example, if a customer has to make 12 payments for his membership dues, and the current transaction is number 3, the sequence number should be set to 3.

Setting the value affects the interchange rate for the transaction.

The next three digits after expiration date on the credit card (in thack 1 data nad track 2 data).

Identifies geographic/service availability. Required for Visa/MasterCard keyed transactions.

Amount of the settlement transaction.

Indicates delay of settlement transaction.
For more detailed information, please, reffer to the provider specification.

For real-time transactions only. The code of the settlement group that the transaction belongs to (if any).

At the time when a Retail Transaction Cycle gets closed, all transactions in the group will either get settled or will get voided. If any single transaction in the group is either voided or unconfirmed, the entire group gets voided.

For more information, please see Integration Specification on settlement group.

Amount of shipping and handling fees charged for the delivery of the order associated with the transaction.

The value is stored in cents.

For example:

100 = $1
1 = 1 cent

City of the shipping address associated with the order/transaction

Country code of the shipping address associated with the transaction/order.

Date of the shipping.

First name of the person in the shipping address associated with the order/transaction

Last name of the person in the shipping address associated with the order/transaction

ZIP code of the address from which a shipment for the order/transaction is done.

State of the shipping address associated with the order/transaction

Street of the shipping address associated with the order/transaction

ZIP code of the shipping address associated with the order/transaction.

Reference to the entity that represents signature transaction resource information.

Reference to the entity that represents information about an original transaction that is split among several recipients.

Number of split-in and split-out transactions associated with an original transaction.

Collection of sub-records associated with the split transaction.

Value associated with structural analysis database.

State of the billing address.

Street of the billing address.

Both Street 1 line and Street 2 line are combined in this field.

Represents the selected type of submission.

Code of the subscription transaction.

Reference to the entity that represents subscription transaction.

Amount of tax charged as part of this transaction. The value is included in the total transaction Amount.

Indicates whether tax information is provided for this transaction.

When separate VAT invoice is produced within the context of the order, unique identifier of this invoice.

Total tax rate charged (if any) on the order/transaction.