SecureNet Docs

91
SecureNet Gateway API Implementation Guide Version 4.1.1. - 05.17.2011 NOTE YOU MUST HAVE A SECURENET DEMO ACCOUNT ESTABLISHED PRIOR TO WORKING WITH THIS API. Wells Fargo is providing the enclosed SecureNet API (the "API") that includes technical information to assist you with your development efforts for the purpose of connecting to the SecureNet gateway. The enclosed API was prepared and is provided by SecureNet, and Wells Fargo assumes no responsibility for the content. In addition, please note that the API may address certain features of functionality of the SecureNet gateway services that Wells Fargo is not authorized or able to provide to you. Again, Wells Fargo assumes no responsibility for the API, including with respect to functionality and services that Wells Fargo is not authorized or able to provide to you. If you have questions, we recommend that you contact Wells Fargo Merchant Services Implementation Manager Chris Civitello at [email protected] before you begin your development efforts.

description

Old Docs

Transcript of SecureNet Docs

Page 1: SecureNet Docs

SecureNet Gateway API

Implementation Guide Version 4.1.1. - 05.17.2011

NOTE

YOU MUST HAVE A SECURENET DEMO ACCOUNT ESTABLISHED PRIOR TO WORKING WITH THIS API.

Wells Fargo is providing the enclosed SecureNet API (the "API") that includes technical information to assist you with your development efforts for the purpose of connecting to the SecureNet gateway. The enclosed API was prepared and is provided by SecureNet, and Wells Fargo assumes no responsibility for the content. In addition, please note that the API may address certain features of functionality of the SecureNet gateway services that Wells Fargo is not authorized or able to provide to you. Again, Wells Fargo assumes no responsibility for the API, including with respect to functionality and services that Wells Fargo is not authorized or able to provide to you.

If you have questions, we recommend that you contact Wells Fargo Merchant Services Implementation Manager Chris Civitello at [email protected] before you begin your development efforts.

Page 2: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

2

Table of Contents

2. Gateway .......................................................................................................................................................... 10

2.1. What is the Gateway? .............................................................................................................................. 10

2.2. Service Based Authorization Process ....................................................................................................... 10

2.3. How does the Gateway work? .................................................................................................................. 10

2.4. What is required to implement the Gateway? .......................................................................................... 10

3. Gateway Implementation ................................................................................................................................. 11

3.1. Service and SOAP Overview ..................................................................................................................... 11

3.2. Authorization Components ...................................................................................................................... 12

3.2.1. Request ............................................................................................................................................ 12

3.2.2. Response .......................................................................................................................................... 12

3.3. Gateway Service Request Definition ........................................................................................................ 12

4. Gateway Request ............................................................................................................................................. 13

4.1. Standard Payment Transactions ............................................................................................................. 14

4.1.1. Transaction Request Object Summary ............................................................................................. 14

4.1.2. Transaction Request Object Specification ......................................................................................... 15

4.1.2.1. TRANSACTION ......................................................................................................................... 15

4.1.2.2. MERCHANT_KEY – REQUIRED FOR ALL TRANSACTIONS ...................................................... 16

Page 3: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

3

4.1.2.3. CARD ........................................................................................................................................ 16

4.1.2.4. CHECK ....................................................................................................................................... 17

4.1.2.5. CUSTOMER_BILL ..................................................................................................................... 18

4.1.2.6. CUSTOMER_SHIP .................................................................................................................... 19

4.1.2.7. ENCRYPTION ........................................................................................................................... 20

4.1.2.8. LEVEL2 ..................................................................................................................................... 20

4.1.2.9. LEVEL3 ..................................................................................................................................... 21

4.1.2.10. LEVEL3PRODUCT .................................................................................................................... 22

4.1.2.11. MPI ........................................................................................................................................... 23

4.1.2.12. AUTO ....................................................................................................................................... 23

4.1.2.13. PETROLEUM ............................................................................................................................ 24

4.1.2.14. HOTEL ...................................................................................................................................... 24

4.1.2.15. PRODUCT................................................................................................................................. 25

4.1.2.16. RESTAURANT SERVICE ........................................................................................................... 25

4.1.2.17. USERDEFINED ......................................................................................................................... 26

4.1.3. Transaction Request Message Format ............................................................................................. 26

4.1.3.1. Credit Card, Debit Card, EBT, and Stored Value Card Transactions .......................................... 26

4.1.3.2. Electronic Check Transactions .................................................................................................. 29

Page 4: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

4

4.2. SecureNet Vault/Tokenization Transactions ............................................................................................. 31

4.2.1. Transaction Vault Object Summary ................................................................................................. 32

4.2.2. Transaction Vault Object Specification ............................................................................................ 32

4.2.2.1. TRANSACTION_VAULT .......................................................................................................... 32

4.2.2.2. ACCOUNT_VAULT .................................................................................................................... 33

4.2.2.3. CUSTOMER_VAULT .................................................................................................................. 33

4.2.2.4. OPERATIONPARAMETERS ...................................................................................................... 34

4.3. AutoBill Transactions ............................................................................................................................... 34

4.3.1. PLAN_AB Object Summary ............................................................................................................. 34

4.3.2. PLAN_AB Object Specification .........................................................................................................35

4.3.2.1. PLAN_AB ..................................................................................................................................35

4.3.2.2. OPTIONS ...................................................................................................................................35

4.3.2.3. INSTALLMENT ......................................................................................................................... 36

4.3.2.4. RECURRING .............................................................................................................................. 37

4.3.2.5. PAYMENT_AB .......................................................................................................................... 38

4.2.1. 4.3.3. PLAN_AB Message Format .................................................................................................... 38

4.4. Settlement Transactions .......................................................................................................................... 39

4.5. Reporting API Services ............................................................................................................................. 39

Page 5: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

5

5. Gateway Response .......................................................................................................................................... 40

5.1. GATEWAYRESPONSE ............................................................................................................................. 41

5.1.1. GATEWAYRESPONSE Object Summary .......................................................................................... 41

5.1.2. GATEWAYRESPONSE Object Specification .................................................................................... 41

5.1.2.1. ABRESPONSE .......................................................................................................................... 42

5.1.2.2. TRANSACTIONRESPONSE ...................................................................................................... 42

5.1.2.3. VAULTACCOUNTRESPONSE .................................................................................................. 45

5.1.2.4. VAULTCUSTOMERRESPONSE ................................................................................................ 46

5.2. Response objects for Settlement Transactions ....................................................................................... 47

5.2.1. BATCHDATA Object Summary ....................................................................................................... 47

5.2.2. BATCHDATA Object Specification ................................................................................................... 47

5.2.2.1. BATCHDATA ............................................................................................................................ 47

5.2.2.2. BATCHDETAIL ......................................................................................................................... 47

5.2.3. BATCHDATA Message format ......................................................................................................... 48

6. Overview of Gateway Methods ....................................................................................................................... 49

6.1. Methods available through https://certify.securenet.com/API/Gateway.svc or

https://gateway.securenet.com/API/Gateway.svc ................................................................................... 49

6.1.1. Methods for Standard Payment Transactions .................................................................................. 49

Page 6: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

6

6.1.2. Methods for Vault Transactions ....................................................................................................... 50

6.1.3. Methods for AutoBill Transactions ................................................................................................... 52

6.1.4. Methods for Settlement Transactions ...............................................................................................53

6.2. Reporting API methods for Batch and Transaction Services, available through:

https://certify.securenet.com/api/data/transaction.svc or

https://gateway.securenet.com/api/data/transaction.svc ............................................................................53

6.3. Reporting API methods for SecureNet Vault and AutoBill Services, available through:

https://certify.securenet.com/api/data/service.svc or or https://gateway.securenet.com/api/data/service.svc

................................................................................................................................................................ 54

7. Appendix ......................................................................................................................................................... 55

7.1. ACDI ........................................................................................................................................................ 55

7.2. AVS_RESULT_CODE ............................................................................................................................... 55

7.3. CARD_CODE_RESPONSE_CODE ............................................................................................................ 56

7.4. CARDLEVEL_RESULTS ........................................................................................................................... 56

7.5. CAVV_RESPONSE_CODE ........................................................................................................................ 57

7.6. CARDTYPE Codes .................................................................................................................................... 58

7.7. DCI ........................................................................................................................................................... 58

7.8. INDUSTRYSPECIFICDATA ....................................................................................................................... 59

7.9. METHOD ................................................................................................................................................. 59

Page 7: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

7

7.10. ORDERID ................................................................................................................................................ 59

7.11. REF_TRANSID ......................................................................................................................................... 60

7.12. RESPONSE_CODE ................................................................................................................................... 60

7.13. SECCODE ................................................................................................................................................ 60

7.14. Transaction Type Table ............................................................................................................................ 61

7.15. SOFTDESCRIPTOR ................................................................................................................................. 66

7.16. TRACKDATA ........................................................................................................................................... 67

7.17. TRANSACTION_SERVICE ........................................................................................................................ 69

7.18. Product Codes for Petroleum Industry Transactions ................................................................................ 69

7.19. Developer Notes .......................................................................................................................................70

7.19.1. Sample Code ....................................................................................................................................70

7.19.1.1. Standard Payment Transaction - C# ..........................................................................................70

7.19.1.2. SecureNet Vault Transactions - C# ............................................................................................ 71

7.19.2. Some best practices for SecureNet API implementation ................................................................... 77

7.19.3. Test Data ........................................................................................................................................... 77

7.19.4. Fault exceptions ................................................................................................................................78

7.19.5. API Error Codes .................................................................................................................................78

7.19.6. How to Contact Technical Support ................................................................................................... 91

Page 8: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

8

Page 9: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

9

1. Introduction

Payment Gateways facilitate electronic commerce by enabling merchants to accept credit cards and electronic checks as methods of payment for goods and services sold. The Gateway acts as a bridge between the merchant's website/terminal and the financial institutions that process payment transactions. Payment data is collected from the shopper and submitted to the Gateway for real-time authorization. Authorization is the process of checking the validity and available balance of a customer's credit card before the transaction can be accepted. To authorize a given credit card transaction, the Gateway transmits the transaction information to the appropriate financial institutions for validation, then returns the response (approved or declined) from the institution to the merchant or customer. The payment Gateway supports real-time and offline requests for credit card authorization. The Gateway also supports electronic check transactions. Merchants can collect customer bank account numbers and routing numbers to pay for purchases. This document describes how transactions can be submitted to the Gateway for real-time processing. The Gateway is the recommended integration method for merchants who have the capability to initiate both client and server-side SSL connections. This method offers the merchant a high degree of security and control because transaction data is submitted to the Gateway over a secure server-to-server connection, initiated by the merchant server. Since the merchant server will receive a response directly from the Gateway, the merchant has more control over the response to the end customer.

Page 10: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

10

2. Gateway

2.1. What is the Gateway? The Gateway is the recommended method of submitting transactions. This method allows merchant’s server to securely connect directly to the payment Gateway to submit transaction data. The merchant retains full control of the payment data collection and the user experience. This method requires merchants to be able to initiate and manage secure Internet connections. 2.2. Service Based Authorization Process Payment authorization utilizes a standards-based Simple Object Access Protocol (SOAP) interface over a Hyper Text Transfer Protocol (HTTP) connection to exchange information. 2.3. How does the Gateway work? When using the Gateway, transactions flow in the following way:

1. The customer’s program has a reference to the Gateway Service and connects securely to the merchant’s server to transmit payment information.

2. The merchant’s server initiates a secure connection to the Gateway and creates the objects as described. It then initiates a “ProcessTransaction” function by passing the TRANSACTION object along with required data to the Gateway server.

3. The payment Gateway receives and processes the TRANSACTION object. 4. The payment Gateway generates the GATEWAYRESPONSE object and submits it to the merchant’s

server. 5. The merchant’s server receives and processes the GATEWAYRESPONSE object. 6. Finally, the merchant’s server communicates the success (or failure) of the authorization to the

customer’s web browser or program. 2.4. What is required to implement the Gateway? Merchants must be able to perform the following functions in order to submit transactions to the Gateway:

1. Establish a secure socket connection. 2. Provide both server and client-side encryption. 3. Develop code on a web server for the integration to the Gateway utilizing the Gateway service (e.g.,

for submitting transaction data object and receiving and translating system response object). 4. Securely store a transaction key to be accessed by the script that submits the transaction to the

Gateway.

Page 11: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

11

3. Gateway Implementation This guide explains how to integrate SecureNet into your website or application to process credit card or electronic check transactions over SecureNet’s payment gateway. Transactions could be submitted to the Gateway for processing through an https POST, as an XML request, as a web-service SOAP message, and using a WCF service. 3.1. Service and SOAP Overview The Gateway has implemented WCF (Windows Communication Foundation) as an underlying technology to support server-to-server authorization capabilities. WCF Services are applications with logic and functions, which are accessible and reusable by means of standard Internet protocols and XML data formats. The WCF service interface is defined in terms of the XML messages that the service accepts and generates. Applications consuming WCF Services can be implemented on any platform in any programming language, as long as they can create and consume messages defined for the service interface. The Gateway has adopted Simple Object Access Protocol (SOAP) as the solution for initiating RPC-based authorization requests. SOAP is a lightweight protocol intended for exchanging structured information in a distributed environment. The protocol uses XML technologies to define an extensible messaging framework to provide a message construct that can be exchanged over a variety of underlying protocols. The framework has been designed to be independent of any particular programming model or language, platform, and other implementation-specific semantics. To implement the Gateway service, a developer would design a script that performs the following: 1. Securely obtain all the information needed to process a transaction.

2. Create a program to consume the Gateway service.

URL for Live merchant accounts: https://gateway.securenet.com/api/Gateway.svc URL for Test merchant accounts: https://certify.securenet.com/api/Gateway.svc

Note: The SecureNet Gateway will only accept transactions on port 443. This request object will include all system variables mentioned in the tables below.

3. Receive and process the response from the Gateway to display the appropriate result to the end-user.

Page 12: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

12

3.2. Authorization Components

An authorization consists of the following: 3.2.1. Request Authorization Request Objects sent to Gateway for processing. One authorization can be sent per request to Gateway. Batch authorizations are not supported. 3.2.2. Response Authorization Response Objects sent to the Merchant as a response to each Authorization Request. 3.3. Gateway Service Request Definition The following is the method signature for the ProcessTransaction service: [ServiceNamespace].GatewayClient Client = new [ServiceNamespace].GatewayClient(“[ServiceBinding]”) oG = Client.ProcessTransaction(oT); Client.Close(); Client: WCF service object oT: TRANSACTION object oG: GATEWAYRESPONSE object ProcessTransaction is initiating Authorization Process.

Page 13: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

13

4. Gateway Request The objects submitted to the Gateway are shown below. Parameters for each object are described in this document.

Standard Payment Transactions Object Name Description Restrictions TRANSACTION The parameters defined in the tables below are assigned

to the instance of this serialized object and passed to the web method “ProcessTransaction” to complete an authorization.

All restrictions as defined in the Request Object Specs apply.

SecureNet Vault/Tokenization Transactions Object Name Description Restrictions ACCOUNT_VAULT Contains account information for a specific customer

within the SecureNet Vault. Must be enabled to use the SecureNet Vault.

CUSTOMER_VAULT Contains customer information for a specific customer within the SecureNet Vault.

Must be enabled to use the SecureNet Vault.

OPERATIONPARAMETERS

This object is used to specify operation type (Add, Update, or Delete).

Must be enabled to use the SecureNet Vault.

TRANSACTION_VAULT Used to process a SecureNet Vault transaction. Must be enabled to use the SecureNet Vault.

AutoBill Transactions

Settlement Transactions

Reporting API Services

Object Name Description Restrictions PLAN_AB

This object defines the information that can be submitted to the Gateway for AutoBill transaction processing.

Must be enabled to use AutoBill.

INSTALLMENT This object contains information on Customer’s installment plan.

Must be enabled to use AutoBill.

RECURRING This object contains information on Customer’s recurring payment plan.

Must be enabled to use AutoBill.

PAYMENT_AB This object contains individual payment information, like amount, payment id, installment date, etc.

Must be enabled to use AutoBill.

Object Name Description Restrictions MERCHANT_KEY This object is used to verify merchant before processing

any transaction and is required for any operation. Required for CloseBatch method.

Object Name Description Restrictions MERCHANT_KEY This object is used to verify merchant before processing any

transaction and is required for any operation. Required for all Reporting API methods except GetABAccount.

PLAN_AB

This object defines the information that can be submitted to the Gateway for AutoBill transaction processing.

Required for GetABAccount method.

Page 14: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

14

4.1. Standard Payment Transactions

4.1.1. Transaction Request Object Summary This section outlines the various high level sections within the Transaction Request Object.

TRANSACTION This object defines the information that can be submitted to the Gateway for real-time transaction processing.

MERCHANT_KEY This object is used to verify merchant before processing any transaction and is required for any operation.

CARD Card payment object contains card information, like card number, expiration date, and can be any of the following: Credit Card, Check Card, Debit Card, Stored Value Card.

CHECK Check payment object is required for electronic check transactions and contains information on corresponding checking or savings account.

CUSTOMER_BILL This object contains customer’s billing information, like billing address and telephone number, and is required for all E-Commerce transactions.

CUSTOMER_SHIP This object contains customer’s shipping information, like name and address.

ENCRYPTION For later use.

LEVEL2

Object used for Level 2 data. Level 2 transactions normally involve corporate cards issued from a U.S. bank. Transactions that qualify for Level 2 processing cost the merchant less than Level 1 transactions. To qualify for Level 2, a transaction must be passed with: merchant name, transaction amount, date, tax amount, customer code, merchant postal code, tax identification, merchant minority code, and merchant state code.

LEVEL3

Object used for Level 3 data. Of the 3 different levels of credit card processing, Level 3 provides the lowest transaction processing rate. But, in order to qualify for the lowest rate, Level 3 transactions must be passed through the processing system with much more detailed transaction information than Level 1 or 2 transactions. Because so much information must be transmitted, not all terminals are equipped to process Level 3 transactions. Purchases that qualify as Level 3 transactions generally are made with government credit card or corporate cards.

MPI Merchant Plug-in Indicator for 3D Secure Transactions.

AUTO This object is used for Rental industry only and includes rental-related information, like city rented and returned in, rental and return times, etc.

PETROLEUM This object is used for Petroleum industry only and includes information, like number of gallons, unit price, etc.

HOTEL This object is used for Hotel industry only and includes information, like check-in, check-out times, room rate, etc.

PRODUCTS Array of PRODUCT objects containing individual product information, like product description, amount, quantity, etc.

SERVICE This object is used for the Restaurant industry and contains gratuity amount and server number.

USERDEFINED

Object containing 50 user defined fields. Allows merchants to store additional data along with transaction information and to view/manage it through the Virtual Terminal. For example, instead of storing shipping information in merchant’s system, a merchant may prefer to send it to the gateway along with transaction and do reports on it later.

SECONDARY_MER-CHANT_KEY

Object used to verify secondary merchant.

TRANSACTION

MERCHANT_KEY

CARD

CHECK

CUSTOMER_BILL

CUSTOMER_SHIP

ENCRYPTION

LEVEL2

LEVEL3

AUTO

PETROLEUM

HOTEL

PRODUCTS

SERVICE

USERDEFINED

MPI

SECONDARY_MER-CHANT KEY

Page 15: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

15

4.1.2. Transaction Request Object Specification This section details high-level Transaction Request Object specification. Descriptions, rules, and notes for each object of the Transaction Request are detailed below. 4.1.2.1. TRANSACTION This object defines information that can be submitted to the Gateway for real-time transaction processing.

XML Tag Data Type / Max Length

Required Notes

<TRANSACTION> Object / 1

<MERCHANT_KEY> Object / 1 True Please see Transaction Request Object Summary

<CARD> Object / 1 Required if METHOD =

CC, PD, DB, SV, or EBT Please see Transaction Request Object Summary

<CHECK> Object / 1 Required if METHOD =

ECHECK or CHECK21 Please see Transaction Request Object Summary

<CUSTOMER_BILL> Object / 1 Required for E-

Commerce transactions

Please see Transaction Request Object Summary

<CUSTOMER_SHIP> Object / 1 False Please see Transaction Request Object Summary

<ENCRYPTION> Object / 1 False Please see Transaction Request Object Summary

<LEVEL2> Object / 1 False Please see Transaction Request Object Summary

<LEVEL3> Object / 1 False Please see Transaction Request Object Summary

<AUTO> Object / 1 Specific to Industry Please see Transaction Request Object Summary

<PETROLEUM> Object / 1 Specific to Industry Please see Transaction Request Object Summary

<HOTEL> Object / 1 Specific to Industry Please see Transaction Request Object Summary

<PRODUCTS> Object Array False Please see Transaction Request Object Summary

<SERVICE> Object / 1 Specific to Industry Please see Transaction Request Object Summary

<USERDEFINED> Object / 1 False Please see Transaction Request Object Summary

<SECONDARY_MERCHANT_KEY>

Object / 1 False Please see Transaction Request Object Summary

</TRANSACTION>

Page 16: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

16

4.1.2.2. MERCHANT_KEY – REQUIRED FOR ALL TRANSACTIONS This object is used to verify merchant before processing any transaction and is required for any operation.

XML Tag Data Type/ Max Length

Required Notes

<MERCHANT_KEY>

<GROUP_ID> Integer / 15 False SecureNet Group ID. Not applicable to all merchants, should be provided by SecureNet. Please contact us for more information.

<SECURENETID> Integer / 8 True 7-digit unique SecureNet ID provided by SecureNet to identify the merchant and is required for each submitted transaction. If you don’t have your SecureNet ID – please contact us.

<SECUREKEY> String / 50 True Case-sensitive unique SecureKey is associated with corresponding SecureNet ID, used to authenticate the merchant and is required for each submitted transaction.

<ADDITIONALINFO> String / 250 Required if METHOD=EB

T

For EBT transactions only. String format: 11 (EBT indicator) followed by a 7-digit FNS number (left-justified, space-filled, if FNS is less than 7 digits).

</MERCHANT_KEY>

4.1.2.3. CARD Card payment object contains card information, like card number, expiration date, and can be any of the following: Credit Card, Check Card, Debit Card, or Stored Value Card.

XML Tag Data Type / Max Length

Required Notes

<CARD>

<CARDCODE> String / 4 Required for all E-commerce and MOTO transactions. May also be manually keyed-in for Retail transactions for added security and lower interchange rate.

A code that is printed on the back of a card. Used as partial assurance that the card is in the buyer’s possession. This code is 3 digits long for Visa, MasterCard, and Discover, and 4 digits long for American Express. Not required but could be used for securing credit card transactions by means of card security code validation. If card security code data is submitted, the issuer verifies whether the number matches the number assigned to the card.

<CARDNUMBER> String / 24 Required for Card-Not-Present transactions and manually keyed-in transactions, when TACKDATA is not present. Full card number is required for AUTH_ONLY, PARTIAL_AUTH_ONLY, AUTH_CAPTURE, PARTIAL_AUTH_CAPTURE, CAPTURE_ONLY, CREDIT_AUTHONLY, FORCE_CREDIT, FORCE_CREDIT_AUTHONLY, VERIFICATION, AUTH_INCREMENT, ISSUE, ACTIVATE, REDEEM, REDEEM_PARTIAL, DEACTIVATE, REACTIVATE, and INQUIRY_BALANCE transactions.

Card number, 16 digits long for Visa, MasterCard and Discover, 15 digits long for American Express. This value may not contain spaces, non-numeric characters, or dashes.

Page 17: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

17

Last 4 digits of the card number are required for PRIOR_AUTH_CAPTURE, VOID, PARTIAL_VOID, CREDIT, CREDIT_PRIORAUTHCAPTURE, and FORCE_CREDIT_PRIORAUTHCAPTURE transactions. Not required when processing transactions for stored customer records.

<EXPDATE> String / 4 Required for Card-Not-Present transactions and manually keyed-in transactions, when TACKDATA is not present.

A valid card expiration date, which is not in the past. Format: MMYY

Example: 1012 represents November 2012.

<KSN> String / 19 Required if METHOD = DB Debit Only – Unaltered KSN Number from PIN pad.

<PINBLOCK> String / 16 Required if METHOD = DB Debit Only – PinBlock from PIN pad.

<TRACKDATA> String / 200 Required for Card-Present Credit Card transactions, Pin Debit transactions, and EBT (Not Voucher Clear) transactions.

This field contains information encoded from a valid magnetic stripe. It includes information such as Primary Account Number and Expiration Date. Please see Appendix for more information.

<ADDITIONALINFO> String / 250 Required if METHOD= EBT and Transaction Type Code=0300 (CAPTURE_ONLY) for Voucher Clear Transactions.

00 – Future use. No credit card account verification, default* 01 –Future use. Credit card account verification* 11 followed by a 15-character long left-justified

space-filled EBT Voucher number.** 02 – Updates the EXPDATE of credit card during

ProcessTransaction by Customer ID, if expiration date supplied is a future date for the PaymentID.

* - Applicable only when adding a new Account to the SecureNet Vault. ** - For EBT Voucher Clear transactions only.

</CARD> 4.1.2.4. CHECK Check payment object is required for electronic check transactions and contains information on corresponding checking or savings account.

XML Tag Data Type / Max Length

Required Notes

<CHECK>

<ABACODE> String / 9 True A 9-digit value representing Bank Routing/ABA Number to identify the Bank.

Page 18: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

18

<ACCOUNTNAME> String / 50 True Account Holder Name. If left blank – will default to Customer Name from CUSTOMER_BILL object. If Customer Name is blank – an error will be returned.

<ACCOUNTNUM> String / 17 True Indicated the Account Number to be charged for the transaction, an all-numeric value.

<ACCOUNTTYPE> String / 8 True Type of Bank Account, i.e. Savings, Checking, Business (for corporate accounts).

<BANKNAME> String / 50 True Name of Account Holders’ Bank.

<CHECKNUM> String / 20 Required if SECCODE is BOC, POS, or ARC

Check Number

<MICRDATA> String / 400 False MICR Data Read from Check reader

<SECCODE> String / 3 True ACH Transaction Classification. The Standard Entry Class (SEC) code is a three letter code that identifies the nature of the ACH entry, like: PPD, WEB, TEL, etc. Please see Appendix.

<ADDITIONALINFO> String / 250 Used only for METHOD = ECHECK

00 – No check verification, default 01 – Check verification with Certegy* 02 – Pre-Note with ACH Provider.** * - Merchant should be enabled with Certegy, please contact SecureNet for more information. For Transaction Type Code 0000 (AUTH_ONLY), or 0100 (AUTH_CAPTURE) data will be sent for processing only if check verification returns an APPROVED status from Certegy. If Transaction Type Code is 0700 (VERIFICATION) data will be sent to Certegy for check verification ONLY, no transaction will be sent for processing. ** - Set transaction type code to 0700 (VERIFICATION). Data will be sent to ACH Provider for Pre-Noting ONLY, no transaction will be sent for processing. Pre-Note CANNOT be used in conjunction with Transaction Type Codes 0000 (AUTH_ONLY) or 0100 (AUTH_CAPTURE).

</CHECK>

4.1.2.5. CUSTOMER_BILL This object contains customer’s billing information, like billing address and telephone number, and is required for all E-Commerce transactions.

XML Tag Data Type/ Max

Length

Required Notes

<CUSTOMER_BILL>

<ADDRESS> String / 60 True for E-Commerce

transactions

Billing street address. Together with Zip Code can be used for securing credit card transactions by means of the Address Verification System (AVS), result of AVS check will be coming back in AVS_RESULT_CODE variable of the TRANSACTIONRESPONSE object.

<CITY> String / 40 True for E-Commerce transactions

Billing City

Page 19: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

19

<ZIP> String / 20 True for E-Commerce transactions

Billing Zip Code. If full address is not provided, it is advised to provide at least the ZIP for more security.

<STATE> String / 40 False Billing State

<COMPANY> String / 50 False Billing Company

<COUNTRY> String / 60 False Billing Country

<EMAIL> String / 255 False Cardholder’s Email address. Has to be specified if Email receipt is to be sent to the Cardholder for successful transaction.

<EMAILRECEIPT> String / 5 False Merchants can choose to send a Gateway generated email receipt to customers, who provide an email address with their transaction. The email receipt includes a summary and results of the transaction. Possible values: TRUE / FALSE. If no email is provided value is considered FALSE.

<FIRSTNAME> String / 50 False Contains the first name of the customer associated with the billing address for the transaction.

<LASTNAME> String / 50 False Contains the last name of the customer associated with the billing address for the transaction.

<PHONE> String / 25 False Contains the phone number of the customer associated with the billing address for the transaction.

</CUSTOMER_BILL>

4.1.2.6. CUSTOMER_SHIP This object contains customer’s shipping information, like name and address.

XML Tag Data Type/ Max Length

Required Notes

<CUSTOMER_SHIP>

<ADDRESS> String / 60 False Customer’s shipping Street Address

<CITY> String / 40 False Customer’s shipping City

<COMPANY> String / 50 False Customer’s shipping Company

<COUNTRY> String / 60 False Customer’s shipping Country

<FIRSTNAME> String / 50 False Shipping First Name

<LASTNAME> String / 50 False Shipping Last Name

<STATE> String / 40 False Shipping State

<ZIP> String / 20 False Shipping Zip Code

</ CUSTOMER_ SHIP >

Page 20: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

20

4.1.2.7. ENCRYPTION

XML Tag Data Type/ Max Length

Required Notes

<ENCRYPTION>

<ENCRYPTIONMODE> Integer For later use. For later use.

<KSI> String For later use. For later use.

<KEYID> String For later use. For later use.

</ ENCRYPTION >

4.1.2.8. LEVEL2 This object is used for Level 2 data. Level 2 transactions normally involve corporate cards issued from a U.S. bank.

XML Tag Data Type / Max

Length

Required Notes

<LEVEL2>

<DUTY> Decimal / 15 False* Duty Amount

<FREIGHT> Decimal / 15 False* Freight Amount

<PONUM> String / 50 False* Purchase Order Number

<TAX> Decimal / 15 False* Tax Amount. This amount must be submitted separately from the total transaction amount.

<TAXFLAG> Integer / 1 False* 0 = No Tax 1 = Tax Included 2 = Tax Exempt

</ LEVEL2>

* - Required for Level 2 processing, if this data is not provided – transaction will still be processed, but as Level 1.

Page 21: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

21

4.1.2.9. LEVEL3 This object is used for Level 3 data. Purchases that qualify as Level 3 transactions generally are made with government credit card or corporate cards. Please note: Level 3 is only available to merchants on First Data Nashville platform and only for E-Commerce , Retail, and MOTO transactions.

XML Tag Data Type / Max Length

Required Notes

<LEVEL3>

<ALTTAX_AMT> Decimal / 15 False Alternate tax Amount

<ALTTAX_AMT_INDICATOR> String / 1 False Alternate tax indicator, Y/N

<COUNTRYCODETO> String / 3 False Country code shipped to

<MERCHANT_VAT_REGISTRATION_NUM> String / 20 False Merchant VAT Registration Number

<ORDER_DISCOUNT_AMT> Decimal / 15 False Order Discount Amount

<PURCHASER_ORDER_DATE> String / 10 False Purchase Order Date

<PURCHASER_VAT_REGISTRATION_NUM

>

String / 20 False Purchaser VAT Registration Number

<SUMMARY_COMMODITY_CODE> String / 4 False Summary Commodity Code

<VATTAX_AMT> Decimal / 15 False VAT Tax Amount

<VATTAX_RATE> Decimal / 15 False VAT Tax Rate

<VAT_INVOICE_REFNUM> String / 15 False VAT invoice Reference Number

<ZIPFROM> String / 20 False Zip Code Shipped From

<ZIPTO> String / 20 False Zip Code Shipped To

<LEVEL3PRODUCTS> Object Array False Array of LEVEL3PRODUCT

</ LEVEL3>

Page 22: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

22

4.1.2.10. LEVEL3PRODUCT This object contains individual level3 product information, like item name, description, tax amount, unit price, quantity, etc.

XML Tag Data Type / Max Length

Required Notes

<LEVEL3PRODUCT>

<ALTTAXID> String / 15 False Alternate tax Amount

<COMMODITYCODE> String / 12 False Commodity Code

<DISCOUNTAMT> Decimal / 15 False Discount Amount

<DISCOUNTRATE> Decimal / 15 False Discount Rate

<DISCOUNT_INDICATOR> String / 1 False Discount Indicator

<GROSSNET_INDICATOR> String / 1 False Gross Net Indicator

<ITEMCODE> String / 12 False Item Code

<ITEMNAME> String / 35 False Item Name

<ITEMTOTALAMT> Decimal / 15 False Item Total Amount

<QUANTITY> Decimal / 15 False Item Quantity

<TAXAMT> Decimal / 15 False Tax Amount

<TAXRATE> Decimal / 15 False Tax Rate

<TAXTYPEIDENTIFIER> String / 2 False 00 - Unknown 01 - Federal/National sales tax 02 - State Sales tax 03 - City Sales tax 04 - Local Sales Tax 05 - Municipal Sales Tax 06 - Other Tax 10 - Value Added Tax (VAT) 11 - Goods and Services Tax (GST) 12 - Provincial Sales Tax 20 - Room Tax 21 - Occupancy Tax 22 - Energy Tax

<TAXTYPE_APPLIED> String / 4 False Tax Type that was Applied

<UNIT> String / 12 False Unit of Measure

<UNITPRICE> Decimal / 15 False Unit Price

Page 23: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

23

</LEVEL3PRODUCT>

4.1.2.11. MPI This object describes Merchant Plug-in Indicator for 3D Secure Transactions.

XML Tag Data Type / Max

Length

Required Notes

<MPI>

<AUTHINDICATOR> String / 50 False The electronic commerce indicator (ECI) value for a Visa transaction; or the universal cardholder authentication field (UCAF) indicator for MasterCard transaction.

<AUTHVALUE> String / 50 False The cardholder authentication verification value (CAVV) for Visa transactions; or accountholder authentication value (AVV)/ universal cardholder authentication field (UCAF) for MasterCard transactions.

</MPI>

4.1.2.12. AUTO This object is used for Rental industry only and includes rental-related information, like city rented and returned in, rental and return times, etc.

XML Tag Data Type / Max

Length

Required Notes

<AUTO>

<EXTRA_CHARGEAMOUNT> Decimal / 15 True Additional Charge Amount

<EXTRA_CHARGECODE> String / 10 True Additional Charge Code

<PREFERRED_CUSTOMER> String / 1 True Preferred Customer, Y/N

<RENTALCITY> String / 50 True City Rented in

<RENTALDATETIME> String / 14 True mmddyyyyhhMMss

<RENTALSTATE> String / 2 True State Rented in

<RETURNCITY> String / 59 True City Returned In

<RETURNDATETIME> String / 14 True mmddyyyyhhMMss

<RETURNSTATE> String / 2 True State Returned in

<SALECODE> String / 2 False Sale Code

</AUTO>

Page 24: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

24

4.1.2.13. PETROLEUM This object is used for Petroleum industry only and includes information, like number of gallons, unit price, etc.

XML Tag Data Type / Max Length

Required Notes

<PETROLEUM>

<DRIVEJOBNUM> String / 6 False Driver Job Number

<FLEET_REFERENCENUM> String / 10 False Fleet Reference Number

<FULLSERV_INDICATOR> String / 3 False Full Service indicator

<GALLONS> Integer / 15 False Number of Gallons

<ODOMETER> String / 6 False Odometer reading

<PIN> String / 10 False

<PRODUCTS> Array of PRODUCT

Objects

True Product Listing. Please see Appendix for Petroleum Product Codes.

<TAXAMOUNT> Decimal / 15 False Tax Amount

<UNITPRICE> Decimal / 15 False Price per unit

<VEHICLENUM> String / 6 False Vehicle Number

</PETROLEUM>

4.1.2.14. HOTEL This object is used for Hotel industry only and includes information, like check-in, check-out times, room rate, etc.

XML Tag Data Type / Max Length

Required Notes

<HOTEL>

<CHARGETYPE> String / 1 True Type of Charge

<CHECKIN_DATE> String / 10 True mmddyyyy

<CHECKOUT_DATE> String / 10 True mmddyyyy

<EXTRA_CHARGEAMOUNT> Decimal / 15 True Additional Charge Amount

<EXTRA_CHARGECODE> String / 10 True Additional Charge Code

<PREFERRED_CUSTOMER> String / 1 True Preferred Customer, Y/N

<ROOMRATE> Decimal / 15 True Rate of room

<SALECODE> String / 2 True Sale Code

Page 25: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

25

</HOTEL>

4.1.2.15. PRODUCT This object contains individual product information, like product description, amount, quantity, etc.

XML Tag Data Type/ Max Length

Required Notes

<PRODUCT>

<AMOUNT> Decimal / 15 False Product Amount

<CODE> String / 9 False Product Code

<DESCRIPTION> String / 50 False Product Description

<NAME> String / 30 False Product Name

<QUANTITY> String / 10 False Product Quantity

<TAX> Decimal / 15 False Product Tax Amount

<TAXABLE> String / 1 False 0 = No 1 = Yes

<UNIT> String / 9 False Unit of Measure

<UNITPRICE> Decimal / 15 False Price per Unit

</PRODUCT>

4.1.2.16. RESTAURANT SERVICE This object is used for the Restaurant industry and contains gratuity amount and server number.

XML Tag Data Type/ Max Length

Required Notes

<SERVICE>

<GRATUITY> Decimal / 15 False Gratuity Amount

<SERVERNUM> String / 6 False Server Number

</SERVICE>

Page 26: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

26

4.1.2.17. USERDEFINED This object contains 50 user defined fields and allows merchants to store additional data along with transaction information. Please note that user defined fields are not intended to and must not be used to capture personally identifying information, like name, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers.

4.1.3. Transaction Request Message Format All gateway transactions include a common set of required parameters (listed first). Additional parameters are required depending on the transaction type. You can also provide many optional parameters, depending on the results you want returned. A sample Transaction Request has been included in the Appendix. 4.1.3.1. Credit Card, Debit Card, EBT, and Stored Value Card Transactions

XML Tag Data Type / Max Length

Required Notes

<TRANSACTION> Object / 1 True Please see Transaction Request Object Summary

<AMOUNT> Decimal / 15 True Total amount to be charged or credited.

Include decimal point followed by decimal amount.

<MERCHANT_KEY> Object / 1 True Please see Transaction Request Object

Summary

<CODE> String / 4 True Transaction Type Code – indicated the type of processing required for Transaction Request.

<METHOD> String / 7 True Transaction method, set to CC, DB, or SV accordingly. See Appendix

<CARD> Object / 1 True Please see Transaction Request Object

Summary

<ORDERID> String / 25 True Unique Transaction Order ID. String A-Z, 0-9 only. See Appendix.

XML Tag Data Type/ Max Length

Required Notes

<USERDEFINED>

<UD1> String / 50 False Additional Data Field

<UD2> String / 50 False Additional Data Field

…. String / 50 False Additional Data Field

<UD50> String / 50 False Additional Data Field

</USERDEFINED>

Page 27: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

27

<DCI> Integer / 1 True Duplicate Check Indicator. Please see Appendix for more information.

<TEST> String / 5 True TRUE = Test Transaction, FALSE = Live Transaction. Default is FALSE.

<TRANSACTION_SERVICE> Integer / 1 True Indicates Transaction Handling when Vault is enabled. See Appendix.

<REF_TRANSID> String / 15 Required for VOID, PARTIAL_VOID, CREDIT, PRIOR_AUTH_CAPTURE

Transaction ID of a previously approved transaction, used in VOID, PARTIAL_VOID, CREDIT, PRIOR_AUTH_CAPTURE. Please see Appendix for more uses of REF_TRANSID.

<INDUSTRYSPECIFICDATA> String / 1 Required for E-commerce and MOTO

transactions. Leave blank for retail

transactions.

Industry Specific Data – Required to send the right indicator for transaction. Accepted values: P, D, 1, 2, 3. Please see Appendix for more information.

<INSTALLMENT_SEQUENCENUM>

Integer / 2 Required if INDUSTRYSPECIFICDAT

A=3

Installment number for installment payment plan. 1-99.

<TOTAL_INSTALLMENTCOUNT> Integer / 2 Required if INDUSTRYSPECIFICDAT

A = 3

Number of total installments for installment plans. 1 – 99.

<AUTHCODE> String / 6 Required for CAPTURE_ONLY

transactions

Valid authorization code for Offline Transaction 0300 (CAPTURE_ONLY). Voice Authorization Code. Valid authorization code for EBT Voucher transaction (CAPTURE_ONLY).

<CUSTOMERID> String / 25 Required for Vault transactions

Contains the customer ID associated with the Authorization Code for EBT Voucher transaction. Must be enabled on your account.

<PAYMENTID> String / 25 Required for Vault transactions

SecureNet Vault Payment ID. Must be enabled on your account.

<AUTO> Object / 1 Specific to Industry Please see Transaction Request Object

Summary

<PETROLEUM> Object / 1 Specific to Industry Please see Transaction Request Object

Summary

<HOTEL> Object / 1 Specific to Industry Please see Transaction Request Object

Summary

<SERVICE> Object / 1 Specific to Industry Please see Transaction Request Object

Summary

<CUSTOMERIP> String / 15 False Customer IP address. Include Customer’s IP that needs to be associated with the transaction. Recommended for eCommerce merchants.

<DEVICECODE> String / 2 False Code for payment device. Blank, unless specified/provided by SecureNet.

Page 28: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

28

<ENTRYSOURCE> String / 2 False Transaction Source. Blank, unless specified/provided by SecureNet.

<INVOICEDESC> String / 50 False Description of the transaction for which invoice is being issued.

<INVOICENUM> String / 50 False Invoice number associated with the transaction.

<MARKETSPECIFICDATA> String / 2 False For bill payment transactions, applicable for Visa only. B – Bill payment D – Debt indicator (contact SecureNet for more info) Don't include if you won't send a value.

<NOTE> String / 500 False Additional Transaction Notes.

<OVERRIDE_FROM> Integer / 1 False Set to override Customer Billing information and User Defined fields from information provided in: 0 –Transaction Request 1 – Customer Vault Object 2 – Account Vault Object 3 – PRIOR_AUTH_CAPTURE transaction request, Level 2 information will be overwritten with the new Level 2 values. Use for PRIOR_AUTH_CAPTURE or SecureNet Vault transactions.

<RETAIL_LANENUM> String / 6 False Lane Number for Retail stores.

<SOFTDESCRIPTOR> String / 25 False Additional DBA descriptor. See Appendix.

<CUSTOMER_BILL> Object / 1 False Please see Transaction Request Object

Summary

<CUSTOMER_SHIP> Object / 1 False Please see Transaction Request Object

Summary

<ENCRYPTION> Object / 1 False Please see Transaction Request Object

Summary

<LEVEL2> Object / 1 False Please see Transaction Request Object

Summary

<LEVEL3> Object / 1 False Please see Transaction Request Object

Summary

<PRODUCTS> Object Array False Please see Transaction Request Object

Summary

<USERDEFINED> Object / 1 False Please see Transaction Request Object

Summary

<MPI> Object / 1 False Please see Transaction Request Object

Summary

<SECONDARY_MERCHANT_KEY> Object / 1 False Please see Transaction Request Object

Summary

</TRANSACTION>

Page 29: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

29

4.1.3.2. Electronic Check Transactions XML Tag Data Type /

Max Length Required Notes

<TRANSACTION> Object / 1 True Please see Transaction Request Object Summary

<AMOUNT> Decimal / 15 True Total amount to be charged or credited.

Include decimal point followed by decimal amount.

<MERCHANT_KEY> Object / 1 True Please see Transaction Request Object Summary

<CODE> String / 4 True Transaction Type Code – indicated the type of processing required for Transaction Request.

<METHOD> String / 7 True Set Transaction Method to ECHECK. See Appendix

<CHECK> Object / 1 True Please see Transaction Request Object Summary

<ORDERID> String / 25 True Unique Transaction Order ID. String A-Z, 0-9 only. See Appendix.

<DCI> Integer / 1 True Duplicate Check Indicator. Please see Appendix for more information.

<TEST> String / 5 True TRUE = Test Transaction, FALSE = Live Transaction. Default is FALSE.

<TRANSACTION_SERVICE> Integer / 1 True Indicates Transaction Handling when Vault is enabled. See Appendix.

<REF_TRANSID> String / 15 Required for VOID, PARTIAL_VOID,

CREDIT, PRIOR_AUTH_CAPTUR

E

Transaction ID of a previously approved transaction, used in VOID, PARTIAL_VOID, CREDIT, PRIOR_AUTH_CAPTURE. Please see Appendix for more uses of REF_TRANSID.

<PAYMENTID> String / 25 Required for Vault transactions

SecureNet Vault Payment ID. Must be enabled on your account.

<CUSTOMERID> String / 25 Required for Vault transactions

Contains the customer ID associated with the transaction. Must be enabled on your account.

<CUSTOMERIP> String / 15 False Customer IP address. Include Customer’s IP that needs to be associated with the transaction. Recommended for e-Commerce merchants.

<ENTRYSOURCE> String / 2 False Transaction Source. Blank, unless specified/provided by SecureNet.

<INVOICEDESC> String / 50 False Description of the transaction for which invoice is being issued.

<INVOICENUM> String / 50 False Invoice number associated with the transaction.

Page 30: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

30

<NOTE> String / 500 False Additional Transaction Notes.

<OVERRIDE_FROM> Integer / 1 False Set to override Customer Billing information and User Defined fields from information provided in: 0 –Transaction Request 1 – Customer Vault Object 2 – Account Vault Object 3 – PRIOR_AUTH_CAPTURE transaction request, Level 2 information will be overwritten with the new Level 2 values. Use for PRIOR_AUTH_CAPTURE or SecureNet Vault transactions.

<RETAIL_LANENUM> String / 6 False Lane Number for Retail stores.

<SOFTDESCRIPTOR> String / 25 False Additional DBA descriptor. See Appendix.

<CUSTOMER_BILL> Object / 1 False Please see Transaction Request Object Summary

<CUSTOMER_SHIP> Object / 1 False Please see Transaction Request Object Summary

<ENCRYPTION> Object / 1 False Please see Transaction Request Object Summary

<USERDEFINED> Object / 1 False Please see Transaction Request Object Summary

<MPI> Object / 1 False Please see Transaction Request Object Summary

<SECONDARY_MERCHANT_KEY>

Object / 1 False Please see Transaction Request Object Summary

</TRANSACTION>

Page 31: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

31

4.2. SecureNet Vault/Tokenization Transactions SecureNet Vault is SecureNet’s PCI-DSS compliant solution for storing information for credit cards, electronic checks, and Pin-less debit cards. It is a virtual database hosted by and at SecureNet on secure servers. Through tokenization, SecureNet Vault allows tokens to be created for credit card numbers. These tokens are then used for transactions instead of the actual credit card number. Multiple credit card information can be stored for a single individual in the form of tokens. Only the credit card number and expiry date will be stored in SecureNet Vault. The security code cannot be stored as it is against PCI compliance to do so. This means that track data cannot be stored either. In addition, debit cards are excluded, since it is against PCI compliance to store the pin and payments cannot be processed without the pin.

TRANSACTION_VAULT

This object defines information that can be submitted to the Gateway for Vault transaction processing.

ACCOUNT_VAULT This object contains account information to add, update or delete, like payment method and corresponding card/account information.

CUSTOMER_VAULT This object contains customer information to add, update or delete, like customer name, address, email, telephone number, etc.

MERCHANT_KEY This object is used to verify merchant before processing any transaction and is required for any operation.

OPERATIONPARAMETERS

This object is used to specify operation type (Add, Update, or Delete) and to specify whether Vault information is to be added even when transaction is declined in ProcessVaultTransaction method.

Page 32: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

32

4.2.1. Transaction Vault Object Summary

4.2.2. Transaction Vault Object Specification

4.2.2.1. TRANSACTION_VAULT This object defines information that can be submitted to the Gateway for Vault transactions processing.

XML Tag Data Type/ Max Length

Required Notes

<TRANSACTION_VAULT>

<ACCOUNT_VAULT> Object / 1 True Please see Transaction Vault Object Summary

<CUSTOMER_VAULT> Object / 1 True Please see Transaction Vault Object Summary

TRANSACTION Transaction information for ProcessVaultTransaction method.

TRANSACTION_VAULT

ACCOUNT_VAULT

CUSTOMER_VAULT

MERCHANT_KEY

OPERATIONPARAMETE

RS

TRANSACTION

Page 33: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

33

<MERCHANT_KEY> Object / 1 True Please see Transaction Request Object Summary

<OPERATIONPARAMETERS> Object / 1 True Please see Transaction Vault Object Summary

<TRANSACTION> Object / 1 True Please see Transaction Vault Object Summary

</TRANSACTION_VAULT>

4.2.2.2. ACCOUNT_VAULT This object contains account information to add, update or delete, like payment method and corresponding card/account information.

XML Tag Data Type/ Max Length

Required Notes

<ACCOUNT_VAULT>

<ACDI> Integer / 1 False Account Duplicate Indicator. Values: 0, 1, 2. See Appendix for more information.

<CUSTOMERID> String / 25 True Contains customer ID associated with transaction or record. Can be any string or AUTO. If AUTO is specified a unique CUSTOMERID is generated and returned in the response object.

<METHOD> String / 7 True Indicates method of payment for the transaction being sent to the system. See Appendix for more information.

<NOTES> String / 250 False Additional Notes field.

<PAYMENTID> String / 25 True Contains the Payment ID associated with the customer record. Can be any string or AUTO. If AUTO is specified, a unique PAYMENTID is generated and returned in the response object.

<PRIMARY> String / 5 False Specifies if the account is Primary or not. Values: TRUE or FALSE. Set to FALSE by default. Multiple accounts (payment methods) can be stored for a single customer and only one account can be set as primary. The system will automatically default to another payment method for the customer if the primary payment is declined.

<CARD> OBJECT / 1 Required if METHOD = CC

or PD

Please see Transaction Request Object Summary

<CHECK> OBJECT / 1 Required if METHOD = ECHECK or CHECK21

Please see Transaction Request Object Summary

<CUSTOMER_BILL> OBJECT / 1 Required for E-Commerce transactions

Please see Transaction Request Object Summary

<USERDEFINED> OBJECT / 1 False Please see Transaction Request Object Summary

</ACCOUNT_VAULT>

4.2.2.3. CUSTOMER_VAULT

Page 34: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

34

This object contains customer information to add, update or delete, like customer name, address, email, phone number, etc.

XML Tag Data Type/ Max Length

Required Notes

<CUSTOMER_VAULT>

<CSDI> Integer / 1 True Customer Duplicate Check Indicator 0 – If Customer ID exists - return an Error 1 – If Customer ID exists - do not add and continue with transaction.

<CUSTOMERID> String / 25 True Contains the customer ID associated with the transaction or record. Can be any string or AUTO. If AUTO is specified a unique CUSTOMERID is generated and returned in the response object.

<NOTES> String / 200 False Additional Notes field.

<CUSTOMER_BILL> Object / 1 False Object containing Billing Customer information.

<USERDEFINED> Object / 1 False Object Containing 50 user defined fields.

</CUSTOMER_VAULT>

4.2.2.4. OPERATIONPARAMETERS This object is used to specify operation type (Add, Update, or Delete) and to specify whether Vault information is to be added even when transaction is declined in ProcessVaultTransaction method.

XML Tag Data Type/ Max Length

Required Notes

<OPERATIONPARAMETERS>

<ACTIONCODE> Integer / 1 False 1 = ADD 2 = Update 3 = Delete

<ADD_IF_DECLINED> Integer / 1 False Add Customer/Account if transaction is declined: 0 – False 1 – True

</OPERATIONPARAMETERS>

4.3. AutoBill Transactions The AutoBill feature allows merchants to set up automatic scheduled and recurring credit card and ACH transactions. Payments can be scheduled for automatic daily, weekly, monthly, quarterly, and yearly recurrence, as well as any interval in between. In addition, merchants can set up one or more single scheduled future payments for any date. The automatic installment generator can take a total amount due and evenly split the payment dates and payment amounts across a designated time frame.

4.3.1. PLAN_AB Object Summary

PLAN_AB

INSTALLMENT

MERCHANT_KEY

RECURRING

Page 35: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

35

4.3.2. PLAN_AB Object Specification 4.3.2.1. PLAN_AB This object defines the information that can be submitted to the Gateway for AutoBill transaction processing.

XML Tag Data Type/ Max Length

Required Notes

<PLAN_AB>

<MERCHANT_KEY> Object / 1 True Merchant Key is required to process any operation.

<INSTALLMENT> Object / 1 True Please see PLAN_AB Object Summary

<RECURRING> Object / 1 True Please see PLAN_AB Object Summary

<SCHEDULE> Array of PAYMENT_AB

True Please see PLAN_AB Object Summary

</PLAN_AB>

4.3.2.2. OPTIONS Please note that OPTIONS is a parent class of INSTALLMENT and RECURRING, so all parameters of OPTIONS are inherited by the two subclasses and are include in INSTALLMENT and RECURRING tables below.

XML Tag Data Type/ Max Length

Required Notes

<OPTIONS>

<CYCLE> String / 1 True W – weekly M – monthly Q – quarterly

PLAN_AB This object defines the information that can be submitted to the Gateway for AutoBill transaction processing.

MERCHANT_KEY This object is used to verify merchant before processing any transaction and is required for any operation.

INSTALLMENT

Installment payment plans consist of a single purchase of goods or services that is billed to an account in multiple segments, over a period of time, with payments occurring on a schedule agreed by a cardholder and merchant. This object contains information on Customer’s installment plan.

RECURRING

Recurring payment plans exist when multiple transactions are processed at pre-determined intervals, as a result of an agreement for the purchase of products or services that are provided over time. This object contains information on Customer’s recurring payment plan.

SCHEDULE Array of PAYMENT_AB objects, containing individual payment information, like amount, payment id, installment date, etc.

PLAN_AB

INSTALLMENT

MERCHANT_KEY

RECURRING

SCHEDULE

Page 36: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

36

B – semiannual Y – yearly

<DAY> Integer / 2 Required if CYCLE=M, Q, B, or Y.

1-28

<FREQUENCY> Integer / 2 True Once every week/month/quarter/six months/year, as following: If CYCLE=M: 1-11 if CYCLE=W: 1-51 if CYCLE=Q: 1-3 for CYCLE=Y or CYCLE=B – frequency is set automatically.

<MONTH> Integer / 2 Required if CYCLE=Q, B, or Y

1-12

<WEEKDAY> Integer / 1 Required if CYCLE=W 1-7, where 1 is Sunday

</OPTIONS>

4.3.2.3. INSTALLMENT Installment payment plans consist of a single purchase of goods or services that is billed to an account in multiple segments, over a period of time, with payments occurring on a schedule agreed by a cardholder and merchant. The INSTALLMENT object below contains information on Customer’s Installment plan.

XML Tag Data Type/ Max Length

Required Notes

<INSTALLMENT>

<CYCLE> String / 1 True W – weekly M – monthly Q – quarterly B – semiannual Y – yearly

<DAY> Integer / 2 Required if CYCLE=M, Q,

B, or Y.

1-28

<FREQUENCY> Integer / 2 True Once every week/month/quarter/six months/year, as following: If CYCLE=M: 1-11 if CYCLE=W: 1-51 if CYCLE=Q: 1-3 for CYCLE=Y or CYCLE=B – frequency is set automatically.

<MONTH> Integer / 2 Required if CYCLE=Q, B,

or Y

1-12

<WEEKDAY> Integer / 1 Required if CYCLE=W

1-7, where 1 is Sunday

<AMOUNT> Decimal / 15 True Installment amount

Page 37: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

37

<AUTOCALC_OPTION> String / 1 True A – automatic M – manual

<BALLOON_AMOUNT> Decimal / 15 True Balloon amount

<BALLOON_OPTION> Integer / 1 True AutoBill offers the capability of the balloon payment to be applied to the first or last payment, as following: 0 – add balloon amount to first payment 1 – add balloon amount to last payment

<COUNT> Integer / 2 True Number of total installments for installment plan. 1-99.

<REMAINDER_OPTION> Integer / 1 True AutoBill offers the ability to choose first or last payment if installments are not equally divided, as following: 0 – add remainder to first payment 1 – add remainder to last payment

</INSTALLMENT>

4.3.2.4. RECURRING Recurring payment plans exist when multiple transactions are processed at pre-determined intervals, as a result of an agreement for the purchase of products or services that are provided over time. Recurring payment plans help simplify the process of billing a cardholder for a product or a service that is being provided on a continuous basis.

XML Tag Data Type/ Max Length

Required Notes

<RECURRING>

<CYCLE> String / 1 True W – weekly M – monthly Q – quarterly B – semiannual Y – yearly

<DAY> Integer / 2 Required if CYCLE=M, Q, B, or Y.

1-28

<FREQUENCY> Integer / 2 True Once every week/month/quarter/six months/year, as following: If CYCLE=M: 1-11 if CYCLE=W: 1-51 if CYCLE=Q: 1-3 for CYCLE=Y or CYCLE=B – frequency is set automatically.

<MONTH> Integer / 2 Required if CYCLE=Q, B, or Y 1-12

<WEEKDAY> Integer / 1 Required if CYCLE=W 1-7, where 1 is Sunday

<AMOUNT> Decimal / 15 True Total value to be charged to the payment method specified. Include decimal point followed by decimal amount.

<NOEND_FLAG> Integer / 1 True 0 - recurring bill has no end date 1 - recurring bill has an end date

Page 38: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

38

</RECURRING>

4.3.2.5. PAYMENT_AB This object contains individual payment information, like amount, payment id, installment date, etc.

XML Tag Data Type/ Max Length

Required Notes

<PAYMENT_AB>

<AMOUNT> Decimal / 15 True Total amount to be charged to the payment method specified. Include decimal point followed by decimal amount.

<INSTALLMENTDATE>

String / 6 True Installment date. MMDDYY.

<INSTALLMENTNUM>

Integer / 2 True Number of installments. 1-99.

<NUMOFRETRIES> Integer / 1 True AutoBill offers the ability to reattempt a declined transaction every day for up to five consecutive days. Enter number of retries, between 1-5.

<PAID> Integer False Available in response. Will contain an array of all records for Installment and Variable billing, so that the merchant can see which has already been paid or not.

<PAYMENTDATE> String False Available in response. Will contain payment date of that Schedule ID for Installment and Variable billing, for Recurring billing - represents next billing date.

<PAYMENTID> String / 25 True Contains the Payment ID associated with the customer record. Can be any string or AUTO. If AUTO is specified, a unique PAYMENTID is generated and returned in the response object.

<PLANID> Integer Required for Update only

Payment plan ID, auto-generated by the system and given to the merchant at the time Plan is added.

<PROCESSED> Integer / 1 False 0 – not yet processed, still in the queue 1 –processed

<SCHEDULEID> Integer Required for Update only

AutoBill allows multiple billing schedules per Customer ID. Schedule ID, auto-generated by the system and given to the merchant at the time Schedule is added.

<TRANSACTIONID> Integer / 15 False System Generated Unique ID for corresponding transaction, returned by the Gateway.

</PAYMENT_AB>

4.3.3. PLAN_AB Message Format

XML Tag Data Type/

Max Length Required Notes

<PLAN_AB>

<ACTIVE> Integer False Available in response. Shows whether recurring billing on this record is enabled or disabled.

Page 39: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

39

0 – Active 1 – Inactive

<CUSTOMERID> String / 25 True Contains customer ID associated with payment plan.

<ENDDATE> String / 6 Required if NOEND_FLAG = 1

(recurring bill has

an end date)

Plan end date. MMDDYY.

<INSTALLMENT> Object / 1 True Please see PLAN_AB Object Summary

<MAXRETRIES> Integer / 1 False AutoBill offers the ability to reattempt a declined transaction every day for up to five consecutive days. Enter maximum number of retries, default is 0, maximum is 5.

<MERCHANT_KEY> Object / 1 True This object is used to verify merchant before processing any transaction and is required for any operation.

<NEXTPAYMENT_DATE> String / 6 False Available in response. Next payment date. MMDDYY.

<PAYMENTID> String / 25 True SecureNet Vault Payment ID. Must be enabled on your account.

<PAYMENTID2> String / 25 False Process through Payment ID 2 if there is a problem with Payment ID.

<PLANID> Integer Required for Update only

Payment plan ID, auto-generated by the system and given to the merchant at the time Plan is added.

<RECURRING> Object / 1 True Please see PLAN_AB Object Summary

<SCHEDULE> Array of PAYMENT_AB

True Please see PLAN_AB Object Summary

<STARTDATE> String / 6 True Plan start date. MMDDYY. Please make sure the date is on or after current date.

<TYPE> String / 3 True Billing types offered include Recurring Billing, Installment Billing and Variable Billing. Set TYPE to one of the following:

REC – for recurring INS – for installment

VAR – for variable

</PLAN_AB>

4.4. Settlement Transactions Request Object used for Settlement Transactions has been described above and is the following:

4.5. Reporting API Services

Object Name Description MERCHANT_KEY Required for CloseBatch method.

Page 40: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

40

Reporting API Services allow merchants to perform additional functionalities to their processing systems. Please note that data in the reporting services database is not updated in real-time, there is a 30-minute delay. The following services are available through the Reporting API:

Transactions Services

• Retrieve Transactions Info by Batch ID • Retrieve Current Transaction Info by Order ID. • Retrieve Current Transaction Info by Transaction ID.

Vault Services

• Allow to lookup Customer and Account information AutoBill Services:

• Allow to lookup AutoBill Account information

Batch Services • Allow the system to initiate a batch close on demand.

To implement any of the above functionalities - create a program to consume one of the following Gateway services: For Batch and Transaction Services: URL for Production: https://gateway.securenet.com/api/data/transaction.svc URL for Certification and Test: https://certify.securenet.com/api/data/transaction.svc For SecureNet Vault and AutoBill Services: URL for Production: https://gateway.securenet.com/api/data/service .svcURL for Certification and Test: https://certify.securenet.com/api/data/service .svc Request Objects used for Reporting API Services have been described above and are the following:

Object Name Description MERCHANT_KEY Required for all Reporting API methods except GetABAccount. PLAN_AB Required for GetABAccount method.

5. Gateway Response This section describes the response returned by the Gateway when a merchant server submits a transaction for processing. The response is an object that contains properties and response values showing the status of a transaction. The merchant server retrieves this data and determines the message to display to the end-user. GATEWAYRESPONSE

Property Name Type Description

Page 41: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

41

ABRESPONSE Object Response for AutoBill Transactions

TRANSACTIONRESPONSE Object Response for Standard Payment Transactions and Reporting API Transactions

VAULTACCOUNTRESPONSE Object Response for SecureNet Vault Account Transactions

VAULTCUSTOMERRESPONSE Object Response for SecureNet Vault Customer Transactions

Response objects for Settlement Transactions

Property Name Type Description BATCHDATA Object Superset and Response object for Batches created.

BATCHDETAIL Object Subset of Batch data with Individual Batch Details. Object is returned only if Batches are created and transactions exist to create a batch.

5.1. GATEWAYRESPONSE 5.1.1. GATEWAYRESPONSE Object Summary

5.1.2. GATEWAYRESPONSE Object Specification

XML Tag Data Type / Max Length

Notes

<GATEWAYRESPONSE>

<ABRESPONSE> Object / 1 Please see Gateway Response Object Summary

GATEWAYRESPONSE This object defines the information that will be sent by the Gateway as a response for all transactions.

ABRESPONSE This object defines the information that will be sent by the Gateway as a response for AutoBill transactions.

SCHEDULE Array of PAYMENT_AB objects, containing individual payment information, like amount, payment id, installment date, etc.

TRANSACTIONRESPONSE This object defines the information that will be sent by the Gateway as a response for all standard payment transactions, as well as transactions submitted through Reporting API Services.

CUSTOMER_BILL This object contains customer’s billing information, like billing address and telephone number, and is required for all E-Commerce transactions.

VAULTACCOUNTRESPONSE

This object defines the information that will be sent by the Gateway as a response for all SecureNet Vault Account transactions.

VAULTCUSTOMERRESPONSE

This object defines the information that will be sent by the Gateway as a response for all SecureNet Vault Customer transactions.

GATEWAYRESPONSE

ABRESPONSE

TRANSACTIONRESPONSE

VAULTACCOUNTRESPON

VAULTCUSTOMERRESPO

SCHEDULE

CUSTOMER_BILL

Page 42: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

42

<TRANSACTIONRESPONSE> Object / 1 Please see Gateway Response Object Summary

<VAULTACCOUNTRESPONSE> Object / 1 Please see Gateway Response Object Summary

<VAULTCUSTOMERRESPONSE>

Object / 1 Please see Gateway Response Object Summary

</GATEWAYRESPONSE>

5.1.2.1. ABRESPONSE This object defines the information that will be sent by the Gateway as a response for AutoBill transactions. Please note that all fields in the ABRESPONSE object are returned in a left-justified, space-filled format.

XML Tag Data Type / Max Length

Notes

<ABRESPONSE>

<RESPONSE_CODE> String / 10 Transaction Response Code. See Appendix

<RESPONSE_REASON_CODE> String / 10 Code for providing more details about the result of the transaction.

<RESPONSE_REASON_TEXT> String / 200 Brief description of the result, which corresponds with the Response Reason Code.

<RESPONSE_SUBCODE> String / 10 Code used by the system for internal transaction tracking.

<CUSTOMERID> String / 25 Contains the customer ID associated with the transaction or record.

<PAYMENTID> String / 25 Contains the Payment ID associated with the customer record.

<PLANID> Integer Echoed from PLAN_AB

<SCHEDULE> Object / 1 Echoed from PLAN_AB

</ABRESPONSE>

5.1.2.2. TRANSACTIONRESPONSE This object defines the information that will be sent by the Gateway as a response for all standard payment transactions, as well as transactions submitted through Reporting API Services. Please note that all fields in the TRANSACTIONRESPONSE object are returned in a left-justified, space-filled format.

XML Tag Data Type / Notes

Page 43: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

43

Max Length <TRANSACTIONRESPONSE>

<ADDITIONALAMOUNT>

Decimal / 15 For Debit cards it will contain the surcharge for the transaction, if one has been setup on the Host. (If surcharge applies, it must be printed on the customer receipt). Applicable to Paymentech only. For EBT and Stored Value cards it will contain the remaining balance on the card.

<ADDITIONALDATA1> String / 100 For Stored Value cards includes Previous Balance (15 characters long zero filled decimal number with explicit decimal point) followed by Cash Out Amount (15 characters long zero filled decimal number with explicit decimal point).

<ADDITIONALDATA2> String / 100 Paymentech specific data -for Debit Transactions it will contain the Trace Number for the transaction. Optional data returned by the Host for Fleet Cards. (If data exists, it must be printed on the customer receipt as reference data). For EBT transactions it will contain the FNS # echoed from the ADDITIONALINFO field of the MERCHANT_KEY object.

<ADDITIONALDATA3> String / 100 For EBT transactions it will contain the Voucher # echoed from the ADDITIONALINFO field of the CARD object.

<ADDITIONALDATA4> String / 100 Future Use

<ADDITIONALDATA5> String / 100 Future Use

<AUTHCODE> String / 6 The six-digit alphanumeric authorization or approval code.

<AUTHORIZEDAMOUNT> Decimal / 15 Authorized Transaction Amount.

<AVS_RESULT_CODE> String / 2 Address Verification System Result Code. See Appendix

<BANK_ACCOUNTNAME> String / 50 Name of Account holder

<BANK_ACCOUNTTYPE> String / 8 Echoed from TRANSACTION

<BATCHID> String / 15 Default = 0, otherwise the Batch number of the transaction

<CARD_CODE_RESPONSE_CODE>

String / 2 Response code from Credit Card Identification Code verification. See Appendix

<CARDHOLDER_FIRSTNAME> String / 50 First Name of Card Holder(Track Data required)

<CARDHOLDER_LASTNAME> String / 50 Last Name of Card Holder (Track Data required)

<CARDLEVEL_RESULTS> String / 10 Additional information about the credit card type. See Appendix

Page 44: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

44

<CARDTYPE> String / 10 Card Type Code is returned. See Appendix

<CASHBACK_AMOUNT> Decimal / 15 Cash Back Amount echoed from TRANSACTION

<CAVV_RESPONSE_CODE> String / 2 Indicates the results of Cardholder Authentication Verification Value (CAVV) verification. See Appendix

<CHECKNUM> String / 20 Echoed from TRANSACTION

<CODE> String / 4 Echoed from TRANSACTION

<CUSTOMERID> String / 25 Echoed from TRANSACTION

<EXPIRYDATE> String / 4 Echoed from TRANSACTION

<GRATUITY> Decimal / 15 Echoed from TRANSACTION

<INDUSTRYSPECIFICDATA> String / 1 Echoed from TRANSACTION

<LAST4DIGITS> String / 4 Last 4 digits of card or bank account number

<LEVEL2_VALID> String / 5 Is Level 2 valid

<LEVEL3_VALID> String / 5 Is Level 3 valid

<MARKETSPECIFICDATA> String / 1 Echoed from TRANSACTION

<METHOD> String / 7 Echoed from TRANSACTION

<NETWORKCODE> String / 10 Network Code for DB transactions

<NETWORKID> String / 10 Transaction Identifier for Authorization Network.

<ORDERID> String / 25 Echoed from TRANSACTION

<PAYMENTID> String / 25 Echoed from TRANSACTION

<RESPONSE_CODE> String / 3 Transaction Response Code. See Appendix

<RESPONSE_REASON_CODE> String / 6 Code for providing more details about the result of the transaction.

<RESPONSE_REASON_TEXT> String / 200 Brief description of the result, which corresponds to the Response Reason Code.

<RESPONSE_SUBCODE> String / 6 Code used by the system for internal transaction tracking.

<RETREFERENCENUM> String / 50 Bank authorization reference #

<SECURENETID> Integer / 8 Echoed from TRANSACTION

Page 45: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

45

<SETTLEMENTAMOUNT> Decimal / 15 Settlement amount of Transaction

<SETTLEMENTDATETIME> String / 14 Settlement date of transaction (MMDDYYYYHHMM00).

<SYSTEM_TRACENUM> String / 50 System Trace # for Authorization Network

<TRACKTYPE> String / 1 Track Type used for transaction, 0 if no track data is present

<TRANSACTIONAMOUNT> Decimal / 15 Echoed from TRANSACTION. For INQUIRY_BALANCE transactions this field indicates the available balance on the gift card.

<TRANSACTIONDATETIME> String / 14 Transaction date and time as recorded in the Gateway according to merchant time zone. (MMDDYYYYHHMMSS)

<TRANSACTIONID> Integer / 15 System Generated Unique ID for transaction. Used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction.

<CUSTOMER_BILL> Object / 1 Echoed from TRANSACTION

</ TRANSACTIONRESPONSE> 5.1.2.3. VAULTACCOUNTRESPONSE This object defines the information that will be sent by the Gateway as a response for all SecureNet Vault Account transactions. Please note that all fields in the VAULTACCOUNTRESPONSE object are returned in a left-justified, space-filled format.

XML Tag Data Type / Max Length

Notes

<VAULTACCOUNTRESPONSE> Object / 1 Response for SecureNet Vault Account Transactions.

<RESPONSE_CODE> String / 10 Transaction Response Code. See Appendix.

<RESPONSE_REASON_CODE> String / 10 Code for providing more details about the result of the transaction.

<RESPONSE_REASON_TEXT> String / 200 Brief description of the result, which corresponds with the Response Reason Code.

<RESPONSE_SUBCODE> String / 10 Code used by the system for internal transaction tracking.

<ACCOUNTTYPE> String / 8 Echoed from ACCOUNT_VAULT

<ADDITIONALDATA1> String / 100 Contains TRANSACTIONID, which is generated while verifying an account before adding/updating a Vault account information.

<ADDITIONALDATA2> String / 100 Future Use

<CARDTYPE> String / 10 Card Type Code is returned. See Appendix

<COMPANY> String / 50 Echoed from ACCOUNT_VAULT

Page 46: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

46

<CUSTOMERID> String / 25 Contains the customer ID associated with the transaction or record

<FIRSTNAME> String / 50 Echoed from ACCOUNT_VAULT

<LAST4DIGITS> String / 4 Last 4 digits of card or bank account.

<LASTNAME> String / 50 Echoed from ACCOUNT_VAULT

<METHOD> String / 7 Echoed from ACCOUNT_VAULT

<PAYMENTID> String / 25 Contains the Payment ID associated with the customer record.

<TRANSACTIONDATETIME> String / 14 Transaction date and time as recorded in the Gateway according to merchant time zone. (MMDDYYYYHHMMSS).

</VAULTACCOUNTRESPONSE>

5.1.2.4. VAULTCUSTOMERRESPONSE Please note that all fields in the VAULTCUSTOMERRESPONSE object are returned in a left-justified, space-filled format.

XML Tag Data Type / Max Length

Notes

<VAULTCUSTOMERRESPONSE>

<COMPANY> String / 50 Echoed from CUSTOMER_VAULT

<CUSTOMERID> String / 25 Contains the customer ID associated with the transaction or record.

<FIRSTNAME> String / 50 Echoed from CUSTOMER_VAULT

<LASTNAME> String / 50 Echoed from CUSTOMER_VAULT

<RESPONSE_CODE> String / 10 Transaction Response Code. See Appendix

<RESPONSE_REASON_CODE> String / 10 Code for providing more details about the result of the transaction.

<RESPONSE_REASON_TEXT> String / 200 Brief description of the result, which corresponds with the Response Reason Code.

<RESPONSE_SUBCODE> String / 10 Code used by the system for internal transaction tracking.

<TRANSACTIONDATETIME> String / 14 Transaction date and time as recorded in the Gateway according to merchant time zone. (MMDDYYYYHHMMSS)

</VAULTCUSTOMERRESPONSE>

Page 47: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

47

5.2. Response objects for Settlement Transactions 5.2.1. BATCHDATA Object Summary

5.2.2. BATCHDATA Object Specification This section details high-level BATCHDATA Object specification. Descriptions, rules and notes for each object of BATCHDATA are detailed below.

5.2.2.1. BATCHDATA This object defines the information that can be submitted to the Gateway for Settlement Transactions.

XML Tag Data Type/ Max Length

Notes

<BATCHDATA>

<BATCHDETAILS> Array of BATCHDETAIL

Please see BATCHDETAIL Object Summary

</BATCHDATA>

5.2.2.2. BATCHDETAIL This object containing individual batch information, like Batch ID created on Batch Close, number of transactions in a batch, etc.

BATCHDATA

This object defines the information that can be submitted to the Gateway for Settlement Transactions.

BATCHDETAILS Array of BATCHDETAIL objects, containing individual batch information, like Batch ID created on Batch Close, number of transactions in a batch, etc.

XML Tag Data Type / Max Length

Notes

BATCHDATA

BATCHDETAILS

Page 48: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

48

5.2.3. BATCHDATA Message format

XML Tag Data Type / Max Length

Notes

<BATCHDATA>

<BATCHCOUNT> String Number of batches.

<BATCHDETAILS> Object Array Array of BATCHDETAIL objects.

<SECURENETID> Integer / 8 7-digit unique SecureNet ID provided by SecureNet to identify the merchant and is required for each submitted transaction.

</BATCHDATA>

<BATCHDETAIL>

<BATCHID> String / 20 Batch ID created on Batch Close. Should be the value returned by the Gateway.

<SECURENETID> String / 20 7-digit unique SecureNet ID provided by SecureNet to identify the merchant and is required for each submitted transaction. If you don’t have your SecureNet ID – please contact us.

<TOTALBATCHAMOUNT>

String / 20 Total Amount of Sale and Credits.

<TOTALCREDITAMOUNT>

String / 20 Total Amount of Sale.

<TOTALSALEAMOUNT> String / 20 Total Amount of Sale.

<TOTALTRANSACTIONS> String / 20 Number of transactions.

</BATCHDETAIL>

Page 49: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

49

6. Overview of Gateway Methods Once you create and populate a data object (ex. TRANSACTION, TRANSACTION_VAULT, PLAN_AB) pass it into the desired Gateway Method. 6.1. Methods available through https://cert ify.securenet.com/API/Gateway.svc or

https://gateway.securenet.com/API/Gateway.svc 6.1.1. Methods for Standard Payment Transactions

Method Name Operation Description

ProcessTransaction Process a non-Vault Transaction This method accepts TRANSACTION as input parameter and processes non Vault Transactions. Set TRANSACTION_SERVICE value to 0. Input parameter: TRANSACTION Output parameter: GATEWAYRESPONSE

ProcessTransaction Process Transaction by Customer ID This is a method to process transaction on-demand for the stored Customer Record. TRANSACTION_SERVICE property value inside TRANSACTION object should be set to 1. MERCHANT_KEY should be supplied within TRANSACTION object. No card/check information should be provided in the CARD/CHECK object. Input parameter: TRANSACTION Output parameter: GATEWAYRESPONSE

ProcessTransaction Process Transaction by Secondary ID (SECONDARY_MERCHANT_KEY)

This is a method to process transaction on-demand for the stored Customer Record. TRANSACTION_SERVICE property value inside TRANSACTION object should be set to 2. MERCHANT_KEY should be supplied within TRANSACTION object and secondary merchant key should be supplied inside SECONDARY_MERCHANT_KEY property of TRANSACTION object. No card/check information should be provided in the CARD/CHECK object. Input parameter: TRANSACTION Output parameter: GATEWAYRESPONSE

Page 50: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

50

6.1.2. Methods for Vault Transactions

Method Name Operation Description

ProcessAccount Add Vault Account This method accepts TRANSACTION_VAULT as input parameter. The ACTIONCODE inside OPERATIONPARAMETERS object should be set to 1 for Add operation. All account information to be added should be passed inside ACCOUNT_VAULT object and MERCHANT_KEY inside TRANSACTION_VAULT object. Input parameter: TRANSACTION_VAULT Output parameter: GATEWAYRESPONSE

ProcessAccount Update Vault Account This Method accepts TRANSACTION_VAULT as input parameter. The ACTIONCODE inside OPERATIONPARAMETERS object should be set to 2 for Update operation. PAYMENTID and CUSTOMERID should be passed inside ACCOUNT_VAULT object and MERCHANT_KEY inside TRANSACTION_VAULT object. Input parameter: TRANSACTION_VAULT Output parameter: GATEWAYRESPONSE

ProcessAccount Delete Vault Account This method accepts TRANSACTION_VAULT as input parameter. The ACTIONCODE inside OPERATIONPARAMETERS object should be set to 3 for Delete operation. PAYMENTID and CUSTOMERID should be passed inside ACCOUNT_VAULT object and MERCHANT_KEY inside TRANSACTION_VAULT object. Note: if you are deleting last account of the customer - the customer will be deleted as well. Input parameter: TRANSACTION_VAULT Output parameter: GATEWAYRESPONSE

ProcessCustomer Add Vault Customer This method accepts TRANSACTION_VAULT as input parameter. The ACTIONCODE inside OPERATIONPARAMETERS object should be set to 1 for Add operation. All customer information to be added should be passed inside CUSTOMER_VAULT object and MERCHANT_KEY inside TRANSACTION_VAULT object. Input parameter: TRANSACTION_VAULT Output parameter: GATEWAYRESPONSE

Page 51: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

51

Method Name Operation Description

ProcessCustomer Update Vault Customer This method accepts TRANSACTION_VAULT as input parameter. The ACTIONCODE inside OPERATIONPARAMETERS object should be set to 2 for Update operation. CUSTOMERID should be passed inside ACCOUNT_VAULT and MERCHANT_KEY inside TRANSACTION_VAULT object. Input parameter: TRANSACTION_VAULT Output parameter: GATEWAYRESPONSE

ProcessCustomer Delete Vault Customer This method accepts TRANSACTION_VAULT as input parameter. The ACTIONCODE inside OPERATIONPARAMETERS object should be set to 3 for Delete operation. CUSTOMERID should be passed inside CUSTOMER_VAULT object and MERCHANT_KEY inside TRANSACTION_VAULT object. Input parameter: TRANSACTION_VAULT Output parameter: GATEWAYRESPONSE

ProcessCustomerAndAccount Add Vault Customer And Account

This method accepts TRANSACTION_VAULT as input parameter. The ACTIONCODE inside OPERATIONPARAMETERS object should be set to 1 for Add operation. All customer information to be added should be passed inside CUSTOMER_VAULT object, account information inside ACCOUNT_VAULT object and MERCHANT_KEY inside TRANSACTION_VAULT object. Input parameter: TRANSACTION_VAULT Output parameter: GATEWAYRESPONSE

ProcessCustomerAndAccount Update Vault Customer And Account

This method accepts TRANSACTION_VAULT as input parameter. The ACTIONCODE inside OPERATIONPARAMETERS object should be set to 2 for Update operation. All customer information to be added should be passed inside CUSTOMER_VAULT object, account information inside ACCOUNT_VAULT object and MERCHANT_KEY inside TRANSACTION_VAULT object. Input parameter: TRANSACTION_VAULT Output parameter: GATEWAYRESPONSE

Page 52: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

52

Method Name Operation Description

ProcessVaultTransaction Process Transaction Add Customer and

Account

This is a method to process transaction on-demand and to store a new Customer and account in Vault. TRANSACTION_SERVICE property value inside TRANSACTION object should be set to 3. MERCHANT_KEY should be supplied within TRANSACTION_VAULT object, customer information to be added should be supplied inside CUSTOMER_VAULT, account information to be added should be supplied inside ACCOUNT_VAULT and transaction information except MERCHANT_KEY should be supplied inside TRANSACTION object. Input parameter: TRANSACTION_VAULT Output parameter: GATEWAYRESPONSE

CopyVaultAccount Copy Vault Account This method allows to copy an existing Vault account from one customer to another and from one SecureNet ID to another. Input parameters: SOURCE_MERCHANT_KEY (MERCHANT_KEY), SOURCE_ACCOUNT_VAULT (ACCOUNT_VAULT), TARGET_MERCHANT_KEY (MERCHANT_KEY), TARGET_ACCOUNT_VAULT (ACCOUNT_VAULT), CREATE_CUSTOMER (integer, 0 – do not create, 1 - create), CHANGE_ACCOUNT_INFO_TO_TARGET (integer, 0 – do not change target account, 1 – change target account). Output parameter: GATEWAYRESPONSE

6.1.3. Methods for AutoBill Transactions

Method Name Operation Description

AddABAAccount Add AutoBill Account Use this method to add an AutoBill Account. Input parameter: PLAN_AB Output parameter: GATEWAYRESPONSE

UpdateABAccount Update AutoBill Account Use this method to update an AutoBill Account. Input parameter: PLAN_AB Output parameter: GATEWAYRESPONSE

UpdateABSchedule Update AutoBill Schedule Use this method to update an AutoBill Schedule. Input parameter: PLAN_AB Output parameter: GATEWAYRESPONSE

Page 53: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

53

6.1.4. Methods for Settlement Transactions

Method Name Operation Description

CloseBatch Close Batch This method is for closing a batch. Input parameter: MERCHANT_KEY Output parameter: BATCHDATA

6.2. Reporting API methods for Batch and Transaction Services, available through:

https://certify.securenet.com/api/data/transaction.svc or https://gateway.securenet.com/api/data/transaction.svc

Method Name

Description

GetBatchTransactions

Method to retrieve the TRANSACTIONRESPONSE data for a particular Batch. Input parameters: MERCHANT_KEY and BATCHID. Output parameter: Array of TRANSACTIONRESPONSE objects.

a. If BATCHID =0 approved transactions from the unclosed batch will be returned b. If BATCHID = 1 transactions for the last closed batch along with original batch

id will be returned c. For all other values in BATCHID, transactions specific to that particular batch

will be returned

GetTransactionByOrderID Method to retrieve the TRANSACTIONRESPONSE data by Order ID when Transaction ID is not available. Transactions with basic validation errors are not stored and returned in this method. Input parameters: MERCHANT_KEY and ORDERID. Output parameter: TRANSACTIONRESPONSE

GetTransactionByTransactionID Method to retrieve the TRANSACTIONRESPONSE data by Transaction ID. Input parameters: MERCHANT_KEY and TRANSACTIONID. Output parameter: TRANSACTIONRESPONSE

GetCurrentBatchID This method will return the last closed batch id. Input parameter: MERCHANT_KEY Output parameter: BATCHID

GetTransactions

Method to retrieve transaction data for transactions processed during a specific period of time.

Page 54: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

54

Input parameters: MERCHANT_KEY, StartDate, EndDate, ExcludeDate, CustomerID, Amount, AmountSpecified, RBOnly. Output parameter: Array of TRANSACTIONRESPONSE objects.

6.3. Reporting API methods for SecureNet Vault and AutoBil l Services, available

through: https://certify.securenet.com/api/data/service.svc or or https://gateway.securenet.com/api/data/service.svc

Method Name

Description

GetABAccount Method to retrieve an AutoBill account. Input parameters: PLAN_AB Output parameter: PLAN_AB

GetABAccounts Method to retrieve an AutoBill account. Input parameters: MERCHANT_KEY and CustomerID Output parameter: PLAN_AB

GetVaultCustomers Method to retrieve a Vault Customer. Input parameters: MERCHANT_KEY and CustomerID Output parameter: CUSTOMER_VAULT

GetVaultAccountByCustomer Method to retrieve Vault Accounts by Merchant Key and Customer ID. Input parameters: MERCHANT_KEY and CustomerID Output parameter: Array of ACCOUNT_VAULT objects

GetVaultAccount Method to retrieve a Vault Account Input parameters: MERCHANT_KEY, CustomerID, and PaymentID Output parameter: ACCOUNT_VAULT

GetVaultRecordByCardNo Method to retrieve Vault Accounts by Merchant Key and Card Number. Input parameters: MERCHANT_KEY and CardNumber Output parameter: Array of ACCOUNT_VAULT objects

Page 55: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

55

7. Appendix 7.1. ACDI Account Duplicate Check Indicator: Indicates whether duplicate account exists.

0 – Checks for Duplicate Card Number for specified Customer ID 1 – Checks for Duplicate Card Number and Expiration Date for specified Customer ID 2 – Checks for Duplicate Card Number for All Customer IDs for specified SecureNet ID 3 – Checks for Duplicate Card Number for All Customer IDs for specified Group ID

Note: For ACCOUNT_VAULT only. Set to 0 by default.

7.2. AVS_RESULT_CODE Indicates the result of Address Verification System (AVS) checks. The Address Verification System (AVS) helps merchants detect suspicious transaction activity. To use this system, the merchant must submit the customer’s credit card billing address (numeric value only) to the Gateway for validation. This information is submitted by the Gateway to the financial institutions. The financial institutions compare the submitted address with the billing address on file for that particular credit card and return an AVS response code to the Gateway. The Gateway includes this code in the response back to the merchant.

AVS Code Description 0 AVS data not provided A Street address matches, Zip Code does not B Postal code not verified due to incompatible formats C Street address and postal code not verified due to incompatible formats D Street address and postal code match E AVS data is invalid G Non-U.S. issuing bank does not support AVS I Address information not verified by international issuer

M Customer Name, Billing Address and Zip match

Page 56: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

56

N Neither street address nor Zip code match P Street address not verified due to incompatible format R Retry: issuer's system unavailable or timed-out S U.S. issuing bank does not support AVS T Street address does not match, but 9-digit Zip code matches U Address information is unavailable W 9-digit Zip matches, street address does not X Street address and 9-digit Zip match Y Street address and 5-digit Zip match Z 5-digit Zip matches, street address does not

Note: It is recommended that merchants enable some level of Address Verification to avoid non-qualified transaction

surcharges that can be levied by merchant banks and merchant service providers.

7.3. CARD_CODE_RESPONSE_CODE (CVV2/CVC2/CID) The Credit Card Identification Code, or “Card Code,” is a three- or four-digit security code that is printed on the back of credit cards in reverse italics in the card’s signature panel (or on the front for American Express cards). The merchant can collect this information from the customer and submit the data to the Gateway. The Gateway will pass this information to the financial institution along with the credit card number. The financial institution will determine if the value matches the value on file for that credit card and return a code indicating whether the comparison failed or succeeded. The Gateway passes back this response code to the merchant.

Code Description M Match N No match P Not processed S Data not present U Issuer unable to process request Y Card Code Matches (Amex Only)

7.4. CARDLEVEL_RESULTS Provides additional information on card type:

Code Description A Visa Traditional B Visa Traditional Rewards C Visa Signature D Visa Infinite G Visa Business Card I Visa Commerce K Visa Corporate Card M MasterCard/EuroCard and Diners Q Private Label R Proprietary Card S Visa Purchasing Card

Page 57: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

57

7.5. CAVV_RESPONSE_CODE Indicates the results of Cardholder Authentication Verification Value (CAVV) verification.

U Visa Travel Money G1 Visa Signature Business S1 Visa Fleet

AX1 American Express DI1 Discover H Classic Visa Check Card or Prepaid N Platinum Visa Check Card P Gold Visa Check Card

G2 Visa Business Check Card J1 General Prepaid J2 Prepaid Gift Card J3 Prepaid Healthcare

Code Description Blank CAVV not validated

0 CAVV not validated because erroneous data was submitted

1 CAVV failed validation

2 CAVV passed validation

3 CAVV validation could not be performed; issuer attempt incomplete

4 CAVV validation could not be performed; issuer system error

5 Reserved for future use

6 Reserved for future use

7 CAVV attempt – failed validation – issuer available (U.S.-issued card/non-U.S acquirer)

8 CAVV attempt – passed validation – issuer available (U.S.-issued card/non-U.S. acquirer)

9 CAVV attempt – failed validation – issuer unavailable (U.S.-issued card/non-U.S. acquirer)

Page 58: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

58

7.6. CARDTYPE Codes The CARDTPYE Code is a system-specific code for different types of cards as identified by the Gateway.

CARDTYPE Code Response Description ACH e-Check AX American Express DB Debit Card DC Diners Club DS Discover

EBT Electronic Benefits Transfer GC Gas Card (Fuelman) JC JCB

MC MasterCard MCF MasterCard Fleet PD PIN-less Debit SV Stored Value Card VI Visa

VIF Visa Fleet VY Voyager WX Wright Express (WEX) Card

CHECK21 Check 21

7.7. DCI

A CAVV attempt – passed validation – issuer unavailable (U.S.-issued card/non-U.S. acquirer)

B CAVV passed validation, information only, no liability shift

Page 59: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

59

Duplicate Transaction Indicator must be activated in Tools tab of the Virtual Terminal: "Duplicate Transaction Lockout Settings". Duplicates are evaluated against AMOUNT, CARDNUMBER, and, optionally, a user defined field (like Customer ID, Invoice Number or one of the UDFs), and within a specified time frame of only APPROVED transactions, unless otherwise noted. If a duplicate transaction is found the new transaction is not reprocessed.

0 No duplicate checking will be done.

1 If evaluation of the above conditions results in a duplicate transaction an exception code will be returned.

2 If evaluation of the above conditions results in a duplicate transaction the original transaction response is returned with RESPONSE_REASON_TEXT = “Approved”.

3 Identical to 1 however ORDERID is not evaluated.

Note: ORDERID will be evaluated and responses sent accordingly AFTER Duplicate check is evaluated and no

duplicate is found.

7.8. INDUSTRYSPECIFICDATA For E-commerce transactions:

P – Physical goods D – Digital goods

For MO/TO transactions: 1 – Single purchase transaction (AVS is required) 2 – Recurring billing transaction (do not submit AVS) 3 – Installment transaction

For Retail transactions – leave blank. Note: If TRANSACTION_SERVICE = 1 or 2, INDUSTRYSPECIFICDATA will be set to 1 by default, unless

transaction request specifies otherwise.

7.9. METHOD Method indicates the method of payment for the transaction being sent to the system and can be one of the following:

Code Description CC Credit Card DB Debit

ECHECK Electronic Check CHECK21 Electronic Check

PD PIN-less Debit SV Stored Value

EBT Electronic Benefits Transfer

7.10. ORDERID

Page 60: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

60

A client generated unique ID for each transaction submitted to the Gateway. ORDERID must be unique to the SecureNet ID, however the uniqueness is only evaluated for APPROVED transactions and only for the last 30 days. If a transaction results in a decline that ORDERID may be used again. The ORDERID is used as a default method to avoid processing duplicate transactions. The ORDERID is not verified for transaction types such as VOID and PRIOR_AUTH_CAPTURE. ORDERID is limited to 25 characters; for example “CUSTOMERID MMddyyyyHHmmss”.

7.11. REF_TRANSID It is possible to “re-run” a transaction, i.e. retrieve credit card information from a previously approved or declined transaction and use this information to submit another transaction. If you set REF_TRANSID to TRANSACTIONID of the previously approved or declined transaction, you are not required to send a credit card number, the number from the transaction referenced by REF_TRANSID will be used. When re-running a transaction, please follow the instructions below:

1. REF_TRANSID should be present. CARDNUMBER, ACCOUNTNUM, TRACKDATA, or MICRDATA should not be present.

2. REF_TRANSID can be from a previously approved or declined transaction. 3. REF_TRANSID should not be older than 90 days for the same SecureNet ID. 4. Re-running a transaction is available for the following transaction codes: AUTH_CAPTURE, AUTH_ONLY,

CAPTURE_ONLY, FORCE_CREDIT, PARTIAL_AUTH_ONLY, PARTIAL_AUTH_CAPTURE, and VERIFICATION. 5. Re-running a transaction cannot be done for a Card-Present transaction, i.e. INDUSTRYSPECIFICDATA in

TRANSACTION object should not be empty or null, it should be set to 1, 2, 3, P, or D.

7.12. RESPONSE_CODE Indicates the result of the transaction:

1 – Approved 2 – Declined 3 – Error / Invalid Data

7.13. SECCODE The Standard Entry Class (SEC) code is a three letter code that identifies the nature of the ACH entry. Here are some common SEC codes:

Code Description ARC Accounts Receivable Entries. A check received by a merchant through mail

or drop box and presented as an ACH entry.

BOC Back Office Conversion. A check that is converted from paper to an electronic debit at a centralized location and presented as an ACH entry.

Page 61: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

61

CCD Corporate Cash Disbursement. Primarily used for business to business transactions.

POS Point-of-Sale. A debit at electronic terminal initiated by use of a plastic card. An example is using your Debit card to purchase gas.

PPD Prearranged Payment and Deposits. Used to credit or debit a consumer account. Popularly used for payroll direct deposits and preauthorized bill payments.

TEL Telephone Initiated-Entry. Verbal authorization by telephone to issue an ACH entry such as checks by phone. (TEL code allowed for inbound telephone orders only. NACHA disallows the use of this code for outbound telephone solicitations calls).

WEB Web Initiated-Entry. Electronic authorization through the Internet to create an ACH entry.

7.14. Transaction Type Table

CODE: Transaction Type Code. The following table describes the Codes of transactions that can be submitted to the Gateway and how the Gateway will process them.

CODE Transaction Type Description 0000 AUTH_ONLY Used to validate a credit/debit card for the amount of goods sold. The Gateway will

send this type of transaction to the financial institution for approval. However this transaction will not be sent for settlement. If the merchant does not act on the transaction within 30 days, the transaction will no longer be available for capture. Available for: E-checks*, Credit Cards, Check Cards, and Prepaid Cards. * Future use

0001 PARTIAL_AUTH_ONLY Used to validate a prepaid card for the amount of goods sold and may return an amount less than the requested amount if the total amount cannot be fully authorized. The Gateway will send this type of transaction to the financial institution for approval. However this transaction will not be sent for settlement. If the merchant does not act on the transaction within 30 days, the transaction will no longer be available for capture. Available for:

• Prepaid Cards • Nashville platform only

Page 62: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

62

CODE Transaction Type Description 0100 AUTH_CAPTURE Identical to AUTH_ONLY, however on approval the transaction will be picked up for

settlement. Available for: E-checks, Credit Cards, Check Cards, PIN Debit, PIN-less Debit, and Prepaid Cards.

0101 PARTIAL_AUTH_CAPTURE Identical to PARTIAL_AUTH_ONLY, however on approval the transaction will be picked up for settlement. Available for: Prepaid Cards.

0200 PRIOR_AUTH_CAPTURE This transaction is used to request settlement for a transaction that was previously submitted as an AUTH_ONLY. The Gateway will accept this transaction and initiate settlement if the following conditions are met:

- The transaction is submitted with the ID of the original authorization-only transaction to be settled.

- The transaction ID is valid and the system has a record of the original authorization-only transaction.

- The original transaction referred to is not already settled, expired, or voided. - The amount being requested for settlement is less than or equal to the

original authorized amount. If no amount is submitted in this transaction, the Gateway will initiate settlement for the amount originally authorized. Note: If extended line item, tax, freight, and/or duty information was submitted with the original transaction, adjusted information may be submitted in the event that the transaction amount changed. If no adjusted line item, tax, freight, and/or duty information is submitted, the information submitted with the original transaction will apply. Available for: E-checks*, Credit Cards, Check Cards, and Prepaid Cards. * Future use

0300 CAPTURE_ONLY This is a request to settle a transaction that was not submitted for authorization through the payment Gateway. The Gateway will accept this transaction if an authorization code is submitted. AUTHCODE is a required field for CAPTURE_ONLY transactions. Available for: Credit Cards, Check Cards, and Prepaid Cards.

Page 63: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

63

CODE Transaction Type Description 0400 VOID This action cancels a previous transaction such that it is not sent for settlement. It can

be performed on the following transaction types: CREDIT, AUTH_CAPTURE, CAPTURE_ONLY, and AUTH_ONLY. The transaction will be accepted by the Gateway if the following conditions are met:

- The transaction is submitted with the ID of the original transaction to be voided (REF_TRANSID).

- The Gateway has a record of the transaction referenced by the ID. - The transaction has not been sent for settlement.

Available for:

• E-checks, Credit Cards, Check Cards, and Prepaid Cards • All platforms

0401 PARTIAL_VOID This action will reduce the amount of a previous unsettled transaction.

- The transaction is submitted with the ID of the original transaction to be

voided (in REF_TRANSID field). - The Gateway has a record of the transaction referenced by REF_TRANSID. - The transaction has not been sent for settlement.

Available for:

• E-checks, Credit Cards, Check Cards, and Prepaid Cards. • MOTO and E-Commerce merchants only • Nashville platform only, TSYS in pipeline.

0402 VOID_BY_ORDERID This action cancels a previous transaction such that it is not sent for settlement. It can

be performed on unsettled transactions of the following types: AUTH_ONLY, AUTH_CAPTURE, PRIOR_AUTH_CAPTURE, CREDIT_AUTHONLY, and FORCE_CREDIT. The transaction will be accepted by the Gateway if the following conditions are met:

- The transaction is submitted with the ORDERID of the original transaction to be voided (in ORDERID field).

- The Gateway has a record of the transaction referenced by the ORDERID. - The transaction has not been sent for settlement.

Available for:

• E-checks, Credit Cards, Check Cards, and Prepaid Cards • All platforms

Page 64: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

64

CODE Transaction Type Description 0500 CREDIT This transaction is also referred to as a “Refund” and indicates to the Gateway that

money should flow from the merchant to the customer. The Gateway will accept a credit (refund) request if the transaction submitted meets the following conditions:

- The transaction is submitted with the ID of the original transaction against which the credit is being issued (REF_TRANSID).

- The transaction ID is valid and the system has a record of the original transaction.

- The original transaction has been settled. - The sum submitted in the credit transaction and all credits submitted against

the original transaction is less than or equal to the original transaction amount.

- The card number (or the last four digits thereof) submitted with the credit transaction matches the card number of the original transaction.

- The credit transaction is submitted within 120 days of the settlement date and time of the original transaction.

Available for: E-checks, Credit Cards, Check Cards, and Prepaid Cards.

0501 CREDIT_AUTHONLY Similar to CREDIT but the transaction is not eligible to be captured until it is marked by Capture using CREDIT_PRIORAUTHCAPTURE Available for: Credit Cards, Check Cards, and Prepaid Cards.

0502 CREDIT_PRIORAUTHCAPTURE Capture CREDIT_AUTHONLY transaction and mark for Capture and Settlement Available for: Credit Cards, Check Cards, and Prepaid Cards.

0600 FORCE_CREDIT Similar to CREDIT used for Unlinked credits when previous Authorized Transaction is not Available. This feature has to be enabled by Merchant Service Provider on the Gateway Available for: E-checks, Credit Cards, Check Cards, and Prepaid Cards.

0601 FORCE_CREDIT_AUTHONLY Similar to FORCE_CREDIT but the transaction is not eligible to be captured until it is marked by Capture using FORCE_CREDIT_PRIORAUTHCAPTURE Available for: Credit Cards, Check Cards, and Prepaid Cards.

0602 FORCE_CREDIT_PRIORAUTHCAPTURE Capture FORCE_CREDIT_AUTHONLY transaction and mark for Capture and Settlement Available for: Credit Cards, Check Cards, and Prepaid Cards.

0700 VERIFICATION Run Transaction Verification on Credit Card or Bank Account with zero dollar amount. Available for: Nashville , TSYS, and SecureNet FrontEnd platforms. Credit Cards and E-checks.

Page 65: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

65

CODE Transaction Type Description 0800 AUTH_INCREMENT This action performs an incremental authorization on a previously authorized

transaction (i.e., AUTH_ONLY). Only applicable to Visa transactions and only if the terminal has been set up as LODGING or AUTO RENTAL industry type. The transaction will be accepted by the Gateway if the following conditions are met:

- The transaction is submitted with the ID of the transaction. - The Gateway has a record of the transaction referenced by the ID. - The transaction has not been sent for settlement.

AUTH_INCREMENT can be submitted multiple times before submitting PRIOR_AUTH_CAPTURE.

0900 ISSUE This action issues a new card or adds funds to an already activated stored value card; also used for refunds to a stored value card. Will be treated as credit to the card holder. Available for:

• Pre-paid Cards only • Paymentech platform only

0901 ACTIVATE This action activates a new card; only necessary if the stored value card is set to require

activation. Available for:

• Pre-paid Cards only • Paymentech platform only

0902 REDEEM This action charges a card; the amount has to be within the available balance.

Available for:

• Pre-paid Cards only • Paymentech platform only

0903 REDEEM_PARTIAL This action charges a card; the card will be approved only for the available balance on

the card if the transaction is approved. Available for:

• Pre-paid Cards only • Paymentech platform only

0904 DEACTIVATE This action de-activates an activated card; amount should be specified as zero.

Available for:

• Pre-paid Cards only • Paymentech platform only

0905 REACTIVATE This action re-activates a de-activated card.

Available for:

• Pre-paid Cards only • Paymentech platform only

Page 66: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

66

CODE Transaction Type Description 0906 INQUIRY_BALANCE This action checks the available balance on the stored value card; amount should be

specified as zero. The available balance on the gift card will be returned in the TRANSACTIONAMOUNT field in the TRANSACTIONRESPONSE object. Available for:

• Pre-paid Cards only • Paymentech platform only

7.15. SOFTDESCRIPTOR Displays a description in addition to the merchant’s DBA. This is currently restricted to credit card transactions only. Contact Support to use this field. Maximum length is 25 characters. The SOFTDESCRIPTOR field should contain the “Doing Business As” (DBA) name of the merchant and be the name most recognizable to the cardholder. The SOFTDESCRIPTOR field must not be used as a description field in lieu of the required, recognizable name. In addition, the SOFTDESCRIPTOR field may contain a merchandise description, order number, reference number, or other information that will further identify the transaction and assist cardholder recognition. If additional information is used, the SOFTDESCRIPTOR field must conform to one of the following formats:

Field Position Data Option 1: Pos. 1–3: Merchant name or abbreviation Pos. 4: Asterisk (*) Pos. 5–25: Descriptive Information

Option 2: Pos. 1–7: Merchant name or abbreviation Pos. 8: Asterisk (*) Pos. 9–25: Descriptive Information

Option 3: Pos. 1–12: Merchant name or abbreviation Pos. 13: Asterisk (*) Pos. 14–25: Descriptive Information

Page 67: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

67

7.16. TRACKDATA This field contains information encoded from a valid magnetic stripe and includes data such as Primary Account Number and Expiration Date. Unaltered Track Data must be forwarded intact. On Debit Card and EBT (Not Voucher Clear) transactions, this field is mandatory (with the exception of Debit Card PIN-Less transactions, which are entered manually). Track Data may contain Track 1 and/or Track 2 data. Track 2 data is required for Pin Debit transactions. Accurate Track 1 or Track 2 data is required to receive Card Present rates. Authorization requests containing altered Track 1 or Track 2 data will be flagged as NOT COMPLIANT by Visa and MasterCard, resulting in the merchant paying the highest transaction rate and forfeiture of chargeback protection. Both associations monitor non-compliant transactions and will assess fines and penalties to merchants that are not in compliance. The POS device or software must perform the following operations on Track read data before it can be used in an authorization request message:

• The longitudinal redundancy checks (LRC) must be calculated for the data read from the Track and compared to the LRC read from the Track. The Track data is assumed to be read without errors when no character parity errors are detected and the calculated and read LRCs match.

• The starting sentinel, ending sentinel, and LRC are discarded.

• The character codes read from the magnetic stripe must be converted from the encoded character set to the set used for the authorization request message. The characters encoded on Track 1 are six bit plus parity codes and the characters encoded on Track 2 are four bit plus parity codes, with the character set used for the request message defined as seven bit plus parity code. All characters read from a Track must be converted to the request message character set and transmitted as part of the request. The converted Track data cannot be modified by adding or deleting non-framing characters and must be a one for one representation of the characters read from the Track.

Note: You only need to submit Track 1 or Track 2 data. If both tracks are sent by the POS application, the Gateway will use the Track 1 information. If neither Track 1 nor Track 2 data is submitted, but x_card_num and x_exp_date are submitted, the Card Present transaction rate might be downgraded.

Track 1 Data This is a variable length field with a maximum data length of 76 characters. The Track 1 data read from the cardholder’s card is checked for parity and LRC errors and then converted from the six-bit characters encoded on the card to seven bit characters as defined in ANSI X3.4. As part of the conversion, the terminal must remove the framing characters (start sentinel, end sentinel, and LRC characters). The separators must be converted to either an ASCII “^” (HEX 5E) or ASCII <US> (HEX 1F) characters. The entire unaltered Track, excluding framing characters, must be provided in the authorization request message or an error condition will result.

Page 68: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

68

Track 1 can be encoded with up to 79 characters as shown below:

SS FC PAN FS NAME FS DATE SVC CD

DISCRETIONARY DATA

ES LRC

LEGEND:

Field Description Length Format SS Start Sentinel 1 % FC Format Code

(“B” for credit cards) 1 Alphanumeric

PAN Primary Account Number 19 max Numeric FS Field Separator 1 ^

NAME Card Holder Name 2-25 max Alphanumeric FS Field Separator 1 ^

DATE Expiration Date (YYMM) 4 Numeric SVC CD Service Code 3 Numeric

DISCRETIONARY DATA Optional Issuer Data Variable Alphanumeric ES End Sentinel 1 ?

LRC Longitudinal Redundancy Check 1 Total Cannot exceed 79 bytes 79

Track 2 Data This is a variable length field with a maximum data length of 37 characters. The Track 2 data read from the cardholder’s card is checked for parity and LRC errors and then converted from the four-bit characters encoded on the card to seven bit characters as defined in ANSI X3.4. As part of the conversion, the terminal must remove the start sentinel, end sentinel, and LRC characters. The separators must be converted to either an ASCII “=” (HEX 3D) or ASCII “D” (HEX 44) characters. The entire UNALTERED Track (excluding framing characters) must be provided in the authorization request message or an error message will be generated. Track 2 Data can be encoded with up to 40 characters as shown below:

SS PAN FS DATE SVC CD

DISCRETIONARY DATA

ES LRC

LEGEND:

Field Description Length Format SS Start Sentinel 1 ;

PAN Primary Account Number 19 max Numeric FS Field Separator 1 =

DATE Expiration Date (YYMM) 4 Numeric SVC CD Service Code 3 Numeric

DISCRETIONARY DATA Optional Issuer Data Variable Alphanumeric ES End Sentinel 1 0F Hex

LRC Longitudinal Redundancy Check 1 Total Cannot exceed 40 bytes 40

Page 69: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

69

7.17. TRANSACTION_SERVICE [Default]

0 – Regular Transaction [SecureNet Vault Transactions] 1 – Process Transaction using Customer ID 2 – Process Transaction using SECONDARY_MERCHANT_KEY 3 – Process Transaction Add Customer and Account

7.18. Product Codes for Petroleum Industry Transactions Paymentech Petroleum Product Codes/Paymentech ‘Generic’ Codes Ethan1 (Regular) 001 Wipers 023 Diesel 002 Battery 024 Unleaded 003 Fluids/Coolants 025 Super Unleaded 004 Tires 026 Other Fuel 005 Hoses 027 Unleaded Plus 006 Filters 028 Gas/Alcohol 007 Repairs 030 Gas/Alcohol 2 008 Oil Change 031 Diesel 2 009 Tune Up 032 Propane 010 Inspection 033 CNG 011 Car Wash 034 Unleaded 10% blend 012 Tires/Batteries/Access 035 Unleaded Plus 10% blend 013 Other 040 Super Unleaded 10% 014 Accessories 041 Unleaded 7% blend 015 Food 042 Unleaded Plus 7% 016 Service 043 Super Unleaded 7% blend 017 Parts 044 Refer Fuel 018 Labor 045 Farm Fuel 019 Reserved 046 Multi-fuel 020 Discount* 051 Motor Oil 021 Sales Tax** 056 Lamps 022

*Product Code 051: Discount is a negative amount **If tax is submitted as a Product Code, it must ALSO be submitted in the purchasing card data fields. Product Amounts can be treated as negative values if they have been setup as such with the host. When submitted, the total of the positive product amounts minus the negative product amounts must equal the transaction amount. Transaction amounts must cross foot:

a) Sum of all Product Amounts must equal Transaction Amount.

Page 70: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

70

b) If provided: Unit Price * Quantity = Product Amount (Quantity multiplied by Unit Price is rounded using 4/5 rounding to derive the extended amount.)

7.19. Developer Notes 7.19.1. Sample Code 7.19.1.1. Standard Payment Transaction - C# Assuming the developer has service reference to the Gateway named “GatewayService” using ProjectNamespace.GatewayService; private void ProcessGatewayTransaction() {

//First define the primary objects that will be needed GatewayClient Client = new GatewayClient("BasicHttpBinding_IGateway"); TRANSACTION oT = new TRANSACTION();

GATEWAYRESPONSE oGr = new GATEWAYRESPONSE(); //All Gateway Transactions require a MERCHANT_KEY oT.MERCHANT_KEY = new MERCHANT_KEY(); //Create an instance of a payment object oT.CARD = new CARD(); //OR oT.CHECK = new CHECK(); //Add some additional objects to the transaction oT.CUSTOMER_BILL = new CUSTOMER_BILL(); oT.USERDEFINED = new USERDEFINED(); //Assign some values oT.MERCHANT_KEY.SECURENETID = 1234567; oT.MERCHANT_KEY.SECUREKEY = "OurSecureKey"; oT.CARD.CARDNUMBER = "4111111111111111"; oT.CARD.CARDCODE = "123"; oT.CARD.EXPDATE = "1212"; //MMYY oT.CUSTOMER_BILL.FIRSTNAME = "Customer"; oT.CUSTOMER_BILL.LASTNAME = "Last Name"; oT.USERDEFINED.UD1 = "Userdefined Value"; oT.USERDEFINED.UD2 = "There are 50 of these to use"; oT.AMOUNT = 1; oT.TEST = "FALSE"; // When testing, use TRUE oT.METHOD = "CC"; // We'll use a credit card oT.ORDERID = DateTime.Now.ToString("MMddyyhhmmss"); // Define a unique id for each transaction oT.CODE = "0000"; // An Auth only transaction //Process the Transaction oGr = Client.ProcessTransaction(oT); //Close the Client

Page 71: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

71

Client.Close(); if (oGr.TRANSACTIONRESPONSE.RESPONSE_CODE == "1") { //Handle approved transaction } else if (oGr.TRANSACTIONRESPONSE.RESPONSE_CODE == "2") { //Handle declined transaction } else { //Handle transaction error } }

7.19.1.2. SecureNet Vault Transactions - C# using System; using VaultCodeSample.GatewayService; namespace VaultCodeSample { class Program { GatewayService.GatewayClient gsClient = new GatewayService.GatewayClient("BasicHttpBinding_IGateway");

// please use basicHttpbinding for SOAP for performance reason

string customerId = "Test" + DateTime.Now.ToString("MMddyyhhmm"); static void Main(string[] args) { Console.WriteLine(" Type and Enter for Vault Transaction\n 1. ProcessVaultTransactionAndAddCustomerAccount \n 2." + "ProcessVaultTransactionByCustomerID \n 3. ProcessVaultAccount\n 4. ProcessTransactionbySecondarySecurenetID");

int s = Convert.ToInt32(Console.ReadLine()); Program p = new Program(); switch (s) { case 1: p.ProcessVaultTransactionAndAddCustomerAccount(); Console.WriteLine(" Request Successful"); break; case 2: p.ProcessVaultTransactionByCustomerID(); Console.WriteLine(" Request Successful"); break; case 3: p.ProcessVaultAccount(); Console.WriteLine(" Request Successful"); break; case 4: p.ProcessVaultTransactionBySecondarySecurenetId(); Console.WriteLine(" Request Successful"); break; default: Console.WriteLine(" Selected item is not valid"); break; } Console.Read();

Page 72: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

72

} public void ProcessVaultTransactionAndAddCustomerAccount() { try { Console.WriteLine(" Running ProcessVaultTransactionAndAddCustomerAccount \n"); OPERATIONPARAMETERS operationParameters = new OPERATIONPARAMETERS(); operationParameters.ACTIONCODE = 1; operationParameters.ADD_IF_DECLINED = 0; var transaction = GetTransactionObject(); var transactionVault = new TRANSACTION_VAULT(); transactionVault.TRANSACTION = transaction; transactionVault.TRANSACTION.TRANSACTION_SERVICE = 3; transactionVault.ACCOUNT_VAULT = GetAccountVault(); transactionVault.CUSTOMER_VAULT = GetCustomerVault(); transactionVault.MERCHANT_KEY = new MERCHANT_KEY(); transactionVault.OPERATIONPARAMETERS = operationParameters; transactionVault.MERCHANT_KEY.SECUREKEY = "cWpQuPz0lI3p"; transactionVault.MERCHANT_KEY.SECURENETID = 1000093; var gatewayResponse = gsClient.ProcessVaultTransaction(transactionVault); Console.WriteLine(" Method |Payment ID | Customer ID|Response \n");

Console.WriteLine(" {0} | {1}| {2}| {3} \n", gatewayResponse.VAULTACCOUNTRESPONSE.METHOD, gatewayResponse.VAULTACCOUNTRESPONSE.PAYMENTID, gatewayResponse.VAULTCUSTOMERRESPONSE.CUSTOMERID, gatewayResponse.VAULTACCOUNTRESPONSE.RESPONSE_REASON_TEXT);

} catch (Exception ex) { Console.WriteLine(ex.Message); } } private void ProcessVaultTransactionByCustomerID() { try { var transactionVault = new TRANSACTION_VAULT(); TRANSACTION transaction = GetTransactionObject(); transaction.TRANSACTION_SERVICE = 1; transaction.CUSTOMERID = "CID1";

// Please increase this number to the next one (e.g. CID2) or provide a unique number each time you run to get an approval

transaction.CUSTOMER_BILL = GetVaultCustomerCustomerBill(); GatewayService.GatewayClient gatewayClient = new GatewayClient("wsBinding"); var gatewayResponse = gatewayClient.ProcessTransaction(transaction);

Page 73: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

73

Console.WriteLine(" Method |Customer ID| Card Type, Response \n");

Console.WriteLine(" {0} | {1}| {2}| {3} \n", gatewayResponse.TRANSACTIONRESPONSE.METHOD, gatewayResponse.TRANSACTIONRESPONSE.CUSTOMERID, gatewayResponse.TRANSACTIONRESPONSE.CARDTYPE, gatewayResponse.TRANSACTIONRESPONSE.RESPONSE_REASON_TEXT);

} catch (Exception ex) { Console.WriteLine(ex.Message); } } private void ProcessVaultTransactionBySecondarySecurenetId() { try { GatewayClient gatewayClient = new GatewayClient("wsBinding"); MERCHANT_KEY merchantSecondaryKey = new MERCHANT_KEY(); merchantSecondaryKey.SECURENETID = 1000093; merchantSecondaryKey.SECUREKEY = "cWpQuPz0lI3p"; var transactionVault = new TRANSACTION_VAULT(); var transaction = GetTransactionObject(); transaction.CUSTOMERID = "CID1";

// Please increase this number to the next one (e.g. CID2) or provide a unique number each time you run to get an approval

transaction.PAYMENTID = "PID1"; // Please increase this number to the next one (e.g. PID2) or provide a unique number each time you run to get an approval

transaction.TRANSACTION_SERVICE = 2; transaction.SECONDARY_MERCHANT_KEY = merchantSecondaryKey; var gatewayResponse = gatewayClient.ProcessTransaction(transaction); Console.WriteLine(" Method |Customer ID| Card Type, Response \n");

Console.WriteLine(" {0} | {1}| {2}| {3} \n", gatewayResponse.TRANSACTIONRESPONSE.METHOD, gatewayResponse.TRANSACTIONRESPONSE.CUSTOMERID, gatewayResponse.TRANSACTIONRESPONSE.CARDTYPE, gatewayResponse.TRANSACTIONRESPONSE.RESPONSE_REASON_TEXT);

} catch (Exception ex) { Console.WriteLine(ex.Message); } } private void ProcessVaultAccount() { try { GatewayClient gatewayClient = new GatewayClient("wsBinding"); var transactionVault = new TRANSACTION_VAULT(); transactionVault.ACCOUNT_VAULT = GetAccountVault(); transactionVault.OPERATIONPARAMETERS = new OPERATIONPARAMETERS { ACTIONCODE = 1 }; //1 - add, 2- update, 3- delete transactionVault.MERCHANT_KEY = new MERCHANT_KEY();

Page 74: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

74

transactionVault.MERCHANT_KEY.SECUREKEY = "cWpQuPz0lI3p"; transactionVault.MERCHANT_KEY.SECURENETID = 1000093; var gatewayResponse = gatewayClient.ProcessAccount(transactionVault); Console.WriteLine(" Method |Response \n");

Console.WriteLine(" {0} | {1}| \n", gatewayResponse.VAULTACCOUNTRESPONSE.METHOD, gatewayResponse.VAULTACCOUNTRESPONSE.RESPONSE_REASON_TEXT);

} catch (Exception ex) { } } private void ProcessVaultCustomer(object sender, EventArgs e) { try { var transactionVault = new TRANSACTION_VAULT(); transactionVault.CUSTOMER_VAULT = GetCustomerVault(); transactionVault.OPERATIONPARAMETERS = new OPERATIONPARAMETERS { ACTIONCODE = 1 }; //1 - add, 2- update, 3- delete transactionVault.MERCHANT_KEY = new MERCHANT_KEY(); transactionVault.MERCHANT_KEY.SECUREKEY = "cWpQuPz0lI3p"; transactionVault.MERCHANT_KEY.SECURENETID = 1000093; gsClient.ProcessCustomer(transactionVault); } catch (Exception ex) { } } private void ProcessVaultAccountAndCustomer(object sender, EventArgs e) { try { var transactionVault = new TRANSACTION_VAULT(); transactionVault.CUSTOMER_VAULT = GetCustomerVault(); transactionVault.ACCOUNT_VAULT = GetAccountVault(); transactionVault.OPERATIONPARAMETERS = new OPERATIONPARAMETERS { ACTIONCODE = 1 }; //1 - add, 2- update, 3- delete transactionVault.MERCHANT_KEY = new MERCHANT_KEY(); transactionVault.MERCHANT_KEY.SECUREKEY = "cWpQuPz0lI3p"; transactionVault.MERCHANT_KEY.SECURENETID = 1000093; gsClient.ProcessCustomerAndAccount(transactionVault); } catch (Exception ex) { Console.WriteLine(ex.Message); } }

Page 75: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

75

private GatewayService.CUSTOMER_VAULT GetCustomerVault() { var customerVault = new CUSTOMER_VAULT(); customerVault.CSDI = 0; customerVault.CUSTOMERID = "CID1";

// Please increase this number to the next one (e.g. CID2) or provide a unique number each time you run to get an approval

customerVault.NOTES = "Notes"; customerVault.CUSTOMER_BILL = GetVaultCustomerCustomerBill(); return customerVault; } private GatewayService.CUSTOMER_BILL GetVaultCustomerCustomerBill() { GatewayService.CUSTOMER_BILL customerBill = new GatewayService.CUSTOMER_BILL(); customerBill.ADDRESS = "tbCVAddress"; customerBill.CITY = "CVCity"; customerBill.COMPANY = "CVCompany"; customerBill.COUNTRY = "CVCountry"; customerBill.EMAIL = "[email protected]"; customerBill.EMAILRECEIPT = "TRUE"; customerBill.FIRSTNAME = "FirstName"; customerBill.LASTNAME = "LastName"; customerBill.PHONE = "3013500000"; customerBill.STATE = "MD"; customerBill.ZIP = "20850"; return customerBill; } private TRANSACTION_VAULT GetTransactionVault() { TRANSACTION_VAULT transactionVault = new TRANSACTION_VAULT(); transactionVault.ACCOUNT_VAULT = GetAccountVault(); transactionVault.CUSTOMER_VAULT = GetCustomerVault(); transactionVault.TRANSACTION = GetTransactionObject(); return transactionVault; } private GatewayService.ACCOUNT_VAULT GetAccountVault() { ACCOUNT_VAULT accountVault = new ACCOUNT_VAULT(); GatewayService.CARD card = new CARD(); card.CARDNUMBER = "4111111111111111"; card.EXPDATE = "1212"; accountVault.ACDI = 0; // other values 1,2 0r 3 accountVault.CUSTOMERID = "CID1";

Page 76: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

76

// Please increase this number to the next one (e.g. CID2) or provide a unique number each time you run to get an approval

accountVault.CARD = card; accountVault.PAYMENTID = "PID1";

// Please increase this number to the next one (e.g. PID2) or provide a unique number each time you run to get an approval accountVault.PRIMARY = "TRUE"; accountVault.METHOD = "CC"; // Possible values DB, ECHECK, CHECK21 return accountVault; } private GatewayService.TRANSACTION GetTransactionObject() { MERCHANT_KEY merchantKey = new MERCHANT_KEY(); merchantKey.SECUREKEY = "cWpQuPz0lI3p"; merchantKey.SECURENETID = 1000093; GatewayService.CARD card = new GatewayService.CARD(); GatewayService.TRANSACTION transaction = new GatewayService.TRANSACTION(); card.CARDNUMBER = "4111111111111111"; card.EXPDATE = "1212"; transaction.CARD = card; transaction.CODE = "0100"; transaction.AMOUNT = 1.00m; transaction.TEST = "FALSE"; transaction.ORDERID = DateTime.Now.ToString().Replace("/", "").Replace(":", "").Replace(" ", ""); transaction.METHOD = "CC"; transaction.TRANSACTION_SERVICE = 1; transaction.MERCHANT_KEY = merchantKey; return transaction; } private GatewayService.CUSTOMER_BILL GetVaultAccountCustomerBill() { GatewayService.CUSTOMER_BILL CustomerBill = new GatewayService.CUSTOMER_BILL(); CustomerBill.ADDRESS = " Test ASddress"; CustomerBill.CITY = " Test City"; CustomerBill.COMPANY = "US"; CustomerBill.EMAIL = "[email protected]"; CustomerBill.EMAILRECEIPT = "FALSE"; CustomerBill.FIRSTNAME = "First Name"; CustomerBill.LASTNAME = "Phone"; CustomerBill.STATE = "MD"; CustomerBill.ZIP = "20878"; return CustomerBill; } } }

Page 77: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

77

7.19.2. Some best practices for SecureNet API implementation Gateway URL, SecureNet ID, SecureKey and test mode should be designed to be configurable by the developer who is integrating to the API. 7.19.3. Test Data To perform tests in our test environment make sure to set Virtual Terminal to ‘LIVE MODE’, the ‘TEST’ parameter as ‘FALSE’, and send the transactions to https://certify.securenet.com/API/Gateway.svc To request a test account, please contact your sales agent, or send a request to [email protected]. Credit Cards: Test Credit Card Numbers for Approved Transactions

American Express 370000000000002 Discover 6011000000000012 MasterCard 5424000000000015 Visa 4444333322221111

Fraud Prevention Settings

AVS Match 20008 CVV/CID Approval 568 CVV/CID Visa 999 CVV/CID MasterCard 998

Test Credit Card Numbers for Declined Transactions

MasterCard 5105105105105100 MasterCard 5555555555554444 Visa 4111111111111111 Visa 4012888888881881 American Express 378282246310005 American Express 371449635398431

Checks:

For checking account number - use any 6-digit number.

Valid Routing Numbers: 222371863 307075259 052000113

Page 78: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

78

7.19.4. Fault exceptions • When you are submitting an incorrect request, which is not validated by our XSD, we will send an “HTTP

400 Bad Request” response. Please look at the RESPONSE_REASON_TEXT for description of the error and modify your request accordingly.

• When submitting an HTTP POST (REST) request: 1. Please make sure that all the request elements are present in the order that is defined in XSD.

2. Fields, which are of value type, i.e. Integer, Decimal, etc., must be present in the request even if not

needed, if their parent object is present. For example: If TRANSACTION object is sent as request xml then OVERRIDE_FROM, TOTAL_INSTALLMENTCOUNT, INSTALLMENT_SEQUENCENUM, TRANSACTION_SERVICE, RETAIL_LANENUM, DCI, AMOUNT, CASHBACK_AMOUNT elements should be present in proper order (as defined in XSD) even if the values are 0.

7.19.5. API Error Codes Gateway API can return multiple errors for different operations. Here are some examples and suggested solutions:

Error Code

Message Correcting this error

0102 “ORDER ID PROVIDED MUST BE UNIQUE FOR YOUR ACCOUNT”

A client generated unique ID is required for each transaction submitted to the Gateway. Please note that if submitting a refund on a previously settled transaction, ORDERID for a refund still needs to be unique (do not use the one from the settled transaction), while TRANSACTIONID remains the same.

0104 SECURE KEY IS INVALID FOR SECURENET ID PROVIDED

Please make sure the SecureNet ID and Secure Key are correct. If they are - this error message is most likely caused by using production SecureNet ID/Key with a demo URL or vice versa. Make sure you are referencing the correct URL: https://certify.securenet.com/api/gateway.svc - Certification Environment (test/demo environment) https://gateway.securenet.com/api/gateway.svc - Production Environment (live environment)

01C0 “MERCHANT ACCOUNT IS NOT SET FOR CARD PRESENT”

Please provide credit card number for the transaction. Full card number is required for: AUTH_ONLY, PARTIAL_AUTH_ONLY, AUTH_CAPTURE, PARTIAL_AUTH_CAPTURE, CAPTURE_ONLY, CREDIT_AUTHONLY, FORCE_CREDIT, FORCE_CREDIT_AUTHONLY, VERIFICATION, AUTH_INCREMENT, ISSUE, ACTIVATE, REDEEM, REDEEM_PARTIAL, DEACTIVATE,

Page 79: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

79

REACTIVATE, and INQUIRY_BALANCE transactions. Last 4 digits of the card number are required for PRIOR_AUTH_CAPTURE, VOID, PARTIAL_VOID, CREDIT, CREDIT_PRIORAUTHCAPTURE, and FORCE_CREDIT_PRIORAUTHCAPTURE transactions.

01C9 “MERCHANT DOES NOT ACCEPT” Merchant does not accept card type submitted with the transaction.

Here is a complete list of API error codes and descriptions:

Response Code

Response Sub Code

Reason Text

0100 0001 ERROR 0100 0002 GATEWAY CONNECTION PROBLEM.RETRY 0100 0003 NetConnect Error 0101 SECURENET ID IS REQUIRED 0102 SECURENET KEY IS REQUIRED 01O3 ORDERID PROVIDED MUST BE EQUAL OR LESS THAN 25 CHARACTERS 0103 SECURENET ID IS INVALID 0104 SECURE KEY IS INVALID FOR SECURENET ID PROVIDED 0105 TEST VALUE SHOULD BE TRUE OR FALSE 0106 ORDERID PER TRANSACTION IS REQUIRED 0107 TRANSACTION AMOUNT IS REQUIRED 0108 METHOD VALUE SHOULD BE SPECIFIED 0109 TRANSACTION TYPE IS INVALID 0110 RECORDTYPE SHOULD BE SPECIFIED SAVE OR RECURRING OR PROCESS 0111 MERCHANT ACCOUNT IS INACTIVE 0112 DEBIT KEY SERIAL NUMBER(KSN) IS REQUIRED 0113 <VARIABLE> IS NOT ALLOWED ON CHECK21 TRANSACTION 0114 DEBIT PIN IS REQUIRED 0115 DEBIT PIN IS INVALID 0116 <VARIABLE> IS NOT ALLOWED ON DEBIT TRANSACTION 0117 <VARIABLE> IS NOT VALID STORED VALUE TRANSACTION 0118 CUSTOMER ID IS REQUIRED 0119 CUSTOMER ID MUST EXIST TO ADD/UPDATE ACCOUNT 0120 PAYMENT ID CANNOT BE NULL 0121 PAYMENT ID SHOULD BE UNIQUE FOR EXISTING CUSTOMER ID 0122 PAYMENT ID DOES NOT EXIST FOR THE CUSTOMER ID 0123 CUSTOMER ID MUST BE UNIQUE FOR EACH CUSTOMER RECORD 0124 CUSTOMER ID DOES NOT EXIST 0125 SECURENET ID SHOULD BE NUMBER ONLY

Page 80: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

80

0126 TRANSACTION ID SHOULD BE NUMBER ONLY

0127 TRANSACTION TYPE SHOULD BE AUTH_CAPTURE, AUTH_ONLY, CAPTURE_ONLY, CREDIT, FORCE_CREDIT, VOID, PRIOR_AUTH_CAPTURE

0128 CUSTOMER ID OR PAYMENT ID DOES NOT EXIST OR INVALID 0129 NO MATCH FOUND AS PER CUSTOMER ID AND PAYMENT ID 0130 MERCHANT ACCOUNT IS NOT VALID 0131 MERCHANT ACCOUNT IS NOT ENABLED FOR MOTO TRANSACTION 0132 MERCHANT ACCOUNT IS NOT ENABLED FOR ECOM TRANSACTION 0133 ECO(FORCE CREDIT) NOT ENABLED FOR THE MERCHANT 0134 NO APPROVED TRANSACTION EXISTS TO VOID FOR THE ORDER ID PROVIDED 0135 CAN NOT RERUN A TRANSACTION FOR A CARD-PRESENT TYPE TRANSACTION 0136 REFERENCE TRANSACTION MUST BE SUBMITTED WITHIN 90 DAYS 0137 INDUSTRY TYPE IS NOT SUPPORTED FOR ASSIGNED PROCESSOR 0138 SETTLED TRANSACTIONS CANNOT BE MODIFIED 0139 APPROVED TRANSACTION IS REQUIRED FOR CHANGING IT TO AUTH_ONLY 0140 <VARIABLE> NUMBER IS INVALID. ACCURACY OF THE CARD CANNOT BE VALIDATED 0141 <VARIABLE> NUMBERS ARE INVALID 0142 CARD TYPE COULDN'T BE IDENTIFIED 0143 BILL PAYMENT TRANSACTION IS NOT ALLOWED FOR RECURRING OR INSTALLMENT 0144 MERCHANT IS NOT ENABLED TO SEND LEVEL 3 TRANSACTION

0145 ADDRESS INFORMATION WITH ZIPCODE SHOULD BE PROVIDED FOR AVS_VERIFICATION CHECK

0146 NO MOTO/ECOM TRANSACTION FOR RETAIL MERCHANT IN NASHVILLE

0147 NO MOTO TRANSACTIONS FOR ECOM MERCHANT OTHER THAN RECURRING TRANSACTION

0148 CardType is invalid. 0150 MERCHANT IS NOT ENABLED FOR BILL PAYMENT 0151 MERCHANT IS NOT ENABLED FOR DEBT PAYMENT 0152 INVALID MARKET SPECIFIC DATA 0153 INSTALLMENT_SEQUENCENUM AND TOTAL_INSTALLMENTCOUNT RANGE 1-99

0154 INSTALLMENT SEQUENCE NUMBER CANNOT BE GREATER THAN TOTAL INSTALLMENT COUNT

0156 <VARIABLE> TRANSACTION IS NOT ALLOWED 0157 PAYMENTID HAS TO BE ALPHANUMERIC 0158 CUSTOMERID HAS TO BE ALPHANUMERIC 0159 CREDIT CARD LAST 4 DIGITS DOES NOT MATCH DURING UPDATE 0170 MerchantID Not Found 0181 Merchant not enabled for BuyPass 01A1 AMOUNT IS INVALID 01A2 AMOUNT CANNOT BE GREATER THAN $999,999.99 01A3 VALID AMOUNT IS REQUIRED 01A4 CASH BACK AMOUNT IS INVALID 01A5 VALID CASH BACK AMOUNT IS REQUIRED 01A6 GRATUITY AMOUNT IS INVALID

Page 81: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

81

01A7 VALID GRATUITY AMOUNT IS REQUIRED 01A8 ROOM RATE AMOUNT IS INVALID 01A9 VALID ROOM RATE AMOUNT IS REQUIRED 01A11 VALID HOTEL EXTRA CHARGE AMOUNT IS REQUIRED 01ACH0 MERCHANT IS NOT ENABLED FOR ACH TRANSACTIONS 01ACH1 9 DIGIT ABA ROUTING NUMBER OF THE BANK IS REQUIRED 01ACH2 ACCOUNT NUMBER IS REQUIRED 01ACH3 BANK NAME IS REQUIRED 01ACH4 INVALID BANK ACCOUNT NUMBER 01ACH7 BANK ACCOUNT NUMBER HAS TO BE NUMERIC 01ACH8 THIS BANK ACCOUNT IS BLOCKED DUE TO PREVIOUS RETURN 01ACH9 NOC RECEIVED, INVALID BANK INFORMATION 01ACH10 MICRDATA NOT RECEIVED FOR CHECK21 TRANSACTIONS 1ACH11 0001 ACH SEC CODE IS NOT SUPPORTED 1ACH11 0003 INVALID ROUTING NUMBER 1ACH11 0004 ACH AMOUNT LIMIT IS EXCEED FOR SEC CODE 1ACH11 0005 INVALID CHECK NO 01B7 BANK ACCOUNT DOES NOT MATCH FOR 01B8 ACCOUNT TYPE DOES NOT MATCH FOR 01C0 MERCHANT ACCOUNT IS NOT SET FOR CARD PRESENT TRANSACTIONS 01C1 CREDIT CARD NUMBER IS REQUIRED 01C2 CREDIT CARD EXPIRY MONTH AND YEAR IS REQUIRED 01C3 0001 CARD NUMBER IS NOT SPECIFIED 01C3 0002 NOT A VALID CARD NUMBER 01C3 0003 THE CARD CODE(CVV2/CVC2/CID) IS INVALID 01C3 0004 EXPIRY DATE HAS TO BE IN MMYY FORMAT 01C3 0005 EXPIRY DATE IS NOT A VALID DATE 01C3 0006 CREDIT CARD HAS EXPIRED 01C3 0007 DEBIT CARD IS NOT VALID 01C3 0008 THE CARD CODE IS INVALID 01C3 0009 STORED VALUE CARD IS NOT VALID 01C4 CARD EXPIRY MONTH AND YEAR MUST BE IN MMYY FORMAT 01C6 INVALID TRACK DATA 01C7 TRACK DATA SHOULD NOT BE PRESENT FOR CARD-NOT-PRESENT TRANSACTION 01C8 CARD NUMBER HAS TO BE NUMERIC 01C9 MERCHANT DOES NOT ACCEPT 01D1 DEBIT CARD NEEDS TO BE SWIPED 01E1 EMAIL RECEIPT VALUE SHOULD BE TRUE OR FALSE 01F1 SERVER NO CANNOT BE GREATER THAN 8 CHARACTERS 01H5 NAME ON THE CUSTOMERS BANK ACCOUNT IS REQUIRED 01H6 BANK ACCOUNT TYPE CHECKING OR SAVINGS IS REQUIRED 01H7 BANK ACCOUNT TYPE SHOULD BE SPECIFIED AS CHECKING OR SAVINGS 01H8 NOC RECIEVED, INVALID BANK INFORMATION

Page 82: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

82

01O1 PREVIOUS TRANSACTION ID IS REQUIRED 01O2 ORDERID PROVIDED MUST BE UNIQUE FOR YOUR ACCOUNT 01R1 TRANSACTION ID DOES NOT EXIST FOR 01R2 CREDIT AMOUNT CANNOT BE GREATER THAN THE AUTHORIZED AMOUNT 01R3 CREDIT CANNOT BE COMPLETED ON A UNSETTLED TRANSACTION 01R4 CREDIT CANNOT BE COMPLETED ON A <VARIABLE >TRANSACTION 01R5 INVALID TRANSACTION ID FOR 01R6 CREDIT OR VOID HAS TO BE DONE IN THE SAME TEST MODE 01R7 CREDIT CARD DOES NOT MATCH FOR 01R8 CREDIT CANNOT BE PERFORMED ON TRANSACTIONS MORE THAN 180 DAYS OLD 01R9 PRIOR_AUTH_CAPTURE CANNOT BE PERFORMED ON 30 DAYS OR OLD TRANSACTION 01R10 TRANSACTION CANNOT BE REVERSED AS ITS ALREADY SETTLED 01R11 CREDIT TRANSACTION CANNOT BE REVERSED AS ITS ALREADY 01V1 SETTLED TRANSACTIONS CANNOT BE VOIDED 01V2 TRANSACTION HAS ALREADY BEEN VOIDED 01V3 CREDIT SETTLED TRANSACTIONS CANNOT BE VOIDED 01V4 AMOUNT CANNOT BE GREATER THAN THE AUTHORIZED AMOUNT 0O01 PARAMETERS MISSING IN PETROLEUM ITEMIZED PRODUCTS 0O02 NO OF PETROLEUM ITEMIZED PRODUCTS CANNOT EXCEED 9 0O03 PETROLEUM PRODUCT CODE IS INVALID 0O04 UNIT PRICE IS NOT IN VALID FORMAT 0O05 INVALID UNIT PRICE 0O06 PRODUCT QUANTITY IS NOT IN VALID FORMAT 0O07 INVALID PRODUCT QUANTITY 0O08 INVALID PRODUCT CODE FOR FUEL ONLY CARD 0O09 INVALID PRODUCT QUANTITY 0O10 PRODUCT AMOUNT IS INVALID FOR UNIT PRICE AND QUANTITY PROVIDED 0O11 LEVEL 2 TAX AMOUNT IS REQUIRED 0O12 TOTAL PRODUCT AMOUNT IS NOT EQUAL TO TRANSACTION AMOUNT 0O14 PRODUCT QUANTITY IS NOT IN VALID FORMAT 0O15 ITEMIZED PRODUCTS ARE REQUIRED 1A10 HOTEL EXTRA CHARGE AMOUNT IS INVALID 1A11 VALID HOTEL EXTRA CHARGE AMOUNT IS REQUIRED 1A12 AUTO EXTRA CHARGE AMOUNT IS INVALID 1A13 VALID AUTO EXTRA CHARGE AMOUNT IS REQUIRED 1A14 AMOUNT CANNOT BE GREATER THAN $99,9999 1A15 CASH BACK AMOUNT CANNOT BE GREATER THAN $100 1A16 CASH BACK AMOUNT CANNOT BE GREATER OR EQUAL TO TRANSACTION AMOUNT 1ACH10 VALID 9 DIGIT ABA ROUTING NUMBER OF THE BANK IS REQUIRED 1DB0 MERCHANT IS NOT ENABLED FOR DEBIT TRANSACTIONS 1SV0 MERCHANT IS NOT ENABLED FOR STORED VALUE TRANSACTIONS 1SV1 STORED VALUE NUMBER IS REQUIRED 1SV2 STORED VALUE MONTH AND YEAR IS REQUIRED IN MMYY FORMAT

Page 83: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

83

1SV5 PARTIAL REVERSAL IS NOT ALLOWED FOR RETAIL INDUSRTY ACD3 DUPLICATE ACCOUNT ACD4 EXISTING ACCT NO/TOKEN COMBINATION AO01 PREFERRED CUSTOMER VALUE IS INVALID AO04 AUTORENTAL SALE CODE IS INVALID AO05 AUTO EXTRA CHARGE INDICATOR IS INVALID AO06 RENTAL DATE IS REQUIRED AO07 RETURN DATE IS REQUIRED AO08 RENTAL DATETIME IS INVALID AO09 RETURN DATETIME IS INVALID AO10 0001 RENTAL TIME IS REQUIRED AO10 0002 INVALID RENTAL AND RETURN DATES AO11 VALID AUTO EXTRA CHARGE AMOUNT IS REQUIRED AO12 RENTAL TIME SHOULD BE VALID TIME AO14 RETURN TIME SHOULD BE VALID TIME AO15 RENTAL STATE IS INVALID AO16 RETURN STATE IS INVALID AO17 RENTAL STATE MUST BE VALID 2 CHARACTER ABBREVIATION AO18 RETURN STATE MUST BE VALID 2 CHARACTER ABBREVIATION AB01 CUSTOMER ID IS REQUIRED AB02 PAYMENT ID IS REQUIRED AB03 AB TYPE IS REQUIRED AB04 MAX RETRIES MUST BE BETWEEN 0 AND 5 AB05 START DATE IS REQUIRED AB06 INVALID START DATE AB08 INVALID CUSTOMERID AB09 NO RECURRING INFORMATION PROVIDED AB11 NO INSTALLMENT INFORMATION PROVIDED AB10 NO VARIABLE INFORMATION PROVIDED AB11 NO INSTALLMENT INFORMATION PROVIDED AB12 INVALID AMOUNT AB13 AB CYCLE IS REQUIRED AB14 INVALID AB CYCLE (W,M,B,Q,Y) AB15 INVALID FREQUENCY AB16 INVALID AB DAY (0 - 28) AB17 INVALID AB MONTH (0 - 12) AB18 INVALID AB WEEKDAY (0 - 7) AB19 INVALID NO END DATE FLAG (0, 1) AB20 VALID END DATE IS REQUIRED AB21 END DATE MUST BE AFTER START DATE AB22 AB AUTO CALC OPTION IS REQUIRED AB23 INVALID AB AUTO CALC OPTION (A, M) AB24 INVALID AB REMAINDER OPTION (0, 1)

Page 84: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

84

AB25 INVALID AB INSTALLMENT COUNT (1 - 99) AB26 INSTALLMENT AMOUNT MINIMUM IS 1.00 AB27 INVALID BALLOON AMOUNT AB28 INVALID AB BALLOON OPTION (0, 1) AB29 AB PLAN NOT FOUND AB30 END DATE CANNOT BE BEFORE CURRENT DATE. AB31 END DATE IS REQUIRED WHEN NO END FLAG = 0 AB32 INVALID END DATE AB33 START DATE CANNOT BE CHANGED ONCE PLAN IT HAS STARTED AB34 START DATE CANNOT BE BEFORE TOMORROW AB35 PLAN ID IS REQUIRED AB36 AB TYPE CANNOT BE CHANGED AB37 AB SCHEDULE IS REQUIRED AB38 INVALID SCHEDULE AB39 SCHEDULED PAYMENT COUNLD NOT BE FOUND AB40 INVALID PAYMENT AMOUNT AB41 INSTALLMENT DATE IS REQUIRED AB42 INVALID INSTALLMENT DATE AB43 INVALID INSTALLMENT NUMBER AB44 INVALID NUMBER OF RETRIES AB45 PAID STATUS CANNOT BE UPDATED AB46 INSTALLMENT NUMBER CANNOT BE UPDATED AB47 NUMBER OF RETRIES CANNOT BE UPDATED AB48 PAYMENT DATE CANNOT BE UPDATED AB49 PLAN ID CANNOT BE UPDATED AB50 PROCESSED CANNOT BE UPDATED AB51 VARIABLE SCHEDULE IS REQUIRED AB52 TRANSACTIONID CANNOT BE UPDATED AB53 PAID TRANSACTIONS CANNOT BE UPDATED AB54 PROCESSED TRANSACTIONS CANNOT BE UPDATED AB55 INSTALLMENT DATE CANNOT BE BEFORE TOMORROW AB54 INSTALLMENT DATE CANNOT BE BEFORE PREVIOUS INSTALLMENT DATE AB57 INSTALLMENT DATE CANNOT BE AFTER NEXT INSTALLMENT DATE AB58 INVALID AB TYPE AB59 ERROR SAVING AB PLAN AB60 ERROR SAVING AB SCHEDULE AB61 CUSTOMER ID NOT FOUND IN VAULT AB62 PAYMENT ID NOT FOUND IN VAULT AB63 SCHEDULED PAYMENT CANNOT BE NULL AB64 ONLY NEXT SCHEDULED PAYMENT CAN BE ADJUSTED FOR RECURRING TYPES AB65 SCHEDULED PAYMENT CANNOT BE UPDATED DUE TO PROCESS STATUS AB66 ONLY AMOUNT CAN BE UPDATED FOR RECURRING SCHEDULE CHANGE AB67 INVALID SCHEDULE ID (ONLY NEXT PAYMENT CAN BE ADJUSTED FOR RECURRING TYPE)

Page 85: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

85

AB68 ONLY ONE SCHEDULED PAYMENT CAN BE UPDATED AT A TIME AB69 SCHEDULE ID IS REQUIRED AB70 CANNOT EXCEED 99 INSTALLMENTS AB71 INSTALLMENT NUMBER IS REQUIRED AB72 BALLOON SCHEDULED PAYMENT AMOUNT CANNOT BE CHANGED AB73 LAST SCHEDULED PAYMENT AMOUNT CANNOT BE CHANGED AB74 NO PLANS FOUND AB75 AB IS NOT ENABLED FOR THIS SECURENET ID AB00 CALCULATION ERROR PR01 PRODUCT COLLECTION CANNOT CONTAIN NULL PRODUCT PR02 LEVEL3PRODUCT COLLECTION CANNOT CONTAIN NULL LEVEL3PRODUCT CA01 AUTHORIZATION CODE IS REQUIRED CA02 AUTHORIZATION CODE LENGTH HAS TO BE 6 HO01 PREFERRED CUSTOMER VALUE IS INVALID HO02 HOTEL CHARGE TYPE IS REQUIRED HO03 HOTEL CHARGE TYPE IS INVALID HO04 HOTEL SALE CODE IS INVALID HO05 HOTEL EXTRACHARGEINDICATOR IS INVALID HO06 HOTEL CHECK IN DATE IS REQUIRED HO07 HOTEL CHECK OUT DATE IS REQUIRED HO08 HOTEL CHECK IN DATE SHOULD BE VALID DATE HO09 HOTEL CHECK IN DATE SHOULD BE VALID DATE HO10 INVALID CHECKIN AND CHECK OUT DATES L201 TAX FLAG VALUE IS INVALID L202 0001 TAX AMOUNT IS REQUIRED IF TAX IS INCLUDED L202 0002 PURCHASE ORDER NUMBER IS REQUIRED L2A1 TAX AMOUNT IS INVALID L2A2 TAX AMOUNT HAS TO BE BETWEEN 0.01% AND 22% OF THE AUTHORIZED AMOUNT L2A3 VALID TAX AMOUNT IS REQUIRED L2A4 TAX AMOUNT CANNOT BE GREATER THAN $99,9999 L2D1 DUTY AMOUNT IS INVALID L2D2 DUTY AMOUNT CANNOT BE GREATER THAN $99,9999 L2D3 VALID DUTY AMOUNT IS REQUIRED L2D4 DUTY AMOUNT CANNOT BE GREATER THAN $99,9999 L301 MERCHANT VAT REGISTRATION NUMBER IS REQUIRED L302 PURCHASER VAT REGISTRATION NUMBER IS REQUIRED L303 VAT INVOICE REF NUMBER IS REQUIRED L304 VAT TAX AMOUNT IS REQUIRED L305 VAT TAX AMOUNT IS INVALID L306 VAT TAX RATE IS REQUIRED L307 ALTERNATE TAX AMOUNT INDICATOR IS INVALID L308 ALTERNATE TAX AMOUNT IS INVALID L309 NATIONAL TAX AMOUNT INDICATOR IS INVALID

Page 86: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

86

L310 NATIONAL TAX AMOUNT IS INVALID L311 ORDER DISCOUNT AMOUNT IS INVALID L312 ORDER DUTY AMOUNT IS INVALID L313 ORDER FREIGHT AMOUNT IS INVALID L314 PURCHASER ORDER DATE IS INVALID L315 PARAMETERS MISSING IN LEVEL 3 ITEMIZED PRODUCTS L316 PRODUCT ITEM CODE IS REQUIRED L317 PRODUCT ITEM NAME IS REQUIRED L318 PRODUCT UNIT PRICE IS REQUIRED L319 PRODUCT UNIT PRICE IS INVALID L320 PRODUCT QUANTITY IS REQUIRED L321 PRODUCT QUANTITY IS INVALID L322 PRODUCT DISCOUNT INDICATOR IS INVALID L323 PRODUCT DISCOUNT RATE IS INVALID L324 PRODUCT DISCOUNT AMOUNT IS INVALID L325 PRODUCT TAX RATE IS INVALID L326 PRODUCT TAX AMOUNT IS INVALID L327 PRODUCT TOTAL AMOUNT IS INVALID L329 PRODUCT GROSS NET INDICATOR IS INVALID L330 TRANSACTION AMOUNT AND LEVEL 3 PRODUCTS TOTAL AMOUNT DOES NOT MATCH L331 LEVEL 3 TAX AMOUNT DOES NOT MATCH WITH LEVEL 2 TAX AMOUNT P004 0001 VEHICLE NUMBER FOR SHELL SHOULD BE 6 CHARACTERS P004 0002 VEHICLE NUMBER SHOULD NOT BE MORE THAN 6 CHARACTERS P004 0003 VEHICLE NUMBER SHOULD NOT BE MORE THAN 5 CHARACTERS P005 ODOMETER SHOULD NOT BE MORE THAN 6 CHARACTERS P006 DRIVER/JOBNUMBER SHOULD NOT BE MORE THAN 6 CHARACTERS P100 TRANSACTION IS NOT ALLOWED

PA10 TRANSACTION AMOUNT CANNOT BE REVERSED MORE THAN THE TOTAL AUTHORIZED AMOUNT

PA11 TRANSACTION HAS BEEN ALREADY VOIDED PA12 CAPTURE AMOUNT CANNOT BE GREATER THAN PREVIOUSLY AUTHORIZED AMOUNT PAC1 0001 TRANSACTION IS ALREADY CAPTURED PAC4 0002 <VARIABLE> IS INVALID FOR THIS TERMINAL PAC5 AUTH_REVERSAL IS VALID FOR VISA ONLY PAC6 AUTH_INCREMENT IS VALID FOR VISA ONLY PAC7 TRANSACTION CANNOT BE CAPTURED(DOES NOT MEET THE CRITERIA) PAC8 TRANSACTION CANNOT BE INCREMENTED(DOES NOT MEET THE CRITERIA) PAC9 TRANSACTION HAS BEEN ALREADY VOIDED RB01 RECURRING AMOUNT IS REQUIRED RB02 RECURRING AMOUNT IS INVALID RB03 VALID RECURRING AMOUNT IS REQUIRED RB04 RECURRING AMOUNT CANNOT BE GREATER THAN $99,9999 RB05 RECURRING BILLING START DATE IS REQUIRED

Page 87: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

87

RB06 RECURRING BILLING START DATE IS INVALID

RB07 RECURRING BILLING START DATE CANNOT BE LESS THAN OR EQUAL TO CURRENT DATE

RB08 SPECIFY RECURRING BILLING HAS END DATE, YES OR NO RB09 RECURRING BILLING HAS END DATE SHOULD BE YES OR NO RB10 RECURRING BILLING END DATE IS INVALID RB11 RECURRING BILLING END DATE CANNOT BE LESS THAN OR EQUAL TO START DATE RB12 SPECIFY RECURRING BILLING PERIOD,Y–YEARLY,M–MONTHLY,W–WEEKLY RB14 RECURRING BILLING PERIOD HAS TO BE Y–YEARLY,M–MONTHLY,W–WEEKLY RB15 SPECIFY RECURRING BILLING DAY BASED ON THE BILLING PERIOD RB16 RECURRING BILLING DAY HAS TO BE A NUMBER

RB17 RECURRING BILLING DAY CAN BE BETWEEN 1-SUNDAY TO 7-SATURDAY WEEKLY BILLING

RB18 SPECIFY RECURRING BILLING MONTH BASED ON THE BILLING PERIOD RB19 RECURRING BILLING MONTH HAS TO BE A NUMBER RB20 SPECIFY RECURRING BILLING ACCOUNT AS ACTIVE, YES OR NO RB21 CUSTOMER ID SHOULD BE SPECIFIED FOR SAVE OR RECURRING RECORD RB22 CUSTOMER ID SHOULD BE UNIQUE FOR SAVE OR RECURRING RECORD

RB23 PASSWORD SHOULD BE PROVIDED FOR THE USERNAME FOR SAVE OR RECURRING RECORD

RB24 USERNAME SHOULD BE UNIQUE FOR SAVE OR RECURRING RECORD

RB25 TRANSACTION TYPE CANNOT BE CREDIT,FORCE_CREDIT, VOID DURING SAVING OR RECURRING

RB26 SPECIFY RECURRING BILLING PERIODICITY FOR THE SPECIFIED RBPERIOD RB27 RECURRING BILLING PERIODICITY HAS TO BE A NUMBER RB28 RECURRING BILLING PERIODICITY CAN BE BETWEEN 1 TO 3 FOR (Y) RB29 RECURRING BILLING PERIODICITY CAN BE BETWEEN 1 TO 51 FOR (W) RB30 RECURRING BILLING PERIODICITY CAN BE BETWEEN 1 TO 11 FOR (M) RB31 RECURRING NEXT BILLING DATE IS REQUIRED RB32 RECURRING NEXT BILLING DATE IS INVALID RB33 RECURRING NEXT BILLING DATE CANNOT BE LESS THAN OR EQUAL TO CURRENT DATE RB34 RECURRING BILLING END DATE IS REQUIRED RB35 RECURRING BILLING DAY CAN BE BETWEEN 1 TO 28 OR 0 FOR MONTH END RB36 RECURRING BILLING MONTH CAN BE BETWEEN 1 AND 12 FOR YEARLY BILLING PD01 PIN-LESS DEBIT CARD NUMBER IS REQUIRED PD02 PIN-LESS DEBIT INVALID TRACK DATA PD03 PIN-LESS DEBIT MERCHANT ACCOUNT IS NOT SET FOR CARD PRESENT PD04 PINLESS DEBIT NUMBER IS REQUIRED PD05 PIN-LESS DEBIT CARD EXPIRY MONTH AND YEAR ARE REQUIRED PD06 PIN-LESS DEBIT CARD EXPIRY MONTH AND YEAR ARE REQUIRED IN MMYY FORMAT PD07 PIN-LESS DEBIT TRANSACTION TYPE IS INVALID PD08 PIN-LESS DEBIT CARD NUMBER IS REQUIRED PD09 IS NOT ALLOWED ON PIN-LESS DEBIT TRANSACTION PD10 0001 PIN-LESS DEBIT CARD NUMBER IS NOT SPECIFIED

Page 88: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

88

PD10 0002 NOT A VALID PIN-LESS DEBIT CARD NUMBER PD10 0003 THE PIN-LESS DEBIT CARD CODE(CVV2/CVC2/CID) IS INVALID PD10 0004 PIN-LESS DEBIT EXPIRY DATE HAS TO BE IN MMYY FORMAT PD10 0005 PIN-LESS DEBIT EXPIRY DATE IS NOT A VALID DATE PD10 0006 PIN-LESS DEBIT CREDIT CARD HAS EXPIRED PD10 0007 PIN-LESS DEBIT DEBIT CARD IS NOT VALID PD10 0008 THE PIN-LESS DEBIT CARD CODE IS INVALID PD10 0009 STORED VALUE PIN-LESS DEBIT CARD IS NOT VALID

01C3 0010 (CARDTYPE NAME) NUMBERS ARE INVALID. ACCURACY OF THE CARD CANNOT BE VALIDATED.

PD11 MERCHANT DOES NOT ACCEPT PIN LESS DEBIT PD12 SECURENET FRONTEND IS NOT ENABLED AT MERCHANT GATEWAY INFORMATION PD13 ONLINE REVERSAL IS NOT ENABLED PD14 ONLINE CREDIT IS NOT ENABLED PD15 INVALID MARKET SPECIFIC DATA FOR NON PINLESS DEBIT PD16 CARD IS NOT ELIGIBLE FOR PIN-LESS DEBIT TRANSACTION

SH200 CANNOT UPDATE ACCOUNTINFO TO NON-PRIMARY, CUSTOMER ID REQUIRES A PRIMARY ACCOUNT.

ACD0 ACDI (ACCOUNT DUPLICATE INDICATOR) VALUE SHOULD BE SPECIFIED AS 0 ,1,2 OR 3 ACD1 NO ACCOUNT ADDED, DUPLICATE ACCOUNT NUMBER ACD2 DUPLICATE ACCOUNT DCT03 DUPLICATE INDICATOR VALUE IS INVALID. CA03 AUTHORIZATION CODE MISMATCH CA04 MISSING AUTHORIZATION CODE CDI1 INVALID VALUE FOR CUSTOMER DUPLICATE INDICATOR (CSDI) DCT02 APPROVED 01CK210 MERCHANT IS NOT ENABLED FOR CHECK21 TRANSACTIONS 01CK2119 MICRDATA NOT RECEIVED FOR CHECK21 TRANSACTIONS 01CK211 VALID 9 DIGIT ROUTING NUMBER OF THE BANK IS REQUIRED 01CK212 ACCOUNT NUMBER IS REQUIRED 01CK219 ACCOUNT NUMBER HAS TO BE NUMBERS 01CK214 INVALID BANK ACCOUNT NUMBER 01CK218 9 DIGIT ABA ROUTING NUMBER OF THE BANK HAS TO BE NUMBERS 01CK2110 VALID 9 DIGIT ABA ROUTING NUMBER OF THE BANK IS REQUIRED 01CK2120 CHECK NUMBER IS REQUIRED 01CK2121 CHECK NUMBER HAS TO BE NUMBERS 01CK217 BANK ACCOUNT TYPE SHOULD BE SPECIFIED AS CHECKING OR SAVINGS 01CHK218 NOC received, INVALID BANK INFORMATION 1ACH12 INVALID CHECK NO CHECK01 MERCHANT IS NOT ENABLED FOR ACH TRANSACTIONS CHECK02 9-DIGIT BANK ABA ROUTING NUMBER IS REQUIRED CHECK03 9 DIGIT ABA ROUTING NUMBER OF THE BANK HAS TO BE NUMERIC CHECK04 VALID 9-DIGIT BANK ABA ROUTING NUMBER IS REQUIRED

Page 89: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

89

CHECK05 ACCOUNT NUMBER IS REQUIRED CHECK06 BANK ACCOUNT NUMBER HAS TO BE NUMERIC CHECK07 INVALID BANK ACCOUNT NUMBER CHECK08 CHECK NUMBER IS REQUIRED CHECK09 CHECK NUMBER MUST BE NUMERIC CHECK10 INVALID CHECK NO CHECK11 BANK ACCOUNT TYPE IS REQUIRED: CHECKING OR SAVINGS CHECK12 BANK ACCOUNT TYPE SHOULD BE SPECIFIED AS CHECKING OR SAVINGS 1ACH13 ACCOUNT VERIFICATION IS NOT ENABLED FOR THE SERVICE PROVIDER 1ACH14 SEC CODE PROVIDED CANNOT BE USED FOR CREDIT TRANSACTIONS

In addition, here is the list of error codes generated based on response received from Card Networks:

Response Reason Code

Response Reason Text

0000 APPROVED AND COMPLETED

0001 REFER TO ISSUER

0002 REFER TO ISSUERCASE-SPECIAL CONDITION

0003 INVALID MERCHANT ID

0004 PICK UP CARD (NO FRAUD)

0005 DO NOT HONOR

0006 GENERAL ERROR

0007 PICK UP CARD, SPECIAL CONDITION (FRAUD ACCOUNT)

0008 HONOR MASTERCARD WITH ID

0010 PARTIAL APPROVAL FOR THE AUTHORIZED AMOUNT RETURNED IN GROUP III VERSION 022

0011 VIP APPROVAL

0012 INVALID TRANSACTION

0013 INVALID AMOUNT

0014 INVALID CARD NUMBER

0015 NO SUCH ISSUER

0019 RE-ENTER TRANSACTION

0021 UNABLE TO BACK OUT TRANSACTION

0028 FILE IS TEMPORARILY UNAVAILABLE

0030 FORMAT ERROR

0033 EXPIRED CARD; PICK UP (BUYPASS)

0034 SUSPECTED FRAUD; PICK UP (BUYPASS)

0036 RESTRICTED CARD; PICK UP (BUYPASS)

0039 NO CREDIT ACCOUNT

Page 90: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

90

0041 LOST CARD, PICK UP (FRAUD ACCOUNT)

0043 STOLEN CARD, PICK UP (FRAUD ACCOUNT)

0051 INSUFFICIENT FUNDS

0052 NO CHECKING ACCOUNT

0053 NO SAVINGS ACCOUNT

0054 EXPIRED CARD

0055 INCORRECT PIN

0057 TRANSACTION NOT PERMITTED-CARD

0058 TRANSACTION NOT PERMITTED-TERMINAL

0059 SUSPECTED FRAUD

006* ERROR RESPONSE TEXT FROM CHECK SERVICE

0060 HOLD - CONTACT ACQUIRER

0061 EXCEEDS WITHDRAWAL LIMIT

0062 INVALID SERVICE CODE, RESTRICTED

0063 SECURITY VIOLATION

0065 ACTIVITY LIMIT EXCEEDED

0075 PIN TRIES EXCEEDED

0076 UNABLE TO LOCATE, NO MATCH

0077 INCONSISTENT DATA, REV., OR REPEAT

0078 NO ACCOUNT

0079 ALREADY REVERSED AT SWITCH

0080 INVALID DATE

0081 CRYPTOGRAPHIC ERROR

0082 CASH BACK LIMIT EXCEEDED

0083 CANNOT VERIFY PIN

0085 NO REASON TO DECLINE

0086 CANNOT VERIFY PIN

0090 SYSTEM ERROR

0091 ISSUER OR SWITCH IS UNAVAILABLE

0092 DESTINATION NOT FOUND

0093 VIOLATION, CANNOT COMPLETE

0094 UNABLE TO LOCATE, NO MATCH

0096 SYSTEM MALFUNCTION

00B1 SURCHARGE AMOUNT NOT PERMITTED ON VISA CARDS OR EBT FOOD STAMPS

00B2 SURCHARGE AMOUNT NOT SUPPORTED BY DEBIT NETWORK ISSUER

00CV CARD TYPE VERIFICATION ERROR

00EA VERIFICATION ERROR

00EB VERIFICATION ERROR

Page 91: SecureNet Docs

SecureNet Gateway Implementation Guide 4.1.1.

91

00EC VERIFICATION ERROR

00HV HIERARCHY VERIFICATION ERROR

00N2 INVALID AMT

00N3 CASH BACK SERVICE NOT AVAILABLE

00N4 EXCEEDS ISSUER WITHDRAWAL LIMIT

00N5 INVALID ACCT NUM

00N6 INVALID ACCT

00N7 CVV2 VALUE SUPPLIED IS INVALID

00N8 SYSTEM ERROR

00N9 INVALID TERMINAL

00R0 CUSTOMER REQUESTED STOP OF SPECIFIC RECURRING PAYMENT

00R1 CUSTOMER REQUESTED STOP OF ALL RECURRING PAYMENTS FROM SPECIFIC MERCHANT

00R3 CUSTOMER REQUESTED STOP OF ALL RECURRING PAYMENTS FROM SPECIFIC MERCHANT

00T0 FIRST CHECK IS OK AND HAS BEEN CONVERTED

00T1 CHECK IS OK BUT CANNOT BE CONVERTED. THIS IS A DECLINED TRANSACTION

00T2 INVALID ABA NUMBER, NOT AN ACH PARTICIPANT

00T3 AMOUNT GREATER THAN THE LIMIT

00T5 DUPLICATE CHECK NUMBER

00T6 MICR ERROR

00T7 TOO MANY CHECKS (OVER MERCHANT OR BANK LIMIT)

AVS01 AVS Mismatch. Address info doesn't match the Billing Address of Cardholder.

AVS02 AVS Mismatch. Zip Code doesn't match the Billing Address of Cardholder.

AVS03 AVS Mismatch. Street Info doesn't match the Billing Address of Cardholder.

CVV01 Card Security Code Mismatch.

7.19.6. How to Contact Technical Support For problems with transaction processing or your connection to the server, contact SecureNet Technical Support at [email protected] or (888)231-0060, option 3. Please note that you will be prompted for your SecureNet ID and may be required to provide sample code for further research into your questions.