UniPay Auth Retail Transaction UML

Added On: 09/13/16

SQL Table: UNI_PAY_AUTH_RETAIL_TRANSACTION

Module: UniCharge

Type: Entity Status: Active

Java Class: UniPayAuthRetailTransaction

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

Available Fields:

Account Data
Account Number
Account Type
Amount
AVS Response Code
Charge Transaction FK
CSC Response Code
Descriptor
Error Code
Error Message
Exception Cause
Exception Field
Exception Format
Exception Hint
Exception Level
Exception Processor
Exception Value
Failed Request Type
Failure Code
Failure Message
Holder Name

Holder Type
Id
Is Partial Authorization
Merchant Account Code
Password
Provider AVS Response Code
Provider CSC Response Code
Provider Merchant Account Code
Provider Response Code
Provider Response Message
Receipt Tag Data
Reference Number
Request Type
Response Account Accessory
Response Amount
Response Approval Code
Response Balance
Response Cashback Amount
Response Code
Response Cycle Code
Response EBT Cash Benefit Balance

Response EBT Food Stamp Balance
Response Extended Account Type
Response Fee Amount
Response Message
Response Network Transaction Id
Response Original Amount
Response Provider Reference Number
Response Reference Number
Response Remaining Amount
Response Token
Response Transaction Date
Response Type
Retail Transaction Cycle FK
Shipping Name
Split Schema FK
Tip Amount
Token
Transaction Code
Transaction Date
Transaction Industry Type
Transaction Mode Type

User Name
Warning Code

Account Data

Added On: 09/13/16

SQL Column:

Java Field: accountData

Status: Active

SQL Type:

Java Type: String

Attributes: Transient

Information about the account associated with transaction.

Account Number

Added On: 09/21/16

SQL Column:

Java Field: accountNumber

Status: Active

SQL Type:

Java Type: String

Attributes: Transient

Number of the account associated with transaction.

Account Type

Added On: 09/13/16

SQL Column: ACCOUNT_TYPE

Java Field: accountType

Status: Active

SQL Type: varchar(1)

Java Type: String

Attributes:

Reference to the entity that represents enumeration of possible account types available in the system.

Amount

Added On: 09/13/16

SQL Column: AMOUNT

Java Field: amount

Status: Active

SQL Type: int(11)

Java Type: Integer

Attributes:

Amount included in the transaction.

AVS Response Code

Added On: 09/13/16

SQL Column: AVS_RESPONSE_CODE

Java Field: avsResponseCode

Status: Active

SQL Type: varchar(2)

Java Type: String

Attributes:

AVS response code generated by the gateway.

Charge Transaction FK

Added On: 09/13/16

SQL Column: CHARGE_TRANSACTION_FK

Java Field: chargeTransaction

Status: Active

SQL Type: bigint(20)

Java Type: Long

References Charge Transaction

Attributes:

Reference to the entity that represents base object for sale transactions.

CSC Response Code

Added On: 09/13/16

SQL Column: CSC_RESPONSE_CODE

Java Field: cscResponseCode

Status: Active

SQL Type: varchar(1)

Java Type: String

Attributes:

CSC response code generated by the gateway.

Descriptor

Added On: 09/13/16

SQL Column: DESCRIPTOR

Java Field: descriptor

Status: Active

SQL Type: varchar(30)

Java Type: String

Attributes:

Dynamic description of a transaction that appears on a statement and can be customized to simplify understanding of charge for a cardholder.

Error Code

Added On: 09/13/16

SQL Column: ERROR_CODE

Java Field: errorCode

Status: Active

SQL Type: varchar(3)

Java Type: String

Attributes:

Error code generated by the system.

Error Message

Added On: 09/13/16

SQL Column: ERROR_MESSAGE

Java Field: errorMessage

Status: Active

SQL Type: varchar(255)

Java Type: String

Attributes:

Error message generated by the system.

Exception Cause

Added On: 09/13/16

SQL Column: EXCEPTION_CAUSE

Java Field: exceptionCause

Status: Active

SQL Type: varchar(40)

Java Type: String

Attributes:

Cause of the exception that occurred within the system.

Exception Field

Added On: 09/13/16

SQL Column: EXCEPTION_FIELD

Java Field: exceptionField

Status: Active

SQL Type: varchar(40)

Java Type: String

Attributes:

Field that caused exception error.

Exception Format

Added On: 09/13/16

SQL Column: EXCEPTION_FORMAT

Java Field: exceptionFormat

Status: Active

SQL Type: varchar(255)

Java Type: String

Attributes:

Additional information about formatting exception occurred.

Exception Hint

Added On: 09/13/16

SQL Column: EXCEPTION_HINT

Java Field: exceptionHint

Status: Active

SQL Type: varchar(255)

Java Type: String

Attributes:

Hint field that is received in exception response.

Exception Level

Added On: 09/13/16

SQL Column: EXCEPTION_LEVEL

Java Field: exceptionLevel

Status: Active

SQL Type: varchar(10)

Java Type: String

Attributes:

Place where the exception error occurred.

Exception Processor

Added On: 09/13/16

SQL Column: EXCEPTION_PROCESSOR

Java Field: exceptionProcessor

Status: Active

SQL Type: varchar(60)

Java Type: String

Attributes:

Processor associated with exception error.

Exception Value

Added On: 09/13/16

SQL Column: EXCEPTION_VALUE

Java Field: exceptionValue

Status: Active

SQL Type: varchar(255)

Java Type: String

Attributes:

Code value of the exception error.

Failed Request Type

Added On: 09/13/16

SQL Column: FAILED_REQUEST_TYPE

Java Field: failedRequestType

Status: Active

SQL Type: varchar(22)

Java Type: String

Attributes:

Type of the failed request.

Failure Code

Added On: 09/13/16

SQL Column: FAILURE_CODE

Java Field: failureCode

Status: Active

SQL Type: varchar(3)

Java Type: String

Attributes:

Failure code generated by the system that indicates a type of the error occured.

Failure Message

Added On: 09/13/16

SQL Column: FAILURE_MESSAGE

Java Field: failureMessage

Status: Active

SQL Type: varchar(255)

Java Type: String

Attributes:

Failure message generated by the system that represents the information about failure occured.

Holder Name

Added On: 09/13/16

SQL Column: HOLDER_NAME

Java Field: holderName

Status: Active

SQL Type: varchar(150)

Java Type: String

Attributes:

Name of the person represented as a holder.

Holder Type

Added On: 09/13/16

SQL Column: HOLDER_TYPE

Java Field: holderType

Status: Active

SQL Type: varchar(1)

Java Type: String

Attributes:

Type of the holder.

Added On: 09/13/16

SQL Column: ID

Java Field: id

Status: Active

SQL Type: bigint(20)

Java Type: Long

Identifier / Primary Key

Attributes: Unique, Required, CreateOnly, ReadOnly

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

Is Partial Authorization

Added On: 09/23/16

SQL Column: IS_PARTIAL_AUTHORIZATION

Java Field: isPartialAuthorization

Status: Active

SQL Type: varchar(1)

Java Type: String

Attributes:

Indicates whether partial authorization is enabled.

Merchant Account Code

Added On: 09/13/16

SQL Column: MERCHANT_ACCOUNT_CODE

Java Field: merchantAccountCode

Status: Active

SQL Type: int(11)

Java Type: Integer

Attributes: Required

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.

Password

Added On: 09/13/16

SQL Column:

Java Field: password

Status: Active

SQL Type:

Java Type: String

Attributes: Transient

Password used by a merchant to log in the system.

Provider AVS Response Code

Added On: 09/13/16

SQL Column: PROVIDER_AVS_RESPONSE_CODE

Java Field: providerAvsResponseCode

Status: Active

SQL Type: varchar(20)

Java Type: String

Attributes:

AVS response code generated by the processor's system.

Provider CSC Response Code

Added On: 09/13/16

SQL Column: PROVIDER_CSC_RESPONSE_CODE

Java Field: providerCscResponseCode

Status: Active

SQL Type: varchar(20)

Java Type: String

Attributes:

CSC response code generated by the processor's system.

Provider Merchant Account Code

Added On: 09/13/16

SQL Column: PROVIDER_MERCHANT_ACCOUNT_CODE

Java Field: providerMerchantAccountCode

Status: Active

SQL Type: int(11)

Java Type: Integer

Attributes:

Code of Merchant Account to which instance of this object is attributed to. Assigned by a service provider. 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.

Provider Response Code

Added On: 09/13/16

SQL Column: PROVIDER_RESPONSE_CODE

Java Field: providerResponseCode

Status: Active

SQL Type: varchar(20)

Java Type: String

Attributes:

Response code generated by the processor's system.

Provider Response Message

Added On: 09/13/16

SQL Column: PROVIDER_RESPONSE_MESSAGE

Java Field: providerResponseMessage

Status: Active

SQL Type: varchar(255)

Java Type: String

Attributes:

Response message generated by the processor's system.

Receipt Tag Data

Added On: 02/08/19

SQL Column: RECEIPT_TAG_DATA

Java Field: receiptTagData

Status: Active

SQL Type: varchar(35)

Java Type: String

Attributes: Transient

Reference Number

Added On: 09/21/16

SQL Column: REFERENCE_NUMBER

Java Field: referenceNumber

Status: Active

SQL Type: varchar(17)

Java Type: String

Attributes:

Identifier which can be used to cross-reference records between UniPay and integrated systems.

Request Type

Added On: 09/13/16

SQL Column: REQUEST_TYPE

Java Field: requestType

Status: Active

SQL Type: varchar(22)

Java Type: String

Attributes:

Type of the request message included in the transaction.

Response Account Accessory

Added On: 09/26/16

SQL Column: RESPONSE_ACCOUNT_ACCESSORY

Java Field: responseAccountAccessory

Status: Active

SQL Type: varchar(10)

Java Type: String

Attributes:

Accessory data that is included in response associated with transaction.

Response Amount

Added On: 09/13/16

SQL Column: RESPONSE_AMOUNT

Java Field: responseAmount

Status: Active

SQL Type: varchar(11)

Java Type: String

Attributes:

Amount included in the response file.

Response Approval Code

Added On: 09/13/16

SQL Column: RESPONSE_APPROVAL_CODE

Java Field: responseApprovalCode

Status: Active

SQL Type: varchar(100)

Java Type: String

Attributes:

Code of the response approval.

Response Balance

Added On: 09/13/16

SQL Column: RESPONSE_BALANCE

Java Field: responseBalance

Status: Active

SQL Type: varchar(11)

Java Type: String

Attributes:

Balance value of the response file.

Response Cashback Amount

Added On: 09/13/16

SQL Column: RESPONSE_CASHBACK_AMOUNT

Java Field: responseCashbackAmount

Status: Active

SQL Type: varchar(11)

Java Type: String

Attributes:

Cashback amount included in the response file.

Response Code

Added On: 09/13/16

SQL Column: RESPONSE_CODE

Java Field: responseCode

Status: Active

SQL Type: varchar(5)

Java Type: String

Attributes:

Response code generated by the system.

Response Cycle Code

Added On: 09/13/16

SQL Column: RESPONSE_CYCLE_CODE

Java Field: responseCycleCode

Status: Active

SQL Type: varchar(17)

Java Type: String

Attributes:

Specific response code generated by the system.

Response EBT Cash Benefit Balance

Added On: 09/13/16

SQL Column: RESPONSE_EBT_CASH_BENEFIT_BALANCE

Java Field: responseEbtCashBenefitBalance

Status: Active

SQL Type: varchar(11)

Java Type: String

Attributes:

Balance value of EBT Cash Benefit account included in response file.

Response EBT Food Stamp Balance

Added On: 09/13/16

SQL Column: RESPONSE_EBT_FOOD_STAMP_BALANCE

Java Field: responseEbtFoodStampBalance

Status: Active

SQL Type: varchar(11)

Java Type: String

Attributes:

Balance value of EBT Food Stamp account included in response file.

Response Extended Account Type

Added On: 09/13/16

SQL Column: RESPONSE_EXTENDED_ACCOUNT_TYPE

Java Field: responseExtendedAccountType

Status: Active

SQL Type: varchar(2)

Java Type: String

Attributes:

Extended information about account type, included in response, associated with transaction.

Response Fee Amount

Added On: 09/26/16

SQL Column: RESPONSE_FEE_AMOUNT

Java Field: responseFeeAmount

Status: Active

SQL Type: varchar(11)

Java Type: String

Attributes:

Fee amount included in response.

Response Message

Added On: 09/13/16

SQL Column: RESPONSE_MESSAGE

Java Field: responseMessage

Status: Active

SQL Type: varchar(255)

Java Type: String

Attributes:

Response message generated by the gateway.

Response Network Transaction Id

Added On: 12/12/18

SQL Column: RESPONSE_NETWORK_TRANSACTION_ID

Java Field: responseNetworkTransactionId

Status: Active

SQL Type: varchar(30)

Java Type: String

Attributes:

Response Original Amount

Added On: 09/13/16

SQL Column: RESPONSE_ORIGINAL_AMOUNT

Java Field: responseOriginalAmount

Status: Active

SQL Type: varchar(11)

Java Type: String

Attributes:

Original amount of the transaction included in response.

Response Provider Reference Number

Added On: 09/13/16

SQL Column: RESPONSE_PROVIDER_REFERENCE_NUMBER

Java Field: responseProviderReferenceNumber

Status: Active

SQL Type: varchar(50)

Java Type: String

Attributes:

Secondary identifier of the provider of response which can be used to cross-reference records between UniPay and integrated systems.

Response Reference Number

Added On: 09/13/16

SQL Column: RESPONSE_REFERENCE_NUMBER

Java Field: responseReferenceNumber

Status: Active

SQL Type: varchar(17)

Java Type: String

Attributes:

Secondary identifier of the response which can be used to cross-reference records between UniPay and integrated systems.

Response Remaining Amount

Added On: 09/26/16

SQL Column: RESPONSE_REMAINING_AMOUNT

Java Field: responseRemainingAmount

Status: Active

SQL Type: varchar(11)

Java Type: String

Attributes:

Amount of the remaining funds included in response.

Response Token

Added On: 09/13/16

SQL Column: RESPONSE_TOKEN

Java Field: responseToken

Status: Active

SQL Type: varchar(50)

Java Type: String

Attributes:

Token value replacing response code.

Response Transaction Date

Added On: 09/13/16

SQL Column: RESPONSE_TRANSACTION_DATE

Java Field: responseTransactionDate

Status: Active

SQL Type: varchar(8)

Java Type: String

Attributes:

Date when the transaction response was generated.

Response Type

Added On: 09/13/16

SQL Column: RESPONSE_TYPE

Java Field: responseType

Status: Active

SQL Type: varchar(22)

Java Type: String

Attributes:

Type of the response generated by the system.

Retail Transaction Cycle FK

Added On: 09/13/16

SQL Column: RETAIL_TRANSACTION_CYCLE_FK

Java Field: retailTransactionCycle

Status: Active

SQL Type: bigint(20)

Java Type: Long

References Retail Transaction Cycle

Attributes:

Reference to the entity that represents a group of realtime transactions that are to be settled together.

Shipping Name

Added On: 09/13/16

SQL Column: SHIPPING_NAME

Java Field: shippingName

Status: Active

SQL Type: varchar(100)

Java Type: String

Attributes:

Shipping name associated with transaction.

Split Schema FK

Added On: 04/21/17

SQL Column: SPLIT_SCHEMA_FK

Java Field: splitSchema

Status: Active

SQL Type: bigint(20)

Java Type: Long

References Split Schema

Attributes:

Tip Amount

Added On: 09/13/16

SQL Column: TIP_AMOUNT

Java Field: tipAmount

Status: Active

SQL Type: int(11)

Java Type: Integer

Attributes:

Amount of the tip included in the transaction.

Token

Added On: 09/23/16

SQL Column: TOKEN

Java Field: token

Status: Active

SQL Type: varchar(50)

Java Type: String

Attributes:

Token associated with the transaction.

Transaction Code

Added On: 09/21/16

SQL Column: TRANSACTION_CODE

Java Field: transactionCode

Status: Active

SQL Type: varchar(60)

Java Type: String

Attributes:

Code of the transaction within the system.

Transaction Date

Added On: 09/26/16

SQL Column: TRANSACTION_DATE

Java Field: transactionDate

Status: Active

SQL Type: varchar(14)

Java Type: String

Attributes:

Date when the transaction was processed.

Transaction Industry Type

Added On: 09/13/16

SQL Column: TRANSACTION_INDUSTRY_TYPE

Java Field: transactionIndustryType

Status: Active

SQL Type: varchar(2)

Java Type: String

Attributes:

Type of the industry the transaction is assigned to.

Transaction Mode Type

Added On: 09/13/16

SQL Column: TRANSACTION_MODE_TYPE

Java Field: transactionModeType

Status: Active

SQL Type: varchar(1)

Java Type: String

Attributes:

Code that identifies the transaction mode of the respective transaction.

User Name

Added On: 09/13/16

SQL Column:

Java Field: userName

Status: Active

SQL Type:

Java Type: String

Attributes: Transient

Name used by a merchant to log in the system.

Warning Code

Added On: 09/13/16

SQL Column: WARNING_CODE

Java Field: warningCode

Status: Active

SQL Type: varchar(11)

Java Type: String

Attributes:

Warning code generated by the system.