Groups: | All Processing Status Debug |
Name | Description |
---|---|
ACTION_CODE | The Action_Code tells what type of transaction you are sending.
Reffer to the STS Provider's Specification for more detailes. |
ADDR1 | Cardholder's street address. |
AUTH_REFERENCE | Authorization number returned when response code = 00. Use this number for follow-on requests such as Void or Add Tip. |
BUSINESS_TYPE | R = Retail/Other;
F = Restaurant. Default is R. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CITY | Cardholder's City. |
EMAIL_ADDR | Cardholder's email address. |
FIRST_NAME | Cardholder's first name.
This field will have one space in it if the name is not in the database. |
ID | Identifier of the object used for references; auto-incremented integer value. |
LAST_NAME | Cardholder's last name.
This field will have one space in it if the name is not in the database. |
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. |
MERCHANT_NUMBER | Merchant number assigned by processor or MSP. |
PHONE1 | Cardholder's primary phone number. |
POINTS_AMOUNT | The amount of points of loyalty, present on card.
No Decimals implied. Required for Action Codes 03 and 04. Example: 20000 = 20 thousand. |
POS_ENTRY_MODE | S = Swiped;
M = Manual. Required except for Action Code 12 (Totals Inquiry). |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
STATE | Cardholder's State or Provence. |
TERMINAL_ID | Terminal ID assigned by processor or MSP. |
TICKET | Ticket or invoice number from your system. |
TIP_AMOUNT | The amount of given tips.
Decimal number is required. Example: $200.00. |
TRANS_TYPE | Default is N.
N = Non-loyalty; L = Loyalty. NA for transactions that don’t include a Points amount. |
TRANSACTION_AMOUNT | The amount of transaction.
Required for Action Codes 01, 02, 06, 07, 08 and 11. Decimal number is required. Example: $200.00. |
TRANSACTION_ID | This number is populated by the POS system (you) and is echoed back to you in the host response. |
ZIP | Cardholder's postal code. |
Name | Description |
---|---|
ACTION_CODE | The Action_Code tells what type of transaction you are sending.
Reffer to the STS Provider's Specification for more detailes. |
ADDR1 | Cardholder's street address. |
AMOUNT_BALANCE | This value is the remaining balance. |
APPROVED_AMOUNT | Amount approved (Can be less than requested amount – partial approval.)
This field only appears in response to action code 19 transactions. |
AUTH_REFERENCE | Authorization number returned when response code = 00. Use this number for follow-on requests such as Void or Add Tip. |
BUSINESS_TYPE | R = Retail/Other;
F = Restaurant. Default is R. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CITY | Cardholder's City. |
EMAIL_ADDR | Cardholder's email address. |
FIRST_NAME | Cardholder's first name.
This field will have one space in it if the name is not in the database. |
ID | Identifier of the object used for references; auto-incremented integer value. |
LAST_NAME | Cardholder's last name.
This field will have one space in it if the name is not in the database. |
LIFE_POINTS_BALANCE | No implied decimal.
Only returned for loyalty transaction requests. Required for loyalty requests. Example: 200 = two hundred. |
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. |
MERCHANT_NUMBER | Merchant number assigned by processor or MSP. |
MISC_MESSAGE | This field can be used to give the merchant additional messages to display on receipts, etc. i.e. a Rewards Message. |
PHONE1 | Cardholder's primary phone number. |
POINTS_AMOUNT | The amount of points of loyalty, present on card.
No Decimals implied. Required for Action Codes 03 and 04. Example: 20000 = 20 thousand. |
POINTS_BALANCE | No implied decimal.
Only returned for loyalty transaction requests. Required for loyalty requests. Example: 200 = two hundred. |
POS_ENTRY_MODE | S = Swiped;
M = Manual. Required except for Action Code 12 (Totals Inquiry). |
RESPONSE_CODE | Each two digit response code maps to a specific response, i.e.
00 = Approved/Captured. 01 = Decline/Error |
RESPONSE_TEXT | Text associated with the transaction approval or decline Response_Code. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
STATE | Cardholder's State or Provence. |
TERMINAL_ID | Terminal ID assigned by processor or MSP. |
TICKET | Ticket or invoice number from your system. |
TIP_AMOUNT | The amount of given tips.
Decimal number is required. Example: $200.00. |
TRANS_DATE_TIME | Fixed date (month, day, year) and time (hour, minute, second) of transaction.
MMDDYYhhmmss. |
TRANS_TYPE | Default is N.
N = Non-loyalty; L = Loyalty. NA for transactions that don’t include a Points amount. |
TRANSACTION_AMOUNT | The amount of transaction.
Required for Action Codes 01, 02, 06, 07, 08 and 11. Decimal number is required. Example: $200.00. |
TRANSACTION_ID | This number is populated by the POS system (you) and is echoed back to you in the host response. |
ZIP | Cardholder's postal code. |
Name | Description |
---|---|
API_KEY | The value of this parameter is assigned to you by Merchant Warrior.
|
AUTH_CODE | This field contain the upstream provider response data.
|
AUTH_MESSAGE | Contains additional text information about the transaction.
|
AUTH_SETTLED_DATE | This field contain the upstream provider response data.
|
CAPTURE_AMOUNT | The amount of the capture. |
CARD_ID | A unique alphanumeric string returned by addCard, used to identify a specific card. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CUSTOM1 | Freeform field. Returned as <custom1> in the XML response.
|
CUSTOM2 | Freeform field. Returned as <custom2> in the XML response.
|
CUSTOM3 | Freeform field. Returned as <custom3> in the XML response.
|
CUSTOMER_ADDRESS | Customer's postal address. |
CUSTOMER_CITY | City of the customer's postal address. |
CUSTOMER_COUNTRY | Country of the customer's postal address. |
CUSTOMER_EMAIL | Customer's email address. |
CUSTOMER_PHONE | Customer's phone number. |
CUSTOMER_POST_CODE | Post code of the customer's postal address. |
CUSTOMER_STATE | State of the customer's postal address. |
HASH | The verifica1on hash is a combination of the MD5 of your API Passphrase, and specific parameters sent in the transaction.
|
ID | Identifier of the object used for references; auto-incremented integer value. |
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. |
MERCHANT_UUID | The value of this parameter is assigned to you by Merchant Warrior.
|
METHOD | This is case sensitive.
|
PAYMENT_CARD_NAME | This must contain at the very least a space and no less than two characters. Only alphanumeric characters, hyphens, spaces and full stops are allowed.
|
REFUND_AMOUNT | The amount of the refund. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
TRANSACTION_AMOUNT | The amount of the transaction. |
TRANSACTION_CURRENCY | Currency in which the transaction is done. |
TRANSACTION_ID_REQUEST | An optional element that contains a unique user defined ID to identify the transaction. The Transaction ID will be returned in the Authorization Gateway response.
|
TRANSACTION_PRODUCT | A product (or sale) description. This field’s primary purpose is to help the transaction be identfiable for reporting and accouning purposes.
|
TRANSACTION_REFERENCE_ID | This is merchant’s unique reference ID for a transaction sent to Merchant Warrior. The main purpose of this ID is to verify the transaction via queryCard method in the event a valid response is not received.
|
Name | Description |
---|---|
API_KEY | The value of this parameter is assigned to you by Merchant Warrior.
|
AUTH_CODE | This field contain the upstream provider response data.
|
AUTH_MESSAGE | Contains additional text information about the transaction.
|
AUTH_RESPONSE_CODE | This field contain the upstream provider response data.
|
AUTH_SETTLED_DATE | This field contain the upstream provider response data.
|
CAPTURE_AMOUNT | The amount of the capture. |
CARD_ID | A unique alphanumeric string returned by addCard, used to identify a specific card. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CUSTOM1 | Freeform field. Returned as <custom1> in the XML response.
|
CUSTOM2 | Freeform field. Returned as <custom2> in the XML response.
|
CUSTOM3 | Freeform field. Returned as <custom3> in the XML response.
|
CUSTOMER_ADDRESS | Customer's postal address. |
CUSTOMER_CITY | City of the customer's postal address. |
CUSTOMER_COUNTRY | Country of the customer's postal address. |
CUSTOMER_EMAIL | Customer's email address. |
CUSTOMER_PHONE | Customer's phone number. |
CUSTOMER_POST_CODE | Post code of the customer's postal address. |
CUSTOMER_STATE | State of the customer's postal address. |
HASH | The verifica1on hash is a combination of the MD5 of your API Passphrase, and specific parameters sent in the transaction.
|
ID | Identifier of the object used for references; auto-incremented integer value. |
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. |
MERCHANT_UUID | The value of this parameter is assigned to you by Merchant Warrior.
|
METHOD | This is case sensitive.
|
PAYMENT_CARD_NAME | This must contain at the very least a space and no less than two characters. Only alphanumeric characters, hyphens, spaces and full stops are allowed.
|
RECEIPT_NO | |
REFUND_AMOUNT | The amount of the refund. |
RESPONSE_CODE | Contains a numeric bit that indicates one or many response messages. |
RESPONSE_MESSAGE | Contains text response to the transaction. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
TRANSACTION_AMOUNT | The amount of the transaction. |
TRANSACTION_CURRENCY | Currency in which the transaction is done. |
TRANSACTION_ID_REQUEST | An optional element that contains a unique user defined ID to identify the transaction. The Transaction ID will be returned in the Authorization Gateway response.
|
TRANSACTION_ID_RESPONSE | The <transactionID> returned for the initial transaction.
|
TRANSACTION_PRODUCT | A product (or sale) description. This field’s primary purpose is to help the transaction be identfiable for reporting and accouning purposes.
|
TRANSACTION_REFERENCE_ID | This is merchant’s unique reference ID for a transaction sent to Merchant Warrior. The main purpose of this ID is to verify the transaction via queryCard method in the event a valid response is not received.
|
Name | Description |
---|---|
Clerk Number.
This eight-digit field appears in all controller requests that represent in-lane transactions. It identifies the employee associated with the transaction. If not applicable, the field should be zero filled. |
|
BIT03 | Processing Code.
May appear in the following message types:
Consists of three two-digit sub fields that indicate how the transaction specified by the message type affects the customer’s related account(s). Note: The authorization service can update the "From" and "To" account information. The operating rules for the authorization service may require the terminal device to print the account information on the receipt. |
BIT04 | Transaction Amount.
This field may appear in the following message types:
The nine-digit transaction amount field represents the monetary value associated with the cardholder’s authorization, debit, or credit transaction request. The amount is entered in the terminal as a seven-digit number and is always right justified and zero filled. This field does not include cash back.
|
BIT07 | Transmission Date and Time.
The transmission date and time field may appear in the following message types:
In the host capture terminal messages this field represents the date and time that the transaction was processed by the host. In the host capture controller messages this is the date/time at which the controller transmitted the transaction to the Tandem Online System. It is set by the controller. In a 0400 reversal message, the date and time apply to the reversal/void request itself, not the original transaction. The ten-digit field is in MMDDYYhhmm format, with the time portion expressed in 24-hour (military) notation. For example, 1114971346 represents Nov. 14, 1997, at 1:46 P.M. |
BIT105 | Contains several fields:
Refer to the specification of the processor for more information. |
BIT106 | Cardholder Identification (AVS).
This 29-character field must appear in the 0100 authorization request or 0200 financial transaction request message when the Bit Map Type is 05, 06, 25, or 26. It contains the data used for address verification. The field contains two data subfields: The first 20 positions are the cardholder’s address data, left justified and space filled; the last nine positions contain the ZIP code. If the ZIP code is present, it must be either five or nine characters in length, left justified and padded with spaces if only five characters. |
BIT107 | Point-of-Service Device Capability Code.
This two-character field must appear in the following messages:
The field contains two subfields that indicate the type of POS device used and the device’s ability to read encoded data. |
BIT109 | P.O. Number/Customer Code.
This twenty-character field contains the purchase order number applicable to a financial transaction or the customer code associated with a purchase card. It is required in the following message types:
The field is optional in the 0200 financial request for a private-label (Bit Map Type 07) or fuel (Bit Map Type 09) sale. |
BIT11 | System Trace Audit Number (STAN).
The in-store controller creates this six-digit number at transaction time to uniquely identify the transaction. This field appears in every message type supported by the Tandem Online System and the instore controller. |
BIT110 | Tax Amount.
This nine-digit field appears in 0100 authorization requests and 0200 financial requests that apply to corporate or purchase credit cards. It contains the dollar amount of tax included in the transaction, in the format 999999999. Sending a value of all 9’s (999999999) in the request message indicates that this is a non-taxable transaction. Sending a value of all 8’s (888888888) in the request message indicates that this is a tax-exempt transaction. Note: For non-corporate/purchase cards, this data element can be sent as all zeroes. |
BIT111 | Additional Data, Private EBT.
This 15-byte field is conditional in the 0200 financial message. Present only when the processing code indicates an EBT transaction, it contains the voucher number required for clearing EBT voice authorizations. |
BIT112 | Card Sequence Number.
The three-digit card sequence number field is conditional in the 0200 financial request message when the processing code indicates an EBT transaction. The field is required only if the card has a generation number and the card was not swiped. The card sequence number distinguishes between separate cards with the same primary account number. |
BIT115 | Trace Data 1.
In the host capture terminal message set, this 16-character field must appear in the 0800 (Bit Map Type 02) and 0810 (Bit Map Type 94) network management request and response when processing the line management test function (echo test). The field is included in all controller messages as an echo field for the controller’s use. The Tandem Online System echoes the data exactly as it was received. |
BIT12 | Local Transaction Date.
The six-digit transaction date appears in all request messages handled by the in-store controller; it indicates the date (MMDDYY) on which the transaction occurred at the point of sale. In 0400 reversal/void requests, this field represents the transaction being voided; see 07 Transmission Date/Time. In a Gift Card Completion message the Local Transaction Date must be populated with the Local Transaction Date received in the Gift Card Preauth approval message. In an Unsolicited Reversal the Local Transaction Date must be populated with the Local Transaction Date received in the original Authorization request message. |
BIT133 | POSA Network ID.
This four-byte field defines the POSA network used to authorize the POSA transaction. This field must appear in all POSA transactions. POSA networks are:
If the merchant is processing POSA cards, but the point-of-sale system is unable to determine the POSA Network, then that merchant can only successfully process for a single POSA network. In this case, the POSA Network ID field must be set up at the point of sale to always indicate the merchant’s selected network (e.g. SWAY). The value should either be hard-coded into the system or set as a parameter. If the merchant also sells their own gift cards via non-POSA networks, then the BIN range(s) for the merchant’s gift cards must be registered with Vantiv, LLC (Tandem Onlines) for processing. Notes: Merchants that do not participate in POSA need to fill the POSA Network ID field with spaces. Contact Vantiv, LLC for current supported networks. |
BIT134 | POSA UPC Data.
This twenty-byte field contains the POSA scanned UPC (bar code data) on the card used to authorize the POSA prepaid transaction. This field must appear in all POSA prepaid transactions |
BIT135 | POSA Stand-In indicator.
This one-byte field is used to indicate a POSA store and forward transaction request due to a merchant stand-in condition. Applicable to POSA activation and reload SAF transaction requests only. Use a value of “Y”, if the POS device has timed out or the host responds with response code “001” or “795” and load the POSA SAF reference number into field 136 of the request message. The POSA SAF Reference Number is returned in field 105.3 of every POSA response message, and should be retained for use in any SAF retransmission request. When setting the POSA Stand-In indicator to “N”, the POSA SAF reference number must be initialized to spaces. This field must appear in any POSA activation or reload SAF requests when the transaction is queued for re-transmission by the POS device. |
BIT136 | POSA SAF Reference Number.
This twelve-byte field contains a unique number generated by the host for each POSA prepaid transaction. The host returns this value on every POSA prepaid transaction that is approved or declined (see field 105.3 – Transaction Identifier). In a Store-and-Forward scenario, where the transaction is queued for retransmission by the POS device this field contains the POSA SAF reference number of the original Activation/Reload transaction in the POSA prepaid request message. If a POSA device time out occurs no POSA SAF Reference Number is available then set the POSA SAF Reference Number to spaces and the POSA Stand-In Indicator (field 135) to a value of “Y”. |
BIT137 | Replacement Amount.
In a partial authorization reversal, the Replacement Amount reflects the corrected total amount of the authorization for the transaction. For a partial reversal, the Transaction Amount field must contain the original amount authorized. The host subtracts the Replacement Amount from the Transaction Amount to determine the amount being reversed. For timeout reversals, and for other cases where the original authorization is to be fully reversed, the replacement amount must be zero. The replacement amount must not be equal to or greater than the transaction amount. Partial reversals are currently only supported for VISA and MasterCard payment types. |
BIT22 | Point-of-Service Entry Mode.
The three-digit POS entry mode field must appear in the following messages:
Contains two subfields that indicate the method used to enter the primary account number (PAN) and whether the POS terminal allows entry of personal identification numbers (PINs). |
BIT25 | Point-of-Service Condition Code.
The ten-digit POS condition code field must appear in the following messages:
Contains four subfields that, together, identify the kind of terminal and indicate whether the customer and/or the customer’s credit card were present at the time of the transaction. |
BIT32 | Acquiring Institution Identification Code.
This four-digit field must appear in the following message types:
The code (referred to in the Tandem Online Systems as the Bank ID) identifies the acquiring institution (i.e., merchant bank, merchant grouping, or merchants’ hierarchy) for the associated Card Acceptor ID Code (the Tandem Online Systems Merchant Number). |
BIT41 | Card Acceptor Terminal Identification.
The three-digit card acceptor terminal ID code (referred to as the Terminal ID in the Tandem Online System) identifies the terminal at the merchant (card acceptor) location at which the transaction was entered. This field must appear in all transaction request messages. |
BIT42 | Card Acceptor Identification Code.
The 12-digit card acceptor ID code (referred to as the Merchant ID in the Tandem Online System) must appear in all transaction request messages. This field, in conjunction with the acquiring institution identification code (Field 32), uniquely identifies the merchant in the Tandem Online System. |
BIT43 | Lane Number.
This three-digit field appears in the following controller message types:
It identifies the cashier location at which the transaction occurred. Note: Of the 3 digit lane number only the right most two bytes are used. Lane numbers must be within the range of 01 to 99. |
BIT60 | Cash Back Amount.
This nine-digit field appears in the 0100 authorization and 0200 financial request messages. It represents the amount of money being given back to the cardholder. The entered amount can be up to seven digits; in the message it must be right-justified and padded with zeros to the full nine positions. This amount should not be included in the transaction amount field. For AVS verification only (Processing code 514000) request, this field must be zero filled. |
BIT63 | Contains several fields:
This six-digit field appears in the 0200 and 0220 financial messages for those transactions (usually designated for specific card types) that use the extended prompts option. The field is required when settling American Express retail transactions. If the message also includes the P.O. Number/Customer Code field (bit 109), this field is ignored unless bit 109 is space-filled. These four-digit fields appear in the 0200 and 0220 financial messages for those transactions (usually designated for specific card types) that use the extended prompts option. These fields are used to cross reference a table in the Tandem Online Systems database that designates the type of merchandise purchased. Required when settling American Express retail transactions. |
BIT65 | Authorization Identification Response.
This six-character field appears in the following messages:
The auth ID response contains an authorization number assigned to the transaction by the authorizing institution. In all host capture terminal messages but the EBT voice-auth request, this data is in bit 38. |
BIT67 | Extended Payment Code.
The two-digit extended payment code field appears in the 0200 and 0220 financial request message. It pertains specifically to JCB transactions where the consumer can specify the number of installment payments they wish to make for each purchase. |
BIT70 | Network Management Information Code.
All request message types support the following codes:
The Tandem Online System will record this transaction as an error transaction with the given code and the error server name as ‘SLHBAS’. Full reversals support the following value: In addition, message type 0800 supports the following values:
|
BIT90 | Original Data Elements.
This eight-character field must appear in 0400 reversals and the nine-character field must appear in 0100 authorization reversal request messages. It contains the retrieval reference number from the original transaction response, and helps identify the original transaction for reversal processing. For timeout reversals where the original transaction's retrieval reference number is not known, populate this field with zeroes. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
G001 | Merchant Reference Data.
Used in settlement to uniquely identify a merchant’s transaction. The Merchant Reference Number can be present in any 0100, 0200, or 0220 authorization request transaction. The Draft locator ID field is a unique value assigned by the POS device for each transaction. The Merchant reference number should be a unique value assigned by the POS device for each transaction. |
G009 | Optional Processing Indicators.
It is a series of codes that identify terminal capability, terminal environment. Refer to the specification of the processor for more information. |
G009 | Optional Processing Indicators.
It is a series of codes that identify terminal capability, terminal environment. Refer to the specification of the processor for more information. |
G009 | Optional Processing Indicators.
It is a series of codes that identify terminal capability, terminal environment. Refer to the specification of the processor for more information. |
G014 | Original Authorization Retrieval Reference Number.
Provides a way to send an original authorization retrieval reference number. This field should be used when sending a 0220 force post. It should also be used with all full and partial reversals. This enables the Host to retrieve the original authorization information (if still available) to supplement settlement data. Note: Must be numeric. Any invalid data will be ignored by the host. |
G015 | Additional Amounts Request.
This 20-byte field contains information — up to six amount sets. The presence of this group is mandatory and indicates to the host this is an IIAS transaction request. The presence of G015 is optional in an EBT WIC authorization request transaction. IIAS transaction request: Amount type 4S must be present. The sum of the additional amount type fields must not exceed the total healthcare amount (4S). Any amount type can only appear once. EBT WIC transaction request: Only a single amount type 52 can be present in an EBT WIC authorization request transaction. Refer to the specification of the processor for more information. |
G021 | Fee Data.
Use this group to send convenience fee data. Please refer to card association regulations for details regarding fee usage. Convenience fees can be sent in a single transaction (Fee Type = 1) or in two transactions (Fee Types 2 and 3). 2. The second transaction must have Fee Type = 3 and both Transaction Amount and Fee Amount containing the convenience fee. VISA CPS/Debit tax fees must be sent in a two-step transaction (Fee Types 2 and 3). 2. The second transaction must have Fee Type = 3 and both Transaction Amount and Fee Amount containing the convenience fee. |
G023 | Restaurant Tip Amount.
Used in conjunction with a sale or adjustment message to log the tip amount received. The cents portion is the last two positions, and the decimal point is implied. Must be numeric. Invalid data will result in a declined transaction. This group is ignored if the merchant is not configured on the host as Restaurant industry. |
IS_DEBIT_TRANSACTION | Indicates whether the processed transaction is debit type. |
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. |
MESSAGE_TYPE_IDENTIFIER | Appears in every message type supported by the Tandem Online Systems host capture message set.
The first two digits identify the class of the message (authorization, financial, reversal, and so on); the last two digits represent the message function (request or response). |
NETWORK_ROUTING | Сan be used to route the transaction through the front-end communications network (for example, CompuServe’s Routing Identifier – CRI). It appears in all messages, but is ignored by the Tandem Online System. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
Name | Description |
---|---|
Clerk Number.
This eight-digit field appears in all controller requests that represent in-lane transactions. It identifies the employee associated with the transaction. If not applicable, the field should be zero filled. |
|
APPROVED_AMOUNT | Approved amount of the transaction. |
BIT_MAP_TYPE | Used in conjunction with the Message Type Identifier to determine which data elements are in the message being transmitted. |
BIT03 | Processing Code.
May appear in the following message types:
Consists of three two-digit sub fields that indicate how the transaction specified by the message type affects the customer’s related account(s). Note: The authorization service can update the "From" and "To" account information. The operating rules for the authorization service may require the terminal device to print the account information on the receipt. |
BIT04 | Transaction Amount.
This field may appear in the following message types:
The nine-digit transaction amount field represents the monetary value associated with the cardholder’s authorization, debit, or credit transaction request. The amount is entered in the terminal as a seven-digit number and is always right justified and zero filled. This field does not include cash back.
|
BIT04_AMOUNT | Amount.
This field may appear in the following message types:
The nine-digit transaction amount field represents the monetary value associated with the cardholder’s authorization, debit, or credit transaction request. The amount is entered in the terminal as a seven-digit number and is always right justified and zero filled. This field does not include cash back. |
BIT07 | Transmission Date and Time.
The transmission date and time field may appear in the following message types:
In the host capture terminal messages this field represents the date and time that the transaction was processed by the host. In the host capture controller messages this is the date/time at which the controller transmitted the transaction to the Tandem Online System. It is set by the controller. In a 0400 reversal message, the date and time apply to the reversal/void request itself, not the original transaction. The ten-digit field is in MMDDYYhhmm format, with the time portion expressed in 24-hour (military) notation. For example, 1114971346 represents Nov. 14, 1997, at 1:46 P.M. |
BIT105 | Contains several fields:
Refer to the specification of the processor for more information. |
BIT105_AVS_RESULT_CODE | AVS Result Code.
The field contains the CVV2 and address verification (AVS) result codes. Used for transactions where CVV2 and/or AVS was requested, it provides an additional indication that the card is being used by the person to which it was issued. The first character is the CVV2 result code, the second character is the AVS result code (space when the transaction does not qualify for AVS). Visa and MasterCard return CVV2/CVC2 response codes. The following tables list the CVV2 and AVS result codes. AVS RESULT CODE (POSITION 2)
|
BIT105_PAYMENT_SERVICE_INDICATOR | Payment Service Indicator.
This single-character field must appear in the following message types:
For VISA, the field contains a code that indicates whether the authorization qualifies for PS 2000 processing. ‘N’ = not PS2000 qualified; other values are as documented by VISA. For MasterCard, the field contains a CVC (card validation character) compliance flag, used internally by the Tandem Online System. |
BIT105_TRANSACTION_IDENTIFIER | Transaction Identifier Banknet/POSA SAF Ref. Num.
(VISA)/Banknet Data (MC)/POSA SAF Reference Number This 15-character field must appear in the following message types:
The field will contain information provided by the authorizer.
|
BIT105_VISA_VALIDATION_CODE | VISA Validation Code.
This four-character field must appear in the following message types:
For VISA transactions, the code in the field is used to determine the accuracy of the authorization data. It is generated by VISA using a VISA-proprietary algorithm based on the following request and response data fields. Primary Account Number Authorization Identification Response Transaction Amount Response Code Merchant Type Payment Service Indicator POS Entry Mode Code (positions 1-2) Transaction Identifier For MasterCard transactions, this field contains the Banknet date. |
BIT106 | Cardholder Identification (AVS).
This 29-character field must appear in the 0100 authorization request or 0200 financial transaction request message when the Bit Map Type is 05, 06, 25, or 26. It contains the data used for address verification. The field contains two data subfields: The first 20 positions are the cardholder’s address data, left justified and space filled; the last nine positions contain the ZIP code. If the ZIP code is present, it must be either five or nine characters in length, left justified and padded with spaces if only five characters. |
BIT107 | Point-of-Service Device Capability Code.
This two-character field must appear in the following messages:
The field contains two subfields that indicate the type of POS device used and the device’s ability to read encoded data. |
BIT109 | P.O. Number/Customer Code.
This twenty-character field contains the purchase order number applicable to a financial transaction or the customer code associated with a purchase card. It is required in the following message types:
The field is optional in the 0200 financial request for a private-label (Bit Map Type 07) or fuel (Bit Map Type 09) sale. |
BIT11 | System Trace Audit Number (STAN).
The in-store controller creates this six-digit number at transaction time to uniquely identify the transaction. This field appears in every message type supported by the Tandem Online System and the instore controller. |
BIT110 | Tax Amount.
This nine-digit field appears in 0100 authorization requests and 0200 financial requests that apply to corporate or purchase credit cards. It contains the dollar amount of tax included in the transaction, in the format 999999999. Sending a value of all 9’s (999999999) in the request message indicates that this is a non-taxable transaction. Sending a value of all 8’s (888888888) in the request message indicates that this is a tax-exempt transaction. Note: For non-corporate/purchase cards, this data element can be sent as all zeroes. |
BIT111 | Additional Data, Private EBT.
This 15-byte field is conditional in the 0200 financial message. Present only when the processing code indicates an EBT transaction, it contains the voucher number required for clearing EBT voice authorizations. |
BIT112 | Card Sequence Number.
The three-digit card sequence number field is conditional in the 0200 financial request message when the processing code indicates an EBT transaction. The field is required only if the card has a generation number and the card was not swiped. The card sequence number distinguishes between separate cards with the same primary account number. |
BIT12 | Local Transaction Date.
The six-digit transaction date appears in all request messages handled by the in-store controller; it indicates the date (MMDDYY) on which the transaction occurred at the point of sale. In 0400 reversal/void requests, this field represents the transaction being voided; see 07 Transmission Date/Time. In a Gift Card Completion message the Local Transaction Date must be populated with the Local Transaction Date received in the Gift Card Preauth approval message. In an Unsolicited Reversal the Local Transaction Date must be populated with the Local Transaction Date received in the original Authorization request message. |
BIT120_BATCH_NUMBER | Julian Day/Batch Number.
This six-digit field appears in the 0210 and 0230 financial response and 0410 reversal response messages. It indicates under which batch the EFT transaction was captured at the host. The field contains the three-digit Julian day when the batch was opened and the three-digit batch number. (The batch number increases by one whenever a batch is released and resets to one for each Julian day). The field does not appear if Bit Map Type is 99. |
BIT120_CARD_TYPE | Network Mnemonic/Card Type.
This field serves one of two purposes, depending on the transaction type. The two- to four-character Card Type appears in the 0110 purchase/corporate card, check verification/guarantee authorization responses, 0210/0230 credit, check conversion responses, and 0410 reversal response messages for credit transactions and check conversion reversals. The value is controlled by the in-store application and the Tandem Online System (BIN table). The third character, when present, indicates the card category.
are the VISA purchase-card categories; The fourth character, if present, is the authorization source indicator returned by Visa. The code is left justified with the remainder of the field space filled. Example of network switch value for payment type DB is “MAES“, for payment type EB is “EWA1”. |
BIT120_DEMO_MERCHANT_FLAG | Demo Merchant Flag.
This single-character field appears in the 0210 and 0230 financial response and 0410 reversal response messages. It indicates whether or not the terminal is being operated in demonstration or production mode. Does not appear if Bit Map Type is 99.
|
BIT123_ERROR_TEXT | Error Text.
This 20-character field must appear in all response messages when the Bit Map Type is 99 (i.e., error responses). The field indicates an error condition; the text is displayed on the POS terminal. |
BIT123_RESPONSE_CODE | Response Code.
The three-digit response code must appear in all response messages when the Bit Map Type is 99 (i.e., error responses). In the case of the 0330 file update response (Bit Map Types 81 and 89), both approval and error messages include the response code. This field is used to further define the cause of a decline or error response, and is displayed in the scroll area of the terminal. POSA Prepaid Transactions When error response code values of “001” or “795” is received, the POS device should place the transaction on a store-and-forward (SAF) queue for retransmission. SAF request messages must have the POSA-Stand-In indicator (Field 135) to “Y” and include the POSA SAF Reference Number (Field 136) of the original transaction when available. The POSA SAF Reference Number is provided in field 105.3 of the response message. A POS device time-out should be treated the same as receiving a “001” response code except that the POSA SAF Reference Number should be set to spaces. If SAF queuing is used, the POS should use parameters to determine number of retries and retry interval. |
BIT124_WORKING_KEY | Working Key.
The 16-character working key appears in all response messages. It is not used when DUKPT encryption is employed. The field will contain blanks if the host does not require a key exchange. If the field does not contain blanks, the terminal uses this working key for future debit/EBT transaction processing. |
BIT128_ADDITIONAL_AMOUNTS | Additional Amounts.
This 20-byte field contains information — up to six amounts and related account data — for which specific data elements are not defined. It is used in 0110, for Premier Issue Mass Transaction, EBT and used in 0210 for EBT, POSA Prepaid and Gift Card responses, where it contains balance information. |
BIT13 | Local Transaction Time.
The six-digit transaction time appears in all request messages handled by the in-store controller; it indicates the time (hhmmss) at which the transaction occurred at the point of sale. In 0400 reversal/void requests, this field represents the transaction being voided; see 07 Transmission Date/Time. In a Gift Card Completion message the Local Transaction Time must be populated with the Local Transaction Time received in the Gift Card Preauth approval message. In a Unsolicited Reversal the Local Transaction Time must be populated with the Local Transaction Time received in the original Authorization request message. |
BIT133 | POSA Network ID.
This four-byte field defines the POSA network used to authorize the POSA transaction. This field must appear in all POSA transactions. POSA networks are:
If the merchant is processing POSA cards, but the point-of-sale system is unable to determine the POSA Network, then that merchant can only successfully process for a single POSA network. In this case, the POSA Network ID field must be set up at the point of sale to always indicate the merchant’s selected network (e.g. SWAY). The value should either be hard-coded into the system or set as a parameter. If the merchant also sells their own gift cards via non-POSA networks, then the BIN range(s) for the merchant’s gift cards must be registered with Vantiv, LLC (Tandem Onlines) for processing. Notes: Merchants that do not participate in POSA need to fill the POSA Network ID field with spaces. Contact Vantiv, LLC for current supported networks. |
BIT134 | POSA UPC Data.
This twenty-byte field contains the POSA scanned UPC (bar code data) on the card used to authorize the POSA prepaid transaction. This field must appear in all POSA prepaid transactions |
BIT135 | POSA Stand-In indicator.
This one-byte field is used to indicate a POSA store and forward transaction request due to a merchant stand-in condition. Applicable to POSA activation and reload SAF transaction requests only. Use a value of “Y”, if the POS device has timed out or the host responds with response code “001” or “795” and load the POSA SAF reference number into field 136 of the request message. The POSA SAF Reference Number is returned in field 105.3 of every POSA response message, and should be retained for use in any SAF retransmission request. When setting the POSA Stand-In indicator to “N”, the POSA SAF reference number must be initialized to spaces. This field must appear in any POSA activation or reload SAF requests when the transaction is queued for re-transmission by the POS device. |
BIT136 | POSA SAF Reference Number.
This twelve-byte field contains a unique number generated by the host for each POSA prepaid transaction. The host returns this value on every POSA prepaid transaction that is approved or declined (see field 105.3 – Transaction Identifier). In a Store-and-Forward scenario, where the transaction is queued for retransmission by the POS device this field contains the POSA SAF reference number of the original Activation/Reload transaction in the POSA prepaid request message. If a POSA device time out occurs no POSA SAF Reference Number is available then set the POSA SAF Reference Number to spaces and the POSA Stand-In Indicator (field 135) to a value of “Y”. |
BIT137 | Replacement Amount.
In a partial authorization reversal, the Replacement Amount reflects the corrected total amount of the authorization for the transaction. For a partial reversal, the Transaction Amount field must contain the original amount authorized. The host subtracts the Replacement Amount from the Transaction Amount to determine the amount being reversed. For timeout reversals, and for other cases where the original authorization is to be fully reversed, the replacement amount must be zero. The replacement amount must not be equal to or greater than the transaction amount. Partial reversals are currently only supported for VISA and MasterCard payment types. |
BIT22 | Point-of-Service Entry Mode.
The three-digit POS entry mode field must appear in the following messages:
Contains two subfields that indicate the method used to enter the primary account number (PAN) and whether the POS terminal allows entry of personal identification numbers (PINs). |
BIT25 | Point-of-Service Condition Code.
The ten-digit POS condition code field must appear in the following messages:
Contains four subfields that, together, identify the kind of terminal and indicate whether the customer and/or the customer’s credit card were present at the time of the transaction. |
BIT32 | Acquiring Institution Identification Code.
This four-digit field must appear in the following message types:
The code (referred to in the Tandem Online Systems as the Bank ID) identifies the acquiring institution (i.e., merchant bank, merchant grouping, or merchants’ hierarchy) for the associated Card Acceptor ID Code (the Tandem Online Systems Merchant Number). |
BIT37_RETRIEVAL_REFERENCE_NUMBER | Retrieval Reference Number.
This eight-digit must appear in the following message types:
The retrieval reference number is used to identify and track the original transaction. The field is conditional; it is present in the message only when the Bit Map Type is not 99. |
BIT41 | Card Acceptor Terminal Identification.
The three-digit card acceptor terminal ID code (referred to as the Terminal ID in the Tandem Online System) identifies the terminal at the merchant (card acceptor) location at which the transaction was entered. This field must appear in all transaction request messages. |
BIT42 | Card Acceptor Identification Code.
The 12-digit card acceptor ID code (referred to as the Merchant ID in the Tandem Online System) must appear in all transaction request messages. This field, in conjunction with the acquiring institution identification code (Field 32), uniquely identifies the merchant in the Tandem Online System. |
BIT43 | Lane Number.
This three-digit field appears in the following controller message types:
It identifies the cashier location at which the transaction occurred. Note: Of the 3 digit lane number only the right most two bytes are used. Lane numbers must be within the range of 01 to 99. |
BIT60 | Cash Back Amount.
This nine-digit field appears in the 0100 authorization and 0200 financial request messages. It represents the amount of money being given back to the cardholder. The entered amount can be up to seven digits; in the message it must be right-justified and padded with zeros to the full nine positions. This amount should not be included in the transaction amount field. For AVS verification only (Processing code 514000) request, this field must be zero filled. |
BIT63 | Contains several fields:
This six-digit field appears in the 0200 and 0220 financial messages for those transactions (usually designated for specific card types) that use the extended prompts option. The field is required when settling American Express retail transactions. If the message also includes the P.O. Number/Customer Code field (bit 109), this field is ignored unless bit 109 is space-filled. These four-digit fields appear in the 0200 and 0220 financial messages for those transactions (usually designated for specific card types) that use the extended prompts option. These fields are used to cross reference a table in the Tandem Online Systems database that designates the type of merchandise purchased. Required when settling American Express retail transactions. |
BIT65 | Authorization Identification Response.
This six-character field appears in the following messages:
The auth ID response contains an authorization number assigned to the transaction by the authorizing institution. In all host capture terminal messages but the EBT voice-auth request, this data is in bit 38. |
BIT65_AUTHORIZATION_IDENTIFICATION_RESPONSE | Authorization Identification Response.
This six-character field appears in the following messages:
The auth ID response contains an authorization number assigned to the transaction by the authorizing institution. In all host capture terminal messages but the EBT voice-auth request, this data is in bit 38. |
BIT67 | Extended Payment Code.
The two-digit extended payment code field appears in the 0200 and 0220 financial request message. It pertains specifically to JCB transactions where the consumer can specify the number of installment payments they wish to make for each purchase. |
BIT70 | Network Management Information Code.
All request message types support the following codes:
The Tandem Online System will record this transaction as an error transaction with the given code and the error server name as ‘SLHBAS’. Full reversals support the following value: In addition, message type 0800 supports the following values:
|
BIT90 | Original Data Elements.
This eight-character field must appear in 0400 reversals and the nine-character field must appear in 0100 authorization reversal request messages. It contains the retrieval reference number from the original transaction response, and helps identify the original transaction for reversal processing. For timeout reversals where the original transaction's retrieval reference number is not known, populate this field with zeroes. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
G001 | Merchant Reference Data.
Used in settlement to uniquely identify a merchant’s transaction. The Merchant Reference Number can be present in any 0100, 0200, or 0220 authorization request transaction. The Draft locator ID field is a unique value assigned by the POS device for each transaction. The Merchant reference number should be a unique value assigned by the POS device for each transaction. |
G009 | Optional Processing Indicators.
It is a series of codes that identify terminal capability, terminal environment. Refer to the specification of the processor for more information. |
G009 | Optional Processing Indicators.
It is a series of codes that identify terminal capability, terminal environment. Refer to the specification of the processor for more information. |
G009 | Optional Processing Indicators.
It is a series of codes that identify terminal capability, terminal environment. Refer to the specification of the processor for more information. |
G014 | Original Authorization Retrieval Reference Number.
Provides a way to send an original authorization retrieval reference number. This field should be used when sending a 0220 force post. It should also be used with all full and partial reversals. This enables the Host to retrieve the original authorization information (if still available) to supplement settlement data. Note: Must be numeric. Any invalid data will be ignored by the host. |
G015 | Additional Amounts Request.
This 20-byte field contains information — up to six amount sets. The presence of this group is mandatory and indicates to the host this is an IIAS transaction request. The presence of G015 is optional in an EBT WIC authorization request transaction. IIAS transaction request: Amount type 4S must be present. The sum of the additional amount type fields must not exceed the total healthcare amount (4S). Any amount type can only appear once. EBT WIC transaction request: Only a single amount type 52 can be present in an EBT WIC authorization request transaction. Refer to the specification of the processor for more information. |
G021 | Fee Data.
Use this group to send convenience fee data. Please refer to card association regulations for details regarding fee usage. Convenience fees can be sent in a single transaction (Fee Type = 1) or in two transactions (Fee Types 2 and 3). 2. The second transaction must have Fee Type = 3 and both Transaction Amount and Fee Amount containing the convenience fee. VISA CPS/Debit tax fees must be sent in a two-step transaction (Fee Types 2 and 3). 2. The second transaction must have Fee Type = 3 and both Transaction Amount and Fee Amount containing the convenience fee. |
G023 | Restaurant Tip Amount.
Used in conjunction with a sale or adjustment message to log the tip amount received. The cents portion is the last two positions, and the decimal point is implied. Must be numeric. Invalid data will result in a declined transaction. This group is ignored if the merchant is not configured on the host as Restaurant industry. |
IS_DEBIT_TRANSACTION | Indicates whether the processed transaction is debit type. |
IS_REVERSAL_APPLIED | Indicates whether the original transactions was already reversed. |
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. |
MESSAGE_TYPE_IDENTIFIER | Appears in every message type supported by the Tandem Online Systems host capture message set.
The first two digits identify the class of the message (authorization, financial, reversal, and so on); the last two digits represent the message function (request or response). |
NETWORK_ROUTING | Сan be used to route the transaction through the front-end communications network (for example, CompuServe’s Routing Identifier – CRI). It appears in all messages, but is ignored by the Tandem Online System. |
R001 | eCommerce VISA Authentication Result.
Used to indicate the result of an eCommerce VISA transaction that requested authentication. This response is only applicable to VISA transactions when G002 is sent in the request message. Notes: Non-U.S. acquired transactions that occur on cards issued in the U.S. region can receive a CAVV result code values of 7,8,9, or A. V.I.P. will reject a transaction with Reject Reason Code 0193 (invalid value) when an issuer returns the response message with the value C or D. |
R006 | Card-Level Results.
The field contains a two-character code created by Visa during the authorization process. Refer to the specification of processor for more information. |
R007 | Additional Amounts.
This 20-byte field contains information — up to four amount sets. This group is returned when the transaction has been partially approved and on balance inquiries. Refer to the specification of processor for more information. |
R008 | Original Authorization Retrieval Reference Number.
This group is used to respond with the retrieval reference number of the authorization transaction. To request this group to be returned the sixth byte of G009 (Optional Processing Indicators) on authorization request has to be set to “Y”. |
R009 | AMEX Transaction Identifier/Discover Network Reference ID.
Used to pass the AMEX Transaction Identifier/Discover Network Reference ID. This response group is returned on approvals or declines when G009 position 4 in request is set to "Y" and the American Express transaction was sent to American Express for authorization, or when G009 position 9 in request is set to "Y" and the Discover transaction was sent to Discover for authorization. |
R999 | Error Group Data Response.
This group response is applicable to any transaction that sends group data in a request message and is determined by the host that it is invalid. Note: A value of “00” in the group field indicates group level error no specific field. Used to indicate any errors found by the host when processing authorization requests that contain any optional group data. Refer to the specification of processor for more information. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
Name | Description |
---|---|
ACCOUNT_SOURCE | This value is used to facilitate transaction routing on Elavon.
0 = Manually entered transaction originated at a device capable of reading track 1 or 2 1 = Inquiry originated at a track 1 magnetic stripe reading device (capable of reading track 1 or 2 data) 2 = Inquiry originated at a track 2 magnetic stripe reading device 3 = Inquiry originated at a Proximity payment reading device 4 = Inquiry originated at a MICR device |
AMOUNT | Total amount of the transactions including discount and tax. The transaction amount in the cardholder’s currency in 9(10)v99 format. |
AUTH_REFERENCE_NBR | Authorization reference number. |
AVS_INDICATOR | Address Verification Service indicator. |
BANK_NBR | This six digit fixed length value is assigned by Elavon.
The bank identification number is used to uniquely identify the financial institution to Elavon. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CUSTOM_DATA | This field is used to pass additional data for specific industries and/or market segments. |
FORCE_APPROVAL | This field is used when reversal contains Approval Code from original transaction. |
FORMAT_CODE | This is a unique code that is used by the Merchant to denote the specific parsing rules for the merchant defined data that is contained in the Format Data field.
The Format Code field is used to denote different parsing structure for this field, if necessary. 000 = ECS Data – Format A 001 = ECS Data – Format B 002 = ECS Enhanced Transaction Data 003 = POS Logistics – Equipment Data 004 = POS Logistics – Statistics Data |
FORMAT_ONE | This is a unique code that is used by the Merchant to denote the specific parsing rules for the merchant defined data that is contained in the Format Data field.
This field contains information in first type of format. |
FORMAT_THREE | This is a unique code that is used by the Merchant to denote the specific parsing rules for the merchant defined data that is contained in the Format Data field.
This field contains information in third type of format. |
FORMAT_TWO | This is a unique code that is used by the Merchant to denote the specific parsing rules for the merchant defined data that is contained in the Format Data field.
This field contains information in second type of format. |
MARKET_SEGMENT | Indicates transaction industry. |
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. |
PARTIAL_AUTH_IND | This value is used to indicate if the POS is capable of performing partial authorizations.
0 = Indicates that the POS is not capable of Partial Authorizations 1 = Indicates that the POS is capable of Partial Authorizations 2 = Indicates that the POS is capable of Partial Authorizations and is a Visa Aggregator |
REG_KEY | Required in all Scripts sent to the Elavon Host for processing and will be sent as a HTTP Header Field in the Post request.
Note: The Registration Key should be sent as an HTTP Header field. The NOVA_PORTAL_FAKE_KEY is only used to send transactions to the Elavon development host and cannot be used to send traffic to production hosts. A production Registration Key will be assigned by the Certification Department after certification is complete and is 20 characters long. |
RESPONSE_CODE | Gateway generated response code. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
STREET | The Merchant’s Street Address. |
TERMINAL_NBR | This sixteen digit fixed length value is assigned by Elavon.
The terminal identification number is used to uniquely identify the Merchant and their financial institution to Elavon. The Terminal ID consists of two parts and is assigned by Elavon for each POS device. |
TRACE_NBR | This value is used as a message reference number identify the transaction request and is returned in all authorization response messages. It is sent to the host on reversal and void messages when applicable. |
TRANSACTION_CODE | This value is used to uniquely identify the type of transaction that is being submitted to Elavon. Refer to the provider's specification for more information. |
VENDOR_ID | This value is assigned by the Vendor Certification Department of ELAVON.
This number is an alphanumeric value and should be capitalized. All Vendor Certification Device Types are value of "Z". |
ZIP | The Merchant’s postal or zip code. |
Name | Description |
---|---|
ACCOUNT_BALANCE | For Credit and Debit cards, if present this value indicates the remaining balance for a pre-paid account. For EBT transactions, if present this value indicates the remaining Food Stamp balance. For Gift Card transactions, if present this value indicates the remaining Gift Card balance on the account. Refer to the specification of the provider for more information. |
ACCOUNT_SOURCE | This value is used to facilitate transaction routing on Elavon.
0 = Manually entered transaction originated at a device capable of reading track 1 or 2 1 = Inquiry originated at a track 1 magnetic stripe reading device (capable of reading track 1 or 2 data) 2 = Inquiry originated at a track 2 magnetic stripe reading device 3 = Inquiry originated at a Proximity payment reading device 4 = Inquiry originated at a MICR device |
AMEX_CAP_CODE | This is the American Express Capture Code field and is returned during a credit card authorization response. It determines the capture option allowed for the American Express Card in the Split Dial environment, where the POS is accessing Amex directly for Authorization processing of Amex Cards.
0 = Do not process 1 = Allow authorizations but do not capture in Settlement file 2 = Allow authorizations and capture in settlement file for processing |
AMOUNT | Total amount of the transactions including discount and tax. The transaction amount in the cardholder’s currency in 9(10)v99 format. |
APPROVAL_CODE | This field contains the Approval Code for an approved transaction.
Note: If the Response Code on the auth. is not equal to "AA" or “AP” the contents of this field are ignored. |
AUTH_RESPONSE | This field contains the 16 character response display message. This field is used by the POS device to display the authorization results. |
AUTH_SOURCE | This value is used to indicate the source for the authorization response. The values in this response message are subject to additions.
For On-Line transactions, the codes are supplied by the Issuer and are returned by Elavon in the response message for all on line approvals For Off-Line transactions, this is a one character field in the list below contains the Authorization Source code: 9 = No Authorization Source Code. This is used for non-authorized transactions, such as Credit Card Returns E = Off-Line Approval. This is used when the approval code is manually entered, such as on a Referral or Force Transaction 6 = Off-Line approval, POS generated the approval. |
AUTHORIZED_AMOUNT | This value is used to indicate the authorized amount of the transaction (excluding adjustments). |
AVS_INDICATOR | Address Verification Service indicator. |
AVS_RESPONSE_CODE | This value contains the address verification response code returned in response message as a result of an AVS Request. It is also a required value for a terminal-based settlement, if returned in the authorization response. |
BANK_NBR | This six digit fixed length value is assigned by Elavon.
The bank identification number is used to uniquely identify the financial institution to Elavon. |
CAP_CODE | This field is used to indicate to the POS which transactions should be captured in the local Shadow file.
0 = Do not Capture – Authorization Only 1 = Capture Transaction in Shadow File (EDC) 2 = Capture Transaction in Shadow File (EDC) This value is used for Debit Returns to indicate that the Debit Purchase is in the current batch. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CUSTOM_DATA | This field is used to pass additional data for specific industries and/or market segments. |
CVV2_RESPONSE | This value contains the Card verification response code returned in Authorization Response. It is also a required value for a terminal-based settlement message, if returned in the authorization response.
M = Match N = No match P = Not Processed S = Issuer indicates that CVV2 data should be present on the card, but the merchant has indicated that the CVV2 data is not present on the card (Visa Only) U = Issuer not certified or registered to process card verification |
FORCE_APPROVAL | This field is used when reversal contains Approval Code from original transaction. |
FORMAT_CODE | This is a unique code that is used by the Merchant to denote the specific parsing rules for the merchant defined data that is contained in the Format Data field.
The Format Code field is used to denote different parsing structure for this field, if necessary. 000 = ECS Data – Format A 001 = ECS Data – Format B 002 = ECS Enhanced Transaction Data 003 = POS Logistics – Equipment Data 004 = POS Logistics – Statistics Data |
FORMAT_ONE | This is a unique code that is used by the Merchant to denote the specific parsing rules for the merchant defined data that is contained in the Format Data field.
This field contains information in first type of format. |
FORMAT_THREE | This is a unique code that is used by the Merchant to denote the specific parsing rules for the merchant defined data that is contained in the Format Data field.
This field contains information in third type of format. |
FORMAT_TWO | This is a unique code that is used by the Merchant to denote the specific parsing rules for the merchant defined data that is contained in the Format Data field.
This field contains information in second type of format. |
MARKET_SEGMENT | Indicates transaction industry. |
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. |
MSDI | The Market Specific Data Indicator value.
Space = Not Specified A = Auto Rental B = Bill Payment E = Visa Aggregator G = MasterCard Payment Gateway H = Hotel Edits J = Business to Business M = HealthCare (Auto Substantiation) N = Not Applicable (Failed Edits) T = Transit (Auto Substantiation) I = Internet PIN 31 |
PARTIAL_AUTH_IND | This value is used to indicate if the POS is capable of performing partial authorizations.
0 = Indicates that the POS is not capable of Partial Authorizations 1 = Indicates that the POS is capable of Partial Authorizations 2 = Indicates that the POS is capable of Partial Authorizations and is a Visa Aggregator |
PS2000_DATA | This data will be as received during the original authorization processing. It will not be present for off line transactions. This is a “retain and return” value for terminal-based settlement messages. |
REFERENCE_NBR | Beginning Transaction reference number. |
REG_KEY | Required in all Scripts sent to the Elavon Host for processing and will be sent as a HTTP Header Field in the Post request.
Note: The Registration Key should be sent as an HTTP Header field. The NOVA_PORTAL_FAKE_KEY is only used to send transactions to the Elavon development host and cannot be used to send traffic to production hosts. A production Registration Key will be assigned by the Certification Department after certification is complete and is 20 characters long. |
RESPONSE_CODE | Gateway generated response code. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
STREET | The Merchant’s Street Address. |
TERMINAL_NBR | This sixteen digit fixed length value is assigned by Elavon.
The terminal identification number is used to uniquely identify the Merchant and their financial institution to Elavon. The Terminal ID consists of two parts and is assigned by Elavon for each POS device. |
TRACE_NBR | This value is used as a message reference number identify the transaction request and is returned in all authorization response messages. It is sent to the host on reversal and void messages when applicable. |
TRANS_DATE | The actual date of the transaction. |
TRANS_TIME | The actual time of the transaction. |
TRANSACTION_CODE | This value is used to uniquely identify the type of transaction that is being submitted to Elavon. Refer to the provider's specification for more information. |
VENDOR_ID | This value is assigned by the Vendor Certification Department of ELAVON.
This number is an alphanumeric value and should be capitalized. All Vendor Certification Device Types are value of "Z". |
ZIP | The Merchant’s postal or zip code. |
Name | Description |
---|---|
ACCOUNT_ENTRY_MODE | This value is used to identify the method used to enter the Account Data for the transaction. Refer to the specification of the provider for more information. |
ACCOUNT_TYPE | This value is used to facilitate transaction routing on Elavon.
0 = Default or primary account on file (In Canada this is only used for Flash Transactions) 1 = Checking 2 = Savings 3 = Food Stamp 4 = Cash Benefits |
APPLICATION_ID | This field is used to indicate the type of POS device that is originating the transaction. These values are case sensitive and must be capitalized. Sample: HZ0000GC. |
APPROVAL_CODE | This field contains the Approval Code for an approved transaction.
Note: If the Response Code on the auth. is not equal to "AA" or “AP” the contents of this field are ignored. |
CASHBACK_AMOUNT | This field is used to indicate the cashback amount applied to the transaction. This amount should be included in the Transaction Amount field. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CUSTOMER_CODE | This value is used to identify the customer number for purchasing card transactions. |
CVV2_INDICATOR | This value is used to indicate the presence of the CVV2 data on the Visa card. For non-Visa Cards, the value of “Present” should be used when CVC2 or CID data is present, or “Bypassed” when not present.
0 = Bypassed 1 = Present 2 = Illegible 9 = Not Present |
DYNAMIC_DBA_NAME | This value allows the merchant to dynamically change the “Doing Business As” name on each transaction submitted to the host for authorization and settlement. The use of the dynamic DBA (dDBA) field is restricted by Elavon and requires prior approval to participate in the program. Values that are sent in this field by merchants that are not approved for use of this field will be ignored by the host prior to authorization and the value currently “on file” with Elavon will be used. |
ECOMMERCE_INDICATOR | This indicates the method used to capture the cardholder’s information for an eCommerce or Internet transaction.
1 = Secure Electronic Commerce Transaction that includes the 3-D Secure Authentication value. (5) 2 = Non-Authenticated Security Transaction from a 3-D Secure capable merchant, and merchant attempted to authorize using 3-D Secure. Transaction Does Not Include 3-D Secure authentication value. (6) 3 = Non-Authenticated Security Transaction w/o Merchant Certificate i.e., Channel Encrypted (7) 4 = Non-Authenticated Security Transaction at a SET Capable merchant (9) 5 = Non-Secure Transaction (no encryption used) (8) |
GIFT_LOYALTY_TRANSACTION_CODE | This character is used by the POS to uniquely identify the transaction to the gift card host. This value is required for both Gift Card and Loyalty reversal transactions.
A unique value assigned by the POS to identify the gift card transaction. |
INSTALLMENT_COUNT | This value is used to indicate the total number of payments for an installment transaction. For example, if the consumer is making payment 1 of 12, then this value should be set to “12”. |
INSTALLMENT_NUMBER | This value is used to indicate the current payment number for an installment transaction. For example, if the consumer is making payment 1 of 12, then this value should be set to “1”. |
INVOICE_NUMBER | This value is used to include the POS’s local transaction invoice or order number. This is a required value for Mail Order and Ecommerce transactions. |
KEY_POINTER | This value is used to indicate which encryption methodology was used for US Debit transactions (POS to Elavon) and which key to use for the next transaction (Elavon to POS).
D = Single-DES DUKPT T = Triple-DES DUKPT P = PIN Less Debit Purchase |
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. |
MERCHANT_REFERENCE_NBR | This value contains the merchant assigned reference number for this transaction. If this value is not present, then Elavon will generate this number for backend use. |
PARTIAL_AUTH_INDICATOR | This value is used to indicate if the POS is capable of performing partial authorizations.
0 = Indicates that the POS is not capable of Partial Authorizations. 1 = Indicates that the POS is capable of Partial Authorizations. 2 = Indicates that the POS is capable of Partial Authorizations and is a Visa Aggregator. |
POS_ENTRY_CAPABILITY | This value is used to identify the account entry capabilities on the POS device originating the transaction. Refer to the specification of the provider for more information. |
POSTAL_ZIP_CODE | This value is used to indicate the cardholder’s Postal or ZIP Code. |
PS2000_DATA | This data will be as received during the original authorization processing. It will not be present for off line transactions. This is a “retain and return” value for terminal-based settlement messages. Refer to the specification of the provider for more information. |
RECURRING_PAYMENT_TYPE | This field is used to identify the type of recurring transaction that is being submitted for authorization.
Recurring transactions have a defined billing cycle and are in effect as long as the contract between the merchant and the cardholder is in good standing. Recurring payments include charges for Utilities, membership fees, subscriptions, insurance premiums, tuition, etc. Installment transactions have a defined transaction amount, billing cycle, and a total number of payments, which equal the full amount for the original agreed upon purchase. Installment payments include charges for loan payments, car purchase, furniture stores, etc. |
REQUEST | Type of request. |
RESPONSE_CODE | This value is a 2 character code indicating the authorization response status. An approval is always indicated with an ‘AA’ or ‘AP’ code, all other codes indicate a non-approval.
AA = Approved Transaction (Authorizations and Reversals) AP = Approved Transaction for a Partial Amount NC = Decline (Pick Up Card) ND = Decline (Hard or Soft) NF = Decline (Record Not Found) NR = Decline (Referral Message) N7 = Decline (For CVV2 Only) NL = Decline (Loyalty/Gift Error) 00-99 = Decline (Additional Gift Card Declined) |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
SALES_TAX | This is the actual sales tax amount applied to this transaction. Consumer or Merchant tax exempt transactions can enter a single zero to properly reflect a tax exempt transaction. |
SHIPPING_DATE | The value is the date that the consumer’s goods were shipped. This value is the “Transaction Date” for direct marketing and ecommerce transactions.
Shipping Date in MMDDYYYY format. |
STREET_ADDRESS | This value is used to identify the cardholder’s street address. |
SURCHARGE_AMOUNT | This field is used to indicate the amount of the surcharge applied to the transaction. This amount should be included in the Transaction Amount field. |
TENDER_TYPE | The value is used to identify the payment method use to activate or reload a gift card.
0 = Cash 1 = Credit Card 2 = Debit Card 3 = Check 9 = Unknown |
TERMINAL_ID | The terminal identification number is used to uniquely identify the Merchant and their financial institution to Elavon. The Terminal ID consists of two parts and is assigned by Elavon for each POS device. |
TRACE_NUMBER | This value is used as a message reference number identify the transaction request and is returned in all authorization response messages. It is sent to the host on reversal and void messages when applicable. |
TRANSACTION_AMOUNT | This is the actual amount of the transaction. The maximum transaction amounts supported are currently $9,999,999.99 for Visa and MasterCard, and $99,999.99 all others card associations.
For Terminal-Based Settlement messages, this value will contain the total amount of the transaction in the Merchant’s currency, including any Tips (for restaurant transactions). For Canadian Debit Authorization Response messages, this field is zero filled and right justified to 12 characters. |
TRANSACTION_CODE | This value is used to uniquely identify the type of transaction that is being submitted to Elavon. Refer to the specification of the provider for more information. |
TRANSACTION_REFERENCE_NBR | The Transaction Reference Number is returned in the authorization response message and is used on void and reversal transactions, when available. This number is assigned by Elavon. |
UCAF_INDICATOR | This value identifies the means in which the transaction was processed between the cardholder and the merchant for a SecureCode authentication transaction.
0 = UCAF data collection is not supported by the Merchant 1 = UCAF data collection is supported by merchant but not populated 2 = UCAF data collection is supported by merchant, and UCAF data must be present |
VOUCHER_CLEAR_NBR | The Voucher Number from an EBT sales slip, used for Voucher Clear Food Stamp transactions.
The 15 digit Voucher Clear Number from the Merchant’s EBT Food Stamp sales slip. |
Name | Description |
---|---|
ACCOUNT_BALANCE1 | For Credit and Debit cards, if present this value indicates the remaining balance for a pre-paid account. For EBT transactions, if present this value indicates the remaining Food Stamp balance. For Gift Card transactions, if present this value indicates the remaining Gift Card balance on the account. Refer to the specification of the provider for more information. |
ACCOUNT_BALANCE2 | For Credit and Debit cards, if present this value indicates the remaining Gift Card Balance on the account.
For EBT transactions, if present this value indicates the remaining Cash Benefit balance. For Gift Card transactions, if present this value indicates the remaining Loyalty points on the account. |
ACCOUNT_ENTRY_MODE | This value is used to identify the method used to enter the Account Data for the transaction. Refer to the specification of the provider for more information. |
ACCOUNT_TYPE | This value is used to facilitate transaction routing on Elavon.
0 = Default or primary account on file (In Canada this is only used for Flash Transactions) 1 = Checking 2 = Savings 3 = Food Stamp 4 = Cash Benefits |
AMEX_CAPTURE_CODE | This is the American Express Capture Code field and is returned during a credit card authorization response. It determines the capture option allowed for the American Express Card in the Split Dial environment, where the POS is accessing Amex directly for Authorization processing of Amex Cards.
0 = Do not process 1 = Allow authorizations but do not capture in Settlement file 2 = Allow authorizations and capture in settlement file for processing |
APPLICATION_ID | This field is used to indicate the type of POS device that is originating the transaction. These values are case sensitive and must be capitalized. Sample: HZ0000GC. |
APPROVAL_CODE | This field contains the Approval Code for an approved transaction.
Note: If the Response Code on the auth. is not equal to "AA" or “AP” the contents of this field are ignored. |
AUTHORIZATION_DATE | This value is the date which the transaction was authorized. For offline transactions, this value should be set to the date when the transaction occurs. |
AUTHORIZATION_RESPONSE | This field contains the 16 character response display message. This field is used by the POS device to display the authorization results. |
AUTHORIZATION_SOURCE | This value is used to indicate the source for the authorization response. The values in this response message are subject to additions.
For On-Line transactions, the codes are supplied by the Issuer and are returned by Elavon in the response message for all on line approvals. For Off-Line transactions, this is a one character field in the table below contains the Authorization Source code: 9 = No Authorization Source Code. This is used for non-authorized transactions, such as Credit Card Returns E = Off-Line Approval. This is used when the approval code is manually entered, such as on a Referral or Force Transaction 6 = Off-Line approval, POS generated the approval. |
AUTHORIZATION_TIME | This value is the time which the transaction was authorized. For offline transactions, this value should be set to the time when the transaction occurs. |
AUTHORIZED_AMOUNT | This value is used to identify the total authorized amount for the authorization request. If the Partial authorization flag is enabled, this amount may be less than the requested amount. |
AVS_RESPONSE | This value contains the address verification response code returned in response message as a result of an AVS Request. It is also a required value for a terminal-based settlement, if returned in the authorization response. Refer to the specification of the provider for more information. |
CAPTURE_CODE | This field is used to indicate to the POS which transactions should be captured in the local Shadow file.
0 = Do not Capture – Authorization Only 1 = Capture Transaction in Shadow File (EDC) 2 = Capture Transaction in Shadow File (EDC). This value is used for Debit Returns to indicate that the Debit Purchase is in the current batch. |
CASHBACK_AMOUNT | This field is used to indicate the cashback amount applied to the transaction. This amount should be included in the Transaction Amount field. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CUSTOMER_CODE | This value is used to identify the customer number for purchasing card transactions. |
CVV2_INDICATOR | This value is used to indicate the presence of the CVV2 data on the Visa card. For non-Visa Cards, the value of “Present” should be used when CVC2 or CID data is present, or “Bypassed” when not present.
0 = Bypassed 1 = Present 2 = Illegible 9 = Not Present |
CVV2_RESPONSE | This value contains the Card verification response code returned in Authorization Response. It is also a required value for a terminal-based settlement message, if returned in the authorization response.
M = Match N = No match P = Not Processed S = Issuer indicates that CVV2 data should be present on the card, but the merchant has indicated that the CVV2 data is not present on the card (Visa Only) U = Issuer not certified or registered to process card verification. |
DEBIT_EBT_NETWORK_ID | This value is used to indicate the Debit Network that the transaction was routed through for authorization. It may also be used on the Debit Purchase and PINLess Purchase transaction to indicate the preferred Debit Network routing ID for authorization. Refer to the specification of the provider for more information. |
DEBIT_EBT_SETTLEMENT_DATE | This value is the debit switch settlement date in MMDD format. |
DYNAMIC_DBA_NAME | This value allows the merchant to dynamically change the “Doing Business As” name on each transaction submitted to the host for authorization and settlement. The use of the dynamic DBA (dDBA) field is restricted by Elavon and requires prior approval to participate in the program. Values that are sent in this field by merchants that are not approved for use of this field will be ignored by the host prior to authorization and the value currently “on file” with Elavon will be used. |
ECOMMERCE_INDICATOR | This indicates the method used to capture the cardholder’s information for an eCommerce or Internet transaction.
1 = Secure Electronic Commerce Transaction that includes the 3-D Secure Authentication value. (5) 2 = Non-Authenticated Security Transaction from a 3-D Secure capable merchant, and merchant attempted to authorize using 3-D Secure. Transaction Does Not Include 3-D Secure authentication value. (6) 3 = Non-Authenticated Security Transaction w/o Merchant Certificate i.e., Channel Encrypted (7) 4 = Non-Authenticated Security Transaction at a SET Capable merchant (9) 5 = Non-Secure Transaction (no encryption used) (8) |
GIFT_LOYALTY_TRANSACTION_CODE | This character is used by the POS to uniquely identify the transaction to the gift card host. This value is required for both Gift Card and Loyalty reversal transactions.
A unique value assigned by the POS to identify the gift card transaction. |
INSTALLMENT_COUNT | This value is used to indicate the total number of payments for an installment transaction. For example, if the consumer is making payment 1 of 12, then this value should be set to “12”. |
INSTALLMENT_NUMBER | This value is used to indicate the current payment number for an installment transaction. For example, if the consumer is making payment 1 of 12, then this value should be set to “1”. |
INVOICE_NUMBER | This value is used to include the POS’s local transaction invoice or order number. This is a required value for Mail Order and Ecommerce transactions. |
ISSUER_RESPONSE_CODE | This value is the original Issuer response as returned during the authorization attempt. |
KEY_POINTER | This value is used to indicate which encryption methodology was used for US Debit transactions (POS to Elavon) and which key to use for the next transaction (Elavon to POS).
D = Single-DES DUKPT T = Triple-DES DUKPT P = PIN Less Debit Purchase |
MEMBER_NAME | The Member name associated with the gift or loyalty card transaction, if available. |
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. |
MERCHANT_REFERENCE_NBR | This value contains the merchant assigned reference number for this transaction. If this value is not present, then Elavon will generate this number for backend use. |
MSDI | The Market Specific Data Indicator value.
0 = Returned if the data was not presented in authorization 1 = Returned if the data passed the Hotel Edits (H) 2 = Returned if the data failed Edits (N) 3 = Healthcare / Auto-Substantiation (M) 4 = Transit / Auto-Substantiation (T) 5 = Returned if the data passed the Visa Aggregator edits (E) 6 = Returned if the data passed the Auto Rental edits (A) 7 = Returned if the data passed the Bill Payment edits (B) 8 = Returned if the data passed the MasterCard Payment Gateway edits (G) 9 = Business to Business Invoice Payments (J) |
PARTIAL_AUTH_INDICATOR | This value is used to indicate if the POS is capable of performing partial authorizations.
0 = Indicates that the POS is not capable of Partial Authorizations. 1 = Indicates that the POS is capable of Partial Authorizations. 2 = Indicates that the POS is capable of Partial Authorizations and is a Visa Aggregator. |
POINTS_ADDED | This value is used to indicate the number of points added to an account an account. |
POINTS_CANCELED | This value is used to indicate the number of points to cancel from an account. |
POS_ENTRY_CAPABILITY | This value is used to identify the account entry capabilities on the POS device originating the transaction. Refer to the specification of the provider for more information. |
POSTAL_ZIP_CODE | This value is used to indicate the cardholder’s Postal or ZIP Code. |
PRE_AUTH_REFERENCE_NUMBER | This is a Gift Card value used to identify the original pre-authorization request. This value is required to submit the post-authorization completion transaction message. |
PS2000_DATA | This data will be as received during the original authorization processing. It will not be present for off line transactions. This is a “retain and return” value for terminal-based settlement messages. Refer to the specification of the provider for more information. |
RECEIPT_MESSAGE | This field contains a custom message as retuned from the Gift Card host to be printed on the cardholder’s receipt. |
RECURRING_PAYMENT_TYPE | This field is used to identify the type of recurring transaction that is being submitted for authorization.
Recurring transactions have a defined billing cycle and are in effect as long as the contract between the merchant and the cardholder is in good standing. Recurring payments include charges for Utilities, membership fees, subscriptions, insurance premiums, tuition, etc. Installment transactions have a defined transaction amount, billing cycle, and a total number of payments, which equal the full amount for the original agreed upon purchase. Installment payments include charges for loan payments, car purchase, furniture stores, etc. |
REFERENCE_NUMBER | This value is a reference number assigned by Elavon and returned in the authorization response message. |
REQUEST | Type of request. |
RESPONSE_CODE | This value is a 2 character code indicating the authorization response status. An approval is always indicated with an ‘AA’ or ‘AP’ code, all other codes indicate a non-approval.
AA = Approved Transaction (Authorizations and Reversals) AP = Approved Transaction for a Partial Amount NC = Decline (Pick Up Card) ND = Decline (Hard or Soft) NF = Decline (Record Not Found) NR = Decline (Referral Message) N7 = Decline (For CVV2 Only) NL = Decline (Loyalty/Gift Error) 00-99 = Decline (Additional Gift Card Declined) |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
SALES_TAX | This is the actual sales tax amount applied to this transaction. Consumer or Merchant tax exempt transactions can enter a single zero to properly reflect a tax exempt transaction. |
SHIPPING_DATE | The value is the date that the consumer’s goods were shipped. This value is the “Transaction Date” for direct marketing and ecommerce transactions.
Shipping Date in MMDDYYYY format. |
STREET_ADDRESS | This value is used to identify the cardholder’s street address. |
SURCHARGE_AMOUNT | This field is used to indicate the amount of the surcharge applied to the transaction. This amount should be included in the Transaction Amount field. |
TENDER_TYPE | The value is used to identify the payment method use to activate or reload a gift card.
0 = Cash 1 = Credit Card 2 = Debit Card 3 = Check 9 = Unknown |
TERMINAL_ID | The terminal identification number is used to uniquely identify the Merchant and their financial institution to Elavon. The Terminal ID consists of two parts and is assigned by Elavon for each POS device. |
TRACE_NUMBER | This value is used as a message reference number identify the transaction request and is returned in all authorization response messages. It is sent to the host on reversal and void messages when applicable. |
TRANSACTION_AMOUNT | This is the actual amount of the transaction. The maximum transaction amounts supported are currently $9,999,999.99 for Visa and MasterCard, and $99,999.99 all others card associations.
For Terminal-Based Settlement messages, this value will contain the total amount of the transaction in the Merchant’s currency, including any Tips (for restaurant transactions). For Canadian Debit Authorization Response messages, this field is zero filled and right justified to 12 characters. |
TRANSACTION_CODE | This value is used to uniquely identify the type of transaction that is being submitted to Elavon. Refer to the specification of the provider for more information. |
TRANSACTION_REFERENCE_NBR | The Transaction Reference Number is returned in the authorization response message and is used on void and reversal transactions, when available. This number is assigned by Elavon. |
UCAF_INDICATOR | This value identifies the means in which the transaction was processed between the cardholder and the merchant for a SecureCode authentication transaction.
0 = UCAF data collection is not supported by the Merchant 1 = UCAF data collection is supported by merchant but not populated 2 = UCAF data collection is supported by merchant, and UCAF data must be present |
VOUCHER_CLEAR_NBR | The Voucher Number from an EBT sales slip, used for Voucher Clear Food Stamp transactions.
The 15 digit Voucher Clear Number from the Merchant’s EBT Food Stamp sales slip. |
Name | Description |
---|---|
ADDRESS_LINE1 | The elements addressLine1 defines the address information |
AMOUNT | The amount element defines the amount of the transaction. Supply the value in cents without a decimal point. |
CAPABILITY | The capability element is a required child of the pos element, which describes the capability of the point of sale terminal. |
CARDHOLDER_ID | The cardholderId element is a required child of the pos element, which describes the method used for cardholder identification at the point of sale. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CITY | The city element defines the customer’s city name |
CLINIC_OTHER_AMOUNT | This value is used to submit the amount of all Clinical or other qualified medical expenses contained within this purchase. |
CUSTOMER_ID | A value assigned by the merchant to identify the consumer. |
DENTAL_AMOUNT | |
The email element defines the email address of the customer |
|
ENTRY_MODE | The entryMode element is a required child of the pos element, which describes the method used for card data entry at the point of sale. |
LITLE_TOKEN | The litleToken element defines the value of the token. The system returns this value in XML responses when issuing new tokens to replace account numbers. |
LITLE_TXN_ID | The litleTxnId element is used to identify transactions in the Litle system. The system returns this element in XML responses. You use it in various requests to reference the original transaction. |
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. |
MERCHANT_ID | The merchantId element is used when you request an Account Update file. This value is a unique string used to identify the merchant within the Litle system. |
NAME | The name element defines the customer name. |
ORDER_ID | The orderId element defines a merchant-assigned value representing the order in the merchant’s system. |
ORDER_SOURCE | The orderSource element defines the order entry source for the type of transaction. |
PAYPAGE_REGISTRATION_ID | |
PHONE | Defines the customers phone number. |
REPORT_GROUP | Defines the merchant sub-group in the user interface where this transaction will be displayed. |
REQUEST_ID | |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RX_AMOUNT | |
STATE | The state element defines the customer’s state name |
TERMINAL_ID | |
TOTAL_HEALTHCARE_AMOUNT | |
TRANSACTION_TYPE | We use such values:
C - Credit Transactions A - Authorization Transactions V - Void Transactions The Credit transaction enables you to refund money to a customer, even if the original transaction occurred outside of the Litle & Co. system. The Authorization transaction enables you to confirm that a customer has submitted a valid payment method with their order and has sufficient funds to purchase the goods or services they ordered. You use a Void transaction to cancel a transaction that occurred during the same business day. |
TYPE | Defines the type of account used in the transaction.
We use such values: VI -Visa Credit, Visa Debit, MC - MasterCard Credit, MasterCard Debit, AX - Amex, DI - Discover, DC - Dinners or empty |
USER | The user element is a required child of the authentication element. It is a unique identifier of the user/merchant used to authenticate that the message is from a valid source. |
VISION_AMOUNT | |
ZIP | The ZIP element defines the customer’s postal code. |
Name | Description |
---|---|
ADDRESS_LINE1 | The elements addressLine1 defines the address information |
ADVANCED_AVS_RESULT | |
AMOUNT | The amount element defines the amount of the transaction. Supply the value in cents without a decimal point. |
AUTH_CODE | The authCode element it specifies the authorization code from the associated Authorization transaction. |
AUTHENTICATION_RESULT | The authenticationResult element defines the Visa CAVV Result code (from Verified by Visa). |
AVS_RESULT | The avsResult defines the Address Verification response code returned by the networks. |
BIN | The BIN element provides the 6-digit Bank (or Issuer) Identification Number of the Issuing Bank. The system returns this value in XML responses when issuing new tokens to replace Visa or MasterCard account numbers. For Discover and American Express cards, this element is empty. |
CAPABILITY | The capability element is a required child of the pos element, which describes the capability of the point of sale terminal. |
CARD_VALIDATION_RESULT | The cardValidationResult defines the Card Validation response code returned by the networks. |
CARDHOLDER_ID | The cardholderId element is a required child of the pos element, which describes the method used for cardholder identification at the point of sale. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CITY | The city element defines the customer’s city name |
CLINIC_OTHER_AMOUNT | This value is used to submit the amount of all Clinical or other qualified medical expenses contained within this purchase. |
CUSTOMER_ID | A value assigned by the merchant to identify the consumer. |
DENTAL_AMOUNT | |
The email element defines the email address of the customer |
|
ENTRY_MODE | The entryMode element is a required child of the pos element, which describes the method used for card data entry at the point of sale. |
LITLE_TOKEN | The litleToken element defines the value of the token. The system returns this value in XML responses when issuing new tokens to replace account numbers. |
LITLE_TXN_ID | The litleTxnId element is used to identify transactions in the Litle system. The system returns this element in XML responses. You use it in various requests to reference the original transaction. |
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. |
MERCHANT_ID | The merchantId element is used when you request an Account Update file. This value is a unique string used to identify the merchant within the Litle system. |
MESSAGE | The message element provides a brief definition of the response code. |
NAME | The name element defines the customer name. |
ORDER_ID | The orderId element defines a merchant-assigned value representing the order in the merchant’s system. |
ORDER_SOURCE | The orderSource element defines the order entry source for the type of transaction. |
PAYPAGE_REGISTRATION_ID | |
PHONE | Defines the customers phone number. |
POST_DATE | The postDate element defines the date the transaction was posted. The format is YYYY-MM-DD. It occurs only in response to Online transactions. |
REPORT_GROUP | Defines the merchant sub-group in the user interface where this transaction will be displayed. |
REQUEST_ID | |
RESPONSE | The response element contains a three digit numeric code which specifies either that the transaction is approved (000 code) or declined. |
RESPONSE_TIME | The responseTime element provides a date/time stamp of the response. The format of the element is YYYY-MM-DDTHH:MM:SS. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RX_AMOUNT | |
STATE | The state element defines the customer’s state name |
TERMINAL_ID | |
TOKEN_MESSAGE | The tokenMessage element contains a short, human-readable explanation of the tokenResponseCode. |
TOKEN_RESPONSE_CODE | The tokenResponseCode element provides a 3-digit code indicating the results of a transaction involving the conversion or attempted conversion of an account number to a token. |
TOTAL_HEALTHCARE_AMOUNT | |
TRANSACTION_TYPE | We use such values:
C - Credit Transactions A - Authorization Transactions V - Void Transactions The Credit transaction enables you to refund money to a customer, even if the original transaction occurred outside of the Litle & Co. system. The Authorization transaction enables you to confirm that a customer has submitted a valid payment method with their order and has sufficient funds to purchase the goods or services they ordered. You use a Void transaction to cancel a transaction that occurred during the same business day. |
TYPE | Defines the type of account used in the transaction.
We use such values: VI -Visa Credit, Visa Debit, MC - MasterCard Credit, MasterCard Debit, AX - Amex, DI - Discover, DC - Dinners or empty |
USER | The user element is a required child of the authentication element. It is a unique identifier of the user/merchant used to authenticate that the message is from a valid source. |
VISION_AMOUNT | |
VOID_LITLE_TXN_ID | |
ZIP | The ZIP element defines the customer’s postal code. |
Name | Description |
---|---|
AMOUNT | The amount element defines the amount of the transaction. Supply the value in cents without a decimal point. |
AVS_ADDRESS1 | Cardholder billing address line 1 (street). |
AVS_CITY | Cardholder billing city. |
AVS_NAME | Cardholder name. |
AVS_STATE | Cardholder billing state code. |
AVS_ZIP | Cardholder billing address ZIP (or postal) code. |
BIN | Transaction Routing Definition. |
CARD_BRAND | Credit card brand. |
CARD_PRESENT_IND | Card Presence Identifier:
Y – Card Present/Swiped N – Manually Entry |
CC_CARD_VERIFY_PRESENCE_IND | 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 |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
COMMENTS | Any additional comments on the transaction. |
CUSTOMER_NAME | Name of the customer. |
DEBIT_BILLER_REFERENCE_NUMBER | |
INDUSTRY_TYPE | Defines the Industry type of the transaction:
RE – Retail |
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. |
MERCHANT_ID | Gateway merchant account number assigned by Chase Paymentech |
ORDER_ID | Merchant Defined Order Number/Invoice Number:
Field defined and supplied by the auth originator, and echoed back in response. |
PARTIAL_AUTH_IND | |
PCARD_DEST_ZIP | |
PCARD_ORDER_ID | |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETRY_TRACE | 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. |
REVERSAL_RETRY_NUMBER | Allowed number of reversal retries. |
SHIPPING_REF | Order shipping reference. |
TAX_AMOUNT | Amount of tax. |
TAX_IND | Tax indicator. |
TERMINAL_ID | Merchant Terminal ID assigned by Chase Paymentech |
TRANS_TYPE | Defines the transaction New Order Transaction Type:
AC – Authorization and Capture R – Refund request |
TX_REF_NUM | Gateway transaction reference number:
A unique value for each transaction, which is required to Void any transaction |
Name | Description |
---|---|
AMOUNT | The amount element defines the amount of the transaction. Supply the value in cents without a decimal point. |
APPROVAL_STATUS | Approval Status:
0 – Decline 1 – Approved 2 – Message/System Error |
AUTHORIZATION_CODE | Issuer approval Code: Unique transactional level code issuer uses to show each request was approved |
AVS_ADDRESS1 | Cardholder billing address line 1 (street). |
AVS_CITY | Cardholder billing city. |
AVS_NAME | Cardholder name. |
AVS_RESP_CODE | Address verification request response |
AVS_STATE | Cardholder billing state code. |
AVS_ZIP | Cardholder billing address ZIP (or postal) code. |
BIN | Transaction Routing Definition. |
CARD_BRAND | Credit card brand. |
CARD_PRESENT_IND | Card Presence Identifier:
Y – Card Present/Swiped N – Manually Entry |
CC_CARD_VERIFY_PRESENCE_IND | 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 |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
COMMENTS | Any additional comments on the transaction. |
CUSTOMER_NAME | Name of the customer. |
CVV_RESP_CODE | Card verification number request response |
DEBIT_BILLER_REFERENCE_NUMBER | |
FAULT_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’. |
HOST_AVS_RESP_CODE | Actual host address verification response code:
Exact address verification response sent by host authorization system [nonnormalized by the gateway]. |
HOST_CVV_RESP_CODE | Actual host card verification response code:
Exact card verification response sent by host authorization system [non-normalized by the gateway] |
HOST_RESP_CODE | Actual host response code:
Exact response sent by host authorization system [non-normalized by the gateway]. |
INDUSTRY_TYPE | Defines the Industry type of the transaction:
RE – Retail |
LAST_RETRY_DATE | The Date / time in which the PREVIOUS transaction using the same retryTrace value was processed by gateway:
Format – ‘YYYYMMDDhh[24]miss’ |
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. |
MERCHANT_ID | Gateway merchant account number assigned by Chase Paymentech |
ORDER_ID | Merchant Defined Order Number/Invoice Number:
Field defined and supplied by the auth originator, and echoed back in response. |
PARTIAL_AUTH_IND | |
PARTIAL_AUTH_OCCURED | Indicates whether partial authorization occured. |
PCARD_DEST_ZIP | |
PCARD_ORDER_ID | |
PROC_STATUS | 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. |
PROC_STATUS_MESSAGE | Response Text message
If ProcStatus = 0, the ‘approvalStratus’ Message text is returned. |
REDEEMED_AMOUNT | |
REMAINING_BALANCE | Remaining balance of the credit card of the customer. |
RESP_CODE | 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 |
RESP_CODE_MESSAGE | Response Text message |
RESP_DATE_TIME | Date / time the transaction was processed by gateway:
Format – ‘YYYYMMDDhh[24]miss’ |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETRY_ATTEMPT_COUNT | 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. |
RETRY_TRACE | 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. |
REVERSAL_RETRY_NUMBER | Allowed number of reversal retries. |
SHIPPING_REF | Order shipping reference. |
TAX_AMOUNT | Amount of tax. |
TAX_IND | Tax indicator. |
TERMINAL_ID | Merchant Terminal ID assigned by Chase Paymentech |
TRANS_TYPE | Defines the transaction New Order Transaction Type:
AC – Authorization and Capture R – Refund request |
TX_REF_IDX | Gateway transaction index:
Will always return a ‘0’ value on original transaction and a ‘1’ on void responses. |
TX_REF_NUM | Gateway transaction reference number:
A unique value for each transaction, which is required to Void any transaction |
Name | Description |
---|---|
AV_CARDHOLDER_STREET_ADDRESS | |
AV_CARDHOLDER_ZIP_CODE | |
AV_EXTENDED_CARDHOLDER_STREET_ADDRESS | |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CLIENT_NUMBER | |
ENTRY_DATA_SOURCE | |
INDUSTRY_CARD_SEQUENCE_NUMBER | |
INDUSTRY_CARD_TOTAL_NUMBER | |
INDUSTRY_CASH_OUT_INDICATOR | |
INDUSTRY_CHARGE_DESCRIPTION | |
INDUSTRY_CODE | |
INDUSTRY_ECOMMERCE_GOODS_INDICATOR | |
INDUSTRY_ELECTRONIC_COMMERCE_INDICATOR | |
INDUSTRY_EMPLOYEE_NUMBER | |
INDUSTRY_INVOICE_NUMBER | |
INDUSTRY_ITEM_CODE | |
INDUSTRY_REFERENCE_CODE | |
INDUSTRY_SERVER_NUMBER | |
INDUSTRY_TIP_AMOUNT | |
INDUSTRY_TIP_AMOUNT | |
INDUSTRY_TIP_AMOUNT | |
INDUSTRY_TYPE_INDICATOR | |
LAST_RETRIEVAL_REFERENCE_NUMBER | |
MARKET_SPECIFIC_DATA_INDICATOR | |
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. |
MERCHANT_NUMBER | |
MISC_AUTHORIZATION_CODE | |
MISC_CASH_BACK_AMOUNT | |
MISC_CASH_BACK_AMOUNT | |
MISC_CASH_BACK_AMOUNT | |
MISC_EBT_TYPE_CODE | |
MISC_RETRIEVAL_REFERENCE_NUMBER | |
PIN_CAPABILITY_CODE | |
PURCHASE_CUSTOMER_REFERENCE_NUMBER | |
PURCHASE_DESTINATION_ZIP | |
PURCHASE_LOCAL_TAX_FLAG | |
PURCHASE_SALES_TAX_AMOUNT | |
PURCHASE_SALES_TAX_AMOUNT | |
PURCHASE_SALES_TAX_AMOUNT | |
REQUEST_TOKEN_DATA | |
REQUEST_TOKEN_DATA | |
REQUEST_TOKEN_DATA | |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
SEQUENCE_NUMBER | |
SYSTEM_INDICATOR | |
TERMINAL_NUMBER | |
TRANSACTION_AMOUNT | |
TRANSACTION_AMOUNT | |
TRANSACTION_AMOUNT | |
TRANSACTION_CODE | |
TRANSACTION_SEQUENCE_FLAG |
Name | Description |
---|---|
AV_CARDHOLDER_STREET_ADDRESS | |
AV_CARDHOLDER_ZIP_CODE | |
AV_EXTENDED_CARDHOLDER_STREET_ADDRESS | |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CLIENT_NUMBER | |
ENTRY_DATA_SOURCE | |
IC_AUTHORIZATION_CHARACTERISTICS_INDICATOR | |
IC_MC_BANK_NET_DATE | |
IC_MC_BANK_NET_REFERENCE_NUMBER | |
IC_MC_CVC_ERROR_INDICATOR | |
IC_MC_CVC_STATUS_CHANGE | |
IC_MC_MAGNETIC_STRIPE_QUALITY_INDICATOR | |
IC_MC_MERCHANT_CATEGORY_CODE | |
IC_VISA_AUTHORIZATION_RESPONSE_CODE | |
IC_VISA_AVS_RESPONSE_CODE | |
IC_VISA_COMMERCIAL_CARD_TYPE | |
IC_VISA_MERCHANT_CATEGORY_CODE | |
IC_VISA_POS_ENTRY_MODE | |
IC_VISA_TOTAL_AUTHORIZATION_AMOUNT | |
IC_VISA_TRANSACTION_ID | |
IC_VISA_VALIDATION_CODE | |
INDUSTRY_CARD_SEQUENCE_NUMBER | |
INDUSTRY_CARD_TOTAL_NUMBER | |
INDUSTRY_CASH_OUT_INDICATOR | |
INDUSTRY_CHARGE_DESCRIPTION | |
INDUSTRY_CODE | |
INDUSTRY_ECOMMERCE_GOODS_INDICATOR | |
INDUSTRY_ELECTRONIC_COMMERCE_INDICATOR | |
INDUSTRY_EMPLOYEE_NUMBER | |
INDUSTRY_INVOICE_NUMBER | |
INDUSTRY_ITEM_CODE | |
INDUSTRY_REFERENCE_CODE | |
INDUSTRY_SERVER_NUMBER | |
INDUSTRY_TIP_AMOUNT | |
INDUSTRY_TIP_AMOUNT | |
INDUSTRY_TIP_AMOUNT | |
INDUSTRY_TYPE_INDICATOR | |
LAST_RETRIEVAL_REFERENCE_NUMBER | |
MARKET_SPECIFIC_DATA_INDICATOR | |
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. |
MERCHANT_NUMBER | |
MISC_AUTHORIZATION_CODE | |
MISC_CASH_BACK_AMOUNT | |
MISC_CASH_BACK_AMOUNT | |
MISC_CASH_BACK_AMOUNT | |
MISC_EBT_TYPE_CODE | |
MISC_RETRIEVAL_REFERENCE_NUMBER | |
PIN_CAPABILITY_CODE | |
PURCHASE_CUSTOMER_REFERENCE_NUMBER | |
PURCHASE_DESTINATION_ZIP | |
PURCHASE_LOCAL_TAX_FLAG | |
PURCHASE_SALES_TAX_AMOUNT | |
PURCHASE_SALES_TAX_AMOUNT | |
PURCHASE_SALES_TAX_AMOUNT | |
REQUEST_TOKEN_DATA | |
REQUEST_TOKEN_DATA | |
REQUEST_TOKEN_DATA | |
RESPONSE_ACTION_CODE | |
RESPONSE_ADDRESS_VERIFICATION_CODE | |
RESPONSE_AUTHORIZATION_ERROR_CODE | |
RESPONSE_AUTHORIZATION_SOURCE | |
RESPONSE_AUTHORIZING_NETWORK_ID | |
RESPONSE_BATCH_NUMBER | |
RESPONSE_BEGINNING_BALANCE | |
RESPONSE_CARD_TYPE | |
RESPONSE_CASH_AVAILABLE_BALANCE | |
RESPONSE_CASH_BEGINNING_BALANCE | |
RESPONSE_CASH_LEDGER_BALANCE | |
RESPONSE_FS_AVAILABLE_BALANCE | |
RESPONSE_FS_LEDGER_BALANCE | |
RESPONSE_MESSAGE | |
RESPONSE_RETRIEVAL_REFERENCE_NUMBER | |
RESPONSE_TRACE_NUMBER | |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
SEQUENCE_NUMBER | |
SYSTEM_INDICATOR | |
TERMINAL_NUMBER | |
TK_B1_CURRENT_BALANCE_AMOUNT | |
TK_B1_CURRENT_BALANCE_AMOUNT | |
TK_B1_CURRENT_BALANCE_AMOUNT | |
TK_B3_PREVIOUS_BALANCE_AMOUNT | |
TK_B3_PREVIOUS_BALANCE_AMOUNT | |
TK_B3_PREVIOUS_BALANCE_AMOUNT | |
TK_B4_APPROVED_AMOUNT | |
TK_B4_APPROVED_AMOUNT | |
TK_B4_APPROVED_AMOUNT | |
TK_B5_CASH_OUT_AMOUNT | |
TK_B5_CASH_OUT_AMOUNT | |
TK_B5_CASH_OUT_AMOUNT | |
TK_B6_AVAILABLE_BALANCE1_AMOUNT | |
TK_B6_AVAILABLE_BALANCE1_AMOUNT | |
TK_B6_AVAILABLE_BALANCE1_AMOUNT | |
TK_B6_AVAILABLE_BALANCE1_CURRENCY_CODE | |
TK_B7_AVAILABLE_BALANCE2_AMOUNT | |
TK_B7_AVAILABLE_BALANCE2_AMOUNT | |
TK_B7_AVAILABLE_BALANCE2_AMOUNT | |
TK_B7_AVAILABLE_BALANCE2_CURRENCY_CODE | |
TK_CV_RESPONSE_VALUE | |
TK_ER_FAILED_TOKEN_INDICATOR | |
TK_Q8_AUTHORIZATION_TYPE_CODE | |
TK_Q8_AUTHORIZED_AMOUNT | |
TK_Q8_CARD_TYPE | |
TK_VB_CAVV_RESPONSE_DATA | |
TK_VC_VISA_CARD_LEVEL_RESULTS_CODE | |
TRANSACTION_AMOUNT | |
TRANSACTION_AMOUNT | |
TRANSACTION_AMOUNT | |
TRANSACTION_CODE | |
TRANSACTION_SEQUENCE_FLAG |
Name | Description |
---|---|
BIT03_TRANSACTION_AMOUNT | |
BIT21_TABLE_DS | |
BIT21_TABLE_SD | |
BIT21_TABLE_VI | |
BIT21_TABLE14 | |
BIT21_TABLE48 | |
BIT21_TABLE53 | |
BIT21_TABLE55 | |
BIT21_TABLE60 | |
BIT21_TABLE62 | |
BIT21_TABLE66 | |
BIT21_TABLE68 | |
BIT21_TABLE69 | |
BIT21_TABLE72 | |
BIT22_APPROVAL_CODE | |
BIT29_POS_ENTRY_MODE | |
BIT30_POS_PIN_CAPABILITY | |
BIT31_POS_CONDITION_CODE | |
BIT36_DEBIT_ACCOUNT_TYPE | |
BIT37_LOCAL_DATE_TIME | |
BIT38_DEBIT_RECEIPT_NUMBER | |
BIT39_CASH_BACK_AMOUNT | |
BIT43_DEBIT_FUNCTION_CODE | |
BIT45_ADDRESS_VERIFICATION | |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
IS_REVERSAL | |
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. |
MERCHANT_ID | Merchant ID assigned by FirstData. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
TRANSACTION_CODE |
Name | Description |
---|---|
APPROVAL_CODE | Authorization code returned by Provider that approved this transaction. In some instances might also be used to store response code returned by Provider when transaction declines. |
APPROVAL_DATE | |
AUTHORIZED_AMOUNT | The total authorized amount for the authorization request. If the Partial authorization flag is enabled, this amount may be less than the requested amount. |
AVS_RESPONSE_CODE | Address Verification Response. One character code indicating the response of the Address Verification process. |
BALANCE1_ACCOUNT_TYPE | |
BALANCE1_AMOUNT | |
BALANCE1_AMOUNT_TYPE | |
BALANCE1_CURRENCY_TYPE | |
BALANCE1_SIGN | |
BALANCE2_ACCOUNT_TYPE | |
BALANCE2_AMOUNT | |
BALANCE2_AMOUNT_TYPE | |
BALANCE2_CURRENCY_TYPE | |
BALANCE2_SIGN | |
BALANCE3_ACCOUNT_TYPE | |
BALANCE3_AMOUNT | |
BALANCE3_AMOUNT_TYPE | |
BALANCE3_CURRENCY_TYPE | |
BALANCE3_SIGN | |
BALANCE4_ACCOUNT_TYPE | |
BALANCE4_AMOUNT | |
BALANCE4_AMOUNT_TYPE | |
BALANCE4_CURRENCY_TYPE | |
BALANCE4_SIGN | |
BALANCE5_ACCOUNT_TYPE | |
BALANCE5_AMOUNT | |
BALANCE5_AMOUNT_TYPE | |
BALANCE5_CURRENCY_TYPE | |
BALANCE5_SIGN | |
BALANCE6_ACCOUNT_TYPE | |
BALANCE6_AMOUNT | |
BALANCE6_AMOUNT_TYPE | |
BALANCE6_CURRENCY_TYPE | |
BALANCE6_SIGN | |
BIT03_TRANSACTION_AMOUNT | |
BIT21_TABLE_DS | |
BIT21_TABLE_DS_RESPONSE | |
BIT21_TABLE_SD | |
BIT21_TABLE_VI | |
BIT21_TABLE_VI_RESPONSE | |
BIT21_TABLE14 | |
BIT21_TABLE14_RESPONSE | |
BIT21_TABLE48 | |
BIT21_TABLE48_RESPONSE | |
BIT21_TABLE49_RESPONSE | |
BIT21_TABLE53 | |
BIT21_TABLE53_RESPONSE | |
BIT21_TABLE55 | |
BIT21_TABLE55_RESPONSE | |
BIT21_TABLE60 | |
BIT21_TABLE62 | |
BIT21_TABLE62_RESPONSE | |
BIT21_TABLE66 | |
BIT21_TABLE66_RESPONSE | |
BIT21_TABLE68 | |
BIT21_TABLE68_RESPONSE | |
BIT21_TABLE69 | |
BIT21_TABLE72 | |
BIT22_APPROVAL_CODE | |
BIT29_POS_ENTRY_MODE | |
BIT30_POS_PIN_CAPABILITY | |
BIT31_POS_CONDITION_CODE | |
BIT36_DEBIT_ACCOUNT_TYPE | |
BIT37_LOCAL_DATE_TIME | |
BIT38_DEBIT_RECEIPT_NUMBER | |
BIT39_CASH_BACK_AMOUNT | |
BIT43_DEBIT_FUNCTION_CODE | |
BIT45_ADDRESS_VERIFICATION | |
CAPTURE_FLAG | |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
IS_REVERSAL | |
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. |
RESPONSE_MESSAGE | |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
TRANSACTION_CODE |
Name | Description |
---|---|
ACTION_CODE | This action tells First Data what service to perform on the transaction.
We use: DR - Refund Auth Reversal (PINLess Debit) PR - Purchase Auth Reversal (PINLess Debit) AR - Authorization Reversal (Amex, MasterCard, Visa, Discover, JCB, GoogleCheckout, PayPal, ValueLink) RA - Refund Auth (PINLess Debit) PA - Purchase Auth (PINLess Debit) AU - Authorize (Credit Card, Alt Pay, ValueLink) |
ADDRESS_LINE1 | Accountholder’s address information |
AMOUNT | Amount of the authorization. 2 decimal implied. Minimum amount for all card types is $0.01 U.S. dollars* (or established international currency equivalent), but no greater than the established Transaction Division limit. The default is $99,999.99 |
AUTHORIZATION_CODE | Authorization code of the approved, original, authorized transaction. This field cannot be blank or the transaction will reject with Response Reason Code 262 (Authorization Code/Response Date Invalid). |
BILLER_REFERENCE_NUMBER | Reference number the biller (merchant) uses on his system to identify this customer |
CARD_SECURITY_PRESENCE | Used to validate the presence of a card security value.
We use: 1 – Value is present (DI, MC, MD, or VI) “ ” – Blank, indicator not sent (AX, MC, MD) |
CITY | Accountholder’s city. |
CLIENT_REF | Unique value, that identifies the transaction.
This value is calculated by the gateway, according to the processor's specification rules. This value is taken into account by the processor on the communications layer. |
COUNTRY_CODE | Accountholder’s country code. |
DIVISION_NUMBER | Assigned and provided to merchant by First Data. First Data assigns a unique Division Number to process each international currency. A single Division Number can support different transaction types and methods of payment in the same currency. |
ENCRYPTION_FLAG | Indicates transaction token status.
Possible values: PAN – TransArmor token request (or on response if tokenization failure and PAN masked; TOK – TransArmor token supplied. |
LENGTH_INDICATOR | Indicates the number of positions submitted for the following field |
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. |
MOP_REQUEST | Method of Payment (MOP) defines the MOP associated with this transaction. |
NAME_TEXT | Accountholder’s name (asterisk should precede last name). |
ORDER_NUMBER | A value composed of any alpha, blank, digit, or punctuation combination that will be returned in the transaction response. This field will tie the merchant’s request to the First Data response. |
PARTIAL_REDEMPTION_INDICATOR | Determines approval functionality for pre-paid/gift card authorizations.
Valid values for American Express: Y – Transaction is not declined if authorization amount is greater than the current balance N – Transaction is declined if authorization amount is greater than the current balance Valid values for Discover: Y – The sale amount can be partially approved but the cash back amount cannot be partially approved. N – Merchant does not support partial authorization. Partial authorization not allowed for both sale amount and cash back amount. Valid values for Visa/MasterCard/MasterCard Diners: Y – Attempt a partial authorization if allowed for the account. N – Do not attempt a partial authorization. |
POSTAL_CODE | Accountholder’s postal code. |
RESPONSE_DATE | Date of approved, original, authorized transaction. YYMMDD format.
Response date must be current or prior date or the transaction will reject with Response Reason Code 262 (Authorization Code/Response Date Invalid). |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
STATE | Accountholder’s state. |
TERMINAL_ID | Terminal identification – code identifying the balancing features available to the POS from the Host. |
TOKEN_TYPE | Merchant Specific Token Value issued by First Data.
This Format record will be returned on all TransArmor submissions. |
TPP_ID | Third Party Processor ID is mandatory on all Authorization requests submitted by Third Parties who have been issued one by First Data.
If you were assigned a Third Party Processor ID, you are required to send this additional format record. If you were not assigned a Third Party Processor ID, this record should not be sent. |
TRACK_INDICATOR | Track that was read.
Valid values: 1 – Track 1 2 – Track 2 |
TRANSACTION_TYPE | Describes the circumstances under which the transaction takes place. Default space filled.
We use: 1 – MOTO Indicator – Single Transaction Mail/telephone order: designates a transaction where the cardholder is not present at a merchant location and consummates the sale via the phone or through the mail. The transaction is not for recurring services or product and does not include sales that are processed via an installment plan. 2 – MOTO Indicator – Recurring Transaction: Designates a transaction that represents an arrangement between a cardholder and the merchant where transactions are going to occur on a periodic basis. 3 – MOTO Indicator – Installment Payment: Designates a group of transactions that originated from a single purchase where the merchant agrees to bill the cardholder in installments. 7 – ECI Indicator – Channel Encrypted Transaction: Designates a transaction between a cardholder and a merchant consummated via the Internet where the transaction includes the use of transaction encryption such as SSL, but authentication was not performed. The cardholder payment data was protected with a form of Internet security, such as SSL, but authentication was not performed. R – Retail Indicator – designates a transaction where the cardholder was present at a merchant location. If an “R” is sent for a transaction with a MOTO Merchant Category Code (MCC) the transaction will downgrade. |
Name | Description |
---|---|
ACTION_CODE | This action tells First Data what service to perform on the transaction.
We use: DR - Refund Auth Reversal (PINLess Debit) PR - Purchase Auth Reversal (PINLess Debit) AR - Authorization Reversal (Amex, MasterCard, Visa, Discover, JCB, GoogleCheckout, PayPal, ValueLink) RA - Refund Auth (PINLess Debit) PA - Purchase Auth (PINLess Debit) AU - Authorize (Credit Card, Alt Pay, ValueLink) |
ADDRESS_LINE1 | Accountholder’s address information |
AMOUNT | Amount of the authorization. 2 decimal implied. Minimum amount for all card types is $0.01 U.S. dollars* (or established international currency equivalent), but no greater than the established Transaction Division limit. The default is $99,999.99 |
AUTHORIZATION_CODE | Authorization code of the approved, original, authorized transaction. This field cannot be blank or the transaction will reject with Response Reason Code 262 (Authorization Code/Response Date Invalid). |
AVS_RESPONSE_CODE | Response to address verification request. |
BILLER_REFERENCE_NUMBER | Reference number the biller (merchant) uses on his system to identify this customer |
CARD_SECURITY_PRESENCE | Used to validate the presence of a card security value.
We use: 1 – Value is present (DI, MC, MD, or VI) “ ” – Blank, indicator not sent (AX, MC, MD) |
CAVV_RESPONSE_CODE | This field will be populated for any Verified by Visa transaction.
It is used during authorization processing to verify that authentication, or attempted authentication, was performed. The Issuer receives the authorization request and validates the CAVV and responds with a CAVV response code, as well as an approval or a decline of the authorization. If the CAVV does not match, the Issuer should decline the transaction. |
CAVV_RESPONSE_CODE | This field will be populated for any Verified by Visa transaction.
It is used during authorization processing to verify that authentication, or attempted authentication, was performed. The Issuer receives the authorization request and validates the CAVV and responds with a CAVV response code, as well as an approval or a decline of the authorization. If the CAVV does not match, the Issuer should decline the transaction. |
CAVV_RESPONSE_CODE | This field will be populated for any Verified by Visa transaction.
It is used during authorization processing to verify that authentication, or attempted authentication, was performed. The Issuer receives the authorization request and validates the CAVV and responds with a CAVV response code, as well as an approval or a decline of the authorization. If the CAVV does not match, the Issuer should decline the transaction. |
CITY | Accountholder’s city. |
CLIENT_REF | Unique value, that identifies the transaction.
This value is calculated by the gateway, according to the processor's specification rules. This value is taken into account by the processor on the communications layer. |
COUNTRY_CODE | Accountholder’s country code. |
CSV_RESPONSE_CODE | Card Security Value Response Code returned by the card Issuer in response to a card security verification request. |
CURRENT_BALANCE | Current Balance |
DIVISION_NUMBER | Assigned and provided to merchant by First Data. First Data assigns a unique Division Number to process each international currency. A single Division Number can support different transaction types and methods of payment in the same currency. |
ENCRYPTION_FLAG | Indicates transaction token status.
Possible values: PAN – TransArmor token request (or on response if tokenization failure and PAN masked; TOK – TransArmor token supplied. |
FIRST_DATA_TOKEN_CODE | The tokenized value of Account Number. |
LENGTH_INDICATOR | Indicates the number of positions submitted for the following field |
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. |
MOP_REQUEST | Method of Payment (MOP) defines the MOP associated with this transaction. |
NAME_TEXT | Accountholder’s name (asterisk should precede last name). |
ORDER_NUMBER | A value composed of any alpha, blank, digit, or punctuation combination that will be returned in the transaction response. This field will tie the merchant’s request to the First Data response. |
PARTIAL_REDEMPTION_INDICATOR | Determines approval functionality for pre-paid/gift card authorizations.
Valid values for American Express: Y – Transaction is not declined if authorization amount is greater than the current balance N – Transaction is declined if authorization amount is greater than the current balance Valid values for Discover: Y – The sale amount can be partially approved but the cash back amount cannot be partially approved. N – Merchant does not support partial authorization. Partial authorization not allowed for both sale amount and cash back amount. Valid values for Visa/MasterCard/MasterCard Diners: Y – Attempt a partial authorization if allowed for the account. N – Do not attempt a partial authorization. |
POSTAL_CODE | Accountholder’s postal code. |
RECURRING_PAYMENT_ADVICE_CODE | Field Recurring payment advice code (MasterCard/MasterCard Diners Only) has such valid values:
01 – New account information available. Obtain new account information. 02 – Try again later. Recycle transaction in 72 hours. 03 – Do not try again. Obtain another type of payment from customer. 21 – Do not try again. Issuer has blocked recurring payment transaction. Default space filled |
REDEMPTION_AMOUNT | Approved amount. Partial authorization is done and redemption amount is returned if authorized amount > available balance. |
RESPONSE_DATE | Date of approved, original, authorized transaction. YYMMDD format.
Response date must be current or prior date or the transaction will reject with Response Reason Code 262 (Authorization Code/Response Date Invalid). |
RESPONSE_REASON_CODE | Description of the response code |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
STATE | Accountholder’s state. |
SURCHARGE_AMOUNT | Amount of surcharge |
TERMINAL_ID | Terminal identification – code identifying the balancing features available to the POS from the Host. |
TOKEN_TYPE | Merchant Specific Token Value issued by First Data.
This Format record will be returned on all TransArmor submissions. |
TOTAL_AMOUNT | Total transaction amount, including surcharge (if any) |
TPP_ID | Third Party Processor ID is mandatory on all Authorization requests submitted by Third Parties who have been issued one by First Data.
If you were assigned a Third Party Processor ID, you are required to send this additional format record. If you were not assigned a Third Party Processor ID, this record should not be sent. |
TRACE_NUMBER | Trace number returned from debit vendor |
TRACK_INDICATOR | Track that was read.
Valid values: 1 – Track 1 2 – Track 2 |
TRANSACTION_TYPE | Describes the circumstances under which the transaction takes place. Default space filled.
We use: 1 – MOTO Indicator – Single Transaction Mail/telephone order: designates a transaction where the cardholder is not present at a merchant location and consummates the sale via the phone or through the mail. The transaction is not for recurring services or product and does not include sales that are processed via an installment plan. 2 – MOTO Indicator – Recurring Transaction: Designates a transaction that represents an arrangement between a cardholder and the merchant where transactions are going to occur on a periodic basis. 3 – MOTO Indicator – Installment Payment: Designates a group of transactions that originated from a single purchase where the merchant agrees to bill the cardholder in installments. 7 – ECI Indicator – Channel Encrypted Transaction: Designates a transaction between a cardholder and a merchant consummated via the Internet where the transaction includes the use of transaction encryption such as SSL, but authentication was not performed. The cardholder payment data was protected with a form of Internet security, such as SSL, but authentication was not performed. R – Retail Indicator – designates a transaction where the cardholder was present at a merchant location. If an “R” is sent for a transaction with a MOTO Merchant Category Code (MCC) the transaction will downgrade. |
Name | Description |
---|---|
ADDRESS1 | The first line of the customer's billing street address. |
ADDRNUM | The numeric portion of the street address. |
CARDEXPMONTH | The numeric expiration month of the credit card |
CARDEXPYEAR | Expiration year of the credit card |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGETOTAL | The total dollar amount of this transaction including subtotal, tax, and shipping |
CITY | Billing city |
COMPANY | Company name |
CONFIGFILE | This field should contain the merchant store name or store number |
CVMINDICATOR | Indicates whether the card code was supplied. We use such values:
- provided - not_provided |
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. |
NAME | Customer's name |
OID | The order Id to be assigned to the transaction. For sale and pre-authorization transactions, this field must be unique. For void, credit and post-authorization transactions this field must be a valid Order Id from a prior Sale or pre-authorization transaction. |
ORDERTYPE | The type of transaction. We use such values: Sale, Void, Credit |
PHONE | Billing phone number. The number shouldn't contain dashes. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
STATE | U.S. state of billing address. For international addresses, this field can be used for the province or territory |
TDATE | This field is returned with every successful transaction. If you want to run a void or other transaction against an existing order ID, you may need to pass the Tdate field to identity the specific transaction you want to void. |
TERMINALTYPE | The type of terminal that is sending the transaction. We use such value:
- POS (for an electronic cash register or integrated POS system) |
TRANSACTIONORIGIN | The source of the transaction. We use such values:
Eci - if order was received via email or Internet MOTO - mail order/telephone order Retail - face to face |
USERID | The userid field is an optional custom field to track customers. |
ZIP | Billing ZIP or postal code. |
Name | Description |
---|---|
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
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. |
RAPPROVED | The result of the transaction, which may be approved, declined, or blockedbecause of fraud. |
RAUTHRESPONSE | Authentication results returned from Verified By Visa and MasterCard Secure Code. |
RAVS | The Address Verification System response for the transaction. |
RCODE | The approval code for the transaction |
RERROR | Any error message associated with the transaction. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RMESSAGE | Any message returned by the processor |
RREF | The reference number returned by the credit card processor. |
RTDATE | A server time-date stamp for the transaction. Used to uniquely identify a specific transaction where one order number may apply to several individual transactions |
RTIME | The time and date of the transaction server response. |
Name | Description |
---|---|
AUTH_CHAR_INDICATOR_REQUEST | Code identifying the type of transaction approval. |
AUTHORIZATION_CODE | Numeric or alphanumeric code assigned to a transaction as verification that a transaction has been approved. |
AVS_ADDRESS | Principal cardholder‘s address entered for address verification. |
AVS_RESPONSE_CODE | Code indicating whether address verification was performed and the results. |
AVS_ZIP_CODE | ZIP (or postal) code of principal cardholder‘s address entered for address verification. |
BATCH_NUMBER | Number identifying the batch; assigned by the POS device. |
CARD_TYPE_INDICATOR | Character indicating the type of card. |
CARD_VERIFICATION_PRESENCE_INDICATOR | Character that indicates whether the CVV2/CVC2/CID value is included with message packet. |
CARDHOLDER_SET_CERTIFICATE_SERIAL_NUMBER | Cardholder Secure Electronic Transaction Certificate Serial number. |
CASH_BACK_AMOUNT | Dollar-and-cent amount ($$$.¢¢) of a debit/EBT cash back amount. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CUSTOMER_CODE | Merchant-assigned code. |
DEVICE_ID | Merchant-assigned code identifying the device at the merchant‘s location. |
EBT_VOUCHER_NUMBER | Number from EBT Voucher Form. |
FORMAT_CODE | Code indicating the type of format for the message to the Host. |
INVOICE_NUMBER | Merchant-defined number. |
ITEM_NUMBER | Number of the transaction in the batch; assigned by the POS. |
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. |
MERCHANT_NUMBER | Number assigned by merchant‘s financial institution. |
MERCHANT_SET_CERTIFICATE_SERIAL_NUMBER | Merchant Secure Electronic Transaction Certificate Serial number. |
ORDER_NUMBER | Merchant-defined number identifying the purchase or service. |
PARTIAL_AUTHORIZATION_INDICATOR | Value will be blank for Online Void. |
PHONE_MAIL_ORDER_FLAG | Code identifying whether the transaction is mail order, phone order or electronic commerce. |
POS_DATA_CODES | POS Codes for American Express Ticket Only (Tran Code 3) transaction. Contact American Express to determine how these values are generated and used for American Express. |
PROTOCOL_TYPE | Character identifying which protocol rule the transaction follows; required field. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
REVISION_NUMBER | Number identifying the number of revisions to a monetary transaction. |
SHIP_TO_POSTAL_CODE | This is a mandatory field for supporting Amex Level 2 Transactions. |
SURCHARGE | Dollar-and-cent amount ($$$.¢¢) of the charge that the cardholder paid the merchant for the ability to perform the transaction. |
TAX_AMOUNT | Dollar-and-cent amount ($$$$$.¢¢) of tax for the purchase. |
TERMINAL_ID | Code identifying the balancing features available to the POS from the Host. |
TIP_AMOUNT | Dollar-and-cent amount ($$$.¢¢) of the tip given at the restaurant for the purchase. |
TOTAL_AMOUNT | Total dollar-and-cent amount ($$$$$.¢¢) of the purchase. |
TOTAL_AUTHORIZED_AMOUNT | Dollar-and-cent amount ($$$$$.¢¢) of the purchase. |
TPP | If a First Data assigned TPP value is not available do not send this field with a default value. |
TRANS_STAIN | A value used to define a merchant‘s security settings for SET. |
TRANSACTION_CODE | Code identifying how the System will respond to the transaction request. |
TRANSACTION_IDENTIFIER | Code generated by the card associations on the authorization; known as TID for Visa and BankNet Reference Number for MasterCard. |
TRANSACTION_TYPE | Code identifying how the System will respond to the transaction request. |
WRITE_CONTROL_CHARACTER | Character identifying the account number entry method and Host response protocol (single or multiple mode). |
XID | A unique transaction identifier assigned to a SET Transaction. |
Name | Description |
---|---|
ACTION_CODE | Code indicating a Host response. |
ADDITIONAL_RESPONSE_INDICATOR | Variable Length, 4 position Field. Positions 2 – 4 Reserved for Future Use. Position 1 Only – used in conjunction with Terminal ID Field. It will only be present in Credit Sale, Credit Auth only transactions for Retail industry. |
APPROVED_AMOUNT | The amount approved if received Partial Sale / Auth, Action Code 3. Must support the PARTIAL AUTHORIZATION INDICATOR within transaction message Industry Specific Formats. If Partial Auth not accepted, this Amount must be the TOTAL AMOUNT of the void transaction to cancel the partially approved transaction. |
AUTH_CHAR_INDICATOR_REQUEST | Code identifying the type of transaction approval. |
AUTHORIZATION_CODE | Numeric or alphanumeric code assigned to a transaction as verification that a transaction has been approved. |
AVS_ADDRESS | Principal cardholder‘s address entered for address verification. |
AVS_RESPONSE_CODE | Code indicating whether address verification was performed and the results. |
AVS_ZIP_CODE | ZIP (or postal) code of principal cardholder‘s address entered for address verification. |
BALANCE_SIGN | If Positive balance position will contain a space Character If Balance is negative, field will contain a ―-―character. |
BATCH_NUMBER | Number identifying the batch; assigned by the POS device. |
CARD_TYPE_INDICATOR | Character indicating the type of card. |
CARD_VERIFICATION_PRESENCE_INDICATOR | Character that indicates whether the CVV2/CVC2/CID value is included with message packet. |
CARD_VERIFICATION_RESPONSE_CODE | The result from performing a CVC2/CVV2/CID check. |
CARDHOLDER_SET_CERTIFICATE_SERIAL_NUMBER | Cardholder Secure Electronic Transaction Certificate Serial number. |
CASH_BACK_AMOUNT | Dollar-and-cent amount ($$$.¢¢) of a debit/EBT cash back amount. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CUSTOMER_CODE | Merchant-assigned code. |
DEBIT_CARD_TYPE_NUMBER | The number of the debit network through which the debit card was processed. |
DEBIT_NETWORK_NAME | The name of the network through which the debit card was processed. |
DEVICE_ID | Merchant-assigned code identifying the device at the merchant‘s location. |
EBT_RESPONSE_CODE | Code sent by Network that processed the transaction. |
EBT_VOUCHER_NUMBER | Number from EBT Voucher Form. |
FORMAT_CODE | Code indicating the type of format for the message to the Host. |
INVOICE_NUMBER | Merchant-defined number. |
ITEM_NUMBER | Number of the transaction in the batch; assigned by the POS. |
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. |
MERCHANT_NUMBER | Number assigned by merchant‘s financial institution. |
MERCHANT_SET_CERTIFICATE_SERIAL_NUMBER | Merchant Secure Electronic Transaction Certificate Serial number. |
ORDER_NUMBER | Merchant-defined number identifying the purchase or service. |
PARTIAL_AUTHORIZATION_INDICATOR | Value will be blank for Online Void. |
PHONE_MAIL_ORDER_FLAG | Code identifying whether the transaction is mail order, phone order or electronic commerce. |
POS_DATA_CODES | POS Codes for American Express Ticket Only (Tran Code 3) transaction. Contact American Express to determine how these values are generated and used for American Express. |
PROTOCOL_TYPE | Character identifying which protocol rule the transaction follows; required field. |
REMAINING_BALANCE | Right justified w/leading spaces when a Balance returned by issuer.
Balance is returned by Issuer when Partial Auth Indicator is set to 1 in the online sale request. When Balance not returned by Issuer, The field will contain the constant value ―UNAVAILABLE‖ Left justified trailing spaces. |
REQUESTED_AMOUNT | The Amount entered at POS to be authorized by Host. |
RESPONSE_CODE | Value defining how the System responded to the transaction. |
RESPONSE_TEXT | Message from the Host which appears on the POS device. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
REVISION_NUMBER | Number identifying the number of revisions to a monetary transaction. |
SURCHARGE | Dollar-and-cent amount ($$$.¢¢) of the charge that the cardholder paid the merchant for the ability to perform the transaction. |
TAX_AMOUNT | Dollar-and-cent amount ($$$$$.¢¢) of tax for the purchase. |
TERMINAL_ID | Code identifying the balancing features available to the POS from the Host. |
TIP_AMOUNT | Dollar-and-cent amount ($$$.¢¢) of the tip given at the restaurant for the purchase. |
TOTAL_AMOUNT | Total dollar-and-cent amount ($$$$$.¢¢) of the purchase. |
TOTAL_AUTHORIZED_AMOUNT | Dollar-and-cent amount ($$$$$.¢¢) of the purchase. |
TPP | If a First Data assigned TPP value is not available do not send this field with a default value. |
TRANS_STAIN | A value used to define a merchant‘s security settings for SET. |
TRANSACTION_CODE | Code identifying how the System will respond to the transaction request. |
TRANSACTION_IDENTIFIER | Code generated by the card associations on the authorization; known as TID for Visa and BankNet Reference Number for MasterCard. |
TRANSACTION_TYPE | Code identifying how the System will respond to the transaction request. |
WRITE_CONTROL_CHARACTER | Character identifying the account number entry method and Host response protocol (single or multiple mode). |
XID | A unique transaction identifier assigned to a SET Transaction. |
Name | Description |
---|---|
BIT11 | |
BIT12 | |
BIT22 | |
BIT25 | |
BIT3 | |
BIT30 | |
BIT31 | |
BIT32 | |
BIT38 | |
BIT4 | |
BIT42 | |
BIT44 | |
BIT48 | |
BIT54 | |
BIT61 | |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
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. |
MESSAGE_TYPE | |
PROCESS_MODE | |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
Name | Description |
---|---|
APPROVED_AMOUNT | Amount actually used. The merchant must tender the difference between the requested amount and the approved amount. |
BIT11 | |
BIT12 | |
BIT22 | |
BIT25 | |
BIT3 | |
BIT30 | |
BIT31 | |
BIT31_ACQUIRER_REFERENCE_DATA | |
BIT31_AUTHORIZATION_SOURCE_CODE | |
BIT31_BALANCE_DATA | |
BIT31_MERCHANT_ADVICE_CODE | |
BIT31_PRODUCT_IDENTIFIER | |
BIT31_PROGRAM_IDENTIFIER | |
BIT31_RESPONSE_CODE | |
BIT31_SYSTEM_ADDRESS | |
BIT31_TRANSACTION_ID | |
BIT31_VALIDATION_CODE | |
BIT32 | |
BIT38 | |
BIT38_APPROVAL_CODE | |
BIT39_ACTION_CODE | |
BIT4 | |
BIT42 | |
BIT44 | |
BIT44_BATCH_AMOUNT | |
BIT44_BATCH_NUMBER | |
BIT44_CASH_BENEFIT_BALANCE | |
BIT44_FOOD_STAMP_BALANCE | |
BIT44_ITEM | |
BIT44_VERBIAGE | |
BIT48 | |
BIT48_ADDITIONAL_DATA | |
BIT48_AVS_RESULT_CODE | |
BIT48_CARD_VERIFICATION_RESULT | |
BIT48_CAVV_RESULT_CODE | |
BIT54 | |
BIT61 | |
BIT62_GLOBAL_PAYMENTS_DATA | |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
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. |
MESSAGE_TYPE | |
PROCESS_MODE | |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
Name | Description |
---|---|
Identifies the merchant to a direct debit switch.
This field must be supplied for all direct debit request transactions except for the Interlink Debit Cancel (Transaction Code 95). This number is provided by the signing member or processor. |
|
ACCOUNT_DATA_SOURCE | Contains code identifying the source of the customer data entered in field:
|
ACQUIRER_BIN | Contains a six-character numeric Visa assigned Bank Identification Number (BIN) issued by the merchant's member bank or processor. The Acquirer BIN identifies the member bank that signed the merchant using the POS application. |
ACQUIRER_BIN | Contains a six-character numeric Visa assigned Bank Identification Number (BIN) issued by the merchant's member bank or processor. The Acquirer BIN identifies the member bank that signed the merchant using the POS application. |
ACQUIRER_BIN_NEW | Contains a six-character numeric Visa assigned Bank Identification Number (BIN) issued by the merchant's member bank or processor. The Acquirer BIN identifies the member bank that signed the merchant using the POS application. |
AGENT_BANK_NUMBER | Contains an agent number assigned by the signing member or processor. The number identifies an institution which signs merchants as an agent of a member. The member uses this number to identify the agent within TSYS Acquiring Solutions’ system. |
AGENT_CHAIN_NUMBER | Contains a merchant chain identification number assigned by the signing member or processor. The member uses this number to identify the merchant chain within the TSYS Acquiring Solutions’ system. |
BATCH_NUMBER | Contains a batch sequence number generated by the terminal. The number wraps from 999 to 001. This number is also transmitted as the data capture batch number. Batch numbers should not be repeated within five days. |
CANCEL_DATA1 | The following sub-fields are required when performing an ATM or Debit Non-Confirm Authorization request, or when performing an Authorization Reversal request, a Debit Reversal/Cancel request, or a AFD Completion Advice message. For all other transaction types, this field should be submitted without data.
Approval Code: Contains approval code returned in the original authorization response record. This is the authorization code for the completed AFD transaction, or the transaction to be either partially or completely reversed. For a debit non-confirm purchase or ATM authorization transactions, the approval code will be space filled. Local Transaction Date: Contains value reflecting the local transaction date returned in the original authorization response record for the AFD sale or the transaction to be canceled or reversed. For a debit non-confirm purchase or ATM authorization transactions, this field will contain the local transaction date. Local Transaction Time: Contains the local transaction time of the original authorization request for the AFD sale or the transaction to be either partially or fully reversed. The Local Transaction Time must be submitted in HHMMSS format. For a debit non-confirm purchase or ATM authorization transactions, this field will contain the local transaction time. Retrieval Reference Number: In AFD Completion Advice messages and reversal transactions, this field must contain Retrieval Reference Number returned in the original authorization response. For debit non-confirm purchase or ATM authorization transactions, this field contains two parts. The first four characters are a yddd date (Julian date) format. The last eight characters are a numeric transaction identification number. |
CANCEL_DATA2 | The following sub-fields are required when requesting any of the following Authorization Transaction Codes: A3, A4, B1, B2, B3, B4, C1, C3, C4 and 5C. This field does not contain data for any other transaction types.
System Trace Audit Number: Must contain the System Trace Audit Number returned in the confirmation data field of the debit authorization response record for the transaction to be canceled or reversed. For a debit non-confirm purchase transaction, this number uniquely. Network Identification Code: When returned in a debit authorization response message, this value designates the debit network through which the request was processed. When performing an Authorization Reversal, this field must contain the one-character Network Identification Code returned in the confirmation data field of the authorization response record for the item to be canceled or reversed. For a debit non-confirm or ATM authorization transactions, the network identification code field will be space-filled. |
CARD_ACCEPTOR_DATA | The following sub-fields are required for direct debit transactions. For all other transactions, the following sub-fields should be configured as parameters within the POS system but need not necessarily contain data.
The format of this 40-byte field is: “NNNNNNNNNNNNNNNNNNNNNNNNNLLLLLLLLLLLLLSS” where NNNN... 1-25 A/N Merchant Name LL.....LL 26-38 A/N Merchant City SS 39-40 A/N Merchant State For Direct Marketing merchants and preferred customer/passenger transport transactions, this field should contain a customer service phone number in XXX-XXXXXXX format. |
CARDHOLDER_ID_CODE | Contains a code that specifies the method used to verify the identity the cardholder. The values can be used in conjunction with AVS and Recurring and Installment Requested ACI Indicators.
|
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CITY_CODE | Contains the code used to further identify the merchant location (ZIP Code). |
INDUSTRY_CODE | Used to identify the industry type of the merchant submitting the authorization request.
|
MARKET_SPECIFIC_DATA | The following sub-fields contain market specific data for hotel and auto rental transactions. The market specific data sub-fields need not be supplied for incremental authorization or authorization reversal transactions.
The format of this field is: “PIDD.”
|
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. |
MERCHANT_CATEGORY_CODE | Contains a number assigned by the signing member or processor to identify a merchant industry classification.
This value is similar to the Standard Industry Code (SIC). |
MERCHANT_NUMBER | Contains a unique number, assigned by the signing merchant’s bank or processor. Used to identify the merchant within the TSYS Acquiring Solutions system. |
MERCHANT_NUMBER | Contains a unique number, assigned by the signing merchant’s bank or processor. Used to identify the merchant within the TSYS Acquiring Solutions system. |
MERCHANT_SETTLEMENT_AGENT_NUMBER | Identifies the merchant settling agent. Provided by the signing member or processor. |
RECORD_FORMAT | Identifies the message format with the TSYS Acquiring Solutions system.
|
RECORD_FORMAT | Identifies the message format with the TSYS Acquiring Solutions system.
|
RECORD_FORMAT | Identifies the message format with the TSYS Acquiring Solutions system.
|
RECORD_FORMAT | Identifies the message format with the TSYS Acquiring Solutions system.
|
RECORD_FORMAT | Identifies the message format with the TSYS Acquiring Solutions system.
|
REQUESTED_ACI | Contains the Requested Authorization Characteristics Indicator (ACI) used to identify an authorization request as potentially qualifying for CPS (Custom Payment Services) and MasterCard Merit programs. If a merchant chooses not to participate in CPS, the Requested ACI value should default to an “N.”
Y - Device is CPS capable R - Recurring Payment. No AVS required N - Device is not CPS capable |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
REVERSAL_TRANSACTION_ID | When performing either an Incremental Authorization or Authorization Reversal request, this field must contain the Transaction Identifier returned in the original authorization response record. For all other transaction types, this field should be submitted without data. |
SECONDARY_AMOUNT | Secondary amount associated with the transaction representing a cashback amount.
This is a variable length field from zero to 12-character numeric in length. This field contains a secondary transaction amount related to the transaction type and industry indicated. The transaction amount is to be presented with an implied decimal point. For example, $.01 could be represented as 1, 01, or 001. The allowable number of significant digits, as well as the positioning of any implied decimal point, are dictated by the Currency Code designated. In the United States, the allowable number of significant characters is seven with an implied decimal point. In industries where cash back is permitted on purchase transactions, this field could contain a cash back amount. For Authorization Reversal transactions, this field must contain the final settlement amount for a partial reversal, and is not used for a full reversal. |
SHARING_GROUPS | Contains a listing of direct debit and EBT networks that a POS device can access. Provided by the signing member or processor. The values must correspond to one of the Visa assigned direct debit network types. This data is part of the TSYS Acquiring Solutions direct debit data. |
STORE_NUMBER | Contains a number assigned by the signing member, processor, or merchant to identify a specific merchant store within the TSYS Acquiring Solutions’ system. |
TERMINAL_NUMBER | Contains a number assigned by the signing member, processor, or merchant to identify a unique terminal within a merchant location.
Because the terminal number submitted in the authorization request is echoed back to the terminal in the authorization response, this field can additionally be used in controller-based environments to assist in the matching and routing of authorization request and response messages at the point of concentration. |
TIME_ZONE_DIFFERENTIAL | Contains a code used to calculate the local time within the TSYS Acquiring Solutions authorization system.
The differential is calculated by the signing member or processor, providing the standard local time zone differential from Greenwich Mean Time (GMT). The first character numeric specifies the direction of the differential and offset increment as well as whether daylight savings is observed, and the last two-character numeric specify the magnitude of the differential. For now, such values is used - 705, 706, 707, 708 |
TRANSACTION_AMOUNT | Contains the transaction amount to be authorized. The transaction amount is to be presented with implied decimal point.
For all Authorization Reversal transactions, this field contains the Total Authorization Amount (the total of all previous authorizations performed for a particular transaction or associated with a single Transaction ID). |
TRANSACTION_CODE | Contains a code identifying the type of authorization or function being requested.
In conditions where an authorization request has been submitted to the host but no response was ever received, the transaction code should be converted to its corresponding “Repeat” value and resubmitted for authorization.
|
TRANSACTION_SEQUENCE_NUMBER | Contains a terminal-generated transaction sequence number to be submitted in all authorization request messages.
This number is echoed back to the terminal for purposes of assisting in the matching of authorization request and response messages. This value must be in the range of 0001 - 9999 and is incremented on each authorization request message. This number is automatically incremented from 9999 to 0001. |
Name | Description |
---|---|
Identifies the merchant to a direct debit switch.
This field must be supplied for all direct debit request transactions except for the Interlink Debit Cancel (Transaction Code 95). This number is provided by the signing member or processor. |
|
ACCOUNT_DATA_SOURCE | Contains code identifying the source of the customer data entered in field:
|
ACQUIRER_BIN | Contains a six-character numeric Visa assigned Bank Identification Number (BIN) issued by the merchant's member bank or processor. The Acquirer BIN identifies the member bank that signed the merchant using the POS application. |
ACQUIRER_BIN | Contains a six-character numeric Visa assigned Bank Identification Number (BIN) issued by the merchant's member bank or processor. The Acquirer BIN identifies the member bank that signed the merchant using the POS application. |
ACQUIRER_BIN_NEW | Contains a six-character numeric Visa assigned Bank Identification Number (BIN) issued by the merchant's member bank or processor. The Acquirer BIN identifies the member bank that signed the merchant using the POS application. |
AGENT_BANK_NUMBER | Contains an agent number assigned by the signing member or processor. The number identifies an institution which signs merchants as an agent of a member. The member uses this number to identify the agent within TSYS Acquiring Solutions’ system. |
AGENT_CHAIN_NUMBER | Contains a merchant chain identification number assigned by the signing member or processor. The member uses this number to identify the merchant chain within the TSYS Acquiring Solutions’ system. |
APPROVAL_CODE | Contains fixed approval code returned in the original authorization response record.
This is the authorization code for the completed AFD transaction, or the transaction to be either partially or completely reversed. For a debit non-confirm purchase or ATM authorization transactions, the approval code will be space filled. |
AUTHORIZATION_RESPONSE_TEXT | Contains a response or display text message. This message can be used by the terminal to display the authorization result. The display text must not be used to determine the nature of a response message. |
AUTHORIZATION_SOURCE_CODE | Contains code indicating the source of the authorization code. The received code must be stored and resubmitted in the data capture settlement record. |
AVS_RESULT_CODE | Contains the Address Verification Result Code. An Address Verification Result Code can provide additional information concerning the authentication of a particular transaction for which cardholder Address Verification was requested. An Address Verification result code of “0” is returned in the response message when no address verification has been requested. The value returned should be stored and submitted as part of the data capture settlement record. |
BATCH_NUMBER | Contains a batch sequence number generated by the terminal. The number wraps from 999 to 001. This number is also transmitted as the data capture batch number. Batch numbers should not be repeated within five days. |
CANCEL_DATA1 | The following sub-fields are required when performing an ATM or Debit Non-Confirm Authorization request, or when performing an Authorization Reversal request, a Debit Reversal/Cancel request, or a AFD Completion Advice message. For all other transaction types, this field should be submitted without data.
Approval Code: Contains approval code returned in the original authorization response record. This is the authorization code for the completed AFD transaction, or the transaction to be either partially or completely reversed. For a debit non-confirm purchase or ATM authorization transactions, the approval code will be space filled. Local Transaction Date: Contains value reflecting the local transaction date returned in the original authorization response record for the AFD sale or the transaction to be canceled or reversed. For a debit non-confirm purchase or ATM authorization transactions, this field will contain the local transaction date. Local Transaction Time: Contains the local transaction time of the original authorization request for the AFD sale or the transaction to be either partially or fully reversed. The Local Transaction Time must be submitted in HHMMSS format. For a debit non-confirm purchase or ATM authorization transactions, this field will contain the local transaction time. Retrieval Reference Number: In AFD Completion Advice messages and reversal transactions, this field must contain Retrieval Reference Number returned in the original authorization response. For debit non-confirm purchase or ATM authorization transactions, this field contains two parts. The first four characters are a yddd date (Julian date) format. The last eight characters are a numeric transaction identification number. |
CANCEL_DATA2 | The following sub-fields are required when requesting any of the following Authorization Transaction Codes: A3, A4, B1, B2, B3, B4, C1, C3, C4 and 5C. This field does not contain data for any other transaction types.
System Trace Audit Number: Must contain the System Trace Audit Number returned in the confirmation data field of the debit authorization response record for the transaction to be canceled or reversed. For a debit non-confirm purchase transaction, this number uniquely. Network Identification Code: When returned in a debit authorization response message, this value designates the debit network through which the request was processed. When performing an Authorization Reversal, this field must contain the one-character Network Identification Code returned in the confirmation data field of the authorization response record for the item to be canceled or reversed. For a debit non-confirm or ATM authorization transactions, the network identification code field will be space-filled. |
CARD_ACCEPTOR_DATA | The following sub-fields are required for direct debit transactions. For all other transactions, the following sub-fields should be configured as parameters within the POS system but need not necessarily contain data.
The format of this 40-byte field is: “NNNNNNNNNNNNNNNNNNNNNNNNNLLLLLLLLLLLLLSS” where NNNN... 1-25 A/N Merchant Name LL.....LL 26-38 A/N Merchant City SS 39-40 A/N Merchant State For Direct Marketing merchants and preferred customer/passenger transport transactions, this field should contain a customer service phone number in XXX-XXXXXXX format. |
CARD_LEVEL_RESULTS | Contains code created by Visa during the authorization process.
Conditional in the response record. It will only be returned if the values are non-zero. |
CARDHOLDER_ID_CODE | Contains a code that specifies the method used to verify the identity the cardholder. The values can be used in conjunction with AVS and Recurring and Installment Requested ACI Indicators.
|
CAVV_RESULTS_CODE | Indicates whether the authentication value submitted by the merchant can be validated by Visa or the issuer. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CITY_CODE | Contains the code used to further identify the merchant location (ZIP Code). |
COMMERCIAL_CARD_RESPONSE_INDICATOR | If the Commercial Card Request Indicator (this field is utilized to request that TSYS Acquiring Solutions systems return a value in the authorization response message identifying whether the card type being presented was a Commercial Card. This field is currently defaulted to 010, and is supported for Visa and MasterCard transactions only) was supplied in the authorization request, the host responds with one of the following response indicators identifying the card being processed.
When a response indicator has been received indicating that the approved card is a Business, Corporate, or Purchasing Card, the POS device should prompt for addendum data elements as needed for settlement. |
FIRST_ACCOUNT_TYPE1 | Contains identifiers for account types. |
FIRST_ACCOUNT_TYPE2 | Contains identifiers for account types. |
FIRST_AMOUNT | Contains any additional amounts related to the authorization request or response. |
FIRST_CURRENCY_CODE | Contains currency code identifying the currency for the returned additional amount. |
FIRST_SIGN | Indicates whether the amount is a debit or credit. |
FOURTH_ACCOUNT_TYPE1 | Contains identifiers for account types. |
FOURTH_ACCOUNT_TYPE2 | Contains identifiers for account types. |
FOURTH_AMOUNT | Contains any additional amounts related to the authorization request or response. |
FOURTH_CURRENCY_CODE | Contains currency code identifying the currency for the returned additional amount. |
FOURTH_SIGN | Indicates whether the amount is a debit or credit. |
HOST_MESSAGE_IDENTIFIER | Contains a unique host message identifier assigned by the authorizing system and returned in debit card response messages. Reserved for future use and will most likely contain spaces. This value must be recorded and submitted in the debit confirmation record. |
INDUSTRY_CODE | Used to identify the industry type of the merchant submitting the authorization request.
|
LOCAL_TRANSACTION_DATE | Contains value reflecting the local transaction date (in MMDDYY format) returned in the original authorization response record for the AFD sale or the transaction to be canceled or reversed. For a debit non-confirm purchase or ATM authorization transactions, this field will contain the local transaction date. |
LOCAL_TRANSACTION_TIME | Contains the local transaction time of the original authorization request for the AFD sale or the transaction to be either partially or fully reversed. The local transaction time must be submitted in HHMMSS format. For a debit non-confirm purchase or ATM authorization transactions, this field will contain the local transaction time. |
MARKET_DATA_IDENTIFIER | Used to indicate which industry data is being submitted.
When this sub-field is supplied in an incremental transaction, it should use the same value that was requested in the original authorization transaction. |
MARKET_SPECIFIC_DATA | The following sub-fields contain market specific data for hotel and auto rental transactions. The market specific data sub-fields need not be supplied for incremental authorization or authorization reversal transactions.
The format of this field is: “PIDD.”
|
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. |
MERCHANT_CATEGORY_CODE | Contains a number assigned by the signing member or processor to identify a merchant industry classification.
This value is similar to the Standard Industry Code (SIC). |
MERCHANT_NUMBER | Contains a unique number, assigned by the signing merchant’s bank or processor. Used to identify the merchant within the TSYS Acquiring Solutions system. |
MERCHANT_NUMBER | Contains a unique number, assigned by the signing merchant’s bank or processor. Used to identify the merchant within the TSYS Acquiring Solutions system. |
MERCHANT_SETTLEMENT_AGENT_NUMBER | Identifies the merchant settling agent. Provided by the signing member or processor. |
NETWORK_ID_CODE | Contains a code that specifies the network to be used for transmission of the message and determines the program rules that apply to the transaction. |
RECORD_FORMAT | Identifies the message format with the TSYS Acquiring Solutions system.
|
RECORD_FORMAT | Identifies the message format with the TSYS Acquiring Solutions system.
|
RECORD_FORMAT | Identifies the message format with the TSYS Acquiring Solutions system.
|
RECORD_FORMAT | Identifies the message format with the TSYS Acquiring Solutions system.
|
RECORD_FORMAT | Identifies the message format with the TSYS Acquiring Solutions system.
|
REQUESTED_ACI | Contains the Requested Authorization Characteristics Indicator (ACI) used to identify an authorization request as potentially qualifying for CPS (Custom Payment Services) and MasterCard Merit programs. If a merchant chooses not to participate in CPS, the Requested ACI value should default to an “N.”
Y - Device is CPS capable R - Recurring Payment. No AVS required N - Device is not CPS capable |
RESPONSE_CODE | Contains code identifying the type of authorization or function being requested.
In conditions where an authorization request has been submitted to the host but no response was ever received, the transaction code should be converted to its corresponding “Repeat” value and resubmitted for authorization. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETRIEVAL_REFERENCE_NUMBER | Contains value reflecting the transaction Retrieval Reference Number returned by the authorizing system.
The POS system should record the retrieval reference number received in the original authorization response. The Retrieval Reference Number from the original response is required when submitting AFD Completion Advice messages and when submitting incremental authorizations, or authorization reversal requests that must be settled for direct debit transactions. |
RETURNED_ACI | Contains the Returned Authorization Characteristics Indicator (ACI).
Provides information concerning the transactions’ CPS qualification status. It is not recommended that the POS system attempt to interpret the meaning of this value. Instead, the POS system should extract whatever value is returned in this field and submit it in the data capture settlement record. The POS system should not interpret any relationship between this field and the presence of data in either the Transaction Identifier or Validation Code fields. |
REVERSAL_TRANSACTION_ID | When performing either an Incremental Authorization or Authorization Reversal request, this field must contain the Transaction Identifier returned in the original authorization response record. For all other transaction types, this field should be submitted without data. |
SECOND_ACCOUNT_TYPE1 | Contains identifiers for account types. |
SECOND_ACCOUNT_TYPE2 | Contains identifiers for account types. |
SECOND_AMOUNT | Contains any additional amounts related to the authorization request or response. |
SECOND_CURRENCY_CODE | Contains currency code identifying the currency for the returned additional amount. |
SECOND_SIGN | Indicates whether the amount is a debit or credit. |
SETTLEMENT_DATE | Contains the transaction settlement date returned by the TSYS Acquiring Solutions authorization system and is submitted in MMDD format. |
SHARING_GROUPS | Contains a listing of direct debit and EBT networks that a POS device can access. Provided by the signing member or processor. The values must correspond to one of the Visa assigned direct debit network types. This data is part of the TSYS Acquiring Solutions direct debit data. |
SPEND_QUALIFIED_INDICATOR | Optionally sent by Visa in an autorization response message. The merchant's intercharge rate may be determined by spend qualified indicator. See the specification of the processor for more information. |
STORE_NUMBER | Contains a number assigned by the signing member, processor, or merchant to identify a specific merchant store within the TSYS Acquiring Solutions’ system. |
SYSTEM_TRACE_AUDIT_NUMBER | Must contain System Trace Audit Number returned in the confirmation data field of the debit authorization response record for the transaction to be canceled or reversed. For a debit non-confirm purchase transaction, this number uniquely identifies a cardholder transaction. The trace number remains unchanged for all messages throughout the life cycle of the transaction. |
TERMINAL_NUMBER | Contains a number assigned by the signing member, processor, or merchant to identify a unique terminal within a merchant location.
Because the terminal number submitted in the authorization request is echoed back to the terminal in the authorization response, this field can additionally be used in controller-based environments to assist in the matching and routing of authorization request and response messages at the point of concentration. |
THIRD_ACCOUNT_TYPE1 | Contains identifiers for account types. |
THIRD_ACCOUNT_TYPE2 | Contains identifiers for account types. |
THIRD_AMOUNT | Contains any additional amounts related to the authorization request or response. |
THIRD_CURRENCY_CODE | Contains currency code identifying the currency for the returned additional amount. |
THIRD_SIGN | Indicates whether the amount is a debit or credit. |
TIME_ZONE_DIFFERENTIAL | Contains a code used to calculate the local time within the TSYS Acquiring Solutions authorization system.
The differential is calculated by the signing member or processor, providing the standard local time zone differential from Greenwich Mean Time (GMT). The first character numeric specifies the direction of the differential and offset increment as well as whether daylight savings is observed, and the last two-character numeric specify the magnitude of the differential. For now, such values is used - 705, 706, 707, 708 |
TRANSACTION_AMOUNT | Contains the transaction amount to be authorized. The transaction amount is to be presented with implied decimal point.
For all Authorization Reversal transactions, this field contains the Total Authorization Amount (the total of all previous authorizations performed for a particular transaction or associated with a single Transaction ID). |
TRANSACTION_CODE | Contains a code identifying the type of authorization or function being requested.
In conditions where an authorization request has been submitted to the host but no response was ever received, the transaction code should be converted to its corresponding “Repeat” value and resubmitted for authorization.
|
TRANSACTION_IDENTIFIER | Contains a transaction identifier (Visa, American Express or Discover) or Reference Number (MasterCard). The POS device does not attempt to interpret the meaning of any data appearing in this field. Data returned in this field is recorded and submitted as part of the data capture settlement format. |
TRANSACTION_SEQUENCE_NUMBER | Contains a terminal-generated transaction sequence number to be submitted in all authorization request messages.
This number is echoed back to the terminal for purposes of assisting in the matching of authorization request and response messages. This value must be in the range of 0001 - 9999 and is incremented on each authorization request message. This number is automatically incremented from 9999 to 0001. |
VALIDATION_CODE | Discover Usage:
Used to indicate the magnetic stripe condition and the vulnerability for fraud in Discover Network Card Transactions. Non-Discover Usage: Can contain specific information generated by the card issuer. The POS device should not attempt to interpret the meaning of any data appearing in this field. Data returned in this field is recorded and submitted as part of the data capture settlement format. |
VERIFICATION_RESULT_CODE | Contains the host returned CVV2/CVC2/CID result code. |
Name | Description |
---|---|
ALLOW_PARTIAL_AUTH | Indicates whether partial authorization is supported. Default is 'N'. Valid values = 'Y' or 'N'. |
AMOUNT | The amount element defines the amount of the transaction. Supply the value in cents without a decimal point. |
BILL_TO_ADDRESS |
Name | Description |
---|---|
APPROVED_AMOUNT | Amount actually used. The merchant must tender the difference between the requested amount and the approved amount. |
AUTH_CODE | The authCode element specifies the authorization code from the associated Authorization or Sale transaction. |
AVS_RESULT_CODE | Address verification result code. |
BALANCE_ON_CARD |
Name | Description |
---|---|
CUSTOMER_NAME | Name of the customer. |
DEBIT_DATE | Date when the payment will be deducted from customer's bank account or credit card. |
EMAIL_ADDRESS | Email address of the customer. |
FIRST_NAME | First name of the customer. |
LAST_NAME | Last name of the customer. |
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. |
MOBILE_PHONE_NUMBER | Mobile phone number of the customer for discussing any processing issues. |
NAME_ON_CREDIT_CARD | Name of the credit card holder, printed on the credit card. |
PAYMENT_AMOUNT_IN_CENTS | The amount to debit from the customer in cents. |
PAYMENT_ID | The unique transaction ID given to the original payment by Ezidebit. |
PAYMENT_REFERENCE | Reference number of the transaction. |
REFUND_AMOUNT_IN_CENTS | The amount that the refund is to be processed for. Must be less than or equal to the amount originally paid by the payer. |
REFUND_BANK_RECEIPT_ID | Receipt Number issued by the Merchant Acquirer (bank) for this refund. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
SMS_EXPIRED_CARD | Indicates whether SMS notification will be sent to the customer if his recorded credit card is due to expire. Optional. |
SMS_FAILED_NOTIFICATION | Indicates whether SMS notification will be sent to the customer if his debit fails. |
SMS_PAYMENT_REMINDER | Indicates whether SMS notification will be sent to the customer to remind him of upcoming scheduled debits. Optional. |
SUBMISSION_CL | Enumeration of possible submission types. |
YOUR_GENERAL_REFERENCE | A secondary unique reference for the customer. If no value is supplied for this field it will default to 'LastnameFirstnameYYYYmmDDhhMM'. |
YOUR_SYSTEM_REFERENCE | A unique system identifier for the customer (e.g. GUID or your primary key). |
Name | Description |
---|---|
BANK_RECEIPT_ID | The Original Receipt Number issued by the Merchant Acquirer (bank) for this payment. |
BANK_RECEIPT_ID | The Original Receipt Number issued by the Merchant Acquirer (bank) for this payment. |
BANK_RECEIPT_ID | The Original Receipt Number issued by the Merchant Acquirer (bank) for this payment. |
CUSTOMER_NAME | Name of the customer. |
CUSTOMER_REF | Unique reference number stored in the Ezidebit database that corresponds to the customer. |
EMAIL_ADDRESS | Email address of the customer. |
ERROR | Code of the occured error. |
ERROR_MESSAGE | Text message explaining the occured error. |
EXCHANGE_PAYMENT_ID | Identifier for the payment within Ezidebit's own payment systems. |
FIRST_NAME | First name of the customer. |
LAST_NAME | Last name of the customer. |
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. |
MOBILE_PHONE_NUMBER | Mobile phone number of the customer for discussing any processing issues. |
NAME_ON_CREDIT_CARD | Name of the credit card holder, printed on the credit card. |
PAYMENT_AMOUNT_IN_CENTS | The amount to debit from the customer in cents. |
PAYMENT_REFERENCE | Reference number of the transaction. |
PAYMENT_RESULT | Result of the processed payment of the customer. |
PAYMENT_RESULT_CODE | Gateway generated result code of the processed payment. |
PAYMENT_RESULT_TEXT | Gateway generated result text message of the processed payment. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
SMS_EXPIRED_CARD | Indicates whether SMS notification will be sent to the customer if his recorded credit card is due to expire. Optional. |
SMS_FAILED_NOTIFICATION | Indicates whether SMS notification will be sent to the customer if his debit fails. |
SMS_PAYMENT_REMINDER | Indicates whether SMS notification will be sent to the customer to remind him of upcoming scheduled debits. Optional. |
SUBMISSION_CL | Enumeration of possible submission types. |
YOUR_GENERAL_REFERENCE | A secondary unique reference for the customer. If no value is supplied for this field it will default to 'LastnameFirstnameYYYYmmDDhhMM'. |
YOUR_SYSTEM_REFERENCE | A unique system identifier for the customer (e.g. GUID or your primary key). |
Name | Description |
---|---|
ADDRESS1 | The first line of the merchant's street address. |
AMOUNT | The amount element defines the amount of the transaction. Supply the value in cents without a decimal point. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CITY | City of the mailing address. |
COUNTRY | |
DESCRIPTOR | |
DESCRIPTOR_PHONE | |
FIRSTNAME | |
LASTNAME | |
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. |
ORDERDESCRIPTION | |
ORDERID | |
PHONE | |
PONUMBER | |
PROCESSOR_ID | |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
SHIPPING | |
SHIPPING_ADDRESS1 | |
SHIPPING_CITY | |
SHIPPING_COUNTRY | |
SHIPPING_FIRSTNAME | |
SHIPPING_LASTNAME | |
SHIPPING_STATE | |
SHIPPING_ZIP | |
STATE | |
TAX | |
TRANSACTIONID | |
TYPE | |
ZIP | ZIP or postal code of the mailing address. |
Name | Description |
---|---|
ADDRESS1 | The first line of the merchant's street address. |
AMOUNT | The amount element defines the amount of the transaction. Supply the value in cents without a decimal point. |
AUTHCODE | The authCode element specifies the authorization code from the associated Authorization or Sale transaction. |
AVSRESPONSE | address verification response code returned in response message as a result of an AVS Request. It is also a required value for a terminal-based settlement, if returned in the authorization response. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CITY | City of the mailing address. |
COUNTRY | |
CVVRESPONSE | |
DESCRIPTOR | |
DESCRIPTOR_PHONE | |
FIRSTNAME | |
LASTNAME | |
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. |
ORDERDESCRIPTION | |
ORDERID | |
PHONE | |
PONUMBER | |
PROCESSOR_ID | |
RESPONSE | |
RESPONSECODE | |
RESPONSETEXT | |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
SHIPPING | |
SHIPPING_ADDRESS1 | |
SHIPPING_CITY | |
SHIPPING_COUNTRY | |
SHIPPING_FIRSTNAME | |
SHIPPING_LASTNAME | |
SHIPPING_STATE | |
SHIPPING_ZIP | |
STATE | |
TAX | |
TRANSACTIONID | |
TYPE | |
ZIP | ZIP or postal code of the mailing address. |
Name | Description |
---|---|
BILL_CITY | |
BILL_COUNTRY | |
BILL_STATE | |
BILL_STREET1 | |
BILL_ZIP | |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
COMPANY | Company name. |
CUSTOMER_NAME | |
IP_ADDR | |
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. |
PHONE | |
PRICE | |
SHIP_CITY | |
SHIP_NAME | |
SHIP_STATE | |
SHIP_STREET1 | |
SHIP_ZIP | |
SOURCE | |
TID |
Name | Description |
---|---|
ACTION | |
AVS_RESPONSE | The Response Code to the Address Verification Service. |
BILL_CITY | |
BILL_COUNTRY | |
BILL_STATE | |
BILL_STREET1 | |
BILL_ZIP | |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
COMPANY | Company name. |
CUSTOMER_NAME | |
CVV_RESPONSE | |
IP_ADDR | |
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. |
PHONE | |
PRICE | |
REF_CODE | |
SHIP_CITY | |
SHIP_NAME | |
SHIP_STATE | |
SHIP_STREET1 | |
SHIP_ZIP | |
SOURCE | |
TID |
Name | Description |
---|---|
BIT11 | Unique trace number that identifies a transaction. Assigned by a merchant. |
BIT12 | Year, month, day and local time when the transaction took place at the card acceptor location. |
BIT13 | Date embossed on the face of the card supported by the processor. |
BIT19 | Country code of the merchant's mailing address. |
BIT22 | Code that identifies terminal capability, security data and specific conditions present at the time the transaction occurred at the point of service. |
BIT24 | Function code. Assigned by the processor. |
BIT25 | Reason code of the merchant. Assigned by the processor. |
BIT26 | MCC code of the merchant. |
BIT27 | Length of the approval code. |
BIT3 | Code that indicates the financial service being requested. Assigned by the processor. |
BIT31 | Reference data associated with the acquirer. |
BIT31_ACQUIRED_REFERENCE_DATA | Reference data associated with the acquirer received in response. |
BIT33 | Identification code of the forwarding institution. |
BIT37 | Retrieval reference number. Assigned by the processor. |
BIT4 | Total transaction amount. |
BIT4_AMOUNT | Total transaction amount received in response. |
BIT41 | Code that identifies a specific terminal at a merchant location. |
BIT42 | Identifier of the merchant in a POS transaction. |
BIT43 | Name and location of the card acceptor. |
BIT47 | Additional data associated with the cardholder. This data field is used only for transactions where the cardholder is not present. |
BIT48 | Extended payment indicator that consists of the plan type and number of installments. Assigned by the processor. |
BIT49 | Code of the currency used in transaction. |
BIT56 | |
BIT63 | Data that is required to process certain types of Authorization Request (1100) messages, such as American Express Travelers Cheque, and verifications for Cardmember Name, Address, ZIP Code, and Telephone Number. |
BIT7 | System date and time when a merchant transmits the transaction information to the processor. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
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. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
Name | Description |
---|---|
BIT11 | Unique trace number that identifies a transaction. Assigned by a merchant. |
BIT12 | Year, month, day and local time when the transaction took place at the card acceptor location. |
BIT13 | Date embossed on the face of the card supported by the processor. |
BIT19 | Country code of the merchant's mailing address. |
BIT22 | Code that identifies terminal capability, security data and specific conditions present at the time the transaction occurred at the point of service. |
BIT24 | Function code. Assigned by the processor. |
BIT25 | Reason code of the merchant. Assigned by the processor. |
BIT26 | MCC code of the merchant. |
BIT27 | Length of the approval code. |
BIT3 | Code that indicates the financial service being requested. Assigned by the processor. |
BIT31 | Reference data associated with the acquirer. |
BIT31_ACQUIRED_REFERENCE_DATA | Reference data associated with the acquirer received in response. |
BIT32 | Identification code of the acquiring institution processing the request. |
BIT33 | Identification code of the forwarding institution. |
BIT37 | Retrieval reference number. Assigned by the processor. |
BIT38_APPROVAL_CODE | Approval code generated within the processor's system. |
BIT4 | Total transaction amount. |
BIT4_AMOUNT | Total transaction amount received in response. |
BIT41 | Code that identifies a specific terminal at a merchant location. |
BIT42 | Identifier of the merchant in a POS transaction. |
BIT43 | Name and location of the card acceptor. |
BIT44_ADDITIONAL_RESPONSE_DATA | Additional data associated with cardholder and included in response. |
BIT47 | Additional data associated with the cardholder. This data field is used only for transactions where the cardholder is not present. |
BIT48 | Extended payment indicator that consists of the plan type and number of installments. Assigned by the processor. |
BIT49 | Code of the currency used in transaction. |
BIT54_ADDITIONAL_AMOUNTS | Additional amounts included in processed transaction. |
BIT56 | |
BIT62_PRIVATE_DATA | Private data associated with a cardholder received in response. |
BIT63 | Data that is required to process certain types of Authorization Request (1100) messages, such as American Express Travelers Cheque, and verifications for Cardmember Name, Address, ZIP Code, and Telephone Number. |
BIT7 | System date and time when a merchant transmits the transaction information to the processor. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
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. |
MESSAGE_TYPE_IDENTIFIER | Identifier of the type of the message. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
Name | Description |
---|---|
Identifies the merchant to a direct debit switch.
This field must be supplied for all direct debit request transactions except for the Interlink Debit Cancel (Transaction Code 95). This number is provided by the signing member or processor. |
|
ACCOUNT_DATA_SOURCE | Contains code identifying the source of the customer data entered in field:
|
ACQUIRER_BIN | Contains a six-character numeric Visa assigned Bank Identification Number (BIN) issued by the merchant's member bank or processor. The Acquirer BIN identifies the member bank that signed the merchant using the POS application. |
ACQUIRER_BIN | Contains a six-character numeric Visa assigned Bank Identification Number (BIN) issued by the merchant's member bank or processor. The Acquirer BIN identifies the member bank that signed the merchant using the POS application. |
ACQUIRER_BIN_NEW | Contains a six-character numeric Visa assigned Bank Identification Number (BIN) issued by the merchant's member bank or processor. The Acquirer BIN identifies the member bank that signed the merchant using the POS application. |
AGENT_BANK_NUMBER | Contains an agent number assigned by the signing member or processor. The number identifies an institution which signs merchants as an agent of a member. The member uses this number to identify the agent within TSYS Acquiring Solutions’ system. |
AGENT_CHAIN_NUMBER | Contains a merchant chain identification number assigned by the signing member or processor. The member uses this number to identify the merchant chain within the TSYS Acquiring Solutions’ system. |
BATCH_NUMBER | Contains a batch sequence number generated by the terminal. The number wraps from 999 to 001. This number is also transmitted as the data capture batch number. Batch numbers should not be repeated within five days. |
CANCEL_DATA1 | The following sub-fields are required when performing an ATM or Debit Non-Confirm Authorization request, or when performing an Authorization Reversal request, a Debit Reversal/Cancel request, or a AFD Completion Advice message. For all other transaction types, this field should be submitted without data.
Approval Code: Contains approval code returned in the original authorization response record. This is the authorization code for the completed AFD transaction, or the transaction to be either partially or completely reversed. For a debit non-confirm purchase or ATM authorization transactions, the approval code will be space filled. Local Transaction Date: Contains value reflecting the local transaction date returned in the original authorization response record for the AFD sale or the transaction to be canceled or reversed. For a debit non-confirm purchase or ATM authorization transactions, this field will contain the local transaction date. Local Transaction Time: Contains the local transaction time of the original authorization request for the AFD sale or the transaction to be either partially or fully reversed. The Local Transaction Time must be submitted in HHMMSS format. For a debit non-confirm purchase or ATM authorization transactions, this field will contain the local transaction time. Retrieval Reference Number: In AFD Completion Advice messages and reversal transactions, this field must contain Retrieval Reference Number returned in the original authorization response. For debit non-confirm purchase or ATM authorization transactions, this field contains two parts. The first four characters are a yddd date (Julian date) format. The last eight characters are a numeric transaction identification number. |
CANCEL_DATA2 | The following sub-fields are required when requesting any of the following Authorization Transaction Codes: A3, A4, B1, B2, B3, B4, C1, C3, C4 and 5C. This field does not contain data for any other transaction types.
System Trace Audit Number: Must contain the System Trace Audit Number returned in the confirmation data field of the debit authorization response record for the transaction to be canceled or reversed. For a debit non-confirm purchase transaction, this number uniquely. Network Identification Code: When returned in a debit authorization response message, this value designates the debit network through which the request was processed. When performing an Authorization Reversal, this field must contain the one-character Network Identification Code returned in the confirmation data field of the authorization response record for the item to be canceled or reversed. For a debit non-confirm or ATM authorization transactions, the network identification code field will be space-filled. |
CARD_ACCEPTOR_DATA | The following sub-fields are required for direct debit transactions. For all other transactions, the following sub-fields should be configured as parameters within the POS system but need not necessarily contain data.
The format of this 40-byte field is: “NNNNNNNNNNNNNNNNNNNNNNNNNLLLLLLLLLLLLLSS” where NNNN... 1-25 A/N Merchant Name LL.....LL 26-38 A/N Merchant City SS 39-40 A/N Merchant State For Direct Marketing merchants and preferred customer/passenger transport transactions, this field should contain a customer service phone number in XXX-XXXXXXX format. |
CARDHOLDER_ID_CODE | Contains a code that specifies the method used to verify the identity the cardholder. The values can be used in conjunction with AVS and Recurring and Installment Requested ACI Indicators.
|
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CITY_CODE | Contains the code used to further identify the merchant location (ZIP Code). |
INDUSTRY_CODE | Used to identify the industry type of the merchant submitting the authorization request.
|
MARKET_SPECIFIC_DATA | The following sub-fields contain market specific data for hotel and auto rental transactions. The market specific data sub-fields need not be supplied for incremental authorization or authorization reversal transactions.
The format of this field is: “PIDD.”
|
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. |
MERCHANT_CATEGORY_CODE | Contains a number assigned by the signing member or processor to identify a merchant industry classification.
This value is similar to the Standard Industry Code (SIC). |
MERCHANT_NUMBER | Contains a unique number, assigned by the signing merchant’s bank or processor. Used to identify the merchant within the TSYS Acquiring Solutions system. |
MERCHANT_NUMBER | Contains a unique number, assigned by the signing merchant’s bank or processor. Used to identify the merchant within the TSYS Acquiring Solutions system. |
MERCHANT_SETTLEMENT_AGENT_NUMBER | Identifies the merchant settling agent. Provided by the signing member or processor. |
RECORD_FORMAT | Identifies the message format with the TSYS Acquiring Solutions system.
|
RECORD_FORMAT | Identifies the message format with the TSYS Acquiring Solutions system.
|
RECORD_FORMAT | Identifies the message format with the TSYS Acquiring Solutions system.
|
RECORD_FORMAT | Identifies the message format with the TSYS Acquiring Solutions system.
|
RECORD_FORMAT | Identifies the message format with the TSYS Acquiring Solutions system.
|
REQUESTED_ACI | Contains the Requested Authorization Characteristics Indicator (ACI) used to identify an authorization request as potentially qualifying for CPS (Custom Payment Services) and MasterCard Merit programs. If a merchant chooses not to participate in CPS, the Requested ACI value should default to an “N.”
Y - Device is CPS capable R - Recurring Payment. No AVS required N - Device is not CPS capable |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
REVERSAL_TRANSACTION_ID | When performing either an Incremental Authorization or Authorization Reversal request, this field must contain the Transaction Identifier returned in the original authorization response record. For all other transaction types, this field should be submitted without data. |
SECONDARY_AMOUNT | Secondary amount associated with the transaction representing a cashback amount.
This is a variable length field from zero to 12-character numeric in length. This field contains a secondary transaction amount related to the transaction type and industry indicated. The transaction amount is to be presented with an implied decimal point. For example, $.01 could be represented as 1, 01, or 001. The allowable number of significant digits, as well as the positioning of any implied decimal point, are dictated by the Currency Code designated. In the United States, the allowable number of significant characters is seven with an implied decimal point. In industries where cash back is permitted on purchase transactions, this field could contain a cash back amount. For Authorization Reversal transactions, this field must contain the final settlement amount for a partial reversal, and is not used for a full reversal. |
SHARING_GROUPS | Contains a listing of direct debit and EBT networks that a POS device can access. Provided by the signing member or processor. The values must correspond to one of the Visa assigned direct debit network types. This data is part of the TSYS Acquiring Solutions direct debit data. |
STORE_NUMBER | Contains a number assigned by the signing member, processor, or merchant to identify a specific merchant store within the TSYS Acquiring Solutions’ system. |
TERMINAL_NUMBER | Contains a number assigned by the signing member, processor, or merchant to identify a unique terminal within a merchant location.
Because the terminal number submitted in the authorization request is echoed back to the terminal in the authorization response, this field can additionally be used in controller-based environments to assist in the matching and routing of authorization request and response messages at the point of concentration. |
TIME_ZONE_DIFFERENTIAL | Contains a code used to calculate the local time within the TSYS Acquiring Solutions authorization system.
The differential is calculated by the signing member or processor, providing the standard local time zone differential from Greenwich Mean Time (GMT). The first character numeric specifies the direction of the differential and offset increment as well as whether daylight savings is observed, and the last two-character numeric specify the magnitude of the differential. For now, such values is used - 705, 706, 707, 708 |
TRANSACTION_AMOUNT | Contains the transaction amount to be authorized. The transaction amount is to be presented with implied decimal point.
For all Authorization Reversal transactions, this field contains the Total Authorization Amount (the total of all previous authorizations performed for a particular transaction or associated with a single Transaction ID). |
TRANSACTION_CODE | Contains a code identifying the type of authorization or function being requested.
In conditions where an authorization request has been submitted to the host but no response was ever received, the transaction code should be converted to its corresponding “Repeat” value and resubmitted for authorization.
|
TRANSACTION_SEQUENCE_NUMBER | Contains a terminal-generated transaction sequence number to be submitted in all authorization request messages.
This number is echoed back to the terminal for purposes of assisting in the matching of authorization request and response messages. This value must be in the range of 0001 - 9999 and is incremented on each authorization request message. This number is automatically incremented from 9999 to 0001. |
Name | Description |
---|---|
Identifies the merchant to a direct debit switch.
This field must be supplied for all direct debit request transactions except for the Interlink Debit Cancel (Transaction Code 95). This number is provided by the signing member or processor. |
|
ACCOUNT_DATA_SOURCE | Contains code identifying the source of the customer data entered in field:
|
ACQUIRER_BIN | Contains a six-character numeric Visa assigned Bank Identification Number (BIN) issued by the merchant's member bank or processor. The Acquirer BIN identifies the member bank that signed the merchant using the POS application. |
ACQUIRER_BIN | Contains a six-character numeric Visa assigned Bank Identification Number (BIN) issued by the merchant's member bank or processor. The Acquirer BIN identifies the member bank that signed the merchant using the POS application. |
ACQUIRER_BIN_NEW | Contains a six-character numeric Visa assigned Bank Identification Number (BIN) issued by the merchant's member bank or processor. The Acquirer BIN identifies the member bank that signed the merchant using the POS application. |
AGENT_BANK_NUMBER | Contains an agent number assigned by the signing member or processor. The number identifies an institution which signs merchants as an agent of a member. The member uses this number to identify the agent within TSYS Acquiring Solutions’ system. |
AGENT_CHAIN_NUMBER | Contains a merchant chain identification number assigned by the signing member or processor. The member uses this number to identify the merchant chain within the TSYS Acquiring Solutions’ system. |
APPROVAL_CODE | Contains fixed approval code returned in the original authorization response record.
This is the authorization code for the completed AFD transaction, or the transaction to be either partially or completely reversed. For a debit non-confirm purchase or ATM authorization transactions, the approval code will be space filled. |
AUTHORIZATION_RESPONSE_TEXT | Contains a response or display text message. This message can be used by the terminal to display the authorization result. The display text must not be used to determine the nature of a response message. |
AUTHORIZATION_SOURCE_CODE | Contains code indicating the source of the authorization code. The received code must be stored and resubmitted in the data capture settlement record. |
AVS_RESULT_CODE | Contains the Address Verification Result Code. An Address Verification Result Code can provide additional information concerning the authentication of a particular transaction for which cardholder Address Verification was requested. An Address Verification result code of “0” is returned in the response message when no address verification has been requested. The value returned should be stored and submitted as part of the data capture settlement record. |
BATCH_NUMBER | Contains a batch sequence number generated by the terminal. The number wraps from 999 to 001. This number is also transmitted as the data capture batch number. Batch numbers should not be repeated within five days. |
CANCEL_DATA1 | The following sub-fields are required when performing an ATM or Debit Non-Confirm Authorization request, or when performing an Authorization Reversal request, a Debit Reversal/Cancel request, or a AFD Completion Advice message. For all other transaction types, this field should be submitted without data.
Approval Code: Contains approval code returned in the original authorization response record. This is the authorization code for the completed AFD transaction, or the transaction to be either partially or completely reversed. For a debit non-confirm purchase or ATM authorization transactions, the approval code will be space filled. Local Transaction Date: Contains value reflecting the local transaction date returned in the original authorization response record for the AFD sale or the transaction to be canceled or reversed. For a debit non-confirm purchase or ATM authorization transactions, this field will contain the local transaction date. Local Transaction Time: Contains the local transaction time of the original authorization request for the AFD sale or the transaction to be either partially or fully reversed. The Local Transaction Time must be submitted in HHMMSS format. For a debit non-confirm purchase or ATM authorization transactions, this field will contain the local transaction time. Retrieval Reference Number: In AFD Completion Advice messages and reversal transactions, this field must contain Retrieval Reference Number returned in the original authorization response. For debit non-confirm purchase or ATM authorization transactions, this field contains two parts. The first four characters are a yddd date (Julian date) format. The last eight characters are a numeric transaction identification number. |
CANCEL_DATA2 | The following sub-fields are required when requesting any of the following Authorization Transaction Codes: A3, A4, B1, B2, B3, B4, C1, C3, C4 and 5C. This field does not contain data for any other transaction types.
System Trace Audit Number: Must contain the System Trace Audit Number returned in the confirmation data field of the debit authorization response record for the transaction to be canceled or reversed. For a debit non-confirm purchase transaction, this number uniquely. Network Identification Code: When returned in a debit authorization response message, this value designates the debit network through which the request was processed. When performing an Authorization Reversal, this field must contain the one-character Network Identification Code returned in the confirmation data field of the authorization response record for the item to be canceled or reversed. For a debit non-confirm or ATM authorization transactions, the network identification code field will be space-filled. |
CARD_ACCEPTOR_DATA | The following sub-fields are required for direct debit transactions. For all other transactions, the following sub-fields should be configured as parameters within the POS system but need not necessarily contain data.
The format of this 40-byte field is: “NNNNNNNNNNNNNNNNNNNNNNNNNLLLLLLLLLLLLLSS” where NNNN... 1-25 A/N Merchant Name LL.....LL 26-38 A/N Merchant City SS 39-40 A/N Merchant State For Direct Marketing merchants and preferred customer/passenger transport transactions, this field should contain a customer service phone number in XXX-XXXXXXX format. |
CARD_LEVEL_RESULTS | Contains code created by Visa during the authorization process.
Conditional in the response record. It will only be returned if the values are non-zero. |
CARDHOLDER_ID_CODE | Contains a code that specifies the method used to verify the identity the cardholder. The values can be used in conjunction with AVS and Recurring and Installment Requested ACI Indicators.
|
CAVV_RESULTS_CODE | Indicates whether the authentication value submitted by the merchant can be validated by Visa or the issuer. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CITY_CODE | Contains the code used to further identify the merchant location (ZIP Code). |
COMMERCIAL_CARD_RESPONSE_INDICATOR | If the Commercial Card Request Indicator (this field is utilized to request that TSYS Acquiring Solutions systems return a value in the authorization response message identifying whether the card type being presented was a Commercial Card. This field is currently defaulted to 010, and is supported for Visa and MasterCard transactions only) was supplied in the authorization request, the host responds with one of the following response indicators identifying the card being processed.
When a response indicator has been received indicating that the approved card is a Business, Corporate, or Purchasing Card, the POS device should prompt for addendum data elements as needed for settlement. |
FIRST_ACCOUNT_TYPE1 | Contains identifiers for account types. |
FIRST_ACCOUNT_TYPE2 | Contains identifiers for account types. |
FIRST_AMOUNT | Contains any additional amounts related to the authorization request or response. |
FIRST_CURRENCY_CODE | Contains currency code identifying the currency for the returned additional amount. |
FIRST_SIGN | Indicates whether the amount is a debit or credit. |
FOURTH_ACCOUNT_TYPE1 | Contains identifiers for account types. |
FOURTH_ACCOUNT_TYPE2 | Contains identifiers for account types. |
FOURTH_AMOUNT | Contains any additional amounts related to the authorization request or response. |
FOURTH_CURRENCY_CODE | Contains currency code identifying the currency for the returned additional amount. |
FOURTH_SIGN | Indicates whether the amount is a debit or credit. |
HOST_MESSAGE_IDENTIFIER | Contains a unique host message identifier assigned by the authorizing system and returned in debit card response messages. Reserved for future use and will most likely contain spaces. This value must be recorded and submitted in the debit confirmation record. |
INDUSTRY_CODE | Used to identify the industry type of the merchant submitting the authorization request.
|
LOCAL_TRANSACTION_DATE | Contains value reflecting the local transaction date (in MMDDYY format) returned in the original authorization response record for the AFD sale or the transaction to be canceled or reversed. For a debit non-confirm purchase or ATM authorization transactions, this field will contain the local transaction date. |
LOCAL_TRANSACTION_TIME | Contains the local transaction time of the original authorization request for the AFD sale or the transaction to be either partially or fully reversed. The local transaction time must be submitted in HHMMSS format. For a debit non-confirm purchase or ATM authorization transactions, this field will contain the local transaction time. |
MARKET_DATA_IDENTIFIER | Used to indicate which industry data is being submitted.
When this sub-field is supplied in an incremental transaction, it should use the same value that was requested in the original authorization transaction. |
MARKET_SPECIFIC_DATA | The following sub-fields contain market specific data for hotel and auto rental transactions. The market specific data sub-fields need not be supplied for incremental authorization or authorization reversal transactions.
The format of this field is: “PIDD.”
|
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. |
MERCHANT_CATEGORY_CODE | Contains a number assigned by the signing member or processor to identify a merchant industry classification.
This value is similar to the Standard Industry Code (SIC). |
MERCHANT_NUMBER | Contains a unique number, assigned by the signing merchant’s bank or processor. Used to identify the merchant within the TSYS Acquiring Solutions system. |
MERCHANT_NUMBER | Contains a unique number, assigned by the signing merchant’s bank or processor. Used to identify the merchant within the TSYS Acquiring Solutions system. |
MERCHANT_SETTLEMENT_AGENT_NUMBER | Identifies the merchant settling agent. Provided by the signing member or processor. |
NETWORK_ID_CODE | Contains a code that specifies the network to be used for transmission of the message and determines the program rules that apply to the transaction. |
RECORD_FORMAT | Identifies the message format with the TSYS Acquiring Solutions system.
|
RECORD_FORMAT | Identifies the message format with the TSYS Acquiring Solutions system.
|
RECORD_FORMAT | Identifies the message format with the TSYS Acquiring Solutions system.
|
RECORD_FORMAT | Identifies the message format with the TSYS Acquiring Solutions system.
|
RECORD_FORMAT | Identifies the message format with the TSYS Acquiring Solutions system.
|
REQUESTED_ACI | Contains the Requested Authorization Characteristics Indicator (ACI) used to identify an authorization request as potentially qualifying for CPS (Custom Payment Services) and MasterCard Merit programs. If a merchant chooses not to participate in CPS, the Requested ACI value should default to an “N.”
Y - Device is CPS capable R - Recurring Payment. No AVS required N - Device is not CPS capable |
RESPONSE_CODE | Contains code identifying the type of authorization or function being requested.
In conditions where an authorization request has been submitted to the host but no response was ever received, the transaction code should be converted to its corresponding “Repeat” value and resubmitted for authorization. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETRIEVAL_REFERENCE_NUMBER | Contains value reflecting the transaction Retrieval Reference Number returned by the authorizing system.
The POS system should record the retrieval reference number received in the original authorization response. The Retrieval Reference Number from the original response is required when submitting AFD Completion Advice messages and when submitting incremental authorizations, or authorization reversal requests that must be settled for direct debit transactions. |
RETURNED_ACI | Contains the Returned Authorization Characteristics Indicator (ACI).
Provides information concerning the transactions’ CPS qualification status. It is not recommended that the POS system attempt to interpret the meaning of this value. Instead, the POS system should extract whatever value is returned in this field and submit it in the data capture settlement record. The POS system should not interpret any relationship between this field and the presence of data in either the Transaction Identifier or Validation Code fields. |
REVERSAL_TRANSACTION_ID | When performing either an Incremental Authorization or Authorization Reversal request, this field must contain the Transaction Identifier returned in the original authorization response record. For all other transaction types, this field should be submitted without data. |
SECOND_ACCOUNT_TYPE1 | Contains identifiers for account types. |
SECOND_ACCOUNT_TYPE2 | Contains identifiers for account types. |
SECOND_AMOUNT | Contains any additional amounts related to the authorization request or response. |
SECOND_CURRENCY_CODE | Contains currency code identifying the currency for the returned additional amount. |
SECOND_SIGN | Indicates whether the amount is a debit or credit. |
SETTLEMENT_DATE | Contains the transaction settlement date returned by the TSYS Acquiring Solutions authorization system and is submitted in MMDD format. |
SHARING_GROUPS | Contains a listing of direct debit and EBT networks that a POS device can access. Provided by the signing member or processor. The values must correspond to one of the Visa assigned direct debit network types. This data is part of the TSYS Acquiring Solutions direct debit data. |
SPEND_QUALIFIED_INDICATOR | Optionally sent by Visa in an autorization response message. The merchant's intercharge rate may be determined by spend qualified indicator. See the specification of the processor for more information. |
STORE_NUMBER | Contains a number assigned by the signing member, processor, or merchant to identify a specific merchant store within the TSYS Acquiring Solutions’ system. |
SYSTEM_TRACE_AUDIT_NUMBER | Must contain System Trace Audit Number returned in the confirmation data field of the debit authorization response record for the transaction to be canceled or reversed. For a debit non-confirm purchase transaction, this number uniquely identifies a cardholder transaction. The trace number remains unchanged for all messages throughout the life cycle of the transaction. |
TERMINAL_NUMBER | Contains a number assigned by the signing member, processor, or merchant to identify a unique terminal within a merchant location.
Because the terminal number submitted in the authorization request is echoed back to the terminal in the authorization response, this field can additionally be used in controller-based environments to assist in the matching and routing of authorization request and response messages at the point of concentration. |
THIRD_ACCOUNT_TYPE1 | Contains identifiers for account types. |
THIRD_ACCOUNT_TYPE2 | Contains identifiers for account types. |
THIRD_AMOUNT | Contains any additional amounts related to the authorization request or response. |
THIRD_CURRENCY_CODE | Contains currency code identifying the currency for the returned additional amount. |
THIRD_SIGN | Indicates whether the amount is a debit or credit. |
TIME_ZONE_DIFFERENTIAL | Contains a code used to calculate the local time within the TSYS Acquiring Solutions authorization system.
The differential is calculated by the signing member or processor, providing the standard local time zone differential from Greenwich Mean Time (GMT). The first character numeric specifies the direction of the differential and offset increment as well as whether daylight savings is observed, and the last two-character numeric specify the magnitude of the differential. For now, such values is used - 705, 706, 707, 708 |
TRANSACTION_AMOUNT | Contains the transaction amount to be authorized. The transaction amount is to be presented with implied decimal point.
For all Authorization Reversal transactions, this field contains the Total Authorization Amount (the total of all previous authorizations performed for a particular transaction or associated with a single Transaction ID). |
TRANSACTION_CODE | Contains a code identifying the type of authorization or function being requested.
In conditions where an authorization request has been submitted to the host but no response was ever received, the transaction code should be converted to its corresponding “Repeat” value and resubmitted for authorization.
|
TRANSACTION_IDENTIFIER | Contains a transaction identifier (Visa, American Express or Discover) or Reference Number (MasterCard). The POS device does not attempt to interpret the meaning of any data appearing in this field. Data returned in this field is recorded and submitted as part of the data capture settlement format. |
TRANSACTION_SEQUENCE_NUMBER | Contains a terminal-generated transaction sequence number to be submitted in all authorization request messages.
This number is echoed back to the terminal for purposes of assisting in the matching of authorization request and response messages. This value must be in the range of 0001 - 9999 and is incremented on each authorization request message. This number is automatically incremented from 9999 to 0001. |
VALIDATION_CODE | Discover Usage:
Used to indicate the magnetic stripe condition and the vulnerability for fraud in Discover Network Card Transactions. Non-Discover Usage: Can contain specific information generated by the card issuer. The POS device should not attempt to interpret the meaning of any data appearing in this field. Data returned in this field is recorded and submitted as part of the data capture settlement format. |
VERIFICATION_RESULT_CODE | Contains the host returned CVV2/CVC2/CID result code. |
Name | Description |
---|---|
ACTION | Type of Alias action requested
Valid values are as follows: DELETE, ADD, CREATE. |
ALIAS | Alternate identifier used to reference a stored value account. |
ALLOW_PARTIAL_AUTH | Indicates whether partial authorization is supported. Default is 'N'.
Valid values = 'Y' or 'N'. |
AMT | Contains total amount of additional amounts. |
BALANCE_INQUIRY_TYPE | Balance Inquiry Type:
CASH = Cash Benefits FOODSTAMP = Food Stamp |
CARD_HOLDER_ADDR | Cardholder address that can be used for address verification. |
CARD_HOLDER_ADDR | Cardholder address that can be used for address verification. |
CARD_HOLDER_ADDR | Cardholder address that can be used for address verification. |
CARD_HOLDER_CITY | Cardholder city.
Maximum length = 20. |
CARD_HOLDER_EMAIL | Cardholder email address.
Maximum length = 40. |
CARD_HOLDER_EMAIL | Cardholder email address.
Maximum length = 40. |
CARD_HOLDER_EMAIL | Cardholder email address.
Maximum length = 40. |
CARD_HOLDER_FIRST_NAME | Cardholder first name.
Maximum length = 26. |
CARD_HOLDER_LAST_NAME | Cardholder last name.
Maximum length = 26. |
CARD_HOLDER_PHONE | Cardholder phone number.
Maximum length = 10. |
CARD_HOLDER_PHONE | Cardholder phone number.
Maximum length = 10. |
CARD_HOLDER_PHONE | Cardholder phone number.
Maximum length = 10. |
CARD_HOLDER_PO_NBR | Purchase order number assigned by the cardholder.
Maximum length = 17. |
CARD_HOLDER_STATE | Cardholder state.
Maximum length = 20. |
CARD_HOLDER_ZIP | Cardholder zip code that can be used for address verification.
Maximum length = 9. |
CARD_PRESENT | Indicates whether a card reader was present when card data was manually entered.
Valid values = Y or N. |
CASH_BACK_AMT_INFO | Cash back amount information, the portion of the settlement amount that represents cash back given to the cardholder.
|
CPC_REQ | Commercial card request.
Valid values = Y or N. |
CURRENCY | Identifies the currency of the transaction amount. |
CVV2_STATUS | Indicates why the CVV2 value was not provided. Valid values include: ILLEGIBLE and NOTPRESENT.
Note:This field is NOT used for EBT transactions. |
DEVELOPER_ID | Developer Identifier, field length is exactly 6 characters.
NOTE: Even though this field is optional in the schema, it is now required for all new certifications. |
DEVICE_ID | Device identifier, assigned by Heartland Payment Systems during registration. |
DIRECT_MKT_INVOICE_NBR | Invoice number for direct marketing.
Maximum length = 25. |
DIRECT_MKT_SHIP_DAY | Ship day for direct marketing. |
DIRECT_MKT_SHIP_MONTH | Ship month for direct marketing.
|
ECOMMERCE | Identifies this transaction as eCommerce or mail order/telephone order.
Valid values = ECOM or MOTO |
ELECTRONIC_VOUCHER_SERIAL_NBR | Serial Number provides by EBT voice authorization System. |
FIRST_ADDITIONAL_AMT | First Amount object.
The first amount must have an AmtType of "4S." |
FIRST_ADDITIONAL_AMT_TYPE | The first amount type is '4S'. |
FOURTH_ADDITIONAL_AMT | Fourth Amount object. |
FOURTH_ADDITIONAL_AMT_TYPE | Type of forth amount object: date and time. |
GRATUITY_AMT_INFO | If present, revises (replaces) the gratuity amount information of the original auth. If not present, does not affect the gratuity amount information, if any, of the original auth. This element is for informational purposes only and does not affect the authorized amount. |
INVOICE_NBR | Invoice number for direct marketing.
Maximum length = 25 |
LICENSE_ID | License identifier, assigned by Heartland Payment Systems Administrator during registration. |
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. |
OFFLINE_AUTH_CODE | Authorization code obtained from the Issuer outside of the POS Gateway.
Maximum characters = 8 |
ONE_TIME_PAYMENT | Indicates whether this is a one time payment (Y) or a recurring payment.
Valid values = Y or N. |
READER_PRESENT | Indicates whether a card reader was present when card data was manually entered.
Valid values = Y or N. |
REQUEST_TYPE | Contains an identifier to aid in determining the type of client's request. |
SECOND_ADDITIONAL_AMT | Second Amount object. |
SECOND_ADDITIONAL_AMT_TYPE | Type of second ammount. |
SITE_ID | Site identifier, assigned by Heartland Payment Systems during registration. |
SITE_TRACE | Site trace, specified by client and echoed in the response for validation. |
TAX_AMT | Tax amount. |
TAX_TYPE | Tax type indicator that qualifies the CPC tax amount. |
THIRD_ADDITIONAL_AMT | Third Amount object. |
THIRD_ADDITIONAL_AMT_TYPE | Type of third amount. |
USER_NAME | User name, assigned by Heartland Payment Systems Administrator during registration. |
VERSION_NBR | POS Version Number.
NOTE: Even though this field is optional in the schema, it is now required for all new certifications. |
VOUCHER_APPROVAL_CD | Provided by EBT Voice Authorization System. |
Name | Description |
---|---|
ACTION | Type of Alias action requested
Valid values are as follows: DELETE, ADD, CREATE. |
ALIAS | Alternate identifier used to reference a stored value account. |
ALLOW_PARTIAL_AUTH | Indicates whether partial authorization is supported. Default is 'N'.
Valid values = 'Y' or 'N'. |
AMT | Contains total amount of additional amounts. |
BALANCE_AMOUNT | If authorized, the new balance on the gift card. |
BALANCE_INQUIRY_TYPE | Balance Inquiry Type:
CASH = Cash Benefits FOODSTAMP = Food Stamp |
CARD_HOLDER_ADDR | Cardholder address that can be used for address verification. |
CARD_HOLDER_ADDR | Cardholder address that can be used for address verification. |
CARD_HOLDER_ADDR | Cardholder address that can be used for address verification. |
CARD_HOLDER_CITY | Cardholder city.
Maximum length = 20. |
CARD_HOLDER_EMAIL | Cardholder email address.
Maximum length = 40. |
CARD_HOLDER_EMAIL | Cardholder email address.
Maximum length = 40. |
CARD_HOLDER_EMAIL | Cardholder email address.
Maximum length = 40. |
CARD_HOLDER_FIRST_NAME | Cardholder first name.
Maximum length = 26. |
CARD_HOLDER_LAST_NAME | Cardholder last name.
Maximum length = 26. |
CARD_HOLDER_PHONE | Cardholder phone number.
Maximum length = 10. |
CARD_HOLDER_PHONE | Cardholder phone number.
Maximum length = 10. |
CARD_HOLDER_PHONE | Cardholder phone number.
Maximum length = 10. |
CARD_HOLDER_PO_NBR | Purchase order number assigned by the cardholder.
Maximum length = 17. |
CARD_HOLDER_STATE | Cardholder state.
Maximum length = 20. |
CARD_HOLDER_ZIP | Cardholder zip code that can be used for address verification.
Maximum length = 9. |
CARD_PRESENT | Indicates whether a card reader was present when card data was manually entered.
Valid values = Y or N. |
CASH_BACK_AMT_INFO | Cash back amount information, the portion of the settlement amount that represents cash back given to the cardholder.
|
CPC_REQ | Commercial card request.
Valid values = Y or N. |
CURRENCY | Identifies the currency of the transaction amount. |
CVV2_STATUS | Indicates why the CVV2 value was not provided. Valid values include: ILLEGIBLE and NOTPRESENT.
Note:This field is NOT used for EBT transactions. |
DEVELOPER_ID | Developer Identifier, field length is exactly 6 characters.
NOTE: Even though this field is optional in the schema, it is now required for all new certifications. |
DEVICE_ID | Device identifier, assigned by Heartland Payment Systems during registration. |
DIRECT_MKT_INVOICE_NBR | Invoice number for direct marketing.
Maximum length = 25. |
DIRECT_MKT_SHIP_DAY | Ship day for direct marketing. |
DIRECT_MKT_SHIP_MONTH | Ship month for direct marketing.
|
ECOMMERCE | Identifies this transaction as eCommerce or mail order/telephone order.
Valid values = ECOM or MOTO |
ELECTRONIC_VOUCHER_SERIAL_NBR | Serial Number provides by EBT voice authorization System. |
FIRST_ADDITIONAL_AMT | First Amount object.
The first amount must have an AmtType of "4S." |
FIRST_ADDITIONAL_AMT_TYPE | The first amount type is '4S'. |
FOURTH_ADDITIONAL_AMT | Fourth Amount object. |
FOURTH_ADDITIONAL_AMT_TYPE | Type of forth amount object: date and time. |
GRATUITY_AMT_INFO | If present, revises (replaces) the gratuity amount information of the original auth. If not present, does not affect the gratuity amount information, if any, of the original auth. This element is for informational purposes only and does not affect the authorized amount. |
INVOICE_NBR | Invoice number for direct marketing.
Maximum length = 25 |
LICENSE_ID | License identifier, assigned by Heartland Payment Systems Administrator during registration. |
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. |
NOTES | Contains rewards messages to be displayed on a receipt, mobile app, or web page to inform an account holder about special rewards or promotions available on the account. |
OFFLINE_AUTH_CODE | Authorization code obtained from the Issuer outside of the POS Gateway.
Maximum characters = 8 |
ONE_TIME_PAYMENT | Indicates whether this is a one time payment (Y) or a recurring payment.
Valid values = Y or N. |
POINTS_BALANCE_AMT | If authorized, the new balance on the stored value account in points. |
READER_PRESENT | Indicates whether a card reader was present when card data was manually entered.
Valid values = Y or N. |
REFUND_AMOUNT | If authorized, the new balance that was on the card before it was deactivated and should be refunded to the cardholder. |
REQUEST_TYPE | Contains an identifier to aid in determining the type of client's request. |
REWARDS | Identifies rewards (dollars or points) added to the account as a result of a transaction. |
SECOND_ADDITIONAL_AMT | Second Amount object. |
SECOND_ADDITIONAL_AMT_TYPE | Type of second ammount. |
SITE_ID | Site identifier, assigned by Heartland Payment Systems during registration. |
SITE_TRACE | Site trace, specified by client and echoed in the response for validation. |
SPLIT_TENDER_CARD_AMT | If insufficient funds on gift card to complete sale, the split tender portion of the total sale that was subtracted from the gift card balance. |
TAX_AMT | Tax amount. |
TAX_TYPE | Tax type indicator that qualifies the CPC tax amount. |
THIRD_ADDITIONAL_AMT | Third Amount object. |
THIRD_ADDITIONAL_AMT_TYPE | Type of third amount. |
USER_NAME | User name, assigned by Heartland Payment Systems Administrator during registration. |
VERSION_NBR | POS Version Number.
NOTE: Even though this field is optional in the schema, it is now required for all new certifications. |
VOUCHER_APPROVAL_CD | Provided by EBT Voice Authorization System. |
Name | Description |
---|---|
ADDRESS | |
AMOUNT_CASHBACK | Amount of change after the purchase, issued in cash. |
AMOUNT_PRESCRIPTION | |
AMOUNT_PURCHASE | Amount of purchased goods
|
AVS_DATA | This is referred to as Address Verification Service (AVS).
Though not impacting the actual authorization approval, a better processing rate is achieved for some (retail, QSR,) merchants if address information is supplied when the card is not swiped. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CUSTOMER_CODE | The actual PO number, the merchant’s zip code, or the transaction invoice number, will sufficient to meet the Level II reporting requirements.
|
INVOICE_NO | The locally generated always incrementing individual transaction number.
|
MEMO | Required field in all ActiveX and WebServices integrations
|
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. |
MERCHANT_ID | Merchant identifier, assigned by processor.
The typical format for a Mercury Merchant ID combines an 11 digit numeric value, separated with an ‘=’ and a 6 digit alpha value as in: 884300XXXXX=ABCDEF.. Is returned without the "Nick Name" in the response. |
NAME | Name of the provider account.
Generated automatically by default. Comprised of a merchant account code followed by the type of provider profile for which it is defined. |
OPERATOR_ID | Identifier of the operator carrying the transaction.
|
PARTIAL_AUTH | Use of the data element will “allow” a partial approval if the balance on the card is less than the purchase amount requested.
The transaction will approve for the authorized balance amount available on the card and will not decline the transaction. |
REF_NO | A transaction reference value returned in the transaction response and indicates that an approved transaction has been “referenced” and is added to the current batch file.
This field is used as a “filler value” on the initial request until an actual host value is returned indicating the transaction is now in the batch file; a true RefNo is returned on the response and logged at the host for all completed transactions. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETURN_CODE | Identifies the any error type.
Value will be zero if transaction processed normally. See Return Codes for possible values. |
STATUS | Indicates the outcome of the command:
"Success" = Command completed successfully "Error" = Error processing command by processor |
TAX | Commission fee for card payment
The purchase amount tag will be the total charge, including tax. The tax field breaks out the tax amount for Level II reporting purposes only. |
TERMINAL_ID | TerminalID is never used on MercuryPay; always use TerminalName if requiring a terminal identifier
|
TRAN_CODE | The actual transactions run (as in Sale, Return, Balance, etc.) under these specific tenders.
|
TRAN_TYPE | Transaction Types include Credit, Debit, EBT, FSA, Gift/Prepaid, Loyalty, Admin, Canadian Debit /EMV and CheckAuth.
|
VOUCHER_NUMBER | |
ZIP | ZIP Code. |
Name | Description |
---|---|
ACQ_REF_DATA | This is a transaction routing and market data (allow up to 200 Alpha-numeric characters in length) and is required to be submitted with all PreAuthCapture request, with ReverseFSASale and used in conjunction with a VoidSale for Reversals.
When submitted it is always included in the <TranInfo> data node. |
ADDRESS | |
AMOUNT_AUTHORIZE | Sum of authorization. |
AMOUNT_BALANCE | Amount available on the card balance. |
AMOUNT_CASHBACK | Amount of change after the purchase, issued in cash. |
AMOUNT_GRATUITY | Amount of tips. |
AMOUNT_PRESCRIPTION | |
AMOUNT_PURCHASE | Amount of purchased goods
|
AUTH_CODE | Authorization Code returned by the processor. |
AVS_DATA | This is referred to as Address Verification Service (AVS).
Though not impacting the actual authorization approval, a better processing rate is achieved for some (retail, QSR,) merchants if address information is supplied when the card is not swiped. |
AVS_RESPONSE | The Response Code to the Address Verification Service. |
CAPTURE_STATUS | Will inform the POS if the transaction was "Captured" or "NotCaptured."
|
CARD_TYPE | Reflect the card type entered submitted ("VISA" "M/C" "AMEX" "DCLB" "DCVR" "JCB" "DEBIT" "FSA" "FSADebit" "OTHER")
|
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CMD_STATUS | Status, received if there are transactions with the same amount and on the same card.
Indicates the outcome of the command: “Approved” = transaction approved by payment processor; “Declined” = transaction declined by payment processor; “Success” =command completed successfully; “Error” =error processing command. |
CUSTOMER_CODE | The actual PO number, the merchant’s zip code, or the transaction invoice number, will sufficient to meet the Level II reporting requirements.
|
CVV_RESULT | A code that reflects the outcome of the CVV2/CVC2 check.
|
DSIX_RETURN_CODE | Server specific or DSIClientX specific TCP/IP six digit codes corresponding to a single or dynamic or variable message text.
|
INVOICE_NO | The locally generated always incrementing individual transaction number.
|
MEMO | Required field in all ActiveX and WebServices integrations
|
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. |
MERCHANT_ID | Merchant identifier, assigned by processor.
The typical format for a Mercury Merchant ID combines an 11 digit numeric value, separated with an ‘=’ and a 6 digit alpha value as in: 884300XXXXX=ABCDEF.. Is returned without the "Nick Name" in the response. |
NAME | Name of the provider account.
Generated automatically by default. Comprised of a merchant account code followed by the type of provider profile for which it is defined. |
OPERATOR_ID | Identifier of the operator carrying the transaction.
|
PARTIAL_AUTH | Use of the data element will “allow” a partial approval if the balance on the card is less than the purchase amount requested.
The transaction will approve for the authorized balance amount available on the card and will not decline the transaction. |
PROCESS_DATA | Transaction routing and market data (allow up to 200 Alpha-numeric characters in length) and is required to be submitted with all PreAuthCapture request, with ReverseFSASale and used in conjunction with a VoidSale for Reversals. When submitted it is always included in the <TranInfo> data node.
|
RECORD_NO | Mercury's proprietary tokenization method. This is the returned token reference.
A RecordNo will be requested with two tags: 1. the Frequency of the token requested ("OneTime" or "Recurring") 2. either a request for token ("RecordNumberRequested") or the actual token returned in the original response. |
REF_NO | A transaction reference value returned in the transaction response and indicates that an approved transaction has been “referenced” and is added to the current batch file.
This field is used as a “filler value” on the initial request until an actual host value is returned indicating the transaction is now in the batch file; a true RefNo is returned on the response and logged at the host for all completed transactions. |
RESPONSE_ORIGIN | |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETURN_CODE | Identifies the any error type.
Value will be zero if transaction processed normally. See Return Codes for possible values. |
STATUS | Indicates the outcome of the command:
"Success" = Command completed successfully "Error" = Error processing command by processor |
TAX | Commission fee for card payment
The purchase amount tag will be the total charge, including tax. The tax field breaks out the tax amount for Level II reporting purposes only. |
TERMINAL_ID | TerminalID is never used on MercuryPay; always use TerminalName if requiring a terminal identifier
|
TEXT_RESPONSE | Optional response message from the processor about the transaction status. |
TRAN_CODE | The actual transactions run (as in Sale, Return, Balance, etc.) under these specific tenders.
|
TRAN_TYPE | Transaction Types include Credit, Debit, EBT, FSA, Gift/Prepaid, Loyalty, Admin, Canadian Debit /EMV and CheckAuth.
|
USER_TRACE_DATA | Сertain information associated with the authorization. |
VOUCHER_NUMBER | |
ZIP | ZIP Code. |
Name | Description |
---|---|
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
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. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
VPC_ACCESS_CODE | 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.
|
VPC_TX_SOURCE | 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. |
VPC_TX_SOURCE_SUB_TYPE | Allows the merchant to flag the subtype of transaction for the cardholder's order. |
VPC3_DS_ENROLLED | The VERes.enrolled field. It will take values:
|
VPC3_DS_STATUS | Included only if payment authentication was used and a PARes was received by the MPI. It will take values:
|
Name | Description |
---|---|
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
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. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
VPC_ACCESS_CODE | 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.
|
VPC_ACQ_C_S_C_RESP_CODE | The response code generated by the Issuing Bank in relation to the Card Security Code. |
VPC_ACQ_RESPONSE_CODE | Acquirer's Response Code is generated by the financial institution to indicate the status of the transaction. |
VPC_AMOUNT | The amount of the transaction in the smallest currency unit expressed as an integer. |
VPC_AUTHORISED_AMOUNT | The total amount of the original authorisation transaction. |
VPC_AUTHORIZE_ID | An identifying code issued by the bank to approve or deny the transaction. |
VPC_BATCH_NO | A date supplied by the acquirer to indicate when this transaction will be settled. |
VPC_CAPTURED_AMOUNT | The amount of the capture transaction in the smallest currency unit expressed as an integer. |
VPC_CARD | A code issued by the Payment Server for the card type used by the cardholder in the transaction. |
VPC_COMMAND | Indicates the transaction type. Must be equal to pay capture, refund, voidCapture, voidRefund, voidPurchase. |
VPC_CSC_RESULT_CODE | 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 |
VPC_MERCH_TXN_REF | 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. |
VPC_MERCHANT | The unique merchant ID assigned by Payment Processor. |
VPC_MESSAGE | Indicates any errors the transaction may have encountered. |
VPC_ORDER_INFO | Your own identifier used to identify the transaction with the cardholder. For example, a shopping cart number, an order number, or an invoice number. |
VPC_RECEIPT_NO | 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. |
VPC_REFUNDED_AMOUNT | The amount of the refund transaction in the smallest currency unit expressed as an integer. |
VPC_SHOP_TRANSACTION_NO | The transaction reference number of the original authorisation or purchase transaction. |
VPC_TICKET_NO | 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. |
VPC_TRANSACTION_NO | 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. |
VPC_TX_SOURCE | 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. |
VPC_TX_SOURCE_SUB_TYPE | Allows the merchant to flag the subtype of transaction for the cardholder's order. |
VPC_TXN_RESPONSE_CODE | A response code that is generated by the Payment Server to indicate the status of the transaction. |
VPC_VER_SECURITY_LEVEL | 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. |
VPC_VER_STATUS | The status codes used by the Payment Server. |
VPC3_DS_ENROLLED | The VERes.enrolled field. It will take values:
|
VPC3_DS_STATUS | Included only if payment authentication was used and a PARes was received by the MPI. It will take values:
|
Name | Description |
---|---|
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
Name | Description |
---|---|
ADDITIONAL_AMOUNT_ACCOUNT_TYPE | |
ADDITIONAL_AMOUNT_AMOUNT | |
ADDITIONAL_AMOUNT_AMOUNT_SIGN | |
ADDITIONAL_AMOUNT_AMOUNT_TYPE | |
ADDITIONAL_AMOUNT_CURRENCY_CODE | |
CARD_TYPE | Type of the credit card used for the transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
EXT_RSP_CODE | |
FAULT_ERROR_CODE | |
FAULT_ERROR_MESSAGE | |
MAP_CAID | |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
TRAN_DATA_AMT | |
TRAN_DATA_AUTH | |
TRAN_DATA_STAN |
Name | Description |
---|---|
BIT11 | This number is echoed in response messages to assist in matching to requests. It is not expected that the same STAN (System Trace Audit Number) be used in any subsequent reversal advice.
|
BIT12 | The local transaction time. Formatted as HHMMSS where HH is 2-digit hour, MM - 2-digit minutes, and SS - 2-digit seconds.
|
BIT13 | The local transaction date.
Formatted as YYMMDD, where YY is 2-digit year, MM - 2-digit month, and DD - 2-digit day. |
BIT18 | Identifies the merchant's Standart Industrial Classification (SIC) code and associated market type.
|
BIT22 | Defines the conditions under which the card account number/PAN is entered and the terminal PIN capabilities. Field is mandatory for all entry modes.
|
BIT3 | Describes the type of transaction and the accounts it affects.
|
BIT38 | The authorization reference returned by the card issuer (or in case of delegated authorization, by the acquirer).
|
BIT4_APPROVED_AMOUNT | The full requested approved amount for authorization/capture.
|
BIT42 | Indicates which merchant originated the transaction.
Assigned by WorldPay. |
BIT54 | This field is included only for purchases with cash back account balances and reversals.
|
BIT59 | Free form. This information is returned in all approval responces.
|
BIT60_REASON_CODE | Identify the reason for a reversal or an advice.
|
BIT62_DEBIT_EBT_NETWORK_RESPONSE_DATA | This field only be returned for Debit and EBT transactions that are approved or denied by the network.
|
BIT7 | Represents the time and date that the transaction is transmitted from the payment switch, gateway, or POS device.
|
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction.
|
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction.
|
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction.
|
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. |
MESSAGE_TYPE | The 4 digit numeric field classifying the high level function of the message.
|
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together.
|
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together.
|
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together.
|
Name | Description |
---|---|
The Summary Data Identifiers pertain to Purchase card, PINIess debit, and petroleum transactions.
|
|
BIT11 | This number is echoed in response messages to assist in matching to requests. It is not expected that the same STAN (System Trace Audit Number) be used in any subsequent reversal advice.
|
BIT12 | The local transaction time. Formatted as HHMMSS where HH is 2-digit hour, MM - 2-digit minutes, and SS - 2-digit seconds.
|
BIT122 | This field carries the Line Item details required for Petroleum, Level III Purchase/Commercial card qualification and used in conjunction with the Summary Data.
|
BIT13 | The local transaction date.
Formatted as YYMMDD, where YY is 2-digit year, MM - 2-digit month, and DD - 2-digit day. |
BIT15_SETTLEMENT_DATE | Required for all 0500 requests and returned in financial responces.
MMDD. |
BIT18 | Identifies the merchant's Standart Industrial Classification (SIC) code and associated market type.
|
BIT22 | Defines the conditions under which the card account number/PAN is entered and the terminal PIN capabilities. Field is mandatory for all entry modes.
|
BIT3 | Describes the type of transaction and the accounts it affects.
|
BIT37 | A unique transaction reference created at the POS device.
|
BIT38 | The authorization reference returned by the card issuer (or in case of delegated authorization, by the acquirer).
|
BIT38_AUTHORIZATION_IDENTIFICATION_RESPONSE | Authorization reference returned by the card issuer (or in case of delegated authorization, by the acquirer).
|
BIT39_WORLD_PAY_RESPONSE_DATA | Defines the disposition of a previous message or an action taken as a result of receipt of a previous message.
|
BIT4 | The full requested amount for authorization/capture.
|
BIT4_APPROVED_AMOUNT | The full requested approved amount for authorization/capture.
|
BIT40 | Defines and qualifies the transaction originated from the POS device.
|
BIT42 | Indicates which merchant originated the transaction.
Assigned by WorldPay. |
BIT44_RESPONSE_DATA | This field is used for WorldPay rejection reason and response literal.
|
BIT48_ADDRESS_VERIFICATION_RESULT | Contains the AVS verification response code which is returned in the Authorization Request Response message when the AVS functionality is used during transaction processing.
|
BIT48_AMERICAN_EXPRESS_RESPONSE_DATA | This subelement is for the financial network code and banknet reference number.
|
BIT48_AUTHENTICATION_VERIFICATION_VALUE_RESULT_CODE | MasterCard UCAF/AAV or Visa CAVV results, left justified and space filled.
|
BIT48_CARD_VERIFICATION_RESULT | Field return when CVV/CVC2/CVV2/CID is sent for a transaction.
|
BIT48_COMMERCIAL_CARD_RESPONSE | This subelement is sent in response to the type of purchase card transactions.
|
BIT48_CREDIT_RESPONSE_DATA | This subelement is sent in response to certain credit card transactions, including Visa and MasterCard.
|
BIT48_MASTER_CARD_RESPONSE_DATA | This subelement is for the financial network code and banknet reference number.
|
BIT48_PREPAID_CARD_DATA | This subelement is for the Prepaid Card ID and password.
|
BIT48_VISA_RESPONSE_DATA | This subelement is for reference number and validation code for approved transactions.
|
BIT54 | This field is included only for purchases with cash back account balances and reversals.
|
BIT54_ADDITIONAL_AMOUNTS | Included only for purchases with cash back account balances and reversals.
|
BIT54_BALANCE | Available balance.
|
BIT54_CASHBACK_AMOUNT | The subelement for the amount type.
The requested/approved amount in the Request/Response messages. |
BIT54_PARTIAL_APPROVED_AMOUNT | The subelement for the amount type.
|
BIT54_TIP_AMOUNT | The amount of tips.
|
BIT59 | Free form. This information is returned in all approval responces.
|
BIT59_WORLD_RETRIEVAL_DATA | Free Form. This element is returned in all approved transactions and approved financial responses.
|
BIT60 | This data element and its subelements identify the reason for a reversal or an advice.
|
BIT60_REASON_CODE | Identify the reason for a reversal or an advice.
|
BIT61 | Element, that is used as Point of Service (POS) Data in WorldPay.
|
BIT62_DEBIT_EBT_NETWORK_RESPONSE_DATA | This field only be returned for Debit and EBT transactions that are approved or denied by the network.
|
BIT7 | Represents the time and date that the transaction is transmitted from the payment switch, gateway, or POS device.
|
BIT90 | Required in reversal messages to assist acquirer and issuer in matching it to the original message.
|
BIT95 | Used for reversal advices only, and may be more or less than the original transaction amount.
|
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. |
MESSAGE_TYPE | The 4 digit numeric field classifying the high level function of the message.
|
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together.
|
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together.
|
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together.
|
Name | Description |
---|---|
A1 | Reference number of the transaction. Corresponds to the referenceNumber field in the gateway. |
A2 | Payment source of the transaction. Corresponds to the transactionIndustryType field in the gateway. |
A4 | Amount of the transaction. Corresponds to the amount field in the gateway.
Two exponents are implied. No decimal point is used (except for currencies with zero exponents). |
A9 | Category of the transaction. Corresponds to the transactionCategory field in the gateway. |
C1 | Name of the cardholder. Corresponds to the holderName field in the gateway. |
C10 | Cardholder's billing address postal/zip code. Corresponds to the zipCode field in the gateway. |
C2 | Cardholder's contact phone number (e.g., 999-999-9999). Corresponds to the phone field in the gateway. |
C3 | Cardholder's email address. Corresponds to the email field in the gateway. |
C5 | Street name of the cardholder's billing address. Corresponds to the street field in the gateway. |
C7 | City name of cardholder's billing address. Corresponds to the city field in the gateway. |
H9 | Value identifying the transaction in a submitter’s system. Corresponds to the transactionCode field in the gateway. |
I1 | Description of the transaction. Corresponds to the memo field in the gateway. |
I2 | Descriptor associated with the transaction. Corresponds to the descriptor field in the gateway. |
I8 | 3D Secure data.
Consists of 3 different values, delimited by a colon sign:
|
M | Merchant ID associated with the merchant account. Corresponds to the merchantAccountCode field in the gateway. |
O | Operation code that is used to determine the requested service.
Possible values:
|
Name | Description |
---|---|
T | Date of the transaction. Corresponds to the transactionDate field in the gateway. |
Z1 | Response ID. |
Z13 | Returns reference number of underlying provider. Corresponds to the providerReferenceNumber field in the gateway. |
Z14 | CVV2 response code. Corresponds to the cvv2ResponseCode field in the gateway.
|
Z15 | Authorized amount. Corresponds to the amount field in the gateway. |
Z16 | Remaining balance on the card (debit and gift cards only; not always available). Corresponds to the balance field in the gateway. |
Z17 | Indicates currency of transaction. Corresponds to the currencyCode field in the gateway. |
Z2 | Response code returns by the underlying processor/bank. Corresponds to the providerResponseCode field in the gateway. |
Z3 | Response message returns by the underlying processor/bank. Corresponds to the providerResponseMessage field in the gateway. |
Z4 | Authorization number issued by the processor; often shown on credit card receipt. Corresponds to the approvalCode field in the gateway. |
Z5 | Risk score. |
Z6 | Gateway generated response code. Corresponds to the responseCode field in the gateway. |
Z9 | Address verification response code. Corresponds to the avsResponseCode field in the gateway. |
Name | Description |
---|---|
ACCOUNT_TYPE | Type of the account. |
ACTION | Type of transaction. |
ADDRESS1 | Customer’s home or business address. |
BILLING_ADDRESS1 | Street (line 1) of the billing address. |
BILLING_CITY | City of the billing address. |
BILLING_COUNTRY | Country of the billing address. |
BILLING_PHONE | Phone number of the billing address. |
BILLING_POSTAL_CODE | ZIP (or postal) code of the billing address. |
BILLING_STATE_REGION | State or region of the billing address. |
CAPTURE_AMOUNT | Amount of the authorized transactions to be validated. |
CITY | City where the customer's address is located. |
COUNTRY | Country where the customer's address is located. |
CREATE_CUSTOMER_IF_DOES_NOT_EXISTS | Indicates whether a new customer account should be created. |
CUSTOMER_NUMBER | Unique identifier representing a specific customer in the system.
*Required if updateCustomerIfExists is ‘Yes’. |
DESCRIPTION | Optional element used to define or explain the purpose of the transaction. |
EFFECTIVE_DATE | Transaction processing date. |
EMAIL_ADDRESS | Email address for discussing any processing issues. |
ENTITY_ID | Unique identifier of the merchant in the processor's system. Also referred to as the merchant ID or MID. |
FIELD1 | Optional information associated with a customer. Data is stored with the customer. Indexed field. |
FIELD2 | Optional information associated with a customer. |
FIELD3 | Optional information associated with a customer. |
FIRST_NAME | First name of an individual customer. |
IP_ADDRESS_OF_ORIGINATOR | IP address of person sending request. May be automatically retrieved. |
IS_BUSSINESS_PAYMENT | Indicates whether the transaction is ACH only as either drawn on a business or personal account. |
IS_COMPANY | Indicates whether a customer is an individual merchant or a business. The default value of ‘Individual’ will be used if null. |
LAST_NAME | Either the last name of an individual customer or the company name on a business account.
Is required if
|
LOCATION_ID | Unique identifier for a location (account) set up under a user. |
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. |
NAME_ON_ACCOUNT | Customer’s name as it appears in the account. Is required for SettlementType ACH when PaymentOrigin is Internet (WEB), Telephone_IVR, Telephone_Operator, Signature_Faxed, Signature_Original Corporate_Trade_Exchange. |
OPERATION_TYPE | Type of the transaction (either a debit or credit). If null, the default value ‘Sale’ is specified. |
ORIGINAL_REFERENCE_NUMBER | Reference number assigned to the transaction to be captured (with an OperationType of ‘Auth’). |
PAYMENT_ORIGIN | Identifies the method the transaction was originated. If not included in the request, the default value ‘Internet’ is specified. |
POSTAL_CODE | ZIP (or postal) code of the customer's address. |
RECURRING_PAYMENT_ORIGIN | Identifies the method the recurring transaction was originated. If not included in the request, the default value ‘Internet’ is specified. |
STATE_REGION | State or region where the customer's address is located. |
STORE_ID | Store ID generated by the processor. Can be unique to each individual merchant, or a master store ID can be assigned at the partner/owner level. |
TOTAL_AMOUNT | Total amount of the transaction. |
TRANSACTION_NUMBER | Number (or code) identifying transaction in the system. |
UPDATE_CUSTOMER_IF_EXISTS | Indicates whether the customer account information should be updated (if changed). |
Name | Description |
---|---|
ACTUAL_DATE | Date and time when the transaction was created. |
ERROR | Identifies whether the error occured during the transaction processing. |
ORIGINATED_AS | Identifies the transaction type. |
REFERENCE_NUMBER | The reference number assigned to the transaction. |
RESPONSE_CODE | Gateway generated response code. |
RESPONSE_MESSAGE | Gateway generated response message explaining the correspoding response code. |
SUCCESS | Identifies whether the transaction was successful. |
Name | Description |
---|---|
AMOUNT | Total amount of the transactions including discount and tax. Amount in minor units of given currency (e.g. cents if in Euro). |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CURRENCY | Code of the currency used for transaction. |
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 partition and data management, to make it easy to determine the ownership of a record within the database. |
RECURRING | Identifies whether transaction is recurring. |
REFERENCE | Reference number of the transaction. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
TEXT_ON_STATEMENT | Text that is placed on cardholder’s bank statement. |
TYPE | Type of the transaction. |
URL_SUFFIX | Suffix to the URL to which the request is sent. |
Name | Description |
---|---|
APPROVED_AMOUNT | Approved amount of the transaction. |
PROCESSED_AT | Date when transaction was processed. |
RESPONSE_CODE | Gateway generated response code. |
RESPONSE_MESSAGE | Gateway generated response message. |
TRANSACTION_ID_RESPONSE | Processor's ID of the transaction. |
Name | Description |
---|---|
The identification number of the user in the system. |
|
ACTION | Special number of a transaction type. |
ADDR | Street address of the customer. |
AMT | The amount of the transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CURRENCY_CODE | The currency code of the transaction. |
MEMBER | Cardholder’s full name. |
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. |
PAYMENT_ID | Payment ID used to identify the payment for subsequent transactions. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
TRACK_ID | A unique tracking ID issued by the merchant's commerce system which is stored with the transaction. (Avoid spaces and extended characters. Use only alphanumeric format.)
|
TRANS_ID | Transaction ID used to identify the original transaction for a void, capture and refund transactions. |
ZIP | ZIP code (or postal code) of the consumer. |
Name | Description |
---|---|
RESPONSE_AUTH | The resulting authorization number of the transaction. |
RESPONSE_AVR | A single letter providing information about the cardholder’s submitted data. The letter indicates how closely the submitted card number, address, and ZIP code match at the card-issuing bank. |
RESPONSE_CARD_BALANCE | The resulting card balance of the stored value transaction instrument. |
RESPONSE_CODE | Gateway generated response code.
If any errors occur during the transmission of the transaction data, the response format will contain a single string indicating that an error occurred. |
RESPONSE_DATE | Transaction date in the format of the authorization system. |
RESPONSE_ECI | Electronic Commerce Indicator (ECI) response. |
RESPONSE_ERROR_CODE_TAG | The code of the error from the response. |
RESPONSE_ERROR_TEXT | Text message explaining the occured error. |
RESPONSE_PAYMENT_ID | Unique order ID generated by commerce gateway. |
RESPONSE_REF | The resulting reference number of the transaction. This number or series of letters is used for referential purposes by some acquiring institutions and should be stored properly. |
RESPONSE_RESULT | Returned as the transaction response evaluator. Check the Result for error and then evaluate the transaction to determine if it performed successfully. |
RESPONSE_RESULT | Returned as the transaction response evaluator. Check the Result for error and then evaluate the transaction to determine if it performed successfully. |
RESPONSE_TRACK_ID | The track ID sent by the merchant in the transaction request. |
RESPONSE_TRANS_ID | Unique transaction ID issued by the ACI commerce gateway. |
Name | Description |
---|---|
ACTION | Authorization action code. |
AUTO_DEPOSIT | Identifies that capture takes place immediately (a sale in one transaction). If not specified, it will be set to sale-auth.
True in case of SMS, false in case of DMS. If this element is not included in XML, by default its value is set to “true”. |
BILLING_ADDRESS_ADDRESS | Address where bill or invoice would be sent. |
BILLING_ADDRESS_CITY | City associated with the billing address. |
BILLING_ADDRESS_COUNTRY | Country code associated with the billing address.
Country in ISO 3166-1 alpha 3 format. |
BILLING_ADDRESS_EMAIL | Email address associated with the billing address. |
BILLING_ADDRESS_NAME | Name of a person who will receive bill or invoice. |
BILLING_ADDRESS_PHONE | Phone number associated with the billing address. |
BILLING_ADDRESS_POST_INDEX | ZIP (or postal code) associated with the billing address. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
DEPOSIT_AMOUNT | Amount that would be transferred to merchant’s account. Hold from remaining funds would be removed immediately. Deposit amount should be smaller than payment amount and larger than 0, written in minor currency units. In case it is not included in XML, full payment amount would be transferred. |
DESCRIPTOR | Dynamic descriptor appearing on cardholder’s credit card statement for the transaction. Is allowed to be included in XML only when dynamic descriptor feature is enabled. |
GATEWAY_KEY | Name of the gateway key file. |
KEY_INDEX | Index of merchant’s RSA public key used for data encryption of the payment in progress. |
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. |
MERCHANT_INTERFACE | A unique code provided by LPB system to a merchant for identification purpose. |
MERCHANT_KEY | Name of the merchant key file. |
MODE | Number of payment processing mode. |
ORDER_AMOUNT | Payment amount in minor currency units. |
ORDER_CURRENCY | Order payment currency. |
ORDER_DESCRIPTION | Order description that will be shown on Payment Form. |
ORDER_ID | Unique code for order identification. |
PAYMENT_ID | Identification number of the payment. |
REMOTE_ADDRESS | IPv4 address (dotted-decimal notation). |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
REVERSAL_AMOUNT | Identifies amount that would be returned to cardholder’s account. Reversal amount should be less than payment amount and more than 0, written in minor currency units. If it is not included, full payment amount would be returned. Can be included in XML if payment is in payment processing state Deposited or Processed. |
Name | Description |
---|---|
ERROR_CODE | A code that identifies encountered system error. |
ERROR_MESSAGE | Description of encountered error, e.g. incorrect data, encryption/decryption error. |
RESPONSE_ACTION_CODE | Response authorization action code, ISO 8583 field 39. |
RESPONSE_APPROVAL_CODE | Response approval code, ISO 8583 field 38. |
RESPONSE_CAVV | Cardholder’s authentication verification value retrieved in response to a request. |
RESPONSE_DESCRIPTION | A response containing order description. |
RESPONSE_ECI | Electronic commerce indicator response. |
RESPONSE_ENROLLED | Status on whether cardholder’s credit card is enrolled in 3D Secure or not, retrieved in response to a request. |
RESPONSE_MESSAGE_ID | Response message identification number. |
RESPONSE_PAYMENT_ID | Unique code for payment identification retrieved in response to a request. |
RESPONSE_PAYMENT_LAST_DATE | Date and time (in EET – Eastern European Time) when payment was last updated, retrieved in response to a request. |
RESPONSE_PAYMENT_START_DATE | Date and time (in EET – Eastern European Time) when payment was initiated, retrieved in response to a request. |
RESPONSE_PAYMENT_STATE | Number of payment processing state that payment is currently in, retrieved in response to a request. |
RESPONSE_STATUS | Status on whether cardholder passed 3D Secure authentication, retrieved in response to a request. |
RESPONSE_TRANSACTION_DATE | Transaction date retrieved in response to a request. |
RESPONSE_XID | Transaction identification number retrieved in response to a request. |
Name | Description |
---|---|
ACCOUNT_TYPE | Type of the account. |
AMOUNT | Amount of the transaction. |
APPLICATION_PROFILE_ID | Token representing the PTLS Socket ID unique to each Service Key and configuration data combination. |
APPROVAL_CODE | Approval code for this authorization. |
BASE_AMOUNT | Base amount of the transaction, not including freight, handling, and tax amounts. |
BILL_PAYMENT | Indicates that the transaction is one in a set of recurring or installment transactions. |
BUSINESS_NAME | Business name of the merchant. |
CAPTURE_AMOUNT | Amount of capture transaction. |
CARD_TYPE | The card type used on the transaction. |
CARDHOLDER_NAME | Cardholder name embossed on the front of the card. Conditional, required if specified in AVSData. |
CASH_BACK_AMOUNT | Specifies a cash back amount for PIN Debit transactions. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TYPE | Indicates the type of charge. In most retail environments this value is set to “RetailOther”, but if other enumerations are applicable they should be used. |
CITY | City address of the cardholder used in AVS verification. |
COMPANY_NAME | Name of the company. |
COUNTRY_CODE | Country code of the cardholder used for AVS verification. |
CURRENCY_CODE | Currency code as defined by the International Standards Organization (ISO). |
CURRENT_INSTALLMENT_NUMBER | Current installment number. |
CUSTOMER_PRESENT | Presence of cardholder relative to the transaction point of service. |
CUSTOMER_SERVICE_INTERNET | Service web URL or email address of the customer used for discussing any processing issues. |
CUSTOMER_SERVICE_PHONE | Phone number used to discuss any processing issues. |
CV_DATA_PROVIDED | Indicates whether or not CV data provided. |
DESCRIPTION | Short description of the order. |
Email address of the merchant. |
|
EMPLOYEE_ID | Clerk/cashier identifier. |
ENTRY_MODE | Indicates how the cardholder data was retrieved. When authorizing with stored card data, either locally or with PaymentAccountDataToken, indicates that the card data was manually collected (keyed or one of its variants). |
EXISTING_DEBT | Amount of existing debt on the credit card. |
FEE_AMOUNT | Specifies the fee amount associated with an authorization, such as convenience fees. |
FIRST | First name of the customer. |
INVOICE_NUMBER | Informational field used to track invoice/receipt number. |
IS_TAX_EXEMPT | Indicates tax exempt status of the transaction. |
LANE_ID | Identifies the cashier location at which the transaction occurred. |
LAST | Last name of the customer. |
MERCHANT_PROFILE_ID | Unique identifer for the merchant profile. |
NAME | Name of the merchant. |
ORDER_NUMBER | Order number as assigned by the merchant. |
ORDER_NUMBER_LEVEL2 | Order number. |
PHONE | Local telephone number of the cardholder used in AVS verification. |
PIN_DEBIT_REASON | Specifies the reason for the undo. Conditional, required for PIN Debit transactions. |
POSTAL_CODE | ZIP (or postal) code of the cardholder used in AVS verification. |
REFERENCE | Specifies user or customer reference data echoed from the request. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETURN_AMOUNT | Amount of the return transaction. |
SERVICE_ID | The ID of the service the transaction should process against. |
SHIP_DATE | Date of goods shipment. |
SIGNATURE_CAPTURED | Specifies whether the cardholder provided a signature for the transaction. |
STATE_PROVINCE | State or province address of the cardholder used in AVS verification. |
STREET1 | Street address (line 1) of the client. |
TAX_AMOUNT | Amount of tax. |
TAX_EXEMPT_NUMBER | Number of the tax extempt. |
TIP_AMOUNT | Positive amount added to the total as a tip. |
TOTAL_NUMBER_OF_INSTALLMENTS | Total number of installments. |
TRANSACTION_DATE_TIME | The local date and time of the transaction as calculated by the merchant and printed on the customer receipt. This field should contain a timezone offset representing the timezone in which the transaction is taking place.
Format: YYYY-MM-DDTHH:MM:SS±offset. |
TRANSACTION_ID | The ID of the transaction. |
Name | Description |
---|---|
ACTUAL_RESULT | Specifies the actual result of AVS from the service provider. |
ADDRESS_RESULT | Specifies the result of AVS as it pertains to address matching. |
ADVICE_RESPONSE | Specifies the reason for issuer decline of recurring payment transactions. |
AUTHORIZATION_SERVER_URL | UR address of the authorization server. |
BATCH_AMOUNT | Amount of batch transaction. |
BATCH_ID | Batch identifier. |
CAPTURE_STATE | State of capture transaction. |
CARD_LEVEL | Code returned by the card association that indicates the type of card used by the customer. |
CARD_TYPE | The card type used on the transaction. |
CARDHOLDER_NAME_RESULT | Specifies the result of AVS as it pertains to cardholder name matching. |
CASH_BACK_AMOUNT | Specifies a cash back amount for PIN Debit transactions. |
CASH_BACK_TOTALS_COUNT | The sum of all PIN Debit transaction cash back amounts included in the batch. |
CASH_BACK_TOTALS_NET_AMOUNT | The sum of all PIN Debit transaction cash back net amounts included in the batch. |
CITY_RESULT | Specifies the result of AVS as it pertains to city matching. |
COMMERCIAL_CARD_RESPONSE | Indicates the status of the card with respect to its ability to utilize purchase card data. When the card is a Business, Corporate, or Purchase card, providing purchase card data can result in improved interchange rates. |
COUNTRY_RESULT | Specifies the result of AVS as it pertains to country matching. |
CV_RESULT | Response code returned by the card issuer indicating the result of Card Verification (CVV2/CVC2/CID). |
DOWNGRADE_CODE | Downgrade reason. |
ERROR_CODE | Code of the occured error. |
ERROR_STRING | Text message explaining the occured error. |
ERROR_TYPE | Type of the occured error. |
FEE_AMOUNT | Specifies the fee amount associated with an authorization, such as convenience fees. |
FINAL_BALANCE | The account balance after the transaction. |
FORCE_POST_CODE | Force post code information. |
HOST_MESSAGE_ID | ID of the host message. |
INDUSTRY_TYPE | The industry type of the transaction(s). |
IS_ACKNOWLEDGED | Indicates if the transaction has been acknowledged by the client application. |
LAST_PAN_DIGITS | Last PAN digits. |
LEVEL3_ADDED | Level 3 added. |
MASKED_PAN | The cardholder’s PAN in masked format. |
MESSAGE_AUTHENTICATION_CODE | Authentication code of the message. |
NET_TOTALS_COUNT | Total count of transactions for the entire batch independent of transaction class. |
NET_TOTALS_NET_AMOUNT | Total net amount of transactions for the entire batch independent of transaction class. |
ORDER_ID | The order ID generated by CWS. This value is often used by service providers for transaction correlation. |
ORIGINATOR_TRANSACTION_ID | ID of the original transaction. |
PAYMENT_ACCOUNT_DATA_TOKEN | Token specified by a tokenization (offsite payment account data storage) service provider, used to retrieve securely stored payment account data. |
PAYMENT_AUTHORIZATION_REQUEST | Payment authorization request. |
PHONE_RESULT | Specifies the result of AVS as it pertains to phone matching. |
PIN_DEBIT_RETURN_TOTALS_COUNT | Total count of PIN Debit returns. |
PIN_DEBIT_RETURN_TOTALS_NET_AMOUNT | Total net amount of PIN Debit returns. |
PIN_DEBIT_SALE_TOTALS_COUNT | Total count of PIN Debit sales. |
PIN_DEBIT_SALE_TOTALS_NET_AMOUNT | Total net amount of PIN Debit sales. |
POSTAL_CODE_RESULT | Specifies the result of AVS as it pertains to postal code matching. |
PREPAID_CARD | Specifies whether or not the card is a prepaid card. The identification of prepaid cards is at the discretion of the payment brand or issuer. |
PROCESSED_AS3_D | Processed as 3D transaction. |
REFERENCE_RESULT | Result of the reference checking. |
RESPONSE_AMOUNT | Amount of the transaction specified in the response. |
RESPONSE_DATE | Date of the actual response. |
RESPONSE_STATUS | Status of the response. |
RESPONSE_STATUS_CODE | Status code of the response. |
RESPONSE_STATUS_MESSAGE | Message explaining the response. |
RESPONSE_TIME | Time for the response from the processor. |
RESPONSE_TIME_ZONE | Time zone response information. |
RESUBMIT | Specifies whether resubmission is supported for PIN Debit transactions. |
RETRIEVAL_REFERENCE_NUMBER | Retrieval reference number generated by the processor used for settlement and reversals. If present in the response, this same data element and value must be provided during settlement of any subsequent authorization linked to this transaction. |
RETURN_TOTALS_COUNT | Total count of returns for the entire batch independent of transaction class. |
RETURN_TOTALS_NET_AMOUNT | Total net amount of returns for the entire batch independent of transaction class. |
RETURNED_ACI | Provides information concerning the status of a transaction’s CPS qualification. |
SALE_TOTALS_COUNT | Total count of sales for the entire batch independent of transaction class. |
SALE_TOTALS_NET_AMOUNT | Total net amount of sales for the entire batch independent of transaction class. |
SERVICE_TRANSACTION_ID | Transaction identifier assigned by the service provider. May be useful for identifying the transaction when contacting the service provider offline. |
SETTLEMENT_DATE | Settlement date. |
STATE_RESULT | Specifies the result of AVS as it pertains to state matching. |
TERMINAL_ID | Transaction device identifier. Often referred to as Terminal Number or Terminal
ID (TID). |
TOKEN_INFORMATION | Token information. |
TRANSACTION_CODE | Specifies if a transaction should override the Evo duplicate charge check.
Either ‘NotSet’ or ‘Override’ |
TRANSACTION_ID | The ID of the transaction. |
TRANSACTION_STATE | Current status of the transaction. |
TRANSMISSION_NUMBER | Transmission number. |
VOID_TOTALS_COUNT | Total count of voids for the entire batch independent of transaction class. |
VOID_TOTALS_NET_AMOUNT | Total net amount of voids for the entire batch independent of transaction class. |
Name | Description |
---|---|
AMOUNT | Amount of the order. |
AUTH_CODE | Authorization code returned from the issuing institution. |
AVS_STREET_NAME | Street name used to check AVS address verification. |
AVS_STREET_NUMBER | Street number used to check AVS address verification. This must match the address that the issuing bank has on file. |
AVS_ZIPCODE | ZIP (or postal) code used to check AVS address verification. |
COMP_AMOUNT | Used when performing a Capture transaction. This must contain 3 digits with two penny values. The minimum value passed can be 0.01 and the maximum 9999999.99. |
CRYPT_TYPE | E-Commerce Indicator:
1 - Mail Order / Telephone Order - Single 2 - Mail Order / Telephone Order - Recurring 3 - Mail Order / Telephone Order - Instalment 4 - Mail Order / Telephone Order - Unknown Classification 5 - Authenticated E-commerce Transaction (VBV) 6 – Non Authenticated E-commerce Transaction (VBV) 7 - SSL enabled merchant 8 - Non Secure Transaction (Web or Email Based) 9 - SET non - Authenticated transaction |
CUST_ID | Unique identification number of the customer. Can be sent as part of a Purchase or PreAuth request. It is searchable from the Moneris Merchant Resource Centre. It is commonly used for policy number, membership number, student ID or invoice number. |
CVD_INDICATOR | CVD (Card Validation Digits) presence indicator. |
DYNAMIC_DESCRIPTOR | Dynamic descriptor used by a client. |
ORDER_ID | Unique number of the order. |
ORIGINAL_TXN_NUMBER | |
REQUEST_TYPE | Type of the request. |
STORE_ID | Unique identification number of the store. |
Name | Description |
---|---|
AVS_RESULT_CODE | Code that indicates the Address Verification Service (AVS) result. |
CARD_TYPE | Type of the credit card used for the transaction. |
CAVV_RESULT_CODE | Code indicating the result of CAVV verification. |
COMPLETE | Transaction was sent to authorization host and a response was received. |
CORPORATE_CARD | |
CVD_RESULT_CODE | Code that indicates the Card Validation Digits (CVD) result. |
IS_VISA_DEBIT | Indicates whether the used card is Visa Debit card. |
ISO | ISO response code. |
ITD_RESPONSE | |
MESSAGE | Response description returned from issuing institution. |
RECEIPT_ID | Order ID specified in the request. |
REFERENCE_NUM | References the terminal used to process the transaction as well as the shift, batch and sequence number. This data is typically used to reference transactions on the host systems and must be displayed on any receipt presented to the customer. This information should be stored by the merchant. The following illustrates the breakdown of this field where "660123450010690030” is the reference number returned in the message, "66012345" is the terminal ID, "001" is the shift number, "069" is the batch number and "003" is the transaction number within the batch. |
RESPONSE_CODE | Gateway generated response code. |
TIMED_OUT | Transaction failed due to a process timing out. |
TRANS_AMOUNT | Amount of the transaction. |
TRANS_DATE | Actual date of the original transaction. |
TRANS_ID | Unique identification number of the transaction. |
TRANS_TIME | Actual time of the original transaction. |
TRANS_TYPE | Type of the transaction. |
Name | Description |
---|---|
ACCOUNT_NUMBER | Account number in the system. |
AMOUNT | The amount of the request, in minor units.
For example, to process US $10.99, this value should be 1099. To process 1000 Japanese yen, this value should be 1000. To process 10.139 Tunisian dinar, this value should be 10139. Note: If the merchant account is set up for a currency that has 3 decimal units, our system will half round up the least significant digit. Therefore, a transaction of 10.139 Tunisian dinar would be processed as 10.14. |
AUTH_ID | Authorization ID. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CITY | City in the billing address. |
COUNTRY | Country code in the billing address. |
DESCRIPTION | Description of the transaction, provided by the merchant. |
DYNAMIC_DESCRIPTOR | Dynamic description of a transaction. Appears on a statement and can be customized to simplify understanding of charge for a cardholder. |
Customer’s email address. |
|
FIRST_NAME | Customer’s first name. |
LAST_NAME | Customer’s last name. |
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. |
MERCHANT_REF_NUM | The merchant reference number created by the merchant and submitted as part of the request. It must be unique for each request. |
PHONE | Customer's telephone number. |
RECURRING | Indicates whether this is an initial or repeat transaction for a customer for whom you will be processing recurring transactions.
The Recurring Indicator is used to identify transactions that are eligible for repeat processing. The merchant should identity the initial transaction processed with full billing information including the card security code (CVV) by setting the recurring indicator to “INITIAL”. Subsequent charges to the same card can be identified with the recurring indicator set to “RECURRING”. For these transactions the card security code is not required and could not be passed in because card regulations do not allow merchants to store it. |
REQUEST_TYPE | Type of initiated request. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
SETTLE_WITH_AUTH | This indicates whether the request is an Authorization only (no Settlement), or a Purchase (Authorization and Settlement).
Note: This value defaults to false. If the merchant wants to find out whether an authorization has been settled, they should check the availableToSettle element. If the amount is 0, the authorization has been fully settled. |
SHIPPING_CITY | Recipient's city address used for the shipment. |
SHIPPING_COUNTRY | Recipient's country code used for the shipment. |
SHIPPING_RECIPIENT_NAME | Name of the recipient. |
SHIPPING_STATE | Recipient's state address used for the shipment. |
SHIPPING_STREET | Recipient's street address used for the shipping. |
SHIPPING_ZIP | Recipient's ZIP (or postal) code used for the shipment. |
STATE | State in the billing address.
Note: 2-character state or province codes for Canada or the United States. |
STREET | First line of the street address in the billing address. |
ZIP | ZIP (or postal) code in the billing address. |
Name | Description |
---|---|
ACQUIRER_AUTH_CODE | Acquirer authorization code. |
ACQUIRER_AVS_CODE | The raw AVS code returned by the acquirer. |
ACQUIRER_BALANCE_RESPONSE | The balance remaining on a gift card, if a gift card was used for the original transaction. |
ACQUIRER_BATCH_NUMBER | The batch number of the transaction. |
ACQUIRER_CODE | Identification code of an acquirer, such as DJN, CRX, etc. |
ACQUIRER_CVV2_RESULT | Acquirer CVV2 verification response result. |
ACQUIRER_DESCRIPTION | Description of the response. |
ACQUIRER_EFFECTIVE_DATE | The date of the bank deposit associated with the transaction. |
ACQUIRER_FINANCING_TYPE | The type of financing offered. |
ACQUIRER_GRACE_PERIOD | The grace period, in months, associated with deferred payment transactions. |
ACQUIRER_MID | The acquirer MID that was sent to the clearing house. |
ACQUIRER_PLAN | The plan number for the financing transaction. |
ACQUIRER_REFERENCE_NBR | Bank Net transaction ID/Merch Tran Ref. |
ACQUIRER_REQUEST_ID | Request ID assigned by NETBANX. |
ACQUIRER_RESPONSE_CODE | The raw response returned by the acquirer. |
ACQUIRER_RESPONSE_ID | The response ID assigned by Credorax. |
ACQUIRER_RESPONSE_REASON_CODE | The raw response reason code returned by Credorax. |
ACQUIRER_SEQ_NUMBER | The merchant's sequence number. |
ACQUIRER_TERM | The number of payments, in months, for equal payment transactions. |
ACQUIRER_TERMINAL_ID | The merchant's terminal ID. |
ACQUIRER_TXN_DATE_TIME | The actual transaction date and time. |
AUTH_CODE | Authorization code assigned by the issuing bank and returned in the response. |
AVAILABLE_TO_REFUND | The amount of this settlement that is available to refund, in minor units. |
AVAILABLE_TO_SETTLE | The amount of of the Authorization remaining to settle, in minor units. |
AVS_RESPONSE | This is the AVS response from the card issuer.
|
CARD_TYPE | Type of credit card used for the request. |
CHILD_ACCOUNT_NUM | The child merchant account number. It is returned only if the transaction was processed via a master account. |
CURRENCY_CODE | Currency of the merchant account (e.g., USD or CAD) returned in the request response. |
CVV_VERIFICATION | This is the response to the CVV submitted with the transaction request.
|
ERROR_CODE | Code of the occured error. |
ERROR_DETAILS | Detailed description of the occured error. |
ERROR_FIELDS | The list of fields that have problems. |
ERROR_MESSAGE | Short description of an occured error. |
LAST_DIGITS | The last four digits of the credit card used for the request. |
RESPONSE_AMOUNT | Amount specified in the response. |
RESPONSE_CODE | Code of the response. |
RESPONSE_MESSAGE | Human readable response message explaining the response code. |
RISK_REASON_CODE | An array of integers is returned, displaying the detailed Risk reason codes if transaction was declined.
Note: It is returned only if the account is configured accordingly. |
STATUS | The status of the authentications request. |
TXN_TIME | The date and time the transaction was processed. |
Name | Description |
---|---|
Used to indicate the transaction request is a test or demo transaction regardless of account status. |
|
Customer identification number assigned by TrustCommerce. |
|
ACTION | Type of transaction action (e.g. "sale", "preauth", "postauth", "credit", "void", "store", and so on). |
ADDRESS1 | Street of the merchant's mailing address.
Personal address information of the merchant. |
AMOUNT | Transaction amount in cents (for example, $1.00 would be submitted as "100"). |
AVS | The "avs" response code returned by the address verification system (AVS). |
BILLING_ID | Alphanumeric code used to retrieve customer payment card and ACH information for future, one-time and recurring/installment transactions. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHECK_CVV | Indicates whether TrustCommerce should decline the transaction on behalf of the integrator if the CSC does not match as reported by the card issuing bank. Only used if “cvv” is provided. |
CITY | City of the merchant's mailing address.
Personal address information of the merchant. |
COUNTRY | Country of the merchant's mailing address.
Personal address information of the merchant. |
CVV_STATUS | This field should be assigned if the “cvv” field is not submitted. Possible values include “present”, “notpresent”, and “illegible”. By default, it will be treated as “notpresent” although some processors may treat it otherwise if this field is not submitted by the integrator.
In all cases, this field is used when the CSC is not submitted. By submitting a CSC, the merchant is stating that the CSC is present and the value is the “cvv” indicated above. Only used if “cvv” is NOT provided. |
Email of the merchant for discussing any processing issues or sending notifications. |
|
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. |
NAME | Name of the customer. |
OFFLINE_AUTH_CODE | Six-digit numeric code used to force the transaction. |
OPERATOR | A field the integrator may choose to use if there are multiple operators that are potentially entering transactions. The operator field is only used for reporting within TrustCommerce systems. |
PAYMENT_NUMBER | The payment number associated with the transaction. It is required for both recurring and installment payment transactions and is required for a transaction to be flagged as recurring. |
PHONE | Phone number of the merchant for discussing any processing issues.
Personal information of the merchant. |
PURCHASE_LEVEL | Purchase level provided by TrustCommerce. |
PURCHASE_ORDER_NUM | Purchase order number "purchaseordernum" is provided by the customer. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
SHIP_TO_ADDRESS1 | The address of the destination where the goods are being shipped. If this field is not provided, TrustCommerce will send blanks. |
SHIP_TO_CITY | The city of the destination where the goods are being shipped. If this field is not provided, TrustCommerce will send blanks. |
SHIP_TO_COUNTRY | The country of the destination where the goods are being shipped. If this field is not provided, TrustCommerce will send blanks. |
SHIP_TO_NAME | The name of the customer to whom the goods are being shipped. If this field is not provided, TrustCommerce will send blanks. |
SHIP_TO_SAME | The same destination where the goods are being shipped before. If this field is not provided, TrustCommerce will send blanks. |
SHIP_TO_STATE | The state of the destination where the goods are being shipped. If this field is not provided, TrustCommerce will send blanks. |
SHIP_TO_ZIP | The ZIP (or postal) code of the destination where the goods are being shipped. If this field is not provided, TrustCommerce will send blanks. |
STATE | State of the merchant's mailing address.
Personal address information of the merchant. |
STORE | "Y" or "N".
This function pushes credit card data to TrustCommerce Citadel and returns a billingID. This enables merchants to charge the cardholder and keep a record on file for use at a later date. The store function only pushes data to citadel if the sale/preauth is approved. The BillingID is returned in the sale/preauth transaction response. The sale/preauth is associated with the BillingID record. |
TAX | The amount of tax, in cents, charged for this order. If the order is tax exempt, you may omit this field or set the field to "0". |
TAX_IDENTIFIER | Can be set to "localsales" or "taxexempt" to indicate the specific tax status of the order. |
TICKET | This discretionary field can be used as a merchant-specified transaction identifier for searching and reporting. In some cases, the value of this field is passed through to the financial institutions. |
TIP | This is the amount of the tip (in cents) to be included in the “postauth” request (for example, $1.00 would be submitted as “100”). |
TOTAL_PAYMENTS | This field indicates the number of installments. It is required for installment payment transactions. |
TRANS_ID | Unique identifier assigned to each transaction regardless of the status. |
TYPE | Indicates that the transaction is assigned to MOTO industry. |
ZIP | ZIP (or postal) code of the merchant's mailing address.
Personal address information of the merchant. |
Name | Description |
---|---|
BILLING_ID | Alphanumeric code used to retrieve customer payment card and ACH information for future, one-time and recurring/installment transactions. |
BLACKLIST_FIELD | The name of the input field that contained the blacklisted value; this can be one of the following: “name”, “cc”, “ach”, “zip”, “address1”, “state”, “country”, “email”, “phone”, or “ip”. |
BLACKLIST_VALUE | The input value that triggered the blacklist decline; for instance, if the decline was due to a blacklisted IP address, the offending IP address would be returned here. |
FRAUD_SCORE | The actual numeric score (0 to 100) assigned by TrustCommerce CrediGuard to the transaction. |
RESPONSE_AUTH_CODE | Authorization response code (result of the authorization). |
RESPONSE_AVS | Response to AVS verification of the transaction. |
RESPONSE_BAD_DATA_TYPE | A status of "baddata" indicates that no transaction was attempted because one or more fields were invalid. In this case, the field error will indicate the problem, and the offender field lists the offending input fields.
See the specification of the processor for more information. |
RESPONSE_CODE | The response code as sent to TrustCommerce from the processing platform. |
RESPONSE_CODE_DESCRIPTOR | The textual description of what this code indicates, as documented in the processing platform’s messaging documentation. |
RESPONSE_COMMERCIAL_CARD | Indicates whether the credit card type is commercial. |
RESPONSE_CVV | Response to CVV verification of the credit card. |
RESPONSE_DECLINE_TYPE | Type of response status.
When status is set to "decline", the "declinetype" field contains corresponding information about declined transaction. See the specification of the processor for more information. |
RESPONSE_ERROR_TYPE | A status of "error" indicates an error occurred while processing the transaction. See the specification of the processor for more information. |
RESPONSE_OFFENDERS | Response offenders. |
RESPONSE_STATUS_TYPE | Type of the response status of the transaction. |
TRANS_ID | Unique identifier assigned to each transaction regardless of the status. |
VELOCITY_TYPE | This is a brief string that contains the precise reason for the velocity decline:
• The first part of the string contains a velocity type, either “global”, “zip”, “ip”, or “cc”. • The second part of the string contains a time period, either “1day”, “3day”, “15day”, or “30day”. • The third part of the string contains an indicator of the type of violation, such as “count” if the transaction count for the velocity type and time period was exceeded, or “total” if the dollar amount sum was exceeded. |
VELOCITY_VALUE | This is the value that exceeded the velocity rule; for example, if the rule were a limit on CC# usage, this would be set to the last four digits of the credit card number. |
Name | Description |
---|---|
Customer identification number assigned by TrustCommerce. |
|
ADDRESS1 | Street of the merchant's mailing address.
Personal address information of the merchant. |
CITY | City of the merchant's mailing address.
Personal address information of the merchant. |
COUNTRY | Country of the merchant's mailing address.
Personal address information of the merchant. |
Email of the merchant for discussing any processing issues or sending notifications. |
|
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. |
NAME | Name of the merchant. |
PHONE | Phone number of the merchant for discussing any processing issues.
Personal information of the merchant. |
STATE | State of the merchant's mailing address.
Personal address information of the merchant. |
TOKEN_TRANSACTION_FK | Reference to the entity that represents information about token transaction. |
VERIFY | Indicates that payment card (credit or debit) information is valid. |
ZIP | ZIP (or postal) code of the merchant's mailing address.
Personal address information of the merchant. |
Name | Description |
---|---|
BILLING_ID | Alphanumeric code used to retrieve customer payment card and ACH information for future, one-time and recurring/installment transactions. |
BLACKLIST_FIELD | The name of the input field that contained the blacklisted value; this can be one of the following: “name”, “cc”, “ach”, “zip”, “address1”, “state”, “country”, “email”, “phone”, or “ip”. |
BLACKLIST_VALUE | The input value that triggered the blacklist decline; for instance, if the decline was due to a blacklisted IP address, the offending IP address would be returned here. |
FRAUD_SCORE | The actual numeric score (0 to 100) assigned by TrustCommerce CrediGuard to the transaction. |
RESPONSE_AVS | Response to AVS verification of the transaction. |
RESPONSE_BAD_DATA_TYPE | A status of "baddata" indicates that no transaction was attempted because one or more fields were invalid. In this case, the field error will indicate the problem, and the offender field lists the offending input fields.
See the specification of the processor for more information. |
RESPONSE_CODE | The response code as sent to TrustCommerce from the processing platform. |
RESPONSE_CODE_DESCRIPTOR | The textual description of what this code indicates, as documented in the processing platform’s messaging documentation. |
RESPONSE_CVV | Response to CVV verification of the credit card. |
RESPONSE_DECLINE_TYPE | Type of response status.
When status is set to "decline", the "declinetype" field contains corresponding information about declined transaction. See the specification of the processor for more information. |
RESPONSE_ERROR_TYPE | A status of "error" indicates an error occurred while processing the transaction. See the specification of the processor for more information. |
RESPONSE_OFFENDERS | Response assigned to offenders list. |
RESPONSE_STATUS_TYPE | Type of the response status of the transaction. |
TRANS_ID | Unique identifier assigned to each transaction regardless of the status. |
VELOCITY_TYPE | This is a brief string that contains the precise reason for the velocity decline:
• The first part of the string contains a velocity type, either “global”, “zip”, “ip”, or “cc”. • The second part of the string contains a time period, either “1day”, “3day”, “15day”, or “30day”. • The third part of the string contains an indicator of the type of violation, such as “count” if the transaction count for the velocity type and time period was exceeded, or “total” if the dollar amount sum was exceeded. |
VELOCITY_VALUE | This is the value that exceeded the velocity rule; for example, if the rule were a limit on CC# usage, this would be set to the last four digits of the credit card number. |
Name | Description |
---|---|
CUSTOMER_ADDRESS_CITY | City of the customer's mailing address. |
CUSTOMER_ADDRESS_COUNTRY | Country code of the customer's mailing address. |
CUSTOMER_ADDRESS_LINE1 | Customer's mailing address (line 1). |
CUSTOMER_ADDRESS_STATE | State code of the customer's mailing address. |
CUSTOMER_ADDRESS_ZIP_CODE | ZIP (or postal) code of the customer's mailing address. |
CUSTOMER_DAY_PHONE_NR | 10-digit phone number that can be used for discussing any processing issues with the customer during the day time. |
CUSTOMER_EMAIL | Email of the customer. Used for payment and subsequent payment action notifications. |
CUSTOMER_FIRST_NAME | First name of the customer. |
CUSTOMER_LAST_NAME | Last name of the customer. |
CUSTOMER_MIDDLE_NAME | Middle name of the customer. |
HEADER_ACCOUNT_NUMBER | Account number of the customer. |
HEADER_EXTERNAL_REFERENCE_NUMBER | External unique identifier of the payment.
Note: External reference number must be unique. Payment will be rejected as a duplicate payment (in current, or any subsequent file) if external reference number is repeated for the same account. |
HEADER_OPERATION | Current payment operation made by the customer. |
HEADER_PAYMENT_AMOUNT | Amount of the payment. |
HEADER_PAYMENT_TYPE_CODE | Code of the payment type. |
HEADER_REFERENCE_NUMBER | Payment reference number. This value will be zero if no payment is found. |
PAYMENT_METHOD_CARD_HOLDER_NAME | Name of the account holder (or credit cardholder name). |
PAYMENT_METHOD_FI_NAME | Name of the bank. |
PAYMENT_METHOD_TYPE | Type of payment method (e.g. credit card type). |
USER_LOGIN_ID | Unique user login ID. |
Name | Description |
---|---|
PAYMENT_RESPONSE_ADDITIONAL_AMOUNT | Optional additional payment amount to be included as part of the transaction, for example a donation. |
PAYMENT_RESPONSE_CONVENIENCE_FEE | Convenience fee determined by configuration. |
PAYMENT_RESPONSE_ERRORS | Payment error description (if occured). |
PAYMENT_RESPONSE_PAYMENT_AMOUNT | Bill payment amount. |
PAYMENT_RESPONSE_PAYMENT_DATE | Date in the mmDDyyyyHHmmss format.
Note: Only present within sale response. |
PAYMENT_RESPONSE_PAYMENT_STATUS | Current status of the payment (Accepted/Failed). |
PAYMENT_RESPONSE_PAYMENT_STATUS_DESCRIPTION | Short description of the payment status. |
PAYMENT_RESPONSE_REFERENCE_NUMBER | Unique Paymentus payment reference number.
Note: Only present within sale and void responses. |
PAYMENT_RESPONSE_TOTAL_AMOUNT | Total amount charged from the customer. |
Name | Description |
---|---|
Account number of the customer. |
|
ALLOW_PARTIAL_CHANGES | Indicates whether it is permissible to authorize less than the total balance available on a prepaid card. |
AMOUNT | Amount of the transaction. |
CASH_BACK_AMOUNT | Typically used as an optional field for PIN Debit processing. The value of cashBackAmount indicates the amount in cash to be given back to the customer during card processing. |
CHECK_NUMBER | Check number. |
CHECK_TYPE | Type of check payment being made. |
CITY | City where address is located. |
COMPANY | Company name. |
COUNTRY | Country code. US is set by default. |
CURRENT_INSTALLMENT | Current installment number. Required if transactionCategory is set as installment. |
DEVELOPER_ID | Developer ID of integrator assigned by SecureNet. |
DUTY_AMOUNT | Duty amount included in the transaction. |
Email address used to send notifications. |
|
FIRST_NAME | First name of the account holder. |
FREIGHT_AMOUNT | Freight amount included in the transaction. |
GRATUITY_AMOUNT | Amount of the tip. |
LAST_NAME | Last name of the account holder. |
LINE1 | Street address of the account holder. |
NOTES | Notes (any additional information) about the record. |
ORDER_DATE | Date of the transaction. |
ORDER_ID | Client-generated unique ID for each transaction, used as a way to prevent the processing of duplicate transactions. The orderId must be unique to the merchant's SecureNet ID, but uniqueness is only evaluated for approved transactions and only for the last 30 days. If a transaction is declined, the corresponding orderId may be used again.
The orderId is limited to 25 characters; e.g., “CUSTOMERID MMddyyyyHHmmss”. |
PHONE | Phone number used to discuss any processing issues. |
PURCHASE_ORDER | Purchase order number associated with the transaction. |
REQUEST_TYPE | Type of the sent request. |
RETAIL_LANE_NUMBER | Lane number at which the transaction was completed in a retail environment. |
SECURE_NET_ID | SecureNet ID assigned by WorldPay. |
SERVER | Server number (used in restaurant transactions). |
STATE | State where address is located. Valid values are 2-character state abbreviations. |
STATUS | Tax status of the transaction. |
TAX_AMOUNT | Tax amount for the transaction. |
TOTAL_NUMBER_OF_INSTALLMENTS | Total number of installments. Required if transactionCategory is set as installment. |
TRANSACTION_DUPLICATE_CHECK_INDICATOR | Indicates how checks for duplicate transactions should behave. Duplicates are evaluated on the basis of amount, card number, and order ID; these evaluation criteria can be extended to also include customer ID, invoice number, or a user-defined field.
Possible values: 0 - No duplicate check 1 - Exception code is returned in case of duplicate 2 - Previously existing transaction is returned in case of duplicate 3 - Check is performed as above but without using order ID, and exception code is returned in case of duplicate The transactionDuplicateCheckIndicator parameter must be enabled in the Virtual Terminal under Tools->Duplicate Transactions. Duplicates are checked only for approved transactions. |
TRANSACTION_ID | Transaction ID of the completed payment. |
TYPE | Type of transaction.
Possible values:
|
TYPE_OF_GOODS | Type of goods that are being purchased.
Possible values:
|
VERIFICATION | Type of check verification that was used for the transaction. |
VERSION | Version number of the integrator's application. |
ZIP | 5- or 9-digit ZIP (or postal) code of the address. |
Name | Description |
---|---|
ADDITIONAL_AMOUNT | Remaining balance on a stored value account. |
AUTHORIZATION_CODE | Authorization approval code. |
AUTHORIZED_AMOUNT | The total authorized amount for the authorization request. If the Partial authorization flag is enabled, this amount may be less than the requested amount. |
AVS_CODE | Address verification code. Refer to the specification of the provider for additional information. |
AVS_RESULT | Address verification result.
Possible values:
|
CARD_CODE_CODE | Card security code result.
Possible values:
|
CARD_CODE_RESULT | Card security code result.
Possible values:
|
CARD_NUMBER | Last 4 digits of the credit card number.
Format: XXXXXXXXXXXX 3456. |
CREDIT_CARD_TYPE | Identifies the credit card type.
Possible values:
|
CUSTOMER_ID | Unique customer identifier. |
INDUSTRY_SPECIFIC_DATA | Industry-specific data for ecommerce and moto transactions.
For eCommerce transactions:
For Moto transactions:
|
LEVEL2_VALID | Indicates whether the credit card is level 2 eligible. |
LEVEL3_VALID | Indicates whether the credit card is level 3 eligible. |
MESSAGE | Text description of the response. |
METHOD | Transaction method.
Possible values:
|
NETWORK_CODE | Identifier for the network that returned the transaction response. |
PAYMENT_TYPE_CODE | Credit card or check type. Valid values can be found in the specification of the provider. |
PAYMENT_TYPE_RESULT | Transaction method.
Possible values:
|
REQUEST_DATE_TIME | Date and time of the sent request. |
RESPONSE_CODE | Response code for the method call. A value of 1 indicates the customer was created. |
RESPONSE_DATE_TIME | Date and time of the transaction response. |
RESPONSE_TEXT | Transaction approval status. |
RESULT | Result of the method call. |
SUCCESS | Customer result. |
SURCHARGE_AMOUNT | Surcharge amount to be added to the transaction. |
TRANSACTION_ID_RESPONSE | Transaction ID in the response to the transaction. |
TRANSACTION_TYPE | Type of the transaction. |
Name | Description |
---|---|
BIT11 | System Trace Audit Number (STAN). |
BIT12 | Transaction date and time. |
BIT22 | POS data code. |
BIT24 | Function code. |
BIT25 | Reason code.
The reason code identifying the decline. |
BIT28 | Reconciliation date. |
BIT29 | Reconciliation number. |
BIT3 | Processing code.
Submitted on all Canadian debit transactions to indicate the transaction type. |
BIT32 | Acquiring institution IC code. |
BIT37 | Retrieval reference number. |
BIT38 | Contains approval code for an approved transaction.
Note: If response code of the authorization is not equal to "AA" or “AP”, the content of this field is ignored. |
BIT4 | Total amount of the transaction. |
BIT41 | Card acceptor terminal identification. |
BIT42 | Card acceptor merchant ID. |
BIT43 | Card acceptor location name and address. |
BIT48 | Additional private data. |
BIT49 | Transaction currency code.
Represents transaction ISO currency code used in the foreign exchange rate message. |
BIT54 | Used to indicate a secondary “cashback” amount associated with the transaction. |
BIT60 | Reserved private data. |
BIT60 | Reserved private data. |
BIT60 | Reserved private data. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
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. |
MESSAGE_TYPE | ISO message type. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
Name | Description |
---|---|
BIT38_RESPONSE | Contains approval code for an approved transaction.
Note: If response code of the authorization is not equal to "AA" or “AP”, the content of this field is ignored. |
BIT39_RESPONSE | Action code. |
BIT4_RESPONSE | Transaction amount. |
BIT48_ELAVON_DATE_TIME | The Elavon Date and Time will be returned to the POS or partner host system in the event of an approval of a sale transaction. This data must be provided to the Elavon host in the event of a reversal of the aforementioned sale transaction. This sub-field must be populated irrespective of whether single or dual message processing is used. |
BIT48_ELAVON_RETRIEVAL_REF_NUMBER | The Elavon RRN field will be returned to the POS or partner host system in the event of an approval of a sale transaction. This data must be provided to the Elavon host in the event of a reversal of the aforementioned sale transaction. This sub-field must be populated irrespective of whether single or dual message processing is used. |
BIT48_ELAVON_STAN | The Elavon STAN will be returned to the POS or partner host system in the event of an approval of a sale transaction. This data must be provided to the Elavon host in the event of a reversal of the aforementioned sale transaction. This sub-field must be populated irrespective of whether single or dual message processing is used. |
BIT48_RESPONSE | Additional private data. |
BIT63_ACI | Reserved private data III.
Authorization characteristic indicator. |
BIT63_AVS_RESULT_CODE | Reserved private data III AVS result code. |
BIT63_BANK_NET_DATE | Reserved private data III. |
BIT63_CVV_RESULT_CODE | Reserved private data III CVV result code. |
BIT63_PRODUCT_ID | Reserved private data III.
Identification number of the purchased product. |
BIT63_RESPONSE | Reserved private data III. |
BIT63_STAN | System Trace Audit Number (STAN)
Unique number of transaction. This value should be unique on the partner’s host system within a 24 hour period. |
BIT63_TRACK_DATA_CONDITION_CODE | Reserved private data III.
Track data condition code. |
BIT63_TRAN_ID | Reserved private data III.
The code of the initial transaction. Provided by the processor. |
BIT63_UP_DATE_TIME | Reserved private data III. |
BIT63_UP_SETTLEMENT_DATE | Reserved private data III. |
BIT63_VALIDATION_CODE | Reserved private data III.
The CPS validation code returned on the original authorization response. |
Name | Description |
---|---|
AMOUNT1 | Amount of transaction.
Varies by transaction type. |
AMOUNT2 | Card balance after transaction.
Varies by transaction type. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
ENTRY_MODE | 0: Other;
1: Magnetic; 2: Manual; 3: Barcode; 4: Contact-less. Optional for G/G0. |
INDUSTRY_CODE | 1: Retail;
2: Restaurant. |
LOCATION_ID | Location identifier, assigned by processor.
4 digits zero-filled. The current server version accepts any number of digits here. |
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. |
MERCHANT_ID | Merchant identifier, assigned by processor.
7 digits zero-filled. The current server version accepts any number of digits here. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
TERMINAL_APP_VERSION | e.g., 2.6. |
TERMINAL_ID | Code identifying the balancing features available to the POS from the Host.
15 digits zero-filled. The first 11 digits duplicate the group and store IDs. |
TERMINAL_SERIAL_NUMBER | Serial number of the terminal.
e.g., 1008078745. |
TERMINAL_TYPE | e.g., O3750, Vx570, N8320, N8400, N8010, N2085. |
TEXT | Formatted OK or decline reason message.
Varies by transaction type. |
TIME_ZONE | e.g., EST, CST. |
TRACK2_FORMAT_CODE | 0 or omitted: Formatted by terminal; Nonzero: Raw data. |
TRANSACTION_CODE | 3 digits zero-filled. The current server version accepts any number of
digits here. |
Name | Description |
---|---|
AMOUNT1_RESPONSE | Optional response message from the processor about amount of transaction. |
AMOUNT2_RESPONSE | Optional response message from the processor about card balance after transaction. |
DECLINE_REASON | See table. Refer to the specification. |
RESULT_CODE | Contains a numeric bit that indicates one or many result messages.
501: Informational response. 502: Successful transaction. 503: Declined. |
TEXT_RESPONSE | Optional response message from the processor about the transaction status. |
TRANSACTION_ID | A six-digit pseudorandom number.
Reserved for future use. |
Name | Description |
---|---|
Identification code of the datawire. |
|
Digital number that represents the specific code of the product/service. |
|
Identification number of the used application. |
|
URL adresses. For example, E-commerce URL address. |
|
BIT11 | A system-generated number is provided by the merchant and it uniquely identifies a transaction. It is ―echoed‖ back to the merchant in the host response messages.
Note: System Trace Number cannot be repeated for another Terminal ID of the same merchant for the same day. |
BIT12 | This is the time stamp of the transaction, and as a Regulation E requirement it should be printed on the Debit Receipt given to a customer. It does not change on subsequent transactions (i.e., on debit reversals). |
BIT13 | For POS terminals sending credit card transactions, this code identifies the month and day a transaction is sent. It must be POS terminal time and match the printed receipt.
This is the date stamp of the transaction and, as a REG-E requirement; it should be printed on the Debit/EBT Receipt given to a customer. It does not change on subsequent transactions (i.e., debit reversal). |
BIT18 | A code that identifies the type of business or services conducted by the service establishment. |
BIT22 | This field specifies how the Primary Account Number was entered into the terminal. The code is comprised of the POS Entry Mode Value and the PIN Capability Value |
BIT24 | This field identifies the acquiring host. This code will be returned on the host response. |
BIT25 | This field describes the conditions at the POS location for a particular transaction. |
BIT3 | A required code is used in conjunction with the message type to define the type of transaction that is by the terminal to the host. |
BIT37 | Authorization only — For Credit and debit transactions (excluding Canadian Debit) the retrieval reference number can be any value based on the merchant‘s choosing (e.g. sequential tracking of transactions, fixed value etc.). The value submitted in the request message is then echoed back in response.
Authorization with capture — For Credit and debit transactions (excluding Canadian Debit), this is a unique 12-byte reference number assigned to a transaction by the merchant and returned in the response message. Capture Only – For Credit card transactions the retrieval reference number must be the same value that was submitted in the original authorization request. Canadian Debit — The POS terminal at the merchant‘s location generates the retrieval reference number and includes it in the transaction request. The host echoes the value back in the response. The terminal must ensure that the number is unique. Reversals — In a 0400 (Debit/Credit) reversal request message, the retrieval reference number does not have to match the original 0100 (Credit) and 0200 (Debit) request. This is applicable to all transaction type (Credit, Debit inclusive of Canadian Debit). |
BIT38 | The Authorization ID Response is the approval code assigned by the association, issuing bank, or Debit/EBT network. |
BIT39 | The host response to a message to indicate the status of the transaction. The value returned in the authorization response is submitted in the capture only transaction request. |
BIT4 | This field specifies the transaction amount, in the acquirer‘s currency. |
BIT41 | This field contains a code that identifies a merchant terminal. |
BIT42 | This field contains a code assigned to a merchant location. |
BIT48 | First Data uses field 48 to communicate elements not included in the ISO 8583 specification. |
BIT49 | Transaction Currency Code.
Can be used to specify the currency type associated with a transaction (e.g., 840=U.S. Dollar). Note : Conditional — Mandatory for "multi-currency" merchants, but optional for merchants who use U.S. currency only. |
BIT54 | This field contains amounts associated with the transaction. For Debit card (with exception of Debit Card PIN-Less transactions) and EBT Cash benefit transactions, this field represents the ―Cash Back‖ amount. On a 0400 (Debit/EBT) reversal message, this field must match the original 0200 (Debit/EBT) request. |
BIT59 | The merchant's postal/ZIP code must be left-justify and filled if less than 9 bytes. |
BIT60 | This field is comprised of the POS Type (first four bits) and the POS Capability (last four bits) data elements. The POS Type describes the general category of terminal used for the transaction. POS Capability describes the data entry methods available at the POS location. |
BIT7 | This code identifies the month, day, hour, minute, and second a transaction is sent (MMDDhhmmss). This must be represented in GMT or Universal time. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CLIENT_REF | Reference to the client. |
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. |
MESSAGE_TYPE | A code that defines the message type. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
SUB_REQUEST_CL | Enumeration of possible sub requests available in the system. |
TABLE60_ADDITIONAL_POS_INFO | MOTO/Bill Payment/Electronic-Commerce additional POS information. |
TRAN_ID | Terminal will send X‘20‘ (spaces) in initial authorization message.
Transaction Identifier back in the authorization response. |
Name | Description |
---|---|
ACI | Authorization Characteristics Indicator.
This field indicates the result of the Visa's evaluation of the authorization characteristics of a custom payment service transaction. |
APPROVED_AMOUNT | Returned with an amount less than the requested amount. |
AUTHORIZATION_CODE | Alphanumeric value assigned by the bank to a merchant sale or cash advance that has received specific approval. The code is used as proof that the transaction has been properly approved. |
AVS_RESPONSE_CODE | Address Verification Response.
One character code indicating the response of the Address Verification process. |
BANK_NET_DATE | Space-fill in the 0100 original authorization request message. The value received in the 0110 original authorization response, must be submitted in the 0100 incremental request & 0400 reversal message and capture only transaction request message. The Issuer will respond with the 4-byte BankNET Date (MMDD). |
BANK_NET_REFERENCE | Space-fill in the 0100 original authorization request message. The value received in the 0110 original authorization response, must be submitted in the 0100 incremental request & 0400 reversal message and capture only transaction request message. The Issuer will respond with the 9-byte BankNET Reference. |
CARD_LEVEL_RESPONSE_CODE | The Card Level Response Code field is required to be included in the Settlement records for Visa sale transactions that were electronically authorized. The Visa Compliance Table is sent in on the request message as a trigger to receive the Visa Compliance table in the response message. |
CVC_ERROR_CODE | Space-fill in authorization request message.
CVC Incorrect Indicator. An indicator, provided by the Issuer in the authorization response, to identify the presence of an invalid card verification code (CVC). If there is an error, the Issuer will respond with the 1-byte CVC Error Code (Y). |
CVV2_RESULT_CODE | The result code of CVV2 verification. |
DEBIT_NETWORK_ID | Applicable to Authorization only, and Authorization and Capture |
DS_ADDRESS_VERIFICATION_RESULT | Result of the mailing address verification. |
DS_NRID | Network ID.
Must match authorization response value. |
DS_PROCESSING_CODE | A required code is used in conjunction with the message type to define the type of transaction that is by the terminal to the host. |
DS_STAN | System trace audit number (STAN). |
DS_TRACK_DATA_CONDITION_CODE | Card Track Data Submitted at the Time of Auth. |
HOST_RESPONSE_TEXT | Text displayed on the terminal corresponds to the response code |
IS_PRIVATE_DATA_FIELD_RESPONSE_PRESENT | Indicates whether the private data field response is present in the request. |
MC | Data associated with MasterCard processing received from the processor. |
MERCHANT_ADVICE_CODE | A code associated with the reason a recurring payment transaction has been declined. |
MERCHANT_ADVICE_CODE | A code associated with the reason a recurring payment transaction has been declined. |
MERCHANT_ADVICE_CODE | A code associated with the reason a recurring payment transaction has been declined. |
MSDI | The value submitted for reversal and capture only request must mirror the value that was submitted in the 0100 initial authorization request. |
POS_DATA | Space-fill in authorization request message.
Only if the American Express Indicator on the authorization request message (0100) is an ―X‖, Amex CAPN POS Data field will be returned in the response (0110), otherwise zero-filled. |
POS_ENTRY_MODE_CHANGE | Space-fill in authorization request message. If the entry mode has changed, the Issuer will respond with the 1-byte POS Entry Mode Change (Y). |
RESPONSE_CODE | Indicates the status of the transaction. For details, refer to Bitmap 39 — Response Code on page 4-19. |
TABLE14_RESP | CPS/2000 Additional credit card Data.
Refer to the specification of the provider for more information. |
TABLE68_ACCOUNT_TYPE1 | Additional Account/Amount Information.
Type of account used.
|
TABLE68_ACCOUNT_TYPE2 | Additional Account/Amount Information.
Type of account used.
|
TABLE68_ACCOUNT_TYPE3 | Additional Account/Amount Information.
Type of account used.
|
TABLE68_ACCOUNT_TYPE4 | Additional Account/Amount Information.
Type of account used.
|
TABLE68_ACCOUNT_TYPE5 | Additional Account/Amount Information.
Type of account used.
|
TABLE68_ACCOUNT_TYPE6 | Additional Account/Amount Information.
Type of account used.
|
TABLE68_AMOUNT_TYPE1 | Additional Account/Amount Information
Type of specified amount.
|
TABLE68_AMOUNT_TYPE2 | Additional Account/Amount Information
Type of specified amount.
|
TABLE68_AMOUNT_TYPE3 | Additional Account/Amount Information
Type of specified amount.
|
TABLE68_AMOUNT_TYPE4 | Additional Account/Amount Information
Type of specified amount.
|
TABLE68_AMOUNT_TYPE5 | Additional Account/Amount Information
Type of specified amount.
|
TABLE68_AMOUNT_TYPE6 | Additional Account/Amount Information
Type of specified amount.
|
TABLE68_AMOUNT1 | Additional Account/Amount Information.
12 digits, with implied decimal relative to the currency code. In Auto-Substantiation transactions, this value reflects the qualified amount of the total purchase. For Discover (JCB (US Domestic only), and Diners) credit card cash disbursement transactions, this value reflects the cash portion of the total purchase amount. |
TABLE68_AMOUNT2 | Additional Account/Amount Information.
12 digits, with implied decimal relative to the currency code. In Auto-Substantiation transactions, this value reflects the qualified amount of the total purchase. For Discover (JCB (US Domestic only), and Diners) credit card cash disbursement transactions, this value reflects the cash portion of the total purchase amount. |
TABLE68_AMOUNT3 | Additional Account/Amount Information.
12 digits, with implied decimal relative to the currency code. In Auto-Substantiation transactions, this value reflects the qualified amount of the total purchase. For Discover (JCB (US Domestic only), and Diners) credit card cash disbursement transactions, this value reflects the cash portion of the total purchase amount. |
TABLE68_AMOUNT4 | Additional Account/Amount Information.
12 digits, with implied decimal relative to the currency code. In Auto-Substantiation transactions, this value reflects the qualified amount of the total purchase. For Discover (JCB (US Domestic only), and Diners) credit card cash disbursement transactions, this value reflects the cash portion of the total purchase amount. |
TABLE68_AMOUNT5 | Additional Account/Amount Information.
12 digits, with implied decimal relative to the currency code. In Auto-Substantiation transactions, this value reflects the qualified amount of the total purchase. For Discover (JCB (US Domestic only), and Diners) credit card cash disbursement transactions, this value reflects the cash portion of the total purchase amount. |
TABLE68_AMOUNT6 | Additional Account/Amount Information.
12 digits, with implied decimal relative to the currency code. In Auto-Substantiation transactions, this value reflects the qualified amount of the total purchase. For Discover (JCB (US Domestic only), and Diners) credit card cash disbursement transactions, this value reflects the cash portion of the total purchase amount. |
TABLE68_CURRENCY_CODE1 | Additional Account/Amount Information.
The 3-digit code defines the currency used in the amount field. |
TABLE68_CURRENCY_CODE2 | Additional Account/Amount Information.
The 3-digit code defines the currency used in the amount field. |
TABLE68_CURRENCY_CODE3 | Additional Account/Amount Information.
The 3-digit code defines the currency used in the amount field. |
TABLE68_CURRENCY_CODE4 | Additional Account/Amount Information.
The 3-digit code defines the currency used in the amount field. |
TABLE68_CURRENCY_CODE5 | Additional Account/Amount Information.
The 3-digit code defines the currency used in the amount field. |
TABLE68_CURRENCY_CODE6 | Additional Account/Amount Information.
The 3-digit code defines the currency used in the amount field. |
TABLE68_SIGN_AMOUNT1 | Additional Account/Amount Information.
|
TABLE68_SIGN_AMOUNT2 | Additional Account/Amount Information.
|
TABLE68_SIGN_AMOUNT3 | Additional Account/Amount Information.
|
TABLE68_SIGN_AMOUNT4 | Additional Account/Amount Information.
|
TABLE68_SIGN_AMOUNT5 | Additional Account/Amount Information.
|
TABLE68_SIGN_AMOUNT6 | Additional Account/Amount Information.
|
TRANSACTION_EDIT_ERROR_CODE | Space-fill in authorization request message. If there is an error, the Issuer will respond with the 1-byte Transaction Edit Error Code. |
VALIDATION_CODE | Space-filled for initial authorization message. The Issuer response will be sent for incremental authorizations and reversals. |
VPAS_RESPONSE_VALUE | VPAS (Visa Payer Authentication Service) response value. |
Name | Description |
---|---|
ACI | A code used to request qualification in the Custom Payment Service (CPS) program as defined by Visa. Upon evaluation, the code may be changed in the response message if provided by Visa. |
ADD_AMT_TYPE1 | Type of additional amount in the transaction. |
ADD_AMT_TYPE10 | Type of additional amount in the transaction. |
ADD_AMT_TYPE11 | Type of additional amount in the transaction. |
ADD_AMT_TYPE12 | Type of additional amount in the transaction. |
ADD_AMT_TYPE13 | Type of additional amount in the transaction. |
ADD_AMT_TYPE14 | Type of additional amount in the transaction. |
ADD_AMT_TYPE2 | Type of additional amount in the transaction. |
ADD_AMT_TYPE3 | Type of additional amount in the transaction. |
ADD_AMT_TYPE4 | Type of additional amount in the transaction. |
ADD_AMT_TYPE5 | Type of additional amount in the transaction. |
ADD_AMT_TYPE6 | Represents the type of additional amount in the transaction. |
ADD_AMT_TYPE7 | Type of additional amount in the transaction. |
ADD_AMT_TYPE8 | Type of additional amount in the transaction. |
ADD_AMT_TYPE9 | Type of additional amount in the transaction. |
ADD_AMT1 | Value for a single additional amount instance. |
ADD_AMT10 | Value for a single additional amount instance. |
ADD_AMT11 | Value for a single additional amount instance. |
ADD_AMT12 | Value for a single additional amount instance. |
ADD_AMT13 | Value for a single additional amount instance. |
ADD_AMT14 | Value for a single additional amount instance. |
ADD_AMT2 | Value for a single additional amount instance. |
ADD_AMT3 | Value for a single additional amount instance. |
ADD_AMT4 | Value for a single additional amount instance. |
ADD_AMT5 | Value for a single additional amount instance. |
ADD_AMT6 | Value for a single additional amount instance. |
ADD_AMT7 | Value for a single additional amount instance. |
ADD_AMT8 | Value for a single additional amount instance. |
ADD_AMT9 | Value for a single additional amount instance. |
ALT_MERCH_ID | Alternate identifier assigned to a merchant by FirstData Prepaid Closed Loop.
For additional information please contact your account representative. |
AM_EX_POS_DATA | Transaction specific data that is returned by American Express and required on subsequent transactions. |
AM_EX_TRAN_ID | A unique value up to 20 digits assigned by American Express, used to identify and link all related transactions for authorization and settlement through American Express. Contains the transaction identifier and validation code returned by American Express. |
AVS_BILLING_ADDR | Street address of the customer. Used to submit the street address of the cardholder when attempting to perform address verification. |
AVS_BILLING_POSTAL_CODE | ZIP (or postal) code of the cardholder. Used to submit ZIP (or postal) code of the cardholder when attempting to perform address verification. |
BANKNET_DATA | Data that is assigned by MasterCard, to every transaction that is processed through MasterCard‘s Banknet System. |
BILL_PYMT_TXN_IND | An identifier used to indicate the type of bill payment transaction. |
CARD_CAPT_CAP | Represents the terminal capability to capture the card data. |
CARD_TYPE | Identifier used to indicate the card type. |
CCV_ERROR_CODE | An error code that may be returned in response to the CCV data submitted at the time of authorization. |
CCV_IND | An identifier provided in the authorization request to indicate the presence or absence of CCV data on the card. |
CH_FIRST_NM | First name of the cardholder. |
CH_LAST_NM | Last name of the cardholder. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CUST_SVC_PHONE_NUMBER | Phone number, provided by the merchant, used to discuss any processing issues. |
DEST_CTRY_CODE | Country code of the location the item(s) in the purchase are being delivered to. |
DEST_POSTAL_CODE | ZIP (or postal) code of the location the item(s) in the purchase are being delivered to. |
DISC_NRID | The Network Result Indicator (NRID) assigned by Discover. |
DISC_POS_DATA | The specific POS capture conditions for the card information at the time of the transaction. |
DISC_POS_ENTRY | The entry mode provided to Discover for the transaction. |
DISC_PROC_CODE | Type of transaction sent to the card acceptor. |
DISC_RESP_CODE | The code assigned by Discover which indicates the status of the transaction. |
DISC_TRANS_QUALIFIER | Magnetic stripe conditions and the vulnerability to fraud for Discover card transactions. |
DISCNT_AMT | Discount amount for the purchase. |
DUTY_AMT | Duty amount for the purchase. |
EBT_TYPE | Identifies whether the EBT card is being used for Cashback transactions. |
ECOMM_TXN_IND | An indicator provided by the merchant to identify the security level of an Ecommerce transaction. In the following description, the term 3-D Secure refers to authentication programs such as Verified by Visa, MasterCard SecureCode and American Express Safekey (AESK). |
ECOMM_URL | URL of the site performing the Ecommerce transaction. |
FRGHT_AMT | Amount for freight included in the purchase. |
GROUP_ID | An ID assigned by First Data, to identify the individual merchant or group of merchants. |
LOCAL_DATE_TIME | Local date and time when the transaction is processed. |
MC_MSDI | Identifies the industry for which the transaction data applies (i.e. healthcare, bill payment, etc.). It must be provided when the transaction is being submitted for one of the categories listed in the Value Set, and has a payment type of Credit. |
MCSC | Multiple Clearing Sequence Count. Represents the total number of Completion transactions being submitted for a single previously approved Authorization transaction. |
MCSN | Multiple Clearing Sequence Number that represents the sequence number of the capture transaction. This field is used when there are multiple capture transactions for a single previously approved authorization transaction. |
MERCH_ID | Unique identifier assigned by FirstData used to identify the merchant within the system. |
MERCH_TAX_ID | Tax ID collected by the merchant for the transaction. |
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. |
MESSAGE_TYPE | Type of the message. |
MRKT_SPECIFIC_DATA_IND | Identifies the industry for which the transaction data applies (i.e. healthcare, bill payment, etc.). It must be provided when the transaction is being submitted for one of the categories listed in the Value Set, and has a payment type of Credit. |
ORDER_NUM | Number of the order assigned to the transaction.
The value must be numeric and contain no more than 8 bytes of data unless prior approval is provided by FirstData. |
ORIG_AUTH_ID | The Authorization ID of the response to the original message. |
ORIG_LOCAL_DATE_TIME | Local date and time of the original authorization transaction. |
ORIG_RESP_CODE | Response code returned in the original authorization response. |
ORIG_STAN | System Trace Audit Number (STAN) of the original transaction. |
ORIG_TRAN_DATE_TIME | Transmission date and time of the original transaction (in GMT/UTC). |
PART_AUTHRZTN_APPRVL_CAPABLT1 | An identifier used to indicate whether or not the terminal/software can support partial authorization approvals. Partial Authorization support is generally required for all Merchants in card-present environments in order to accommodate cardholder accounts where limited funds may be available (e.g. Debit or Open Loop Prepaid cards). Additionally, Merchant Aggregators and MOTO Merchants are required to support Partial Authorization approvals. Ecommerce merchants have the option to support Partial Authorization approvals and are strongly encouraged to do so.
Note: If a Merchant sends the Partial Authorization Approval Capability indicator of ― "0", when they were required to send the Partial Authorization Approval Capability indicator of ― "1", they will receive higher fees, interchange downgrades or possibly both. For more information, please contact your Account Representative. |
PAYEE_ID | Payee ID for the data being submitted for processing.
|
PAYEE_PHONE_NUM | The phone number of the payee (biller) as part of the data being submitted for processing. |
PC_ORDER_NUM | The reference number or order number to be reported as a part of the purchase card data. |
POS_COND_CODE | An identifier used to indicate the transaction condition at the POS. |
POS_ENTRY_MODE | An identifier used to indicate how the account number was entered on the transaction and the PIN entry capability of the POS (Point of Sale). |
POS_ENTRY_MODE_CHG | Identifies that POS entry mode was changed by the Issuer. |
POS_ID | Identifies the specific device or point of entry where the transaction originated. For example, pump number, lane number, etc. |
POSID | Identifies the specific device or point of entry where the transaction originated. For example, pump number, lane number, etc. |
POSID | Identifies the specific device or point of entry where the transaction originated. For example, pump number, lane number, etc. |
POSID | Identifies the specific device or point of entry where the transaction originated. For example, pump number, lane number, etc. |
POSID | Identifies the specific device or point of entry where the transaction originated. For example, pump number, lane number, etc. |
PROD_DESC | Description of an item purchased with the card. |
PROGRAM_ID | An identifier used by the merchant to designate the preferred authorizer for a prepaid card. |
PURCH_IDFR | Represents the data used by the merchant or customer to identify the purchase. This can be a SKU, code, or reference number. |
PYMT_TYPE | Payment type of the transaction. |
REF_NUM | Value assigned by a merchant to uniquely reference a transaction and any subsequent related transactions. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
REVERSAL_IND | Reason code of the transaction that is being reversed. |
SETTLE_IND | Identifies a type of settlement other than Host Capture. This field is not applicable for Host Capture merchants. If sent with a value of 1, then response messages will contain several fields that are normally not returned for host capture merchants, but are needed to build a PTS settlement file. Includes the merchant category code in common group for Debit, PINLess Debit, EBT, and Credit transactions. If the transaction is a MasterCard transaction, MasterCard POS Data in the MasterCard group will also be returned.
Note: Non host capture merchants are required to send the Settlement Indicator on all transactions, including transactions for which there will be no subsequent settlement, e.g. a Prepaid Closed Loop Load. |
SHIP_FROM_POSTAL_CODE | ZIP (or postal) code the item(s) in the purchase are to be shipped from. |
STAN | Number assigned by the merchant to uniquely reference the transaction. This number must be unique within a day per merchant ID and terminal ID. |
TAX_AMT | Amount of the tax included in the transaction. |
TAX_AMT_CAPABLT | An indicator that describes the capability of the terminal to prompt for the tax amount, and then handle the Commercial card type in the response message. |
TAX_IND | Identifies the taxable status of the transaction. |
TERM_CAT_CODE | An identifier used to describe the type of terminal being used for the transaction. |
TERM_ENTRY_CAPABLT | An identifier used to indicate the entry mode capability of the terminal. |
TERM_ID | Unique identifier assigned by FirstData to identify a terminal. |
TERM_LOC_IND | Indicates the location of the terminal. |
TPP_ID | Rapid Connect identifier assigned by FirstData for a specific version of vendor/merchant software. |
TPPID | Rapid Connect identifier assigned by FirstData for a specific version of vendor/merchant software. |
TPPID | Rapid Connect identifier assigned by FirstData for a specific version of vendor/merchant software. |
TPPID | Rapid Connect identifier assigned by FirstData for a specific version of vendor/merchant software. |
TPPID | Rapid Connect identifier assigned by FirstData for a specific version of vendor/merchant software. |
TRANS_ID | Unique value up to 20 digits assigned by Visa, used to identify and link all related transactions for authorization and settlement through Visa. Сontains transaction identifier and validation code. |
TRNMSN_DATE_TIME | Transmission date and time of the transaction (in GMT/UTC). |
TXN_AMT | Amount of the transaction inclusive of all additional amounts provided in the Additional Amounts Group or other amount fields, e.g. tax amount in Purchase Card L2 Group. It is submitted in the currency represented by the Transaction Currency field. The transaction amount returned in the response will be different than the amount submitted in the request for an approved partial authorization. |
TXN_CRNCY | Numeric currency code of the transaction amount. |
TXN_TYPE | Type of the transaction. |
UCAF_COLLECT_IND | Identifies whether the merchant supports MasterCard UCAF (secure code) data collection. |
Name | Description |
---|---|
ACI_RESPONSE | A code used to response qualification in the Custom Payment Service (CPS) program as defined by Visa. |
ADD_AMT_ACCT_TYPE1_RESPONSE | Additional amount account type returned in response messages. |
ADD_AMT_CRNCY1_RESPONSE | Response for numeric currency of the additional amount in the transaction. |
ADD_AMT_TYPE1_RESPONSE | Response for type of additional amount in the transaction. |
ADD_AMT1_RESPONSE | Response value for a single additional amount instance. |
ADDTL_RESP_DATA | Additional data that may be returned in an authorization response message. Could contain values that describe items such as the reason for a decline, the field in error, etc.
Note: сustomer should not code their application to the actual text in this field. |
ATH_NTWK_ID | Network ID as returned by the host, if available. |
ATH_NTWK_NM | Authorization network number. |
AUTH_ID | The value assigned by the authorizer and returned in the response to the authorization request. |
AVS_RESULT_CODE | The result of checking the cardholder‘s postal code and any additional address information provided against the Issuer‘s system of record. |
CARC | Visa-defined code to indicate card authentication results. |
CARD_CLASS | A value returned from the host that classifies the card usage. This value provides information about the card to the merchant. |
CAVV_RESULT_CODE | The result code to indicate the success or failure of a Visa Secure transaction. |
CCV_RESULT_CODE | The result code of the CCV verification. |
CH_FULL_NM_RES | A response field containing the result of checking the cardholder’s first name and last name. Returned in the response of a Discover AVS transaction where the fields cardholder first name and cardholder last name were submitted in the request. |
ERROR_DATA | A code and description returned in the response message that describes an error condition encountered when processing the transaction. |
MC_POS_DATA | Transaction specific data that may be returned in MasterCard response messages. For merchants that send settlement files directly to PTS, the values in this field would be sent in the XE02 PTS record for MasterCard transactions. |
MERCH_ADVICE_CODE | A code returned by the issuer, used to indicate the decline reason for a recurring transaction. |
PROC_IND | Identifies the transaction processing type as returned by MasterCard. |
RESP_CODE | Сode representing status of the transaction.
Note: If the message format is not valid then a RejectResponse message may be returned containing Error Data. |
RT_IND | Retail transaction indicator. |
SAFEKEY | The result code to indicate the success or failure of an American Express Safekey transaction. |
SERV_CODE | A three digit value contained in the track data. |
SIG_IND | Signature indicator. |
SOURCE_REASON_CODE | The source of the decision for the transaction. |
SPEND_Q_IND | Response only field representing an indicator that describes whether the transaction met the spend assessment threshold defined by Visa. |
STTLM_DATE | Date when the transaction will be settled. |
TAX_AMT_CAPABLT_RESPONSE | A response indicator that describes the capability of the terminal to prompt for the tax amount, and then handle the Commercial card type in the response message. |
TRAN_EDIT_ERR_CODE | Identifies the error encountered with the track data provided in the authorization request message. |
TRNMSN_DATE_TIME_RESPONSE | The transmission date and time of the transaction (in GMT/UTC) (from provider's response). |
TXN_AMT_RESPONSE | Response for transaction amount. |
XCODE_RESP | Represents the authorizing agent ID code as received from MasterCard. |
Name | Description |
---|---|
ACCOUNT_NUMBER | Account Number being paid.
This field is optional. When Tokenization is not available and encryption is allowed on the server, the field contains encrypted credit card number or bank account number. 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. |
ADDRESS_LINE1 | Mailing address of the cardholder (street line). |
BASE_AMOUNT | The original amount authorized. (Does NOT include convenience fee). |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CITY | City of the merchant's mailing address. |
CONV_FEE_AMOUNT | The amount of the convenience fee of this transaction (Can be $0.00) |
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. |
NAME_ON_CARD | Name of the cardholder written on the credit card. |
ORIGIN | The Origin to apply the payment to.
This field is provided by HPG Implementation. |
PHONE | Phone of the merchant's mailing address. |
REFERENCE | Not used by API, it is returned in the result information to assist with Async calls or tracking. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
STATE | State of the merchant's mailing address. |
TOTAL_AMOUNT | Total amount of authorization (including base amount and convenience fee amount). |
TRANSACTION_TYPE | Type of the original transaction. |
ZIP_CODE | ZIP code of the mailing address of the cardholder. Max 5 characters. |
Name | Description |
---|---|
AUTH_CODE | The authorization code sent from the CC Processor. |
AUTH_REFERENCE | The additional reference sent from the CC Processor. |
BASE_AMOUNT_AUTHORIZED | The original amount authorized. (Does NOT include convenience fee). |
CONV_FEE_AMOUNT_AUTHORIZED | The amount of the convenience fee of this transaction (Can be $0.00). |
FEE_AMOUNT | The amount of the convenience fee, can be 0.00. |
RESPONSE_CODE | Gateway generated response code.
0 – Success 100 – Failure |
RESPONSE_MESSAGE | Gateway generated response message.
A description of the response if there was an error. |
TOTAL_AMOUNT_AUTHORIZED | Total фmount of authorization (including base amount and convenience fee amount). |
UNIQUE_ID | Unique identifier for transaction.
This field is required for voids. |
Name | Description |
---|---|
AMOUNT | The amount element defines the amount of the transaction. Supply the value in cents without a decimal point.
|
AVS_ADDRESS | Street address for AVS verification. Review the Appendix of your acquirer, provided separately, to check how to format this parameter.
|
AVS_ZIP | ZIP Code for AVS verification. Review the Appendix of your acquirer, provided separately, to check how to format this parameter.
|
CHARGE_TRANSACTION_FK | Reference to the entity that represents transaction of type Sale.
|
CHARGE_TRANSACTION_FK | Reference to the entity that represents transaction of type Sale.
|
CHARGE_TRANSACTION_FK | Reference to the entity that represents transaction of type Sale.
|
COUNTRY_ID | ISO 3166 Country code (numeric) that indicates the country where the transaction took place.
|
CURRENCY_ID | ISO 4217 Currency code (numeric) that indicates the currency of the transaction.
|
DBA_CITY | Second part of dynamic descriptor. Check the Appendix of your acquirer, provided separately, to know how to format this parameter.
|
DBA_NAME | First part of dynamic descriptor. Check the Appendix of your acquirer, provided separately, to know how to format this parameter.
|
MEMBER_GUID | This value is provided by Payvision and is used to authenticate a merchant.
|
MEMBER_ID | This value is provided by Payvision and is used to authenticate a merchant.
|
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. |
MERCHANT_ACCOUNT_TYPE | This value represents the type of the merchant account that will be used to perform the transaction. Valid values are:
1 – E-Commerce 2 – Mail Order / Telephone order 4 - Recurring |
REQUEST_TYPE | Type of request from the client. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together.
|
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together.
|
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together.
|
TRACKING_MEMBER_CODE | This value is the order number or tracking code, it can contain any alphanumeric value with a maximum length of 100 chars. The value must be unique during 24 hours.
|
TRANSACTION_GUID | Guid obtained with an Authorize transaction.
|
TRANSACTION_ID | ID, obtained with an Authorize transaction.
|
Name | Description |
---|---|
BANK_APPROVAL_CODE | The specific code returned by the acquiring in the CDC field, indicating whetehr the transaction is approved or not.
|
BANK_CODE | The specific code returned by the acquiring in the CDC field.
|
BANK_MESSAGE | The specific code returned by the acquiring in the CDC field in text message.
|
CARD_GUID | Card Guid obtained during a RegisterCard operation
|
CARD_ID | Card identifier obtained during a RegisterCard operation
|
CVV_RESULT | A code that reflects the outcome of the CVV2/CVC2 check.
The CVV code must be sent for E-Commerce transactions. This field is optional depending on the merchant account. |
ERROR_CODE | Special code that identifies the type of occurred error.
|
ERROR_MESSAGE | Special text message from the provider about occurred error.
|
MESSAGE | Friendly message indicating the result of the card registration.
|
RESULT_CODE | This value indicates if the card was successfully registered or not. A 0 means OK, different than 0 means error.
The codes represent group of common errors, in some cases you will be able to obtain a detailed code in the CDC. |
TRANSACTION_DATE_TIME | UTC date and time in which the transaction was processed by Payvision.
|
Name | Description |
---|---|
ACCOUNT_NAME | Name of the account in the system. |
ACCOUNT_NUM | Bank account number. Required if adding bank account info as part of the signup. |
ACCOUNT_TYPE | Type of client's account. |
ADDR | Street address of the client. |
AMOUNT | Amount of the purchase. |
CARDHOLDER_NAME | Name of the credit card holder (owner). |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CITY | City of the client's address. |
COMMENT1 | Optional field. |
INV_NUM | Return of the value the client passed. |
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. |
RECURRING_PAYMENT | Inicates whether the payment is recurring. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
STANDARD_ENTRY_CLASS_CODE | Standart entry class code. |
STATE | If domestic signup this value MUST be one of the standard 2 character abbreviations. Rule also applies for Canadian signups. |
TRANS_NUM | The ProPay transaction identifier. |
TRANS_TYPE | Type of transaction. |
ZIP | ZIP (or postal) code of the address. |
Name | Description |
---|---|
AUTH_CODE | Issuer authorization code. |
AVS | Issuer returns AVS response. Most issuers approve even if mismatch, but you can turn around and void the transaction if unsatisfactory response is received. |
CONVERTED_AMOUNT | Returned on multi-currency transactions. Amount expressed in the currency of the merchant account. |
CONVERTED_CURRENCY_CODE | Converted currency code of the one used in the transaction. |
CURRENCY_CONVERSION_RATE | Returned on multi-currency transactions. Exchange rate of the currency conversion. |
CVV2_RESP | Issuer returns CVV2 response. Almost all issuers also decline if CVV mismatch. |
GROSS_AMT | Transaction Gross Amount. |
GROSS_AMT_LESS_NET_AMT | The resulting sum of both types of fee applied to this transaction. |
NET_AMT | Transaction Net Amount after ProPay applies fees. |
PER_TRANS_FEE | The ‘flat’ per transaction portion of the ProPay fee applied to this transaction. |
RATE | The percentage based fee applied to this transaction. |
RESP | Textual representation of the responseCode. |
RESPONSE_CODE | Issuer response code. |
RESPONSE_TRANS_NUM | Transaction number that comes in the response. |
STATUS | Status of the transaction. |
Name | Description |
---|---|
AMOUNT | The dollar amount of the transaction in DDDDDDDDDD.CC format. Must include Tip Amount, Tax Amount and Item Amounts. |
BILLING_CITY | The cardholder’s city. Used for Address Verification (AVS). Not required if using a CardToken. |
BILLING_COUNTRY | The cardholder’s country in 2-letter abbreviation (ex. US = United States). Not required if using a CardToken. |
BILLING_EMAIL_ADDRESS | The cardholder’s email address. Not required if using a CardToken. |
BILLING_PHONE | The cardholder’s contact phone. Not required if using a CardToken. Do not include hyphens or special characters. |
BILLING_POST_CODE | The cardholder’s postal/ZIP code. Used for Address Verification (AVS). Not required if using a CardToken. |
BILLING_STATE | The cardholder’s state. Used for Address Verification (AVS). Not required if using a CardToken. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CID | Your Spindle CID. This will be assigned to you. |
INVOICE_NUMBER | Your invoice number or identifying number to identify transaction. InvoiceNumber must be passed for all eCommerce or web based transactions. |
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. |
NAME_ON_CARD | 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. |
RESP_TRANSACTION_ID | The TransactionID of this sale request. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
SID | 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. |
TAX_AMOUNT | A value respresnting a tax amount. TaxAmount should be included in the Amount listed above. (ex. TipAmount + TaxAmount + ItemAmounts = Amount). |
TIP_AMOUNT | A value representing a tip amount. TipAmount should be included in the Amount listed above (ex. TipAmount + TaxAmount + ItemAmounts = Amount) |
TRANSACTION_TYPE | Type of held transaction (authorize, sale, capture, void, etc.). |
Name | Description |
---|---|
RESP_AMOUNT | The dollar amount that was refunded. |
RESP_AUTH_CODE | Authorization Code returned from the processing bank. |
RESP_RECEIPT_NUMBER | The receipt number for this SID. This number will increment by 1 for each transaction that is processed from this SID. |
RESP_STATUS_CODE | The status code of the transaction.
0 = Declined 1 = Approved 2 = Error |
RESP_STATUS_MESSAGE | Detailed message of the status code sent back through the response. |
RESP_TRANSACTION_ID | The TransactionID of this sale request. |
RESP_TRANSACTION_KEY |
Name | Description |
---|---|
ACCOUNT_TYPE | Type of account. See specification of the processor for more information about available account types. |
ADDITIONAL_AMOUNT_FIELD | Cashback amount for ATM/debit, EBT cash benefit and check transactions or convenience fee for quasi-cash merchants. |
APPLICATION_TYPE | Type of application used for the transaction. |
AUTHORIZATION_CODE | Returned from authorizing network for pre-auth and sale requests. Echoed from request for all others. |
BATCH_NUMBER | Generated by terminal application whenever a new batch is opened. New batches should be based on the current date and current batch count number. |
CARD_HOLDER_ID_METHOD | Method used to identify the cardholder:
|
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CUSTOMER_ADDRESS | Street address associated with customer account. |
CUSTOMER_ZIP_CODE | ZIP/postal code of the address associated with customer account. |
DEVICE_IDENTIFIER | Immidiately follows the terminal identification field and allows to utilize the same terminal identification number for locations with multiple terminals. Must be uniques for each POS terminal and should be 00 for standalone POS terminals. |
EBT_AUTHORIZATION_CODE | EBT authorization code.
Offline EBT approval data. Required for all EBT voice authorized transactions. |
EBT_VOUCHER_NUMBER | EBT voucher number.
Offline EBT approval data. Required for all EBT voice authorized transactions. |
ENTRY_METHOD | Reports how the specific transaction was submitted. |
LOCAL_TRANSACTION_DATE | Default transaction date (YYMMDD). During the settlement upload it must contain the value returned in the original authorization response if the transaction was authorized online, if not - it must contain a POS device generated date. |
LOCAL_TRANSACTION_TIME | Default transaction time in 24-hour format (HHMMSS). During the settlement upload it must contain the value returned in the original authorization response if the transaction was authorized online, if not - it must contain a POS device generated date. |
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. |
MESSAGE_NUMBER | Message sequence number.
Should increment by one for each terminal message so that a unique number is generated for each authorization request, regardless of outcome of the transaction. Terminal software should validate that the message sequence number in the response matches message sequence number in the request. This number must be reset to the starting value of 0001 after reaching the maximum value of 9999. |
MISCELLANEOUS_MERCHANT_ID | Invoice/order number for credit, debit and EBT transactions.
ACH processing. Required for ACH transactions. |
MOTO_ECOMMERCE_FLAG | Indicates the type of industry. |
OVERRIDING_SIC_CODE | Overriding SIC code. |
PARTIAL_AUTHORIZATION_SUPPORT | Indicates whether terminal support partial authorization responses. |
PROCESSING_TYPE | Type of transaction processing.
Two types are available:
|
REQUEST_TYPE | Type of request. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
RETRIEVAL_BILLABLE_EVENT_DATA | Retrieval data format. |
SEQUENCE_NUMBER | Numeric, generated by the terminal application. Two types are available:
|
SIC_OVERRIDE_FLAG | Indicates what type of SIC is used. Two values are available:
Y - Override existing SIC; N - Use existing SIC code. |
TERMINAL_IDENTIFICATION | Comprised of a:
These numbers are assigned by WorldPay. The terminal identification number in the host response must match the terminal identification in the host request message for the transaction to be valid. |
TERMINAL_INPUT_CAPABILITIES | Describes tha highest level of transaction input the terminal is capable of. |
TOTAL_AMOUNT | Amount including any cashback requested. |
TRAN_TYPE_IDENTIFIER | Transaction type identifier.
Credit data. Only returned on credit transactions. |
TRANSACTION_CODE | Type of processed transaction. |
Name | Description |
---|---|
ACTION_CODE | Response code of the processor. |
ADDITIONAL_RECEIPT_DATA | Additional receipt data returned from the host is varied depending on the transaction type. |
AMOUNT_OF_CASH_BACK_AUTHORIZED | Amount of cashback authorized.
Debit data. Only returned on ATM or debit transactions. |
AUTH_SOURCE | This value is used to indicate the source for the authorization response. |
AVS_RESULT_CODE | AVS result code. See the specification of the processor for more information. |
CASH_ACCOUNT_BALANCE | Available amount of cash on the cardholder's account.
EBT data. Only returned on EBT transactions. |
CREDIT_ACI_AUTHORIZATION_CHARACTERISTICS_INDICATOR | Credit ACI authorization characteristics indicator (VISA only).
Credit data. Only returned on credit transactions. |
DEBIT_BALANCE | Debit data. Only returned on ATM or debit transactions. |
FCS_NUMBER | EBT data. Only returned on EBT transactions. |
FOOD_ACCOUNT_BALANCE | Food account balance.
EBT data. Only reurned on EBT transactions. |
PURCHASE_CARD_INDICATOR | Purchase card indicator. Five values are available:
Credit data. Only returned on credit transactions. |
RESPONSE_LITERAL | Response message from the processor generated by the gateway. |
RETRIEVAL_DATA | Various retrieval data. See specification of the processor for more information. |
TOTAL_AMOUNT_AUTHORIZED | For ATM, debit, EBT and check transactions:
Includes any casback amount specified in the request, but does not include fee amount charged to the customer. For terminals supporting partial authorization: May be less than the originally requested amount. |
UCAF_CAVV_RESULT_CODE | UCAF/CAVV result code. See the specification of the processor for more information. |
VALIDATION_CODE | Validation code (VISA only). |
Name | Description |
---|---|
API_KEY | The value of this parameter is assigned to you by Merchant Warrior. |
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. |
MERCHANT_UUID | The value of this parameter is assigned to you by Merchant Warrior. |
Name | Description |
---|---|
RESPONSE_CODE | A signed integer which allows the quick identifiication of the response status. The value of this parameter is sent by Merchant Warrior.
There are three possible types of Response Code’s that can be returned: 1. < 0. - MWV validation error. 2. = 0. - Command was successful. 3. > 0. - Command failed due to nonvalidation error. |
RESPONSE_MESSAGE | This field contain a textual string which offers more information on the specific response received. |
Name | Description |
---|---|
Credit card number. |
|
ACCOUNT_TYPE | Type of an account. |
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. |
TRANSACTION_AMOUNT | The amount of transaction. |
Name | Description |
---|---|
BRAND | A brand of a bank card used by a merchant. Includes: Visa, MasterCard, American Express, Diners, Discover. |
CALCULATED_ADJUSTMENT_ADJUSTMENT | Calculated adjustment for the card number submitted. |
CALCULATED_ADJUSTMENT_CAP | Maximum calculated adjustment for the card number submitted. Function of transaction amount. Potentially used for receipt display purposes. |
CALCULATED_ADJUSTMENT_FIXED | Fixed fee used to calculate adjustment for the card number submitted. Not applicable to interchange based calculations. |
CALCULATED_ADJUSTMENT_RATE | Rate used to calculate adjustment for the card number submitted. Not applicable to interchange based calculations. |
CATEGORY | A type of a bank card used by a merchant. Includes: debit, consumer, rewards, business and international. |
MAXIMUM_ADJUSTMENT_ADJUSTMENT | Maximum calculated adjustment. Applicable only when PaymentVehicleType=CARD. |
MAXIMUM_ADJUSTMENT_CAP | Maximum adjustment - function of transaction amount. Applicable only when PaymentVehicleType=CARD. Potentially used for receipt display purposes. |
MAXIMUM_ADJUSTMENT_FIXED | Fixed fee used to calculate maximum adjustment. Applicable only when PaymentVehicleType=CARD. Not applicable to interchange based calculations. |
MAXIMUM_ADJUSTMENT_RATE | Rate used to calculate maximum adjustment. Applicable only when PaymentVehicleType=CARD. Not applicable to interchange based calculations. |
MINIMUM_ADJUSTMENT_ADJUSTMENT | Minimum calculated adjustment. Applicable only when PaymentVehicleType=CARD. |
MINIMUM_ADJUSTMENT_CAP | Minimum adjustment - function of transaction amount. Applicable only when PaymentVehicleType=CARD. Potentially used for receipt display purposes. |
MINIMUM_ADJUSTMENT_FIXED | Fixed fee used to calculate minimum adjustment. Applicable only when PaymentVehicleType=CARD. Not applicable to interchange based calculations. |
MINIMUM_ADJUSTMENT_RATE | Rate used to calculate minimum adjustment. Applicable only when PaymentVehicleType=CARD. Not applicable to interchange based calculations. |
REGULATED_DEBIT_ADJUSTMENT_ADJUSTMENT | Calculated adjustment of a regulated debit card. |
REGULATED_DEBIT_ADJUSTMENT_CAP | Maximum adjustment of a regulated debit card. Function of transaction amount. Potentially used for receipt display purposes. |
REGULATED_DEBIT_ADJUSTMENT_FIXED | Fixed fee used to calculate adjustment of a regulated debit card. Not applicable to interchange based calculations. |
REGULATED_DEBIT_ADJUSTMENT_RATE | Rate used to calculate adjustment for a regulated debit card. Not applicable to interchange based calculations. |
Name | Description |
---|---|
ACCOUNT_NAME | Name of the ProPay account. |
ACCOUNT_NUMBER_MASKED | Masked account number of the client. |
ACCOUNT_OWNERSHIP_TYPE | Required if adding bank account info as part of the signup. Valid values are ‘Personal’ or ‘Business’ If accountType is G, then this value is always overwritten as ‘Business’. |
ACCOUNT_TYPE | Type of account from which funds are being pulled. Valid values are “Savings” or “Checking”. |
ADDR | Address of the user. |
ADDR3 | Physical address of the user. |
APT_NUM | Either aptNum or addr2. Do not supply both for this field. Refer to the cpecification of the processor for more information. |
BANK_NAME | Name of the issuing bank. |
BUSINESS_ADDRESS | Business address of the user. |
BUSINESS_ADDRESS2 | Address (line 2) of the business address. |
BUSINESS_COUNTRY | Country code of the business address. |
BUSINESS_STATE | State code of the business address of the client. |
BUSINESS_ZIP | ZIP (or postal) code of the business address. If domestic signup this value MUST be either 5 or 9 characters with no dash. For Canada this value MUST be 6 characters. |
CITY | City address of the user. |
COUNTRY | Country code of the business address. |
CURRENCY_CODE | Code of the currency used in the transaction. |
DAY_PHONE | Day phone used for iscussing any processing issues. If domestic or Canadian signup this value must be 10 characters with no dash. |
DESCRIPTION | Description of bank account. ‘Personal’ or ‘Business’. |
DOB | The date of birth of the user.
mm-dd-yyyy. The person must be at least 18 years old to obtain an account. |
DOING_BUSINESS_AS | Merchant's DBA ("Doing Business As") name. |
EVEN_PHONE | Evening phone number for discussing any processing issues. If domestic or Canadian signup this value must be 10 characters with no dash. |
EXP_DATE | Expiration date of the credit card used in the transaction. |
EXTERNAL_ID | External identification number of the account. One of the optional account identification values. |
FIRST_NAME | First name of the ProPay account holder. |
INTL_ID | Omit unless specially instructed by ProPay. |
LAST_NAME | Last name of the ProPay account holder. |
MAIL_ADDR | Mailing address of the user. |
MAIL_ADDR3 | Mailing address values will override user address for shipping a debit card. |
MAIL_CITY | City mailing address of the user. |
MAIL_STATE | State code of the mailing address of the user. |
MAIL_ZIP | ZIP (or postal) code of the mailing address of the user. If domestic signup this value MUST be either 5 or 9 characters with no dash. For Canada this value MUST be 6 characters. |
MCC_CODE | Merchant category code. |
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. |
MINITIAL | Title of the customer. |
PAYMENT_METHOD_ID | Used to pay for an account via a ProtectPay Payment Method ID. Valid value is a GUID. |
PHONE_PIN | Numeric value which will give access to your user to ProPay’s IVR system. Also used to reset password if you forget your login. |
PORTFOLIO_CODE | Code of the portfolio associated with the record. |
PROVISIONING_TRANSACTION_FK | Reference to the entity taht represents information about provisioning transaction. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together. |
ROUTING_NUMBER_MASKED | Masked routing number of the bank account. |
SECONDARY_ACCOUNT_NAME | Required if adding secondary bank account info as part of the signup. This will become the account to which proceeds of transactions are sent in split sweep functionality. |
SECONDARY_ACCOUNT_TYPE | Required if adding secondary bank account info as part of the signup. Valid values are ‘Checking’, ‘Savings’, or simply ‘C’ or ‘S’. ‘G’ must be passed for GL accounts. This will become the account to which proceeds of transactions are sent in split sweep functionality. |
SOURCE_EMAIL | Omit unless specially instructed by ProPay. |
STATE | State of the physical address of the user. |
TIER | The type of ProPay account owned by this user. Your ProPay affiliation will have pre-defined tiers available to it. |
USER_ID | Unique identifier of the ProPay user. |
ZIP | ZIP (or postal) code o the client's address. |
Name | Description |
---|---|
ACCNT_NUM | Identifier of the account assigned by a processor. |
ERROR_CODE | Code of the error message generated by the procesor. |
ERROR_MESSAGE | Error message generated by a processor. |
STATUS | Status of the transaction. |
Name | Description |
---|---|
ACCOUNT_TYPE | Contains the type of account. Valid values are Checking or Savings.
|
ADDRESS1 | The first line of the consumer’s address. The Address1 can be up to 200 alpha-numeric characters and can include the following: "#" , " - " , " : " , " ; ". |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHARGE_TRANSACTION_FK | Reference to the entity that represents real-time financial transaction. |
CHECK_AMOUNT | The amount of the check.
|
CITY | The city of the consumer’s address. |
CODE | Contains the text message with the Authorization Number if the transaction was Approved or additional information if the transaction was not approved.
|
COMPANY_NAME | The consumer company's name. |
CUSTOM1 | This is the optional element that can contain up to 50 alpha numeric
characters. |
DL_NUMBER | Contains the consumer’s driver’s license number. |
DL_STATE | The consumer’s driver’s license state or province code. |
DOB_YEAR | Contains the date of birth of the consumer. The date of birth must be 4 numeric characters begin with either 19 or 20. |
FIRST_NAME | The first name of the consumer which can be up to 100 alpha characters.
|
IDENTIFIER | Contains a value that identifies the packet being sent as an Authorization, Void, Override or Payroll transaction. The identifier is a single alpha character.
(A=Authorize, V=Void, O=Override, P=Payroll, R=Recurring, F=Reversal) |
LAST_NAME | The last name of the consumer which can be up to 100 alpha characters. |
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. |
PHONE_NUMBER | The contact phone number of the consumer.
Required for PPD, CCD, TEL and WEB transactions, optional for POP and Check21 transactions. |
REQUEST_ID | Contains a unique user defined ID to identify the authorization gateway request. The Request ID will be returned in the Authorization Gateway
response. |
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together.
|
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together.
|
RETAIL_TRANSACTION_CYCLE_FK | Reference to the entity that represents a group of real-time transactions which must be settled together.
|
SSN4 | Contains the last four digits of the consumer’s social security number. The SSN4 must be 4 numeric characters.
|
STATE | The state or province of the consumer’s address. |
TERMINAL_ID | Contains the ID for the Terminal. The Terminal ID will be numeric and be six digits.
Unique to each “virtual terminal” used. Provided by GETI at time of terminal approval. |
TRANSACTION_ID | An optional element that contains a unique user defined ID to identify the transaction. The Transaction ID will be returned in the Authorization Gateway response.
|
ZIP | The ZIP code of the consumer’s address.
|
Name | Description |
---|---|
CODE | Contains the text message with the Authorization Number if the transaction was Approved or additional information if the transaction was not approved.
|
MESSAGE | Contains additional text information about the transaction. |
RESPONSE_TYPE | Contains an identifier to aid in determining the transaction result. |
RESPONSE_TYPE_TEXT | The full text description of the response type identifier. |
RESULT_CODE | Contains a numeric bit that indicates one or many result messages. Examples of result messages are Approved, Decline, or Unpaid Check Limit Exceeded. |
TYPE_CODE | Contains a numeric bit that indicates one or many type messages. Examples of type messages are Personal Check, Business Check, or Voided Check |
Name | Description |
---|---|
AMOUNT | |
BALLOT | |
BILL_ADDRESS | |
BILL_CITY | |
BILL_COUNTRY | |
BILL_PHONE_NUMBER | |
BILL_STATE | |
BILL_ZIP_CODE | |
CARDHOLDER | |
CURRENCY_CODE | |
MERCHANT | |
PROC_CODE | |
SHIP_ADDRESS | |
SHIP_CITY | |
SHIP_COUNTRY | |
SHIP_PHONE_NUMBER | |
SHIP_STATE | |
SHIP_ZIP_CODE | |
SITE_IP_ADDRESS | |
TERMINAL | |
TRACKING |
Name | Description |
---|---|
AUTHORIZATION_NUMBER | |
BALLOT_NUMBER | |
DATE | |
REFERENCE_NUMBER | Unique identifier of the transaction. Generated by the gateway. |
RESPONSE_CODE | |
TIME |