MiGS Auth Retail Transaction UML
Added On: 03/10/14
Module: UniCharge
Type: Entity
Status: Active
Java Class: MigsAuthRetailTransaction
MiGS specific low-level representation of Retail Transaction produced by Forward Transformation Process within Authorization Process.
During Generation Process, MiGS specific interchange message is generated from this object for authorization. Consequently, all fields of the object are mapped into message segments/elements.
Added On: 03/10/14
SQL Column: CHARGE_TRANSACTION_FK
Java Field: chargeTransaction
Status: Active
SQL Type: bigint(20)
Java Type: Long
Reference to the entity that represents real-time financial transaction.
Added On: 03/10/14
SQL Column: ID
Java Field: id
Status: Active
SQL Type: bigint(20)
Java Type: Long
Attributes:
Unique, Required, CreateOnly, ReadOnly
Identifier of the object used for references; auto-incremented integer value.
Added On: 03/10/14
SQL Column: MERCHANT_ACCOUNT_CODE
Java Field: merchantAccountCode
Status: Active
SQL Type: int(11)
Java Type: Integer
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.
Added On: 03/10/14
SQL Column: RETAIL_TRANSACTION_CYCLE_FK
Java Field: retailTransactionCycle
Status: Active
SQL Type: bigint(20)
Java Type: Long
Reference to the entity that represents a group of real-time transactions which must be settled together.
Added On: 03/10/14
SQL Column: VPC_ACCESS_CODE
Java Field: vpcAccessCode
Status: Active
SQL Type: varchar(8)
Java Type: String
Identifier that is used to authenticate you as the merchant while you are using the Virtual Payment Client. Generated and allocated to you by the Payment Server.
Added On: 03/10/14
SQL Column: VPC_ACQ_C_S_C_RESP_CODE
Java Field: vpcAcqCSCRespCode
Status: Active
SQL Type: varchar(1)
Java Type: String
The response code generated by the Issuing Bank in relation to the Card Security Code.
Added On: 03/10/14
SQL Column: VPC_ACQ_RESPONSE_CODE
Java Field: vpcAcqResponseCode
Status: Active
SQL Type: varchar(3)
Java Type: String
Acquirer's Response Code is generated by the financial institution to indicate the status of the transaction.
Added On: 03/10/14
SQL Column: VPC_AMOUNT
Java Field: vpcAmount
Status: Active
SQL Type: int(11)
Java Type: Integer
The amount of the transaction in the smallest currency unit expressed as an integer.
Added On: 03/10/14
SQL Column: VPC_AUTHORISED_AMOUNT
Java Field: vpcAuthorisedAmount
Status: Active
SQL Type: int(11)
Java Type: Integer
The total amount of the original authorisation transaction.
Added On: 03/10/14
SQL Column: VPC_AUTHORIZE_ID
Java Field: vpcAuthorizeId
Status: Active
SQL Type: varchar(12)
Java Type: String
An identifying code issued by the bank to approve or deny the transaction.
Added On: 03/10/14
SQL Column: VPC_BATCH_NO
Java Field: vpcBatchNo
Status: Active
SQL Type: varchar(8)
Java Type: String
A date supplied by the acquirer to indicate when this transaction will be settled.
Added On: 03/10/14
SQL Column: VPC_CAPTURED_AMOUNT
Java Field: vpcCapturedAmount
Status: Active
SQL Type: int(11)
Java Type: Integer
The amount of the capture transaction in the smallest currency unit expressed as an integer.
Added On: 03/10/14
SQL Column: VPC_CARD
Java Field: vpcCard
Status: Active
SQL Type: varchar(4)
Java Type: String
A code issued by the Payment Server for the card type used by the cardholder in the transaction.
Added On: 03/10/14
SQL Column:
Java Field: vpcCardExp
Status: Active
SQL Type:
Java Type: String
The expiry date of the card to be processed for payment.
Added On: 03/10/14
SQL Column:
Java Field: vpcCardNum
Status: Active
SQL Type:
Java Type: String
The number of the card that is used for processing the payment.
Added On: 03/10/14
SQL Column:
Java Field: vpcCardSecurityCode
Status: Active
SQL Type:
Java Type: String
Is a security feature used for card not present transactions that compares the Card Security Code on the card with the records held in the card issuer's database.
Added On: 03/10/14
SQL Column:
Java Field: vpcCardTrack1
Status: Active
SQL Type:
Java Type: String
ASCII text representing the card track 1 data.
Added On: 03/10/14
SQL Column:
Java Field: vpcCardTrack2
Status: Active
SQL Type:
Java Type: String
ASCII text representing the card track 2 data.
Added On: 03/10/14
SQL Column: VPC_COMMAND
Java Field: vpcCommand
Status: Active
SQL Type: varchar(16)
Java Type: String
Indicates the transaction type. Must be equal to pay capture, refund, voidCapture, voidRefund, voidPurchase.
Added On: 03/10/14
SQL Column: VPC_CSC_RESULT_CODE
Java Field: vpcCscResultCode
Status: Active
SQL Type: varchar(1)
Java Type: String
The response code generated by the MiGS Payment Server in relation to the Card Security Code.
Should be used for a more accurate representation of the CSC Response:
M: Valid or matched CSC
N: Code invalid or not matched
P: CSC Not Processed
S: Merchant indicates CSC not present on card
U: Card issuer is not registered and/or certified
Added On: 03/10/14
SQL Column: VPC_MERCH_TXN_REF
Java Field: vpcMerchTxnRef
Status: Active
SQL Type: varchar(40)
Java Type: String
A unique value created by you to identify the DO. It is used to track the progress of a transaction and allows it to be identified on the Payment Server should a communication's failure occur and the DR is not received.
Added On: 03/10/14
SQL Column: VPC_MERCHANT
Java Field: vpcMerchant
Status: Active
SQL Type: varchar(16)
Java Type: String
The unique merchant ID assigned by Payment Processor.
Added On: 03/10/14
SQL Column: VPC_MESSAGE
Java Field: vpcMessage
Status: Active
SQL Type: varchar(200)
Java Type: String
Indicates any errors the transaction may have encountered.
Added On: 03/10/14
SQL Column: VPC_ORDER_INFO
Java Field: vpcOrderInfo
Status: Active
SQL Type: varchar(34)
Java Type: String
Your own identifier used to identify the transaction with the cardholder. For example, a shopping cart number, an order number, or an invoice number.
Added On: 03/10/14
SQL Column: VPC_RECEIPT_NO
Java Field: vpcReceiptNo
Status: Active
SQL Type: varchar(12)
Java Type: String
Passed back to the cardholder for their records if the merchant application does not generate its own receipt number. Also known as the Reference Retrieval Number (RRN), which is a unique identifier.
Added On: 03/10/14
SQL Column: VPC_REFUNDED_AMOUNT
Java Field: vpcRefundedAmount
Status: Active
SQL Type: int(11)(10)
Java Type: Integer
The amount of the refund transaction in the smallest currency unit expressed as an integer.
Added On: 03/10/14
SQL Column: VPC_SHOP_TRANSACTION_NO
Java Field: vpcShopTransactionNo
Status: Active
SQL Type: varchar(21)
Java Type: String
The transaction reference number of the original authorisation or purchase transaction.
Added On: 03/10/14
SQL Column: VPC_TICKET_NO
Java Field: vpcTicketNo
Status: Active
SQL Type: varchar(15)
Java Type: String
Allows to include a ticket number, such as an airline ticket number in the DO. It is stored on the Payment Server database for the transaction and is not returned in the DR.
Added On: 03/10/14
SQL Column: VPC_TRANSACTION_NO
Java Field: vpcTransactionNo
Status: Active
SQL Type: varchar(12)
Java Type: String
A unique number generated by the Payment Server for the transaction. It is stored in the Payment Server as a reference and used to perform actions such as a refund or capture.
Added On: 03/10/14
SQL Column: VPC_TX_SOURCE
Java Field: vpcTxSource
Status: Active
SQL Type: varchar(16)
Java Type: String
Allows the merchant to specify the source of the transaction.
This can only be used if the merchant has their privilege set to use this command, otherwise the transaction will be set to the merchant's default transaction source as defined by your Merchant Manager.
Added On: 03/10/14
SQL Column: VPC_TX_SOURCE_SUB_TYPE
Java Field: vpcTxSourceSubType
Status: Active
SQL Type: varchar(12)
Java Type: String
Allows the merchant to flag the subtype of transaction for the cardholder's order.
Added On: 03/10/14
SQL Column: VPC_TXN_RESPONSE_CODE
Java Field: vpcTxnResponseCode
Status: Active
SQL Type: varchar(1)
Java Type: String
A response code that is generated by the Payment Server to indicate the status of the transaction.
Added On: 03/10/14
SQL Column:
Java Field: vpcUser
Status: Active
SQL Type:
Java Type: String
Special AMA user created to allow this function to operate.
Added On: 03/16/14
SQL Column: VPC_VER_SECURITY_LEVEL
Java Field: vpcVerSecurityLevel
Status: Active
SQL Type: varchar(2)
Java Type: String
Is generated at the card issuer as a token to prove that the cardholder was enrolled and authenticated OK.
Contains the security level to be used in the AUTH message.
'05' - Fully Authenticated.
'06' - Not authenticated, (cardholder not participating), liability shift.
'07' - Not authenticated. Usually due to a system problem, for
example the merchant password is invalid.
Added On: 03/16/14
SQL Column: VPC_VER_STATUS
Java Field: vpcVerStatus
Status: Active
SQL Type: varchar(1)
Java Type: String
The status codes used by the Payment Server.
Added On: 03/10/14
SQL Column:
Java Field: vpcVerToken
Status: Active
SQL Type:
Java Type: String
Generated by the card issuer as a token to prove that the cardholder authenticated OK. This is a base64 encoded value.
Added On: 03/10/14
SQL Column:
Java Field: vpc3DsEci
Status: Active
SQL Type:
Java Type: String
The 3-D Secure Electronic Commerce Indicator, which is set to '05' when the cardholder authenticates OK, and '08' when the cardholder is not enrolled. (These values may change depending on the locale or issuer).
Added On: 03/10/14
SQL Column: VPC3_DS_ENROLLED
Java Field: vpc3DsEnrolled
Status: Active
SQL Type: varchar(1)
Java Type: String
The VERes.enrolled field. It will take values:
- Y - Yes
- N - No
- U - Unavailable for Checking.
Added On: 03/10/14
SQL Column: VPC3_DS_STATUS
Java Field: vpc3DsStatus
Status: Active
SQL Type: varchar(1)
Java Type: String
Included only if payment authentication was used and a PARes was received by the MPI. It will take values:
- Y - Yes
- N - No
- A - Attempted Authentication
- U - Unavailable for Checking.
Added On: 03/10/14
SQL Column:
Java Field: vpc3DsXid
Status: Active
SQL Type:
Java Type: String
It is a unique transaction identifier that is generated by the merchant to identify the 3DS transaction.
Added On: 03/10/14
SQL Column:
Java Field: vpcPassword
Status: Active
SQL Type:
Java Type: String
The password used to authorise the AMA user to access this function.