Form Fields - Appendix A – Transaction Fields

4. Appendix A – Transaction Fields

4.1 Form Fields

The following table provides an alphabetical list of all of the possible values that will be recognized by the system when sent in an HTML form. This table specifies which fields and which values are needed for each of the different connection types.

Legend

Method D Direct

R Redirect

U Update Link

Flow I Input

O Output

Presence M Mandatory

O Optional

C Conditional

CONFIDENTIAL AND PROPRIETARY © 2013, Total System Services, Inc. All rights reserved worldwide. Total System Services, Inc.® and TSYS are federally registered service marks of Total System Services, Inc., in the United States. Total System Services, Inc., owns a number of service marks that are registered in the United States and in other countries. All other products and company names are trademarks or registered trademarks of their respective companies.

Page 51 of 72 authorization request. This will be the amount right justified with leading zeroes, with the

D/R/U I M PurchaseCurrencyExponent N(1) Purchase Currency no. of decimals. Valid values are 0, 2, 3

D/R/U I/O M OrderID AN(150) The transaction ID of the order that uniquely identifies the transaction in the merchant‟s system.

10.

D/R/U I/O C Signature AN(28) The hash value that is produced using either MD5 or SHA1 hash algorithm on the fields described earlier. The produced value is the value calculated either by the merchant if it is incoming or by the system if it is outgoing.

Since the result of the Hash is an array of bits, the system will expect the value to be transmitted using Base-64 encoding, making a 28 character string. In case a response is in error, or declined, the Signature might not be present.

11.

D/R/U I/O O SignatureMethod AN(4) Either MD5 or SHA1 is the valid values in the current release. Default value if not present is SHA1

12.

D/R I/O O TestFlag A(5) Valid values are :

“True”: Current message is a test message.

“False”: Default Value if not present.

This is only used if the merchant is in the

“NORM”, live mode and it is available in order to cater for any future testing required by the merchant.

Page 52 of 72 from either batch file or through the Merchant Admin site. If not present, system will use the selected option from the database. Make a note that if the Merchant is set to “NEW”, then the system will ignore the fields as all appears on the back of his/her card.

17.

D/R I/O C TransactionStain AN(28) In case 3-D Secure process took place prior to linking into SENTRY, this field is required to send a 3-D Secure authorization request to the payment systems. In case SENTRY has performed 3-D Secure authentication, this field will be returned back in the response to to send a 3-D Secure authorization request to the payment systems. In case SENTRY has performed 3-D Secure authentication, this field will be returned back in the response to the merchant.

19.

D/R I/O C AuthenticationResult A(1) In case 3-D Secure process took place prior to linking into SENTRY, this field is required to send a 3-D Secure authorization request to the payment systems. In case SENTRY has performed 3-D Secure authentication, this field will be returned back in the response to the merchant.

Valid values are “Y”, “N” or “A”. If value is “N”, authorization will not take place and process is terminated. If the value is “Y”, authorization will proceed and result of the authorization is

Page 53 of 72 20.

D/R I/O C CAVVValue AN(28) In case 3-D Secure process took place prior to linking into SENTRY, this field is required to send a 3-D Secure authorization request to the payment systems. In case SENTRY has performed 3-D Secure authentication, this field will be returned back in the response to the merchant.

21.

D/R/U O C ResponseCode N(1) Indicates the result of the transaction. The result can be an approval, decline, or error.

22.

D/R/U O C ReasonCode N(3) This is a code that can give you more information about the transaction, such as what particular error occurred.

23.

D/R/U O C ReasonCodeDesc AN(100) This is a text string that will briefly explain the type of response encountered

24.

D/R O C AuthCode AN(6) A valid Authorization Code in case transaction was approved. according the card used, i.e. it can be 11, 13, 16, 19 or 25 characters. not supplied and field is set as required in the Payment Form, system will ask the customer to complete it and SENTRY will return it back in the response.

30.

D/R I/O C ShipToLastName AN(30) If field is supplied, then SENTRY will display the contents in the Payment form. If field is not supplied and field is set as required in the Payment Form, system will ask the customer to complete it and SENTRY will return it back in the response.

31.

D/R I/O D ShipToMiddleName AN(30) If field is supplied, then SENTRY will display the contents in the Payment form. If field is not supplied and field is set as required in the Payment Form, system will ask the customer to complete it and SENTRY will return it back in the response.

32.

D/R I/O C ShipToAddress1 AN(50) If field is supplied, then SENTRY will display the contents in the Payment form. If field is not supplied and field is set as required in the Payment Form, system will ask the customer to complete it and SENTRY will return it back in the response.

Page 54 of 72 33.

D/R I/O C ShipToAddress2 AN(50) If field is supplied, then SENTRY will display the contents in the Payment form. If field is not supplied and field is set as required in the Payment Form, system will ask the customer to complete it and SENTRY will return it back in the response.

34.

D/R I/O C ShipToCity AN(30) If field is supplied, then SENTRY will display the contents in the Payment form. If field is not supplied and field is set as required in the Payment Form, system will ask the customer to complete it and SENTRY will return it back in the response.

35.

D/R I/O C ShipToState AN(2) If field is supplied, then SENTRY will display the contents in the Payment form. If field is not supplied and field is set as required in the Payment Form, system will ask the customer to complete it and SENTRY will return it back in the response.

36.

D/R I/O C ShipToCountry N(3) If field is supplied, then SENTRY will display the contents in the Payment form. If field is not supplied and field is set as required in the Payment Form, system will ask the customer to complete it and SENTRY will return it back in the response.

37.

D/R I/O C ShipToPostCode AN(10) If field is supplied, then SENTRY will display the contents in the Payment form. If field is not supplied and field is set as required in the Payment Form, system will ask the customer to complete it and SENTRY will return it back in the response.

38.

D/R I/O C ShipToCounty AN(15) If field is supplied, then SENTRY will display the contents in the Payment form. If field is not supplied and field is set as required in the Payment Form, system will ask the customer to complete it and SENTRY will return it back in the response.

39.

D/R I/O C ShipToEMail AN(100) If field is supplied, then SENTRY will display the contents in the Payment form. If field is not supplied and field is set as required in the Payment Form, system will ask the customer to complete it and SENTRY will return it back in the response.

40.

D/R I/O C ShipToTelephone N(20) If field is supplied, then SENTRY will display the contents in the Payment form. If field is not supplied and field is set as required in the Payment Form, system will ask the customer to complete it and SENTRY will return it back in the response.

41.

D/R I/O C ShipToFax N(20) If field is supplied, then SENTRY will display the contents in the Payment form. If field is not supplied and field is set as required in the Payment Form, system will ask the customer to complete it and SENTRY will return it back in the response.

Page 55 of 72 42.

D/R I/O C ShipToMobile N(20) If field is supplied, then SENTRY will display the contents in the Payment form. If field is not supplied and field is set as required in the Payment Form, system will ask the customer to complete it and SENTRY will return it back in the response.

43.

D/R I/O C BillToFirstName AN(30) If field is supplied, then SENTRY will display the contents in the Payment form. If field is not supplied and field is set as required in the Payment Form, system will ask the customer to complete it and SENTRY will return it back in the response.

44.

D/R I/O C BillToLastName AN(30) If field is supplied, then SENTRY will display the contents in the Payment form. If field is not supplied and field is set as required in the Payment Form, system will ask the customer to complete it and SENTRY will return it back in the response.

45.

D/R I/O D BillToMiddleName AN(30) If field is supplied, then SENTRY will display the contents in the Payment form. If field is not supplied and field is set as required in the Payment Form, system will ask the customer to complete it and SENTRY will return it back in the response.

46.

D/R I/O C BillToAddress1 AN(50) If field is supplied, then SENTRY will display the contents in the Payment form. If field is not supplied and field is set as required in the Payment Form, system will ask the customer to complete it and SENTRY will return it back in the response.

47.

D/R I/O C BillToAddress2 AN(50) If field is supplied, then SENTRY will display the contents in the Payment form. If field is not supplied and field is set as required in the Payment Form, system will ask the customer to complete it and SENTRY will return it back in the response.

48.

D/R I/O C BillToCity AN(30) If field is supplied, then SENTRY will display the contents in the Payment form. If field is not supplied and field is set as required in the Payment Form, system will ask the customer to complete it and SENTRY will return it back in the response.

49.

D/R I/O C BillToState AN(2) If field is supplied, then SENTRY will display the contents in the Payment form. If field is not supplied and field is set as required in the Payment Form, system will ask the customer to complete it and SENTRY will return it back in the response.

50.

D/R I/O C BillToCountry N(3) If field is supplied, then SENTRY will display the contents in the Payment form. If field is not supplied and field is set as required in the Payment Form, system will ask the customer to complete it and SENTRY will return it back in the response.

Page 56 of 72 51.

D/R I/O C BillToPostCode AN(10) If field is supplied, then SENTRY will display the contents in the Payment form. If field is not supplied and field is set as required in the Payment Form, system will ask the customer to complete it and SENTRY will return it back in the response.

52.

D/R I/O C BillToCounty AN(15) If field is supplied, then SENTRY will display the contents in the Payment form. If field is not supplied and field is set as required in the Payment Form, system will ask the customer to complete it and SENTRY will return it back in the response.

53.

D/R I/O C BillToEMail AN(100) If field is supplied, then SENTRY will display the contents in the Payment form. If field is not supplied and field is set as required in the Payment Form, system will ask the customer to complete it and SENTRY will return it back in the response.

54.

D/R I/O C BillToTelephone N(20) If field is supplied, then SENTRY will display the contents in the Payment form. If field is not supplied and field is set as required in the Payment Form, system will ask the customer to complete it and SENTRY will return it back in the response.

55.

D/R I/O C BillToFax N(20) If field is supplied, then SENTRY will display the contents in the Payment form. If field is not supplied and field is set as required in the Payment Form, system will ask the customer to complete it and SENTRY will return it back in the response.

56.

D/R I/O C BillToMobile N(20) If field is supplied, then SENTRY will display the contents in the Payment form. If field is not supplied and field is set as required in the Payment Form, system will ask the customer to complete it and SENTRY will return it back in the response.

Page 57 of 72 contains order detail fields, set the flag to “Y”.

If value is not present, “N” is assumed. The order details can be used by the merchant to display an itemized Invoice/Order on the Checkout Page in case the Payment Processor supports this feature. The current version will store the order details and displaying them during checkout, but it will not display the related information on the Merchant Administration site. Order details are not returned back on the response from

“Y”. If not present, “N” will be assumed.

67.

Page 58 of 72 69.

D/R I O ItemQuantityN N(3) N a value from 1 to 10, i.e. ItemQuantity1 to ItemQuantity10. This will contain the number of items for the specific product

70.

D/R I O ItemUnitPriceN N(12) N a value from 1 to 10, i.e. ItemUnitPrice1 to ItemUnitPrice10. This will contain the price for this product. This will be right justified with leading zeroes, with the decimals implied based on PurchaseCurrency and PurchaseCurrencyExponent.

71.

D/R I O ItemTotalPriceN N(12) N a value from 1 to 10, i.e. ItemTotalPrice1 to ItemTotalPrice10. This will contain the total price for the product. This will be right justified with leading zeroes, with the decimals implied based on PurchaseCurrency and PurchaseCurrencyExponent.

72.

D/R I O ShippingCost N(12) This is the cost for shipping the current order.

This will be right justified with leading zeroes, with the decimals implied based on contains additional detail fields, set the flag to

“Y”. If value is not present, “N” is assumed.

The additional details can be used by the merchant to store extra fields not supported by default. Contact your Payment Processor if this functionality is available. The additional fields are not returned back and in current security Number) and field 12 will be set to FieldDescription12=Passport No

Page 59 of 72 79.

U I O CustomerCode AN(17)

80.

U I O IssueDate N(8) The date the ticket was issued.

Format YYYYMMDD 81.

U I O TravelAgencyCode AN(8)

82.

U I O TravelAgencyName AN(25)

83.

U I O TicketNumber AN(60)

84.

U I O IssuingCarrier AN(4)

85.

U I O TotalFare N(12) This will be the amount right justified with leading zeroes, with the decimals implied based on the purchase currency.

86.

U I O TotalFees N(12) This will be the amount right justified with leading zeroes, with the decimals implied based on the purchase currency.

87.

U I O TotalTax N(12) This will be the amount right justified with leading zeroes, with the decimals implied based on the purchase currency.

88.

U I O NationalTax N(12) This will be the amount right justified with leading zeroes, with the decimals implied based on the purchase currency.

Page 60 of 72 89.

D/R I O BitMapSIn N(4) This is a bitmap of the optional fields that are included in the signature that the Merchant sends. It can be used to enhance the security level for the particular function (signature verification for the transaction request). The default Signature includes all the Mandatory Fields plus the OrderID, PurchaseAmt and numbers next to each field. For example if the Signature has the Password, MerID, AcqID, PurchaseAmt, CardNo and CardCVV2, then the signature bitmap would be 1 + 16 + 64 = 83

In the above example the string that will be hashed to produce the signature will contain the compalsury fields concatenated with PurchaseAmt&CardNo&CardCVV2 in this

In document SENTRY Payment Gateway (Page 50-61)