Paymentech Auth Retail Transaction UML
Added On: 02/13/12
Module: UniCharge
Type: Entity
Status: Active
Java Class: PaymentechAuthRetailTransaction
Added On: 02/13/12
SQL Column: AMOUNT
Java Field: amount
Status: Active
SQL Type: int(11)
Java Type: Integer
The amount element defines the amount of the transaction. Supply the value in cents without a decimal point.
Added On: 02/13/12
SQL Column: APPROVAL_STATUS
Java Field: approvalStatus
Status: Active
SQL Type: varchar(1)
Java Type: String
Approval Status:
0 – Decline
1 – Approved
2 – Message/System Error
Added On: 02/13/12
SQL Column: AUTHORIZATION_CODE
Java Field: authorizationCode
Status: Active
SQL Type: varchar(6)
Java Type: String
Issuer approval Code: Unique transactional level code issuer uses to show each request was approved
Added On: 02/13/12
SQL Column: AVS_ADDRESS1
Java Field: avsAddress1
Status: Active
SQL Type: varchar(30)
Java Type: String
Cardholder billing address line 1 (street).
Added On: 02/13/12
SQL Column: AVS_CITY
Java Field: avsCity
Status: Active
SQL Type: varchar(20)
Java Type: String
Added On: 05/25/12
SQL Column: AVS_NAME
Java Field: avsName
Status: Active
SQL Type: varchar(30)
Java Type: String
Added On: 02/13/12
SQL Column: AVS_RESP_CODE
Java Field: avsRespCode
Status: Active
SQL Type: varchar(2)
Java Type: String
Address verification request response
Added On: 02/13/12
SQL Column: AVS_STATE
Java Field: avsState
Status: Active
SQL Type: varchar(2)
Java Type: String
Cardholder billing state code.
Added On: 02/13/12
SQL Column: AVS_ZIP
Java Field: avsZip
Status: Active
SQL Type: varchar(10)
Java Type: String
Cardholder billing address ZIP (or postal) code.
Added On: 02/13/12
SQL Column: BIN
Java Field: bin
Status: Active
SQL Type: varchar(6)
Java Type: String
Transaction Routing Definition.
Added On: 05/25/12
SQL Column: CARD_BRAND
Java Field: cardBrand
Status: Active
SQL Type: varchar(2)
Java Type: String
Added On: 02/13/12
SQL Column: CARD_PRESENT_IND
Java Field: cardPresentInd
Status: Active
SQL Type: varchar(1)
Java Type: String
Card Presence Identifier:
Y – Card Present/Swiped
N – Manually Entry
Added On: 05/25/12
SQL Column:
Java Field: ccAccountNum
Status: Active
SQL Type:
Java Type: String
Credit card (or bank account) number of the customer.
Added On: 05/25/12
SQL Column:
Java Field: ccCardVerifyNum
Status: Active
SQL Type:
Java Type: String
Credit card verification number.
Added On: 02/13/12
SQL Column: CC_CARD_VERIFY_PRESENCE_IND
Java Field: ccCardVerifyPresenceInd
Status: Active
SQL Type: varchar(1)
Java Type: String
Card Security Presence Indicator
If a Card Verification Number for a manual entry transaction is attempted to be collected, this value needs to be passed for a Visa or Discover [and only those cards] transaction:
9 - Cardholder states data not available
Added On: 05/25/12
SQL Column:
Java Field: ccExp
Status: Active
SQL Type:
Java Type: String
Expiration date of the customer's credit card.
Added On: 02/13/12
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: 05/25/12
SQL Column: COMMENTS
Java Field: comments
Status: Active
SQL Type: varchar(64)
Java Type: String
Any additional comments on the transaction.
Added On: 05/25/12
SQL Column: CUSTOMER_NAME
Java Field: customerName
Status: Active
SQL Type: varchar(30)
Java Type: String
Added On: 02/13/12
SQL Column: CVV_RESP_CODE
Java Field: cvvRespCode
Status: Active
SQL Type: varchar(1)
Java Type: String
Card verification number request response
Added On: 05/25/12
SQL Column: DEBIT_BILLER_REFERENCE_NUMBER
Java Field: debitBillerReferenceNumber
Status: Active
SQL Type: varchar(25)
Java Type: String
Added On: 02/13/12
SQL Column: FAULT_STRING
Java Field: faultString
Status: Active
SQL Type: varchar(255)
Java Type: String
An error message from a SOAP message can be carried inside a Fault element. If a Fault element is present, it will appear as a
child element of the Body element. A Fault element can only appear once in a SOAP message.
The Orbital Gateway SOAP Fault element has the following sub elements:
-faultcode
-faultstring
Fault Code - For errors generated by the Orbital Gateway, this value will be ‘SOAP-ENV:Server’.
Added On: 02/13/12
SQL Column: HOST_AVS_RESP_CODE
Java Field: hostAvsRespCode
Status: Active
SQL Type: varchar(2)
Java Type: String
Actual host address verification response code:
Exact address verification response sent by host authorization system [nonnormalized by the gateway].
Added On: 02/13/12
SQL Column: HOST_CVV_RESP_CODE
Java Field: hostCvvRespCode
Status: Active
SQL Type: varchar(1)
Java Type: String
Actual host card verification response code:
Exact card verification response sent by host authorization system [non-normalized by the gateway]
Added On: 02/13/12
SQL Column: HOST_RESP_CODE
Java Field: hostRespCode
Status: Active
SQL Type: varchar(3)
Java Type: String
Actual host response code:
Exact response sent by host authorization system [non-normalized by the gateway].
Added On: 02/13/12
SQL Column: ID
Java Field: id
Status: Active
SQL Type: bigint(20)
Java Type: Long
Attributes:
Unique, Required
Identifier of the object used for references; auto-incremented integer value.
Added On: 02/13/12
SQL Column: INDUSTRY_TYPE
Java Field: industryType
Status: Active
SQL Type: varchar(2)
Java Type: String
Defines the Industry type of the transaction:
RE – Retail
Added On: 02/13/12
SQL Column: LAST_RETRY_DATE
Java Field: lastRetryDate
Status: Active
SQL Type: varchar(14)
Java Type: String
The Date / time in which the PREVIOUS transaction using the same retryTrace value was processed by gateway:
Format – ‘YYYYMMDDhh[24]miss’
Added On: 05/25/12
SQL Column:
Java Field: magStripeTrack1
Status: Active
SQL Type:
Java Type: String
Added On: 05/25/12
SQL Column:
Java Field: magStripeTrack2
Status: Active
SQL Type:
Java Type: String
Added On: 02/13/12
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: 02/13/12
SQL Column: MERCHANT_ID
Java Field: merchantId
Status: Active
SQL Type: varchar(15)
Java Type: String
Gateway merchant account number assigned by Chase Paymentech
Added On: 05/25/12
SQL Column:
Java Field: orbitalConnectionPassword
Status: Active
SQL Type:
Java Type: String
Password used for Chase Paymentech Orbital payment gateway connection.
Added On: 05/25/12
SQL Column:
Java Field: orbitalConnectionUsername
Status: Active
SQL Type:
Java Type: String
Username used for Chase Paymentech Orbital payment gateway connection.
Added On: 02/13/12
SQL Column: ORDER_ID
Java Field: orderId
Status: Active
SQL Type: int(11)
Java Type: Integer
Merchant Defined Order Number/Invoice Number:
Field defined and supplied by the auth originator, and echoed back in response.
Added On: 05/25/12
SQL Column: PARTIAL_AUTH_IND
Java Field: partialAuthInd
Status: Active
SQL Type: varchar(1)
Java Type: String
Added On: 05/25/12
SQL Column: PARTIAL_AUTH_OCCURED
Java Field: partialAuthOccured
Status: Active
SQL Type: varchar(1)
Java Type: String
Indicates whether partial authorization occured.
Added On: 05/25/12
SQL Column: PCARD_DEST_ZIP
Java Field: pcardDestZip
Status: Active
SQL Type: varchar(10)
Java Type: String
Added On: 05/25/12
SQL Column: PCARD_ORDER_ID
Java Field: pcardOrderId
Status: Active
SQL Type: varchar(17)
Java Type: String
Added On: 02/13/12
SQL Column: PROC_STATUS
Java Field: procStatus
Status: Active
SQL Type: varchar(6)
Java Type: String
Process Status:
The first data set that should be checked to determine the result of a request. It is the only element that is returned in all response scenarios. It identifies whether transactions have successfully passed all of the Gateway edit checks.
0 – Success
All other values constitute an error condition and will be returned in a SOAPFault.
Added On: 02/13/12
SQL Column: PROC_STATUS_MESSAGE
Java Field: procStatusMessage
Status: Active
SQL Type: varchar(255)
Java Type: String
Response Text message
If ProcStatus = 0, the ‘approvalStratus’ Message text is returned.
Added On: 05/25/12
SQL Column: REDEEMED_AMOUNT
Java Field: redeemedAmount
Status: Active
SQL Type: varchar(12)
Java Type: String
Added On: 05/25/12
SQL Column: REMAINING_BALANCE
Java Field: remainingBalance
Status: Active
SQL Type: varchar(12)
Java Type: String
Remaining balance of the credit card of the customer.
Added On: 02/13/12
SQL Column: RESP_CODE
Java Field: respCode
Status: Active
SQL Type: varchar(2)
Java Type: String
Response Code:
Normalized authorization response code issued by the PNS host system, which identifies an approval (‘00’) or the reason for a decline or error.
Value conditionally returned when procStatus = 0
Added On: 02/13/12
SQL Column: RESP_CODE_MESSAGE
Java Field: respCodeMessage
Status: Active
SQL Type: varchar(255)
Java Type: String
Added On: 02/13/12
SQL Column: RESP_DATE_TIME
Java Field: respDateTime
Status: Active
SQL Type: varchar(14)
Java Type: String
Date / time the transaction was processed by gateway:
Format – ‘YYYYMMDDhh[24]miss’
Added On: 02/13/12
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: 02/13/12
SQL Column: RETRY_ATTEMPT_COUNT
Java Field: retryAttemptCount
Status: Active
SQL Type: varchar(2)
Java Type: String
Defines the number of times a Transaction Result has been returned:
0 - First Response [unique retryTrace]
1 or Greater means the Orbital Gateway has processed this request previously and is echoing back the response. The number represents the number of requests processed by the Gateway with the same retryTrace number.
Added On: 02/13/12
SQL Column: RETRY_TRACE
Java Field: retryTrace
Status: Active
SQL Type: bigint(20)
Java Type: Long
Defines the Trace Number used for Retry Logic.
The Orbital Gateway offers functionality, referred to as “Retry Logic”, which allows a customer to retry a transaction without
duplicating the original request.
The result is any Client properly utilizing Retry Logic can reprocess transactions with an unknown result without:
• Risk of double authorizing a transaction against a cardholder’s available balance.
• Prevent duplicate [or more] settlement items.
Added On: 05/25/12
SQL Column: REVERSAL_RETRY_NUMBER
Java Field: reversalRetryNumber
Status: Active
SQL Type: bigint(20)
Java Type: Long
Allowed number of reversal retries.
Added On: 05/25/12
SQL Column: SHIPPING_REF
Java Field: shippingRef
Status: Active
SQL Type: varchar(40)
Java Type: String
Order shipping reference.
Added On: 05/25/12
SQL Column: TAX_AMOUNT
Java Field: taxAmount
Status: Active
SQL Type: int(11)
Java Type: Integer
Added On: 05/25/12
SQL Column: TAX_IND
Java Field: taxInd
Status: Active
SQL Type: varchar(1)
Java Type: String
Added On: 02/13/12
SQL Column: TERMINAL_ID
Java Field: terminalId
Status: Active
SQL Type: varchar(3)
Java Type: String
Merchant Terminal ID assigned by Chase Paymentech
Added On: 02/13/12
SQL Column: TRANS_TYPE
Java Field: transType
Status: Active
SQL Type: varchar(2)
Java Type: String
Defines the transaction New Order Transaction Type:
AC – Authorization and Capture
R – Refund request
Added On: 02/13/12
SQL Column: TX_REF_IDX
Java Field: txRefIdx
Status: Active
SQL Type: varchar(4)
Java Type: String
Gateway transaction index:
Will always return a ‘0’ value on original transaction and a ‘1’ on void responses.
Added On: 02/13/12
SQL Column: TX_REF_NUM
Java Field: txRefNum
Status: Active
SQL Type: varchar(40)
Java Type: String
Gateway transaction reference number:
A unique value for each transaction, which is required to Void any transaction