DC Gateway API Developer's Guide -...

Direct Connect Merchant Services, LLC. is a registered ISO

of Wells Fargo Bank NA, Walnut Creek, CA.

DC Gateway

API Developer's Guide

Last updated: December 1, 2016

Version 2.1

Printed on: December 19, 2016 of 177



Table of Contents

Direct Connect Gateway ........................................................................................................................................................................ 6 Customizing and Integrating to the DC Gateway ............................................................................................................................... 6

Application Programming Interfaces (APIs) ................................................................................................................................................ 6 Simple Object Access Protocol (SOAP) API .................................................................................................................................................. 6 Name-Value Pairs (NVP) ................................................................................................................................................................................ 7 Hosted Payment Pages.................................................................................................................................................................................. 8

Getting Started ........................................................................................................................................................................................ 8 Gateway Integration Certification Overview ............................................................................................................................................... 8 Step 1: Registration ........................................................................................................................................................................................ 9 Step 2: Specification and Analysis ................................................................................................................................................................ 9 Step 3: Development ..................................................................................................................................................................................... 9 Step 4: Certification ........................................................................................................................................................................................ 9 Step 5: Transition ........................................................................................................................................................................................... 9

Web Services .......................................................................................................................................................................................... 10 Administration Web Service ........................................................................................................................................................................ 11

AddMerchant ............................................................................................................................................................................................ 12 UpdateMerchant ...................................................................................................................................................................................... 14

ExtData Parameters (AddMerchant, UpdateMerchant) ................................................................................................................... 16 Merchant Parameters (AddMerchant, UpdateMerchant) ................................................................................................................ 16 Access Parameters (AddMerchant, UpdateMerchant) ..................................................................................................................... 17 PaymentMethodXml Parameters (AddMerchant, UpdateMerchant) ............................................................................................. 17 RegistersXml Parameters (AddMerchant, UpdateMerchant) .......................................................................................................... 18 CardVerification Parameters (AddMerchant, UpdateMerchant) .................................................................................................... 18

DeleteMerchant ........................................................................................................................................................................................ 20 Response Structure (AddMerchant, UpdateMerchant, DeleteMerchant) ......................................................................................... 20 InfoMerchant ............................................................................................................................................................................................ 20 Response Structure (InfoMerchant) ....................................................................................................................................................... 21 AddUser ..................................................................................................................................................................................................... 22 UpdateUser ............................................................................................................................................................................................... 24 Response (AddUser, UpdateUser) .......................................................................................................................................................... 24 InfoUser ..................................................................................................................................................................................................... 25 Response (InfoUser) ................................................................................................................................................................................. 25 InfoCustomer ............................................................................................................................................................................................ 26 InfoContract .............................................................................................................................................................................................. 26 Response Structure (InfoCustomer, InfoContract) ............................................................................................................................... 27

PaymentMethod Parameters (InfoCustomer, InfoContract) ........................................................................................................... 27 Contract Parameters (InfoContract) ................................................................................................................................................... 28

GetAPIUser ................................................................................................................................................................................................ 29 Response (GetAPIUser) ............................................................................................................................................................................ 29 GetDebitAccount ...................................................................................................................................................................................... 29 Login........................................................................................................................................................................................................... 30 Response (Login) ...................................................................................................................................................................................... 30

Transaction Processing Web Service ......................................................................................................................................................... 31 GetInfo ....................................................................................................................................................................................................... 31 ProcessCash .............................................................................................................................................................................................. 32

ExtData Parameters (ProcessCash) .................................................................................................................................................... 33 ProcessCheck ............................................................................................................................................................................................ 33

ExtData Parameters (ProcessCheck) .................................................................................................................................................. 34 ProcessCreditCard .................................................................................................................................................................................... 36

ExtData Parameters (ProcessCreditCard) .......................................................................................................................................... 40 CustomFields Parameters ................................................................................................................................................................... 42 LineItemDetail Parameters (Level III) ................................................................................................................................................. 43 P2PE Parameters (Point to Point Encryption) .................................................................................................................................... 43 Presentation Parameters ..................................................................................................................................................................... 44




ProcessDebitCard ..................................................................................................................................................................................... 44 ExtData Parameters (ProcessDebitCard) ........................................................................................................................................... 46 P2PE Parameters (Point to Point Encryption) .................................................................................................................................... 47

ProcessEBTCard ........................................................................................................................................................................................ 47 ExtData Parameters (ProcessEBTCard) .............................................................................................................................................. 50 EWICDetGrp (eWIC Line Item) ............................................................................................................................................................. 51

ProcessGiftCard ........................................................................................................................................................................................ 51 ExtData Parameters (ProcessGiftCard) .............................................................................................................................................. 53

ProcessSignature ...................................................................................................................................................................................... 53 ExtData Parameters (ProcessSignature) ............................................................................................................................................ 54

ProcessLoyaltyCard .................................................................................................................................................................................. 54 Response (Transact Web Service) ........................................................................................................................................................... 54

ExtData ................................................................................................................................................................................................... 55 Card Safe Web Service ................................................................................................................................................................................. 56

StoreCard .................................................................................................................................................................................................. 56 Response (StoreCard) .............................................................................................................................................................................. 57 ProcessCreditCard .................................................................................................................................................................................... 57

ExtData Parameters (ProcessCreditCard) .......................................................................................................................................... 59 LineItemDetail Parameters (Level III) ................................................................................................................................................. 62 CustomFields Parameters ................................................................................................................................................................... 63

Response (ProcessCreditCard) ............................................................................................................................................................... 63 ExtData ................................................................................................................................................................................................... 64

Recurring Payment Web Service ................................................................................................................................................................ 65 ManageCustomer ..................................................................................................................................................................................... 65

ExtData Parameters (ManageCustomer) ........................................................................................................................................... 68 ManageCheckInfo ..................................................................................................................................................................................... 68

ExtData (ManageCheckInfo) ................................................................................................................................................................ 71 ManageCreditCardInfo ............................................................................................................................................................................ 71 UpdateContractSettings .......................................................................................................................................................................... 72

ExtData Parameters (UpdateContractSettings) ................................................................................................................................ 73 FailureRetryResultCode Parameters .................................................................................................................................................. 73 RecurringBillingSettings Parameters .................................................................................................................................................. 74

ManageContract ....................................................................................................................................................................................... 74 ExtData (ManageContract) .................................................................................................................................................................. 78 FailureRetryResultCode Parameters .................................................................................................................................................. 78

ManageContractAddDaysToNextBillDt .................................................................................................................................................. 78 ProcessCheck ............................................................................................................................................................................................ 79

ExtData (ProcessCheck) ....................................................................................................................................................................... 80 ProcessCreditCard .................................................................................................................................................................................... 81

ExtData (ProcessCreditCard) ............................................................................................................................................................... 82 AddRecurringCheck .................................................................................................................................................................................. 82 AddRecurringCreditCard ......................................................................................................................................................................... 82 Response (Recurring Web Service) ......................................................................................................................................................... 82

Transaction Reporting Web Service ........................................................................................................................................................... 84 GetCardTrx ................................................................................................................................................................................................ 84 GetCardTrx2 .............................................................................................................................................................................................. 86 GetCardTrxSummary ............................................................................................................................................................................... 88 GetCheckTrx .............................................................................................................................................................................................. 89 GetOpenBatchSummary ......................................................................................................................................................................... 91

ExtData Parameters (GetCardTrx; GetCardTrx2; GetCheckTrx) ...................................................................................................... 92 ExtData Parameters (GetCardTrxSummary; GetOpenBatchSummary) ......................................................................................... 92

TrxDetailCard (Transaction Reporting Web Service) ............................................................................................................................ 92 PaymentMethod (Transaction Reporting Web Service) ....................................................................................................................... 94

Custom Fields Web Service ......................................................................................................................................................................... 96 AddCustomField ....................................................................................................................................................................................... 96 Response (AddCustomField) ................................................................................................................................................................... 97




GetCustomFields ...................................................................................................................................................................................... 97 Response (GetCustomFields) .................................................................................................................................................................. 98

Card Account Updater Web Service ........................................................................................................................................................... 99 UpdateSettings ......................................................................................................................................................................................... 99 Response (UpdateSettings) ................................................................................................................................................................... 100 InfoSettings ............................................................................................................................................................................................. 100 Response (InfoSettings) ......................................................................................................................................................................... 100 GetCardAdminReport ............................................................................................................................................................................ 101 Response (GetCardAdminReport) ........................................................................................................................................................ 102

Validate Credit Card Web Service ............................................................................................................................................................. 103 GetCardType ........................................................................................................................................................................................... 103 Response (GetCardType) ....................................................................................................................................................................... 103 GetNetworkID ......................................................................................................................................................................................... 104 Response (GetNetworkID) ..................................................................................................................................................................... 104 IsCommercialCard .................................................................................................................................................................................. 104 Response (IsCommercialCard) .............................................................................................................................................................. 105 ValidCard ................................................................................................................................................................................................. 105 Response (ValidCard) ............................................................................................................................................................................. 105 ValidCardLength ..................................................................................................................................................................................... 105 Response (ValidCardLength) ................................................................................................................................................................. 105 ValidExpDate ........................................................................................................................................................................................... 106 Response (ValidExpDate) ....................................................................................................................................................................... 106 ValidMod10 ............................................................................................................................................................................................. 106 Response (ValidMod10) ......................................................................................................................................................................... 106

Enumerations ...................................................................................................................................................................................... 107 Hosted Payment Pages ...................................................................................................................................................................... 118

Response (Hosted Payment Page) ....................................................................................................................................................... 119 Appendix .............................................................................................................................................................................................. 121

Front End Processors ................................................................................................................................................................................. 121 Responses ................................................................................................................................................................................................... 121

HTTP Status Codes ................................................................................................................................................................................. 121 DC Gateway Result ................................................................................................................................................................................. 121 DC Gateway ResultCode ........................................................................................................................................................................ 123

Address Verification System (AVS) Result Codes .................................................................................................................................... 124 Card Verification System (CVS) Result Codes .......................................................................................................................................... 124 Examples ..................................................................................................................................................................................................... 125

Admin Web Service Examples ............................................................................................................................................................... 125 AddMerchant ...................................................................................................................................................................................... 125 UpdateMerchant ................................................................................................................................................................................. 126 DeleteMerchant .................................................................................................................................................................................. 128 InfoMerchant ....................................................................................................................................................................................... 128 AddUser ............................................................................................................................................................................................... 130 UpdateUser ......................................................................................................................................................................................... 131 InfoUser ............................................................................................................................................................................................... 132 InfoCustomer ...................................................................................................................................................................................... 133 InfoContract ........................................................................................................................................................................................ 134 GetAPIUser .......................................................................................................................................................................................... 134 Login ..................................................................................................................................................................................................... 135

Transact Web Service Examples ........................................................................................................................................................... 136 GetInfo ................................................................................................................................................................................................. 136 ProcessCash ........................................................................................................................................................................................ 136 ProcessCheck ...................................................................................................................................................................................... 137 ProcessCreditCard .............................................................................................................................................................................. 138 ProcessDebitCard ............................................................................................................................................................................... 139

Cardsafe Web Service Examples........................................................................................................................................................... 139 StoreCard ............................................................................................................................................................................................. 139




ProcessCreditCard .............................................................................................................................................................................. 140 Recurring Web Service Examples ......................................................................................................................................................... 141

ManageCustomer (ADD) .................................................................................................................................................................... 141 ManageCustomer (UPDATE) .............................................................................................................................................................. 142 ManageCustomer (DELETE) ............................................................................................................................................................... 143 ManageCheckInfo (ADD) .................................................................................................................................................................... 144 ManageCheckInfo (UPDATE) ............................................................................................................................................................. 145 ManageCheckInfo (DELETE) ............................................................................................................................................................... 146 ManageCreditCardInfo (ADD) ........................................................................................................................................................... 147 ManageCreditCardInfo (UPDATE) ..................................................................................................................................................... 148 ManageCreditCardInfo (DELETE) ...................................................................................................................................................... 148 UpdateContractSettings..................................................................................................................................................................... 149 ManageContract (Check ADD) ........................................................................................................................................................... 150 ManageContract (Check UPDATE) .................................................................................................................................................... 151 ManageContract (Check DELETE) ...................................................................................................................................................... 153 ManageContract (CreditCard ADD) .................................................................................................................................................. 154 ManageContract (CreditCard UPDATE) ............................................................................................................................................ 155 ManageContract (CreditCard DELETE) ............................................................................................................................................. 157 ManageContractAddDaysToNextBillDt ............................................................................................................................................ 158 ProcessCheck ...................................................................................................................................................................................... 158 ProcessCreditCard .............................................................................................................................................................................. 159

TrnDetail Web Service Examples .......................................................................................................................................................... 160 GetCardTrx .......................................................................................................................................................................................... 160 GetCardTrx2 ........................................................................................................................................................................................ 161 GetCardTrxSummary ......................................................................................................................................................................... 163 GetCheckTrx ........................................................................................................................................................................................ 165 GetOpenBatchSummary .................................................................................................................................................................... 166

CustomFields Web Service Examples................................................................................................................................................... 168 AddCustomField.................................................................................................................................................................................. 168 GetCustomField .................................................................................................................................................................................. 169

CardAccountUpdater Web Service Examples ..................................................................................................................................... 169 UpdateSettings.................................................................................................................................................................................... 169 InfoSettings ......................................................................................................................................................................................... 169 GetCardAdminReport ......................................................................................................................................................................... 170

Validate Web Service Examples ............................................................................................................................................................ 172 GetCardType ....................................................................................................................................................................................... 172 GetNetworkID ..................................................................................................................................................................................... 173 IsCommercialCard .............................................................................................................................................................................. 173 ValidCard ............................................................................................................................................................................................. 174 ValidCardLength ................................................................................................................................................................................. 174 ValidExpDate ....................................................................................................................................................................................... 175 ValidMod10.......................................................................................................................................................................................... 175

Document Revisions ........................................................................................................................................................................... 176




Direct Connect Gateway

The Direct Connect Payment Gateway (DC Gateway) is a service used by merchants and service providers to

take payments from customers. DC Gateway can stand alone as a web-based storefront with (or without)

attached card readers or may be used in combination with point-of-sale (POS) and order entry applications. DC

Gateway accepts payments in many forms, including check, credit, debit, gift, loyalty and EBT cards. Payments

may be taken online, over the telephone, from a mobile phone and at physical store locations. In addition to

handling large volumes of commercial transactions, the DC Gateway manages and settles batches, protects

sensitive card information, administers billing contracts and produces operational and analytical reports.

Customizing and Integrating to the DC Gateway

Administrators with web browsers configure DC Gateway through its user interface by entering company name,

contact information, applying branding themes and specifying the content and format of the customer-facing

webpages presented by the DC Gateway. Direct Connect will customize the DC Gateway User Interface, virtual

terminal screens and/or transaction reports for clients whose needs cannot be fully met through configuration

options. The DC Gateway may also be integrated quickly with web applications using Hosted Payment Pages

and integrated seamlessly with software and hardware products using DC Gateway Application Programming

Interfaces.

Application Programming Interfaces (APIs)

APIs make the same capabilities that are available interactively through the DC Gateway user interface

accessible programmatically to software applications and hardware devices. Systems and devices communicate

with the DC Gateway by exchanging messages. An application – the client - formulates and sends a request to

the DC Gateway – the server - which prepares and returns a response.

1. Client Application formulates a message and transmits the request to the DC Gateway

2. DC Gateway translates request and relays it to Payment Processing Network

3. Payment Processing Network processes request and returns response to the DC Gateway

4. DC Gateway translates response and relays to Client Application

Simple Object Access Protocol (SOAP) API

Client applications use the SOAP protocol to communicate with DC Gateway. The body of SOAP request and

response messages contain the name of a web service operation and, in addition, all input or output

parameters. The body is enclosed in an envelope and both parts of each message are encoded using extensible

markup language (XML). Requests and responses are exchanged by the client application and DC Gateway’s web

services in the same way that a web browser communicates with a web server across the Internet – using the

secure form of the Hypertext Transfer Protocol (HTTPS).




Developer Notes

DC Gateway SOAP APIs are based on open, web services standards, including the Simple Object Access

Protocol (SOAP), Web Services Definition Language (WSDL), and the XML Schema Definition language (XSD).

Submit a request to the endpoints of web services with the query string of ‘WSDL’ to generate files that define

the operations, parameters and data structures supported by DC Gateway API.

Inspect status code from HTTP header to verify that request message was successfully received by DC

Gateway.

Inspect Result or Code from SOAP Message body to reveal outcome from DC Gateway Web Service operation

that was invoked.WebServicesEndpoints

Name-Value Pairs (NVP)

Client applications may also format messages for DC Gateway using a lightweight alternative to SOAP, known as

Name-Value Pairs (NVP.) DC Gateway web services listen for HTTP GET and POST requests made to the

addresses of their endpoints using the name of an operation to be invoked. Input parameters are passed as

pairs of URL encoded names and values either on the query string of a GET request or in the body of a POST. DC

Gateway responses are encoded using XML but without SOAP envelopes or bodies.

Developer Notes

A name-value pair must be provided for both required and also optional input parameters in NVP integrations

with DC Gateway. A client application should not include a value for any input parameter whose value is not

explicitly specified when it invokes web service operations using NVP-formatted request messages.

Inspect status code from HTTP header to verify that GET/POST request was successfully received by DC

Gateway.

Inspect Result or Code from XML-encoded response to reveal outcome from the DC Gateway Web Service

operation that was invoked.




Hosted Payment Pages

The simplest and shortest way to add payment processing to an existing application or website is with Hosted

Payment Pages (HPP). Administrators configure and activate an HPP through the DC Gateway User Interface.

HPPs may be created quickly, are easily deployed and minimize the scope of the Payment Card Industry Data

Security Standards (PCI-DSS) compliance requirements. Since the DC Gateway forwards card holder data

provided by customers directly to payment networks, the sensitive data never passes through the application’s

or website’s own servers. Once it is active, a webmaster embeds, links or redirects to the HPP from her/his

website to process payments.

1. Customer touches payment link on website

2. Browser opens Hosted Payment Page

3. Customer fills and submits order form to DC Gateway

4. DC Gateway forwards payment details to Payment Processing Network

5. Payment Processing Network approves or declines transfer from Customer to Merchant account and

notifies DC Gateway

6. DC Gateway redirects browser to website

7. Customer reviews result of payment request

Getting Started

Take the following steps to integrate an application with DC Gateway in your development environment.

Gateway Integration Certification Overview

To ensure secure and compliant integration with Direct Connect’s Payment Gateway, Direct Connect has

developed a certification process for payment integrators. Certification is required for final integration to the DC

Gateway.

All integration documentation is available via the DC Developer Portal (http://directconnectps.com/developers/).

The DC Gateway Integration Support Team ([email protected]) will provide guidance along with the

necessary information to complete the certification process.




Step 1: Registration

Visit http://directconnectps.com/developers/ to register for a free DC Gateway test account. Follow the

instructions contained in the registration response email. Download the API Developer’s Guide to learn how to

formulate and transmit requests to the DC Gateway and interpret the responses.

Step 2: Specification and Analysis

Test account registrants will be contacted within 2 business days to discuss business and technical

requirements. The DC Integration Support Team provides expert guidance for engineering gateway integration,

defines required test cases, offers card numbers for cases, monitors testing progress, and describes how test

results should be documented using saved receipts and preserved gateway response messages.

Step 3: Development

Developers will facilitate integration certification using testing and documentation guidelines as directed by the

DC Integration Support Team. To ensure a secure and compliant integration solution, integrators should retain

an Assessor (trained and validated by the PCI Security Standards Council) or complete a PCI Self-Assessment

Questionnaire (SAQ). When integration, testing, and documentation is complete, integrators must submit

certification requests to the Integration Support Team for evaluation.

Step 4: Certification

Direct Connect reviews testing documentation and certification requests to ensure integration compliance with

Payment Card Industry Data Security Standards (PCI-DSS). The DC Integration Support Team will approve and

confirm certification, or will advise and assist with additional requirements.

Step 5: Transition

Successful certified integrators will be introduced to Support Representatives at Direct Connect who will provide

ongoing DC Gateway support.

Developer Notes

Install your development platform according to its product documentation.

Read through all the steps before you get started. You may also wish to review the rest of the Developer’s

Guide to familiarize yourself with DC Gateway terms, capabilities, web services and operations.

3 5 1 2 4

Registration

Specification

and Analysis

Development

Certification

Transition




Web Services

DC Gateway APIs are grouped into the following web services:

Name Description Endpoint

Administration Perform administrative functions of DC Gateway /vt/ws/admin.asmx

Batch Info Retrieve batch information for existing transactions /ws/batchinfo.asmx

Card Account Updater Automatically update payment card details stored by the DC Gateway /ws/cardsafe.asmx

Card Safe Store and retrieve payment methods for existing customers /ws/cardsafe.asmx

Custom Fields Adds a field to capture a value for each processed transaction /ws/customfields.asmx

Recurring Payment Manage customers, payment methods and contracts for recurring

payments

/vt/ws/recurring.asmx

Transaction Processing Process payments by methods such as Checks and Credit, Debit, EBT and

Gift cards

/ws/transact.asmx

Transaction Reporting Query transactions processed by DC Gateway for a merchant /vt/ws/trxdetail.asmx

Validate Card Validate Credit Card types and numbers /ws/validate.asmx

Developer Notes

The base URL for DC Gateway Web services is https://gateway.1directconnect.com.

Contact Direct Connect Sales Representative to request custom URL.

DC Gateway removes XML predefined entities from user-supplied values. Enclose values in CDATA section

or substitute replacement values for special characters: double quotation mark - ", ampersand -

&, apostrophe - ', less-than sign - <, greater-than sign - >.

DC Gateway Web Service Definition Language references for each Web Service is located below:

Name Web Service Definition Language URL

Administration https://gateway.1directconnect.com/paygate/ws/admin.asmx?wsdl

Batch Info https://gateway.1directconnect.com/ws/batchinfo.asmx?wsdl

Card Account Updater https://gateway.1directconnect.com/paygate/ws/cardaccountupdater.asmx?wsdl

Card Safe https://gateway.1directconnect.com/ws/cardsafe.asmx?wsdl

Custom Fields https://gateway.1directconnect.com/ws/customfields.asmx?wsdl

Recurring Payment https://gateway.1directconnect.com/paygate/ws/recurring.asmx?wsdl

Transaction Processing https://gateway.1directconnect.com/ws/transact.asmx?wsdl

Transaction Reporting https://gateway.1directconnect.com/paygate/ws/trxdetail.asmx?wsdl

Validate Card https://gateway.1directconnect.com/ws/validate.asmx?wsdl

https://gateway.1directconnect.com/

https://gateway.1directconnect.com/paygate/ws/admin.asmx?wsdl

https://gateway.1directconnect.com/ws/batchinfo.asmx?wsdl

https://gateway.1directconnect.com/paygate/ws/cardaccountupdater.asmx?wsdl

https://gateway.1directconnect.com/ws/cardsafe.asmx?wsdl

https://gateway.1directconnect.com/ws/customfields.asmx?wsdl

https://gateway.1directconnect.com/paygate/ws/recurring.asmx?wsdl

https://gateway.1directconnect.com/ws/transact.asmx?wsdl

https://gateway.1directconnect.com/paygate/ws/trxdetail.asmx?wsdl

https://gateway.1directconnect.com/ws/validate.asmx?wsdl




Administration Web Service

Name

Administer Gateway.

Description

Perform administrative functions of DC Gateway.

Operations

Name Description

AddMerchant Add a Merchant account in DC Gateway.

UpdateMerchant Update a Merchant account in DC Gateway.

DeleteMerchant Delete a Merchant account in DC Gateway.

InfoMerchant Retrieve information about a Merchant in DC Gateway.

AddUser Add a Username for a Merchant in DC Gateway.

UpdateUser Update a Username for a Merchant in DC Gateway.

InfoUser Retrieve information about a Username for a Merchant in DC Gateway.

InfoCustomer Retrieve information about a Customer stored in DC Gateway.

InfoContract Retrieve information about Contracts stored for a Customer in DC Gateway.

GetAPIUser Retrieve network credentials for a Username (with access to DC Gateway APIs).

GetDebitAccount Retrieve information about Debit Account for a Merchant in DC Gateway.

Login Login to DC Gateway Virtual Terminal.

Developer Notes

Originating Internet Protocol (IP) address must be whitelisted in order for operations of the Administration web

service to be invoked. Please contact Direct Connect Integration Coordinator to add IP addresses to the DC

Gateway Administration web service whitelist.

User Credentials Requirements Matrix




AddMerchant

Description

Add a Merchant account to DC Gateway.

Parameters

Field Name Type Max

Length Required Description

Username

string 25 Required

User name assigned in DC Gateway.

The account must be granted a

sufficient level of security access in

order to invoke the operation.

SecureToken string Variable Required

A unique value for each User Name

that is used by DC Gateway to

authenticate the originator of API

requests.

ResellerKey string 10 Required Unique identifier for Direct Connect

reseller.

MerchantUsername string 25 Required User Name of Primary User for

Merchant in DC Gateway.

MerchantPassword string 20 Required Password for User Name of Primary

User for Merchant in DC Gateway.

MerchantID string 50 Optional Unique identifier for a Merchant in DC

Gateway.

MerchantID2 string 50 Optional Unique identifier for a Merchant in DC

Gateway.

AnnualSales string 18 Optional Annual Sales for a Merchant, in US or

CAN Dollars.

BusinessStartDate string 10 Optional Merchant's first day in business.

CompanyName string 50 Required Company Name of Merchant Account

Holder.

DoingBusinessAs string 50 Optional Trade name for a Merchant.

Url string 50 Optional Universal Resource Locator (for

Merchant website).

FederalTaxID string 25 Optional

Unique identifier for a business entity

issued by the Internal Revenue Service

(IRS), also known as an Employer

Identification Number (EIN).

StateTaxID string 25 Optional

Unique identifier for a Merchant

assigned by a State in the United

States.

SalesTaxID string 25 Optional Sales Tax identifier of a Merchant in

DC Gateway.

OwnershipType string 25 Optional Structure of ownership for Merchant

Business.

AutoCloseBatch enum

(BooleanVerboseType) 5 Optional

Valid values are True/False; Close

transaction batches automatically

(Terminal-based settlement only).

AutoCloseBatchHour string 2 Optional

Hour of day (between 0 and 23) for DC

Gateway to close transaction batches

when AutoCloseBatch = T (Terminal-

based settlement, only).

ForceDuplicate enum


Valid values are True/False; Allow

(True) duplicate transactions (in

batch).




Field Name Type Max


RequirePNRef enum


Valid values are True/False; DC

Gateway requires (True) unique

identifier for original transaction to

allow refunds or credits.

ContactFirstName string 50 Required First name of Contact Person at

Merchant Account Holder.

ContactLastName string 50 Required Last name of Contact Person at


ContactEmail string 100 Required Electronic Mail Address of Contact

Person at Merchant Account Holder.

ContactDayPhone string 13 Required Daytime Phone number of Contact


ContactFax string 13 Optional Fax number for Contact Person at


ContactStreet1 string 50 Required First line of Address of Contact Person

at Merchant Account Holder.

ContactStreet2 string 50 Optional Second line of Address of Contact


ContactCity string 50 Required City for Address of Contact Person at


ContactState string 2 Required

State Abbreviation for Address of

Contact Person at Merchant Account

Holder.

ContactPostalCode string 10 Required

ZIP/Postal Code for Address of


Holder.

ContactCountryCode string 3 Required

Code (USA or CAN) for Country of

Address of Contact Person at


TimeZoneOffset string 6 Required Offset from Coordinated Universal

Time (in minutes).

PaymentMethodsXml xml

PaymentMethodsXml

Variable Optional

Collection of methods allowed for

payments to Merchant through DC

Gateway (XML encoded).

RegistersXml xml RegistersXml Variable Optional

Collection of registers or terminals

configured for a Merchant in DC

Gateway.

ReadOnlyCardSafeCustomerID enum


Prevent (True) CustomerID associated

with a Recurring Payment Agreement

from being changed.

ReadOnlyRecurringBillingContractID enum


Prevent (True) ContractID associated


from being changed.

ReadOnlyRecurringBillingCustomerID enum



with Card Safe payment method from

being changed.

BypassAvsCvvFiltersEnabled enum


Bypass (True) AVS/CVV verification on

a per transaction basis.

ExtData xml ExtData Variable Optional Structure for extended data provided

to/from DC Gateway.

Returns




Hyperlink to AddMerchant Response structure

Example

Hyperlink to AddMerchant Request/Response example

UpdateMerchant

Description

Update information for an existing Merchant account in DC Gateway.

Developers Notes

Invoke the InfoMerchant operation to retrieve values for corresponding parameters to the UpdateMerchant

operation to ensure that existing data are not overwritten with empty values.

Parameters

Field Name Type Max


Username string 25 Required






A value - unique for each User Name -



requests.

MerchantKey string 10 Required Unique identifier for a Merchant in DC

Gateway.


reseller.

MerchantID string 50 Optional Unique identifier for a Merchant in DC

Gateway.

MerchantID2 string 50 Optional Unique identifier for a Merchant in DC

Gateway.

AnnualSales string 18 Optional Annual Sales for a Merchant, in US or

CAN Dollars.

BusinessStartDate string 10 Optional Merchant's first day in business.

CompanyName string 50 Required Company Name of Merchant Account

Holder.

DoingBusinessAs string 50 Optional Trade name for a Merchant.

Url string 50 Optional Universal Resource Locator (for

Merchant website).

FederalTaxID string 25 Optional

Unique identifier for a business entity

issued by the Internal Revenue Service

(IRS), also known as an Employer

Identification Number (EIN).

StateTaxID string 25 Optional

Unique identifier for a Merchant

assigned by a State in the United

States.

SalesTaxID string 25 Optional Sales Tax identifier of a Merchant in

DC Gateway.

OwnershipType string 25 Optional Structure of ownership for Merchant

Business.

AutoCloseBatch enum


Close (True) transaction batches

automatically (Terminal-based

settlement only).




Field Name Type Max


AutoCloseBatchHour string 2 Optional

Hour of day (between 0 and 23) for DC

Gateway to close transaction batches

when AutoCloseBatch = T (Terminal-

based settlement, only).

ForceDuplicate enum


Allow (True) duplicate transactions (in

batch).

RequirePNRef enum


DC Gateway requires (True) unique

identifier for original transaction to

allow refunds or credits.

ContactFirstName string 50 Required First name of Contact Person at


ContactLastName string 50 Required Last name of Contact Person at


ContactEmail string 100 Required Electronic Mail Address of Contact


ContactDayPhone string 13 Required Daytime Phone number of Contact


ContactFax string 13 Optional Fax number for Contact Person at


ContactStreet1 string 50 Required First line of Address of Contact Person


ContactStreet2 string 50 Optional Second line of Address of Contact


ContactCity string 50 Required City for Address of Contact Person at


ContactState string 2 Required



Holder.

ContactPostalCode string 10 Required

ZIP/Postal Code for Address of


Holder.

ContactCountryCode string 3 Required

Code for Country of Address of


Holder.

TimeZoneOffset string 6 Required Offset from Coordinated Universal

Time (in minutes).

PaymentMethodsXml xml

PaymentMethodsXml

Variable Optional

Collection of methods allowed for

payments to Merchant through DC

Gateway (XML encoded).

RegistersXml xml RegistersXml Variable Optional

Collection of registers or terminals

configured for a Merchant in DC

Gateway.





from being changed.



Prevent (True) ContractID associated


from being changed.





being changed.



Bypass (True) AVS/CVV verification on

a per transaction basis.




Field Name Type Max



to/from DC Gateway.

Returns

Hyperlink to UpdateMerchant Response structure

Example

Hyperlink to UpdateMerchant Request/Response example

ExtData Parameters (AddMerchant, UpdateMerchant)

Field Name Type Max


SendEmail enum (BooleanType) 1 Optional Enable (T) DC Gateway to send message

to new merchant/user.

Merchant xml Merchant Variable Optional Structure for configuration specified for

merchant in DC Gateway.

Access xml Access Variable Optional Structure for configuration of access

parameters specified for merchant in

DC Gateway.

Merchant Parameters (AddMerchant, UpdateMerchant)

The Merchant element consists of a set of features enabled or disabled in DC Gateway enclosed within a

Configuration XML tag:

Field Name Type Max


ImageCapture enum

(BooleanType)

1 Optional Enable (T) merchant to store

signatures.

ReceiptCapture enum

(BooleanType)

1 Optional Enable (T) merchant to store receipt

images.

VirtualTerminalShippingAmount enum

(BooleanType)

1 Optional Enable (T) merchant to specify an

amount for shipping through virtual

terminal user interface.

VirtualTerminalAllowRepeat enum

(BooleanType)

1 Optional Enable (T) merchant to process repeat

sales through virtual terminal user

interface.

VirtualTerminalCreditAccess enum

(BooleanType)

1 Optional Enable (T) merchant to process

refunds/credits through virtual


VirtualTerminalTipAmount enum

(BooleanType)

1 Optional Enable (T) merchant to specify a tip

amount through virtual terminal user

interface.

VirtualTerminalTaxAmount enum

(BooleanType)

1 Optional Enable (T) merchant to specify a tax

amount through virtual terminal user

interface.

VirtualTerminalConvenienceAmount enum

(BooleanType)

1 Optional Enable (T) merchant to specify a

convenience amount through virtual





Field Name Type Max


VirtualTerminalCorporateCard enum

(BooleanType)

1 Optional Enable (T) merchant to specify that

payment method is corporate card

through virtual terminal user interface.

AutoSettleMerchantEmail enum

(BooleanType)

1 Optional Enable (T) DC Gateway to send

message to merchant when batch

settled automatically is complete.

InvoiceDuplicate enum

(BooleanType)

1 Optional Enable (T) new invoice number to be

required when multiple transactions

with same payment method and

amount are processed for the same

time period.

CardVerification xml

CardVerification

1 Optional Structure for configuration specified in

DC Gateway for address (AVS) and

card verification (CVS) services.


(BooleanType)

1 Optional Prevent (T) CustomerID associated


from being changed


(BooleanType)

1 Optional Prevent (T) ContractID associated with

a Recurring Payment Agreement from

being changed


(BooleanType)

1 Optional Prevent (T) CustomerID associated


being changed

EnableRecurringBillingSettings enum

(BooleanType)

1 Optional Override (T) values provided by

Merchant or API User for MaxFailure,

FailureInterval, FailureResultCode and

MaxBillingCycleRetry

BypassExpiredCardValidationForCreditCards enum

(BooleanType)

1 Optional Enable (T) DC Gateway to bypass

validation of credit card expiration

date.

Access Parameters (AddMerchant, UpdateMerchant)

Field Name Type Max


DialIn enum (BooleanType) 1 Optional Enable (T) transactions to be sent to DC

Gateway via dial-up connection.

BinManagementApi enum (BooleanType) 1 Optional Enable (T) access to Debit Bin

Management API.

PaymentMethodXml Parameters (AddMerchant, UpdateMerchant)

Field Name Type Max


ProcessorID enum

(ProcessorIDType)

10 Optional Front end processor used to process a

type of payment transaction for

merchant.

PaymentTypeID enum

(PaymentTypeIDType)

10 Optional Payment Type: CREDIT, DEBIT, EBT,

CASH, CHECK, ECHECK, VERIFY, EGC.




Field Name Type Max


HostBased enum

(BooleanVerboseType)

5 Optional Batch settlement process initiated by

Host (True) or by merchant (False) in DC

Gateway virtual terminal.

RegistersXml Parameters (AddMerchant, UpdateMerchant)

The RegistersXml element defines Register details for a Merchant in DC Gateway enclosed within a Registers

XML tag:

Field Name Type Max


Register enum

(ProcessorIDType)

10 Optional Unique identifier for the register,

terminal or computer on which the

transaction was processed.

RegisterName string 25 Optional Register Name – used to define each

specific register used by merchant.

RegisterNum string 10 Optional Register Number – used to define each

specific register used by merchant.

CardVerification Parameters (AddMerchant, UpdateMerchant)

Developer Notes

Card Verification services are supported by the following processors: Concord EFS Network, Elavon (NOVA

Information System, First Data Nashville, First Data North, First Data Omaha, First Data Rapid Connect, Global

Payments, Heartland Payment Systems, Paymentech - Tampa, TSYS Host, TSYS Terminal (Vital).

Description

The CardVerification element contains settings for DC Gateway to determine whether to accept or reject

transactions based on results from the address (AV) and card verification (CV) services of terminal capture

processors:

Field Name Type Max


AVExactMatch enum (BooleanType) 1 Optional Accept (T) transactions for which AV

service reports exact match.

AVZipOnly enum (BooleanType) 1 Optional Accept (T) transactions for which AV

service reports ZIP Code match only.

AVAddOnly enum (BooleanType) 1 Optional Accept (T) transactions for which AV

service reports only Address line match.

AVNoMatch enum (BooleanType) 1 Optional Accept (T) transactions for which AV

service reports no Address match.

AVVerUnavail enum (BooleanType) 1 Optional Accept (T) transactions for which AV

service reports Address verification

service not available.

AVServUnsupported enum (BooleanType) 1 Optional Accept (T) transactions for which AV

service reports Address verification is

not supported by process.




Field Name Type Max


AVInvalidAddZip enum (BooleanType) 1 Optional Accept (T) transactions for which AV

service reports formats of address and

ZIP code are invalid.

AVAddNotVerifiable enum (BooleanType) 1 Optional Accept (T) transactions for which AV

service reports Address not verifiable.

AVAddNotVerifiableGlobal enum (BooleanType) 1 Optional Accept (T) transactions for which global

AV service reports Address is not

verifiable.

AVUnregCode enum (BooleanType) 1 Optional Accept (T) transactions for which AV

service returns unrecognized result.

AVNoData enum (BooleanType) 1 Optional Accept (T) transactions for which AV

service returns no result.

AVNotRequested enum (BooleanType) 1 Optional Accept (T) transactions for which AV was

not requested.

CVMatch enum (BooleanType) 1 Optional Accept (T) transactions for which CV

service reports code matches.

CVNoMatch enum (BooleanType) 1 Optional Accept (T) transactions for which CV

service reports code does not match.

CVNotProcessed enum (BooleanType) 1 Optional Accept (T) transactions not processed

through CV service.

CVNotPresent enum (BooleanType) 1 Optional Accept (T) transactions for which CV

service reports code not provided.

CVNoDataFromIssuer enum (BooleanType) 1 Optional Accept (T) transactions for which CV

service reports no code provided from

issuing bank for card number.

CVUnregCode enum (BooleanType) 1 Optional Accept (T) transactions for which CV

service returns unrecognized result.

CVNoData enum (BooleanType) 1 Optional Accept (T) transactions for which CV

service returns no result.

BypassAvsCvvFiltersEnabled enum (BooleanType) 1 Optional Bypass (T) AVS/CVV verification on a per

transaction basis.




DeleteMerchant

Description

Delete a Merchant account in DC Gateway.

Parameters

Field Name Type Max











requests.


reseller.


Gateway.


to DC Gateway.

Returns

Hyperlink to DeleteMerchant Response structure

Example

Hyperlink to DeleteMerchant Request/Response example

Response Structure (AddMerchant, UpdateMerchant, DeleteMerchant)

Field Name Type Max

Length Description

code GatewayResultCode 50 Result code returned from DC Gateway.

error string Variable Message from DC Gateway describing the result of

the processed web method call.

Partner string 10 Direct Connect Reseller number.

Vendor string 10 Unique identifier for a Merchant in DC Gateway.

Username string 25 DC Gateway user name (when operation invoked).

InfoMerchant

Description

Retrieve information about a Merchant in DC Gateway.

Parameters

Field Name Type Max










Field Name Type Max






requests.

VendorKey string 10 Required Unique identifier for Customer (also

known as RPNum in DC Gateway).


to/from DC Gateway.

Example

Hyperlink to InfoMerchant Request/Response example

Response Structure (InfoMerchant)

Field Name Type Max

Length Description

code GatewayResultCode 50 Result Code (returned from DC Gateway).

error string Variable

Message from DC Gateway describing the result of

a processed transaction. Only present when an

error is returned for the request message.

Partner string 10 Direct Connect reseller.


Username string 25 DC Gateway User Name (when operation invoked).

ResellerKey string 10 Unique identifier for Direct Connect reseller.

MerchantID string 50 Unique identifier for a Merchant in DC Gateway.

MerchantID2 string 50 Unique identifier for a Merchant in DC Gateway.

AnnualSales string 18 Annual Sales for a Merchant, in US or CAN Dollars.

BusinessStartDate string 10 Merchant's first day in business.

CompanyName string 50 Company Name of Merchant Account Holder.

DoingBusinessAs string 50 Trade name for a Merchant.

Url string 50 Universal Resource Locator (for Merchant website).

FederalTaxID string 25

Unique identifier for a business entity issued by the

Internal Revenue Service (IRS), also known as an

Employer Identification Number (EIN).

StateTaxID string 25 Unique identifier for a Merchant assigned by a

State in the United States.

SalesTaxID string 25 Sales Tax identifier of a Merchant in DC Gateway.

OwnershipType string 25 Structure of ownership for Merchant Business.

AutoCloseBatch string 1 Close transaction batches automatically (Terminal-

based settlement only).

AutoCloseBatchHour string 2

Hour of day (between 0 and 23) for DC Gateway to

close transaction batches when AutoCloseBatch = T

(Terminal-based settlement, only).

ForceDuplicate string 1 Allow duplicate transactions (in batch).

RequirePNRef string 1 DC Gateway requires unique identifier for original

transaction to allow refunds or credits.

ContactFirstName string 50 First name of Contact Person at Merchant Account

Holder.

ContactLastName string 50 Last name of Contact Person at Merchant Account

Holder.

ContactPostalCode string 10 ZIP/Postal Code for Address of Contact Person at





Field Name Type Max

Length Description

ContactSate string 2 State Abbreviation for Address of Contact Person at


ContactCity string 50 City for Address of Contact Person at Merchant

Account Holder.

ContactStreet2 string 50 Second line of Address of Contact Person at


ContactStreet1 string 50 First line of Address of Contact Person at Merchant

Account Holder.

ContactFax string 25 Fax number for Contact Person at Merchant

Account Holder.

ContactDayPhone string 25 Daytime Phone number of Contact Person at


ContactEmail string 100 Electronic Mail Address of Contact Person at

Merchant Account Holder

ContactCountryCode string 3 Code for Country of Address of Contact Person at


TimeZoneOffset string 6 Offset from Coordinated Universal Time (in

minutes).

PaymentMethodXml xml

PaymentMethodXml Variable

Collection of methods allowed for payments to

Merchant through DC Gateway (XML encoded).


(BooleanVerboseType) 5

Prevent (True) CustomerID associated with a

Recurring Payment Agreement from being

changed.



Prevent (True) ContractID associated with a

Recurring Payment Agreement from being

changed.



Prevent (True) CustomerID associated with Card

Safe payment method from being changed.



Bypass (True) AVS/CVV verification on a per

transaction basis.

RegistersXml xml RegistersXml Variable

Collection of registers or terminals configured for a

Merchant in DC Gateway. Only present if registers

are configured for a merchant account.

ExtData xml ExtData Variable Structure for extended data provided to/from DC

Gateway.

AddUser

Description

Add a User Name for a Merchant in DC Gateway.

Parameters

Field Name Type Max


adminUserName string 25 Required DC Gateway User Name for Merchant

Administrator.

adminPassword string 20 Required Password for Merchant Administrator

User Name.

partner string 10 Conditional

Direct Connect Reseller number;

Required when creating a Reseller

user account.




Field Name Type Max


vendor string 10 Conditional

Unique identifier for a merchant in DC

Gateway; Required when creating a

Merchant user account.

username string 25 Optional





password string 20 Optional Password for the user name assigned

in DC Gateway.

contactFirstName string 50 Required First name of Contact Person at


contactLastName string 50 Required Last name of Contact Person at


contactEmail string 100 Required Electronic Mail Address of Contact


contactDayPhone string 25 Required Daytime Phone number of Contact


contactFax string 25 Optional Fax number for Contact Person at


contactStreet1 string 50 Optional First line of Address of Contact Person


contactStreet2 string 50 Optional Second line of Address of Contact


contactCity string 50 Optional City for Address of Contact Person at


contactState string 2 Optional



Holder.

contactPostalCode string 10 Optional ZIP/Postal Code for Address of Contact


contactCountryCode string 3 Required

Code for Country of Address of


Holder.

userSecurityLevel string 1 Required Level of Security Access granted to

User Name in DC Gateway.

timeZoneOffset string 6 Required Offset from Coordinated Universal

Time (in minutes).


to DC Gateway.

Returns

Hyperlink to AddUser Response structure.

Example

Hyperlink to AddUser Request/Response example




UpdateUser

Description

Update a User for a Merchant in DC Gateway.

Developers Notes

Invoke the InfoUser operation to retrieve values for corresponding parameters to the UpdateUser operation to

ensure that existing data are not overwritten with empty values.

Parameters

Field Name Type Max











requests.

VendorKey string 10 Required Unique identifier for a reseller in DC

Gateway.

TargetUsername string 25 Required User Name (requested from DC

Gateway for a new User).

FirstName string 50 Required First Name for Customer stored in DC

Gateway.

LastName string 50 Required Last name of Customer stored in DC

Gateway.

Email string 100 Required Electronic Mail Address.

DayPhone string 25 Required Daytime Phone Number.

Fax string 25 Optional Fax number.

Street1 string 50 Optional House number and Street name of a

postal address.

Street2 string 50 Optional Second line of a postal address.

City string 50 Optional City of the cardholder's billing address.

State string 2 Optional

United States Postal Service

abbreviation for a state, possession or

territory.

Zip string 10 Optional ZIP or Postal Code.

Country string 3 Required Country Code of Shipping Address.

Status enum

(UserStatusType) 1 Required

Status of User Name in DC Gateway; 1

= ACTIVE; 2 = INACTIVE.

UserSecurityLevel string 1 Required Level (1-4) of Security Access granted

to User Name in DC Gateway.

SysSecurityLevel string 1 Required System security level (1-4).

MerchantGroupXml xml

MerchantGroupXml Variable Required

Collection of Merchants with which a

User Name is associated.


to/from DC Gateway.

Example

Hyperlink to UpdateUser Request/Response example

Response (AddUser, UpdateUser)




Field Name Type Max

Length Description

code GatewayResultCode 50 Result code returned from DC Gateway.

error string Variable Message from DC Gateway describing the result of


Partner string 10 Direct Connect Reseller number.


Username string 25 DC Gateway user name (when operation invoked).

InfoUser

Description

Retrieve information about a User Name for a Merchant in DC Gateway.

Parameters

Field Name Type Max











requests.

VendorKey string 10 Required Unique identifier for a reseller in DC

Gateway.

TargetUsername string 25 Required User Name (requested from DC

Gateway for a new User).


to/from DC Gateway.

Example

Hyperlink to InfoUser Request/Response example

Response (InfoUser)

Field Name Type Max

Length Description


error string Variable Message from DC Gateway describing the result of a

processed transaction.




FirstName string 50 First name of the user.

LastName string 50 Last name of the user.

Email string 100 Electronic mail address for the user.

Street1 string 50 First line of postal address for user.

Street2 string 50 Second line of postal address for user.

City string 50 City name of postal address for user.

State string 2 State abbreviation of postal address for user.

Zip string 10 ZIP Code of postal address for user.




Field Name Type Max

Length Description

Country string 3 User Country code (USA, CAN) of postal address.

DayPhone string 25 Daytime phone number of user.

Fax string 25 Facsimile phone number of user.

Status string 1 Status (1 - Active or 0 - Inactive) of username.

UserSecurityLevel string 1 Level (1-4) of Security Access granted to User Name

in DC Gateway.

SysSecurityLevel string 1 Level (1-4) of Security Access granted to User Name

in DC Gateway.

MerchantGroupXml xml

MerchantGroupXml Variable

Collection of Merchant identifiers enclosed by one

or more MerchantKey elements within a

MerchantGroup tag for a DC Gateway Username.


Gateway.

InfoCustomer

Description

Retrieve information about a Customer stored in DC Gateway.

Parameters

Field Name Type Max











requests.

CustomerKey string 10 Required Unique identifier for Customer (in DC

Gateway).


to/from DC Gateway.

Returns

Hyperlink to InfoCustomer Response structure.

Example

Hyperlink to InfoCustomer Request/Response example

InfoContract

Description

Retrieve information about Contracts stored for a Customer in DC Gateway.

Parameters

Field Name Type Max










Field Name Type Max






requests.


Gateway).


to/from DC Gateway.

Example

Hyperlink to InfoContract Request/Response example

Response Structure (InfoCustomer, InfoContract)

Field Name Type Max

Length Description







City string 50 City of postal address.

Country string 3 Country code (USA, CAN) of postal address.

DayPhone string 25 Phone number (daytime).

Department string 50 Department Name in Address of Primary Contact

for Customer.

Email string 100 Electronic mail address of Primary Contact for

Customer.

Fax string 25 Facsimile phone number of Primary Contact for

Customer.

FirstName string 50 First Name of Primary Contact for Customer.

LastName string 50 Last Name of Primary Contact for Customer.

Mobile string 50 Mobile phone number of Primary Contact for

Customer.

NightPhone string 50 Phone number (night time) of Primary Contact for

Customer.

Province string 50 Canadian Province.

State string 2 USPS abbreviation for state, province, district or

possession.

Street1 string 50 House number and street name for postal address.

Street2 string 50 Second line of postal address.

Street3 string 50 Third line of postal address.

Title string 50 Title of Primary Contact for Customer.

Zip string 10 ZIP/Postal code of postal address.

PaymentMethods (only present in

InfoCustomer web method) xml PaymentMethod Variable

Collection of methods for payments from Customer

through DC Gateway.

Contract (only present in InfoContract

web method) xml Contract Variable

Collection of Recurring Payment Agreements

between a DC Gateway Customer and a Merchant.

PaymentMethod Parameters (InfoCustomer, InfoContract)




Field Name Type Max

Length Description

CcType enum (PaymentType) Card Brand._PaymentType_(DC_Gateway

CcZIP string 10 ZIP Code of cardholder postal address.

CcStreet string 25 Street line of cardholder postal address.

CcNameonCard string 25 Name of cardholder (as it appears on card).

CcExpDate string 4 Expiration date on card.

CcAccountNum string 19 Card number (all but final 4 digits of number are

masked to protect privacy).

CardInfoKey string 10 Unique identifier assigned to card in DC Gateway.

Contract Parameters (InfoContract)

Field Name Type Max

Length Description

AmountToDate string 18 Total of all recurring payments made on contract to-

date.

BillAmt string 18 Sales amount for each recurring payment.

BillingInterval string 2 Number of periods between payments.

BillingPeriod string Unit (DAY, WEEK, MONTH, YEAR) for billing time

period.

BillsToDate string 10 Number of bills presented to Customer from the

initiation of payment agreement until current date.

ContractID string 10 Unique identifier assigned by user to the Recurring

Payment Agreement between Merchant and

Customer.

ContractName string 100 Description for Recurring Payment Agreement.

CreatedDT string 10 Date of initiation for Recurring Payment Agreement.

DayOfWeek string 1 Days of week (1-7) on which recurring payments are

processed.

EmailCustOnFailure enum (BooleanType) 1 Send (T) electronic mail message to Customer when

an attempted payment is unsuccessful.

EmailCustOnSuccess enum (BooleanType) 1 Send (T) electronic mail message to Customer when

an attempted payment is successful.

EmailMerchantOnFailure enum (BooleanType) 1 Send (T) electronic mail message to Merchant when

an attempted payment is unsuccessful.

EmailMerchantOnSuccess enum (BooleanType) 1 Send (T) electronic mail message to Merchant when

an attempted payment is successful.

EndDT string 10 Date of termination for Recurring Payment

Agreement.

FailurePeriod string Unit (DAY, WEEK, MONTH, YEAR) for failure time

period.

FailureInterval string 2 Number of time periods between reprocessing

attempts (after an unsuccessful payment).

NextBillDt string 10 Date of next scheduled payment.

NumPayments string 2 Number of payments authorized by Recurring

Payment Agreement.




Field Name Type Max

Length Description

PaymentPref string 2 Credit Card (CC) or Check (CK).

StartDT string 10 Date of first payment.

TaxAmt string 18 Tax amount (for each payment).

TotalAmt string 18 Total (Sales + Tax) amount (for each payment).

ContractKey string 10 Unique identifier assigned to a Recurring Payment

Agreement created by DC Gateway.

GetAPIUser

Description

Retrieve network credentials for a User Name (with access to DC Gateway APIs).

Developers Notes

GetAPIUser is not currently a viable operation of the DC Gateway Administration web service.

Parameters

Field Name Type Max


userName string 25 Required





secureToken string Variable Required




requests.

merchantKey string 10 Required Unique identifier for a Merchant in DC

Gateway.

Example

Hyperlink to GetAPIUser Request/Response example

Response (GetAPIUser)

Field Name Type Max

Length Description

UserName string 25 DC Gateway User Name (when operation invoked).

Password string Variable Password for DC Gateway User Name.

SecurePassword string Variable Password for DC Gateway User Name (encrypted).

Domain string 10 Network domain of DC Gateway User Name.

GetDebitAccount

Description

The GetDebitAccount operation is not supported by DC Gateway.




Login

Description

Login to DC Gateway Virtual Terminal.

Parameters

Field Name Type Max







Password string 20 Required Password for the user name assigned

in DC Gateway.

Example

Hyperlink to Login Request/Response example

Response (Login)

Field Name Type Max

Length Description

code GatewayResultCode 50 Result Code (returned from DC Gateway)



Partner string 10 Direct Connect reseller

Vendor string 10 Unique identifier for a Merchant in DC Gateway

Username string 25 DC Gateway User Name (when operation invoked)




Transaction Processing Web Service

Name

Process Transaction with Card or Check.

Description

Process payments with Checks and Cards.

Operations

Name Description

GetInfo Retrieves information about the status or configuration of DC Gateway.

ProcessCash Process transaction with Cash.

ProcessCheck Process transaction with a Check.

ProcessCreditCard Process transaction with a Credit Card.

ProcessDebitCard Process transaction with a Debit Card.

ProcessEBTCard Process transaction with an Electronic Benefits Transfer (EBT) Card.

ProcessGiftCard Process transction with a Gift Card.

ProcessLoyaltyCard Deprecated - Process transaction with a Loyalty Card.

ProcessSignature Add Signature to a transaction processed with DC Gateway.

Developer Notes

Invoke Transaction Processing Web Service operations with a Testing Account and a Trigger Amount to elicit

a specific response from DC Gateway during development and testing._Testing_Accounts

Default timeout values (in seconds) are 30 for transaction and 300 for settlement requests.

GetInfo

Description

Retrieves information about the status of DC Gateway.

Developer Notes

GetInfo StatusCheck operation is supported by DC Gateway for all processors.

GetInfo BatchInquiry/KeyChangeRequest/Initialize/Setup transaction types have been deprecated.

Parameters

Field Name Type Max


UserName string 25 Required






in DC Gateway.




Field Name Type Max


TransType string 11 Required

Valid TransType value: StatusCheck -

provides status of the DC Gateway

(BatchInquiry, KeyChangeRequest,

Initialize, and Setup transaction types

have been deprecated).

ExtData xml ExtData Variable Optional

There are no Extended Data

parameters for the GetInfo -

StatusCheck Operation.

Returns

Hyperlink to Transact Web Service Response structure.

Example

Hyperlink to GetInfo Request/Response example

ProcessCash

Description

Process a transaction with Cash.

Developer Notes

ProcessCash allows DC Gateway to produce comprehensive reports of payments processed by a Merchant in a

batch or over a time period.

Parameters

Field Name Type Max








in DC Gateway.

TransType enum

(CashTransType) 6 Required

Transaction type for processing a cash

payment. Valid TransType values: Sale;

Return.

Amount string 18 Required $0.00 > Amount < $1,000,000.00

(DDDDDD.CC).

InvNum string 20 Optional

Identifier assigned by the merchant to

locate a specific transaction or

multiple transactions (grouped by a

single invoice).

PNRef string 10 Conditional

Unique identifier of a transaction,

assigned by DC Gateway.

Required for TransType =Return;

Optional for TransType = Sale.

RegisterNum string 10 Optional

A string that uniquely identifies the

register, terminal, or computer on

which the transaction was performed.




Field Name Type Max



Structure for extended data provided

to/from Transaction Processing Web

Service.

ExtData Parameters (ProcessCash)

Field Name Type Max


Timeout string 10 Optional Processor timeout, in seconds.

TrainingMode enum (BooleanType) 1 Optional

Transactions are processed for local

loop back testing when Training Mode

is active (T).

Returns


Example

Hyperlink to ProcessCash Request/Response example

ProcessCheck

Description

Process a transaction with Check.

Developer Notes

Account and routing data outputted by a MICR can be passed through the API. Refer to MICR manufacture

documentation.

Important notes regarding the ProcessCheck - Capture operation:

o Capture and CaptureAll web methods are only supported by processors that operate on terminal

settlement platform. _Front_End_Processors

o Merchant must successfully make a sale before invoking a ProcessCheck - Capture operation.

o Include the value of PNRef in the response received from a ProcessCheck – Sale operation as the PNRef

parameter to ProcessCheck – Capture operation.

Parameters

Field Name Type Max








in DC Gateway.

TransType enum

(CheckTransType) 10 Required

Transaction type for processing a

check payment. Valid TransType

values: Auth; Sale Return; Force; Void;

Capture; CaptureAll.

CheckNum string 10 Required Unique identifier for an original check

(on a Checking Account).




Field Name Type Max


TransitNum string 9 Required

A Nine-digit code, used in the United

States to identify the financial

institution on which a check is drawn.

AccountNum string 20 Required Unique identifier of the check owner's

bank account.


(DDDDDD.CC).

MICR string 250 Optional

Magnetic Ink Check Reader (MICR)

data line, including routing number of

Bank and Account number of owner.

NameOnCheck string 50 Required Check owner's name as it appears on

the check.

DL string 255 Optional Identifier on Driver's License of Check

owner.

SS string 11 Optional

Nine-digit number issued to citizens,

permanent residents and temporary

workers by the Social Security

Administration in the United States.

DOB string 10 Optional Date of Birth (MM/DD/YYYY or YYYY-

MM-DD).

StateCode string 2 Conditional


abbreviation for a state, district,

possession or territory.

Required for TransType = Sale;

Return;

Optional for TransType = Auth; Force;

Void; Capture; CaptureAll.

CheckType enum (CheckType) 10 Conditional

Checking Account Type: Personal,

Business.


Return;



ExtData xml ExtData Variable Conditional



Service.


Return; Void;



ExtData Parameters (ProcessCheck)

Field Name Type Max


AccountType enum (CheckAcctType) 10 Conditional

Valid Account Type: Checking, Savings.


Return;



AllianceNum string 20 Optional Alliance number associated with

checking account.




Field Name Type Max


AuthOptionForm enum

(AuthOptionFormType) 25 Conditional

Signed Form authorization option.

Required for SECCType CCD or PPD.

AuthOptionVoice enum

(AuthOptionVoiceType) 25 Conditional

Recorded Voice authorization option.

Required for SECCType = TEL.

BillToStreet string 100 Conditional

Address of Customer.


Return;



BillToCity string 50 Conditional

City of Customer.


Return;



BillToState string 50 Optional





Return;



BillToPostalCode string 5 Conditional

Zip code of Customer.


Return;



BillToCountry string 3 Optional Country of Customer.

CItyOfAccount string 50 Optional City of Account.

CustomerID string 50 Optional Identifier assigned by merchant to

cardholder.

Email string 100 Optional Electronic Mail Address of checking

account owner.

ExternalIP string 15 Optional Originating IP address to use for

logging and IP filtering.


Identifier assigned by merchant to



single invoice).

Phone string 12 Conditional

Phone number of Customer: xxx-xxx-

xxxx.


Return;






Required for TransType = Return;

Void; Capture;

Optional for TransType = Auth; Sale;

Force; CaptureAll.




Field Name Type Max


RawMICR string 250 Optional


received from a check reader

composed of a transit number, the

letter “T”, an account number, the

letter “O” and the check number.

SECCType enum (SECCType) 3 Conditional Standard Entry Class codes. Required

for First ACH transactions.

Timeout string 10 Optional Processor timeout, in seconds.

TrainingMode enum (BooleanType) 1 Optional

Transactions are processed for local

loop back testing when Training Mode

is active (T).

Returns


Example

Hyperlink to ProcessCheck Request/Response example

ProcessCreditCard

Description

Process a transaction with a Credit Card.

Developer Notes

The ProcessCreditCard operation is supported by the following processors: Concord EFS Network, Elavon

(NOVA Information System), First Data Nashville, First Data North, First Data Omaha, First Data Rapid

Connect, Global Payments, Heartland Payment Systems, Paymentech - Tampa, TSYS Host, TSYS Terminal

(Vital).

Important notes regarding obtaining customer card information:

o A value for MagData is required for DC Gateway to process payment with credit card presented by

consumer and obtained with swipe or proximity (Near Field Communication) card reader at the point of

sale/service.

o Proximity (NFC) card readers are supported by the following processors: First Data North, First Data

Rapid Connect, TSYS Terminal (Vital).

o EMV payment technology is supported by First Data Rapid Connect processor.

Notes regarding Level II processing:

o The PONum and TaxAmt extended data elements used to specify Purchase Order Number and Tax

Amount Level II data item for the following processors: First Data Nashville, First Data North, First Data

Omaha, First Data Rapid Connect, Global Payments, Heartland Payment Systems, Paymentech – Tampa,

TSYS Host, TSYS Terminal (Vital).

o Transactions must be processed with Purchasing/Procurement Cards to qualify for Level II interchange

rates.

o The CustCode extended data element used to specify Purchase Order Number Level II data item for the

Global Payments processor.

Notes regarding Level III processing:

o Level III - Line Item detail provided with ProcessCreditCard – Auth operation will be preserved during

ProcessCreditCard – Force and Capture operations.

o Level III – Line Item detail is supported for Visa and MasterCard transactions by the following

processors: First Data North, Heartland Payment Systems.

o Line Item detail should only be provided for transactions processed with Business/Corporate Cards.




Notes regarding Partial Authorization processing:

o The ProcessCreditCard – Auth (Partial) operation is supported for Visa and MasterCard transactions by

the following processors: First Data Rapid Connect, TSYS Host, TSYS Terminal (Vital).

o Inspect value (for “Partial Approval” or “Approval”) of Message element in Response message received

from ProcessCreditCard – Auth operation when Merchant Account is configured to support Partial

Authorization.

Transactions that require PNRef number for processing:

o Include the value of PNRef in the response received from a ProcessCreditCard - Auth operation as the

PNRef parameter to ProcessCreditCard – Force operation.

o Include the value of PNRef in the response received from a ProcessCreditCard – Sale or RepeatSale

operation as the PNRef parameter to ProcessCreditCard – Return operation.


operation as the PNRef parameter to ProcessCreditCard – Reversal operation and Void operation.

o Include the value of PNRef in the response received from a ProcessCreditCard – Sale, RepeatSale or Auth

operation as the PNRef parameter to ProcessCreditCard – Capture operation.

Merchant must successfully authorize a transaction or make a sale before invoking a ProcessCreditCard

Void operation.

Merchant must successfully make a sale or force an authorization before invoking a ProcessCreditCard -

CaptureAll operation.

A value for the CVPresence extended data element is required with ProcessCreditCard operations for the

following processors: First Data Nashville, First Data North, First Data Omaha, First Data Rapid Connect.

Utility Bill Payments are supported (through the BillPayment extended data element) by the following

processors: First Data North, Global Payments, TSYS Terminal (Vital).

Special processing for medical expenses supported for Visa transactions by First Data North processor using

the following extended data elements: IIAS_Indicator, Partial_Indicator, QHP_Amount, RX_Amount,

Vision_Amount, Dental_Amount, Clinical_Amount.

Concord EFS Network processor refuses duplicate transactions (ignores instruction received from DC

Gateway as value of ForceDuplicate extended data element).

The name and address of secondary Merchants (which share a single Merchant Account) are supported for

First Data Rapid Connect processor with the following extended data elements: AltMerchName,

AltMerchAddr, AltMerchCity, AltMerchState, AltMerchZip.

The ProcessCreditCard – Capture and CaptureAll operations are supported by the following processors

operating on terminal settlement platforms: First Data North, First Data Omaha, Paymentech - Tampa, TSYS

Terminal (Vital).

For Sale/Auth transactions, AVS and CVV responses are validated against the fraud filters (if enabled).

For RepeatSale transactions, AVS and CVV responses are not validated against the fraud filters (if

enabled)._Front_End_Processors

Parameters

Field Name Type Max








in DC Gateway.




Field Name Type Max


TransType enum

(CreditCardTransType) 10 Required


credit card payment. Valid TransType

values: Auth; Sale; Force; RepeatSale;

Return; Reversal; Void; Capture;

CaptureAll.

CardNum string 19 Conditional

The Primary Account Number (PAN)

uniquely identifies the issuer and

credit cardholder account.

Required for TransType = Auth; Sale;

RepeatSale; Return; Reversal;

Optional for TransType = Force; Void;


ExpDate string 4 Conditional

Expiration Date (MMYY)


RepeatSale; Return; Reversal;



MagData string Variable Conditional

The data - number and expiration date

- read from magnetic stripe on card.

Required when credit card

presented by consumer at point of

sale/service.

NameOnCard string 25 Optional Cardholder's name as it appears on

the card.

Amount string 18 Conditional

$0.00 > Amount < $1,000,000.00

(DDDDDD.CC).


RepeatSale; Force; Return; Reversal;

Optional for TransType = Void;






single invoice).




Required for TransType = Force;



RepeatSale; CaptureAll.

Zip string 10 Optional ZIP or Postal Code of cardholder's

billing address.

Street string 25 Optional House number and Street name of

cardholder's billing address.

CVNum string 4 Optional Credit Card Verification Number.




Service;

Required for TransType = Sale w/

Level II/III Data and P2PE enabled

transactions.

Optional for Auth; Sale (w/o Level II/III);

Reversal.




ExtData Parameters (ProcessCreditCard)

Field Name Type Max


AltMerchName string 50 Optional

Soft descriptor: name of secondary

Merchant (single Merchant Account

used for more than one merchant

website). Specific to First Data Rapid

Connect & FD ISO Nashville.

AltMerchAddr string 50 Optional

Soft descriptor: address of secondary





AltMerchCity string 50 Optional

Soft descriptor: city of secondary





AltMerchState string 2 Optional

Soft descriptor: state of secondary



website).

AltMerchZip string 10 Optional

Soft descriptor: ZIP Code of secondary





AuthCode string 20 Optional Authorization/approval code assigned

to original transaction by processor.

Authentication string 20 Optional Value to authenticate the payment.

BillPayment enum (BooleanType) 1 Optional Indicate (T) transaction accepted for

payment on Utility Bill.

BillToState string 2 Optional State abbreviation of checking

account owner’s billing address.

BypassAvsCvv enum (BooleanType) 1 Optional

Flag used to indicate if the DC

Gateway should bypass AVS and CVV

validation.

City string 50 Optional City of checking account owner’s

billing address.

Clinical_Amount string 13 Optional Subtotal for clinical services

(DDDD.CC). Decimal included.

ConvenienceAmt string 18 Optional

Fee (added to Amount) for utility

company, government or school to

recover cost of accepting credit card

for payment (DDDDD.CC).

CustCode string 20 Optional


allow payment processed by Global

Payments to be traced to purchase

order number.


cardholder.

CustomFields xml CustomFields Variable Optional User defined Custom fields for





Field Name Type Max


CVPresence enum

(CVPresenceType) 1 Optional

Card verification provided for

transaction:

1 – No CV provided

2 – No CV submitted (along with key-

entered card number)

3 – CV submitted

4 – CV illegible

5 – CV not on card.

Dental_Amount string 13 Optional Subtotal for dental services


EMVData string Variable Optional

Application cryptogram generated by

chip requesting issuer to confirm

legitimacy of card.

EntryMode enum

(EntryModeType) 15 Conditional

Indicate how merchant obtained

values from credit card, as follows:

UNKNOWN; MANUAL MagneticStripe;

ICC; PROXIMITY.

Required when MagData or

EMVData fields are populated.



Fleet string Deprecated

Force enum (BooleanType) 1 Optional

Force (T) DC Gateway to accept

duplicate transaction into current

batch (ignored by Concord EFS

processor).

IIAS_Indicator enum (BooleanType) 1 Optional

Indication (T) received from an

Inventory Information Approval

System (IIAS) that credit card payment

for eligible medical expense. Specific

to First Data North.

Invoice string Deprecated

Items string Deprecated

Level3Amt string 18 Optional Total amount for line items in order

LineItemDetail xml LineItemDetail Variable Conditional

XML element. Detail for 1 – 99 line

items which must be provided to

qualify transaction for Level III

interchange. See LineItemDetail

section below for definition.

Required in order to qualify for

Level III transactions.

P2PE xml P2PE Variable Conditional

XML element containing the

necessary point to point encryption

values for magnetic stripe data.

Required for transactions that

obtain customer account

information using Point to Point

encryption.

Partial_Indicator enum (BooleanType) 1 Optional

Processor may (T) authorize partial

amount for medical expense based

on funds available.




Field Name Type Max


PONum string 20 Optional


allow payment processed (by

processor other than Global

Payments) to be traced to purchase

order number.

Presentation xml Presentation Variable Optional XML element indicating presence of

card at point of sale.

QHP_Amount string 13 Optional Subtotal for over-the-counter medical

items (DDDD.CC). Decimal included.




which transaction was performed.

RX_Amount string 13 Optional Subtotal for prescribed medical items


SequenceCount string 5 Optional

Total number of payments to be

processed on a repeat sale or

Recurring Payment Agreement.

SequenceNum string 5 Optional

The order in which a payment was



ServerID string 50 Optional Unique identifier of DC Gateway used

to process transaction.

Target string 50 Optional

Numeric value originally assigned by

Merchant (using TransactionID

extended data element) to identify

transaction (for use as alternative to

DC Gateway-assigned PNRef).

TaxAmt string 18 Optional

Fee (added to Amount) to cover cost

of sales tax (DDDDD.CC). Required

for Level II/III transactions.

TimeOut string 10 Optional Processor timeout, in seconds.

TipAmt string 18 Optional

Fee (included in Amount) specified by

consumer as gratuity for service

performed (DDDDD.CC).

TrainingMode enum (BooleanType) 1 Optional Process transactions for local loop

back testing (T).

TransactionID string 50 Optional

Numeric value assigned by Merchant

to identify a transaction (for use as

alternative to DC Gateway-assigned

PNRef).

Vision_Amount string 13 Optional Subtotal for vision services


CustomFields Parameters

All Custom Fields elements must be enclosed in a <CustomFields></CustomFields> data tag.

Field Name Type Max


“user defined field #1” string 12 Optional Custom field defined by merchant.

“user defined fieldn” where n is

iterative string 12 Optional Custom field defined by merchant.




LineItemDetail Parameters (Level III)

Each LineItemDetail record must be enclosed in a <LineItem></LineItem> data tag.

Field Name Type Max


CommodityCode string 12 Conditional

Commodity/Service classification of

item.

Required for Level III transactions.

Description string 50 Conditional Item description.


DiscountAmount string 50 Conditional Discount applied to item.


DiscountIncluded enum (BooleanType) 1 Conditional

Indicator defining if Discount is

included in amount.


LineItemTotal string 50 Conditional

Subtotal for item (Amount –

DiscountAmount + TaxAmount).


ProductCode string 50 Conditional

Product code for item assigned by

merchant.


Quantity string 18 Conditional Number of units of item in order.


TaxAmount string 50 Conditional

Total tax to apply to item (see also

TaxIncluded).


TaxRate string 50 Conditional Tax rate applied to item.


TaxType enum (TaxType) 50 Conditional Tax table applied to item.


UnitOfMeasure enum

(UnitOfMeasureType) 3 Conditional

Division of quantity accepted as

standard for exchange.


UnitPrice string 18 Conditional Cost of item per unit.


P2PE Parameters (Point to Point Encryption)

The Point to Point Encrypted elements must be enclosed in <P2PE></P2PE> data tag.

Field Name Type Max


HSMDevice string 6 Conditional Value = “Thales”.

Required for P2PE transactions.

TerminalType string 25 Conditional

Type of terminal used to generate

the point to point encryption

transaction.


EncryptionType string 5 Conditional

Type of encryption method. Value =

“DUKPT”.


KSN string 20 Conditional

Key serial number for encrypted

magnetic stripe data.





Field Name Type Max


DataBlock string Variable Conditional

Data block containing the encrypted

magnetic stripe data for transaction.


Presentation Parameters

Field Name Type Max


CardPresent enum

(CardPresentType) 7 Optional Card presence indicator.

Returns


Example

Hyperlink to ProcessCreditCard Request/Response example

ProcessDebitCard

Description

Process a transaction with a Debit Card.

Developer Notes

Processor specific notes regarding debit support:

o The ProcessDebitCard operation is supported by the following processors: Concord EFS Network, Elavon

(NOVA Information System), First Data North, First Data Omaha, First Data Rapid Connect, Global

Payments, Paymentech - Tampa, TSYS Host, TSYS Terminal (Vital).

o PIN-less Debit Card transactions are supported by Global Payments processor.

o Returning cash from ProcessDebitCard – Sale operation supported by the following processors: Elavon

(NOVA Information System), First Data Rapid Connect, Global Payments, TSYS Host, TSYS Terminal (Vital).

o The ProcessDebit – Reversal operation is supported by First Data North, First Data Rapid Connect, Global

Payments, TSYS Host, TSYS Terminal (Vital).

o Processors limit time period between a ProcessDebitCard - Sale operation and the corresponding

ProcessDebit – Reversal operation: two (2) hours – TSYS Host, TSYS Terminal (Vital), 24 hours - First Data

North, First Data Rapid Connect, Global Payments.

Important notes regarding obtaining customer card information:

o A value for MagData is required for DC Gateway to process payment with debit card presented by

consumer and obtained with swipe or proximity (Near Field Communication) card reader at the point of

sale/service.

o Proximity (NFC) card readers are supported by the following processors: First Data North, First Data

Rapid Connect, TSYS Terminal (Vital).

o EMV payment technology is supported by First Data Rapid Connect processor.


o Include the value of PNRef in the response received from a ProcessDebitCard – Sale operation as the

PNRef parameter to ProcessDebit Card – Return operation.


PNRef parameter to ProcessDebit Card – Capture operation.


PNRef parameter to ProcessDebit Card – Reversal operation.




DC Gateway rejects ProcessDebitCard operations unless Personal Identification Number (PIN) encrypted

when a value is provided for Pin parameter.

Merchant must successfully make a sale before invoking a ProcessDebitCard Return operation.

Merchant must successfully make a sale before invoking a ProcessDebitCard CaptureAll operation.

Merchants selling through both telephone (i.e. automated Voice Response Unit) and also internet must use

the RegisterNum Extended Data element to specify channel for each sale (made by telephone or internet).

The ProcessDebitCard – Capture and CaptureAll operations are supported by the following processors


Terminal (Vital)._Front_End_Processors

Parameters

Field Name Type Max








in DC Gateway.

TransType enum

(DebitCardTransType) 10 Required


debit card payment. Valid TransType

values: Sale; Return; Reversal;





debit cardholder account.


Return; Reversal;

Optional for TransType = Capture;

CaptureAll.


Expiration Date.


Return; Reversal;


CaptureAll.


The data - number and expiration

date - read from magnetic stripe on

card.


Return; Reversal;


CaptureAll.


the card.


Sale Amount (DDDDD.CC format).


Return; Reversal;


CaptureAll.

InvNum string 10 Optional Invoice Number.




Field Name Type Max





Required for TransType = Return;

Capture; Reversal;

Optional for TransType = Sale;

CaptureAll.

Pin string Variable Conditional

The encrypted PIN-block returned

from a secure cryptographic device,

such as a PIN Pad.

Required when processor requires

customer to provide Personal

Identification Number.



register, terminal, -r computer on

which-the transaction was

performed.

SureChargeAmt string 18 Optional

The amount charged - surcharge

applied - by a merchant to process a

transaction with a debit card.

CashBackAmt string 18 Optional

Amount added to a Sale Amount that

is returned in Cash (DDDDD.CC

format).




Service.

Required for online PIN debit

transactions and/or P2PE enabled

transactions.

ExtData Parameters (ProcessDebitCard)

Field Name Type Max




CustomerID string 50 Optional




order number.





processor).

KeySerialNumber string 20 Conditional

Serial number of PIN pad and

encryption key for the transaction.

Required for online PIN debit

transctions.

P2PE xml P2PE Variable Conditional

XML element containing the

necessary point to point encryption

values for magnetic stripe data.

Required for P2PE enabled

transactions.






Field Name Type Max








back testing (T).

P2PE Parameters (Point to Point Encryption)

Field Name Type Max


HSMDevice string 6 Conditional Value = “Thales”.


TerminalType string 25 Conditional

Type of terminal used to generate the

point to point encryption transaction.


EncryptionType string 5 Conditional

Type of encryption method. Value =

“DUKPT”.


KSN string 20 Conditional

Key serial number for encrypted

magnetic stripe data.


DataBlock string Variable Conditional

Data block containing the encrypted

magnetic stripe data for transaction.


Returns


Example

Hyperlink to ProcessDebitCard Request/Response example

ProcessEBTCard

Description

Process a transaction with an Electronic Benefits Transfer (EBT) Card.

Developer Notes

The Food and Nutrition Service (FNS) of the US Department of Agriculture grants license (and issues FNS

Number) for Merchant to participate in Special Nutrition Assistance Program (SNAP) and accept payment

with EBT Card.

The ProcessEBTCard operation is supported by First Data Rapid Connect processor for Special Supplemental

Nutrition Assistance Program (SNAP) for Women, Infants and Children (WIC) transaction types.

Processor specific notes regarding EBT support:

o The ProcessEBTCard operation is supported by the following processors: Concord EFS Network, Elavon

(NOVA Information System), First Data Rapid Connect, Global Payments, Paymentech - Tampa, TSYS

Host, TSYS Terminal (Vital).


o Include the value of PNRef in the response received from a ProcessEBTCard – FoodStampSale operation

as the PNRef parameter to ProcessEBTCard – Return operation.




o Include the value of PNRef in the response received from a ProcessEBTCard – Sale operation as the

PNRef parameter to ProcessEBTCard – Capture operation.

o Include the value of PNRef in the response received from a ProcessEBTCard – EWICAUTHORIZATION

operation as the PNRef parameter to ProcessEBTCard – EWICCOMPLETION operation.

DC Gateway rejects ProcessEBTCard operations unless Personal Identification Number (PIN) encrypted

when a value is provided for PIN parameter.

Merchant must successfully make a sale using EBT Card before invoking a ProcessEBTCard Capture

operation.

Merchant must successfully make a Food Stamp sale using EBT Card before invoking a ProcessEBTCard

FoodStampReturn operation.

Merchant must obtain voice approval to make Sale with EBT Card without Personal Identification Number

(PIN) provided by customer.

Merchants selling through both telephone (i.e. automated Voice Response Unit) and also internet must use

the RegisterNum Extended Data element to specify channel for each sale (made by telephone or internet).

Merchant must authorize an eWIC payment with ProcessEBTCard – EWICAUTHORIZATION operation before

posting that transaction into the current batch.

An authorization code (obtained during voice approval) and voucher reference number are required to

invoke ProcessEBTCard – Force operation.

The ProcessEBT – Capture and CaptureAll operations are supported by the following processors operating

on terminal settlement platforms: Paymentech - Tampa, TSYS Terminal (Vital)._Front_End_Processors

Parameters

Field Name Type Max








in DC Gateway.

TransType enum

(EBTCardTransType) 20 Required

Transaction type for processing an

EBT card payment. Valid TransType

values: FoodStampSale;

FoodStampReturn; CashBenefitsSale;

EWICSale; EWICAuthorization;

EWICCompletion; EWICVoucherClear;

SNAPVoucherClear; Force; Inquire;

Reversal; Void; Capture; CaptureAll.



uniquely identify the issuer of an EBT

cardholder's account.

Required for TransType =

EWICAuthorization; EWICSale;

EWICVoucherClear; FoodStampSale;

FoodstampReturn; Inquire;

Reversal; SNAPVoucherClear;

CashBenefitsSale;


EWICCompletion; Capture; CaptureAll.




Field Name Type Max



Expiration Date.






CashBenefitsSale;






Required when EBT card presented

by consumer at point of sale/

service.


the card.


Sale Amount (DDDDD.CC format).






CashBenefitsSale;







single Invoice).




Required for FoodStampReturn;

Capture; EWICCOMPLETION;

Optional for FoodStampSale;

CashBenefitSale; Inquire; CaptureAll;

Force; EWICAUTHORIZATION;

EWICSALE.

Pin string Variable Conditional

The encrypted PIN-block returned

from a secure cryptographic device,

such as a PIN pad.

Required when processor requires

customer to provide Personal

Identification Number.




which the transaction was performed.

SureChargeAmt string 18 Optional

The amount charged - surcharge

applied - by a merchant to process a

transaction with a debit card.

CashBackAmt string 18 Optional

Amount added to a Sale Amount that

is returned in Cash (DDDDD.CC

format).




Field Name Type Max





Service.

Required for online PIN EBT

transactions.

ExtData Parameters (ProcessEBTCard)

Field Name Type Max








order number.

EWICDetGrp xml EWICDetGrp Variable Conditional

Detail for items covered by WIC

supplemental benefits of SNAP.

Required for EWIC transactions.





processor).

KeySerialNumber string 20 Conditional

Serial number of PIN pad and

encryption key for the transaction.

Required for online PIN transctions.

MerchantFNS string 255 Optional

Identifier assigned by USDA FNS for

Merchant licensed to participate in

SNAP.

Settle string Deprecated

Target string 50 Optional






TimeOut string 10 Optional Processor timeout, in seconds


back testing (T).





PNRef).

VoucherNumber string 50 Conditional

Reference number on a paper voucher

used for an EBT purchase.

Required for voucher purchase

transactions.




EWICDetGrp (eWIC Line Item)

Field Name Type Max


UPCPLUInd string 1 Conditional

Indicator of Universal Product Code

(UPC) or Price Look Up (PLU) code (0 -

UPC, 1 – PLU).


UPCPLUData string 16 Conditional

Item Code (UPC or PLU, based on

UPCPLUInd).


UPCPrice string 18 Conditional Item Price.


UPCQty string 5 Conditional

Number or Total Weight of item

(NNNDD – Implied Decimal).


Returns


ProcessGiftCard

Description

Process a transaction with a Gift Card.

Developer Notes

The ProcessGiftCard operation is supported by the following processors: Givex, Valutec

Gift Card must be Activated before it may be used for ProcessGiftCard – Inquire, Redeem, Reload and

Deactivate operations


o Include the value of PNRef in the response received from a ProcessGiftCard – Redeem operation as the

PNRef parameter to ProcessGiftCard – Refund operation.

o Include the value of PNRef in the response received from a ProcessGiftCard – Redeem or Force

operation as the PNRef parameter to ProcessGiftCard – Void operation.

o Include the value of PNRef in the response received from a corresponding ProcessGiftCard operation as

the PNRef parameter to ProcessGiftCard – Capture

operation._Front_End_Processors_Front_End_Processors

Merchant must successfully make Gift Card sale before invoking a ProcessGiftCard Refund operation.

Merchant must successfully make a sale using Gift Card before invoking a ProcessGiftCard Void operation.

Merchant must successfully process transaction using Gift Card before invoking a ProcessGiftCard Capture

operation.

Merchant must successfully process transaction using Gift Card before invoking a ProcessGiftCard

CaptureAll operation._Front_End_Processors_Front_End_Processors

The ProcessGiftCard – Force operation is supported by Paymentech – Tampa

processor._Front_End_Processors

Include authorization code received from processor as the AuthCode extended data parameter of

ProcessGiftCard – Force operation.

The ProcessGiftCard – Capture and CaptureAll operations are supported by the following processors

operating on terminal settlement platforms: First Data Nashville, First Data North, First Data Omaha,

Heartland Payment Systems, Paymentech - Tampa, TSYS Terminal (Vital).




Parameters

Field Name Type Max








in DC Gateway.

TransType enum

(GiftCardTransType) 10 Required

Transaction type for processing a Gift

card payment. Valid TransType values:

Activate; Inquire; Redeem; Force;

Refund; Void; Reload; Deactivate;






Required for TransType = Activate;

Redeem; Inquire; Refund; Reload;

Deactivate.




Expiration Date.


Redeem; Inquire; Refund; Reload;

Deactivate.






Required when gift card presented

by consumer at point of

sale/service.


Sale Amount (DDDDD.CC format)


Redeem; Refund; Reload;







single invoice).




Required for TransType = Void;

Capture;

Optional for TransType = Activate;

Inquire; Redeem; Force; Reload;

Deactivate; CaptureAll.




Service.




ExtData Parameters (ProcessGiftCard)

Field Name Type Max








order number.





processor).

ForceAuth string Deprecated





TimeOut string 10 Optional Processor timeout, in seconds


back testing (T).





PNRef).

Returns


ProcessSignature

Description

Add Signature to a transaction processed with DC Gateway.

Developer Notes

The ProcessSignature operation is a function of DC Gateway supported for all processors.

Merchant must successfully make a sale before invoking a ProcessSignature operation.


o Include the value of PNRef in the response received from a corresponding operation as the PNRef

parameter to ProcessSignature operation.

o Include the value of AuthCode in the response received from a corresponding operation as the

AuthCode parameter to ProcessSignature operation.

Take following steps to process and upload image of captured signature to DC Gateway in Receipt1

SignatureType: verify or convert signature image into Tagged Image File Format (TIFF) file; compress file

using Lempel-Ziv-Welch (LZW) algorithm (if TIFF file is not already LZW-compressed); translate compressed

image from binary data into text string format using Base64-encoding; set value of SignatureData

parameter to Base64-encoded text string (representing signature Image); invoke ProcessSignature

operation.

SignatureData in Signature4 format consists of a text string of comma-separated vector coordinates,

delimited by caret (^), as follows: x1,y1^x2,y2^ ... xN,yN^ (and where 0,65535 signals that a pointer, such as

stylus or finger, was lifted from capture pad).




Parameters

Field Name Type Max








in DC Gateway.

SignatureType enum (SignatureType) 10 Optional

The format in which SignatureData is

stored. Valid types include: Signature1;

Signature2; Signature4; Receipt1.

SignatureData string Variable Optional

The signature of a cardholder or check

owner presented as Base64-encoded

text string or list of vectors.

PNRef string 10 Required Unique identifier of a transaction,


Result string 1 Optional

Result from response of

corresponding Transaction Processing

operation: approved (1) or declined

(0).

AuthCode string 20 Optional

Alphanumeric authorization code

(from Issuing Bank) used during

settlement or an error message (from

Payment Processor).




Service.

ExtData Parameters (ProcessSignature)

Field Name Type Max



back testing (T).

Returns


ProcessLoyaltyCard

Description

The ProcessLoyaltyCard operation is not supported by DC Gateway.

Response (Transact Web Service)

Operations of the Transaction Processing Web Service return data in the following structure:

Field Name Type Max

Length Description

AuthorizedAmount string 18 Amount authorized by processor (when value of

Partial_Indicator extended data element = T)

Balance string 18 Balance remaining on method used to process

transaction




Field Name Type Max

Length Description

Result GatewayResult 10 Numeric value returned from DC Gateway to

summarize result from invoking operation

RespMSG string 150 Message returned from DC Gateway describing

result from processing transaction

Message string 150 Message returned from DC Gateway to describe


Message1 string 150 Additional detail returned from DC Gateway to

describe result from processing transaction

Message2 string 150 More additional detail returned from DC Gateway to


AuthCode string 20

Six-character alphanumeric authorization code

(from Issuing Bank) used during settlement or an

error message (from Payment Processor)

PNRef string 10 Unique numeric identifier generated by DC Gateway

for a processed transaction.

HostCode string 30 Unique identifier generated by the payment

processor for a transaction

HostURL string n/a Unused (returns empty value)

ReceiptURL string n/a Unused (returns empty value)

GetAVSResult AVSResult 10 Address verification result code (returned by

Payment Processor)

GetAVSResultTXT string 25 Address verification result message (returned by

Payment Processor)

GetStreetMatchTXT string 25 Address Verification Service evaluation of ZIP Code

from cardholder address

GetZipMatchTXT string 25 Address Verification Service evaluation of street line


GetCVResult CVResult 1 Credit Card Verification result code (returned by

Issuing Bank)

GetCVResultTXT string 25 Credit Card Verification message (returned by

Issuing Bank)

GetGetOrigResult string n/a Unused (returns empty value)

GetCommercialCard string 5 Commercial card indicator (from the Payment

Processor) - True, False.

WorkingKey string n/a Unused (returns empty value)

KeyPointer string n/a Unused (returns empty value)

ExtData string Variable Structure for extended data provided to/from DC

Gateway

ExtData

Field Name Type Max

Length Description

ReceiptData

Requested_Amt string 18

Amount requested for authorization with

Partial_Indicator = T (DDDDD.CC).

ReceiptData

Approved_Amt string 18

Amount authorized by processor with

Partial_Indicator = T.

EmvResponseData string Variable Cryptogram received from issuer for card indicating

whether transaction is authorized or declined




Card Safe Web Service

Name

Tokenize and Use Credit Card.

Description

Encrypt and Store Payment Methods and Types for Reuse.

Operations

Name Description

StoreCard Add stored payment method to an existing customer record.

ProcessCreditCard Process a transaction using Credit Card or Checking account in Card Safe.

Developer Notes

Merchant must add a customer to DC Gateway (with ManageCustomer operation of Recurring Payments web

service) before storing a payment method (for that customer) in DC Gateway Card Safe.

StoreCard

Description

Add Credit Card to Card Safe for a Customer in DC Gateway.

Developer Notes

Merchant must add a customer to DC Gateway before storing a payment method (for that customer) in

Card Safe.

Merchant must store a customer’s Credit Card in Card Safe before adding a Recurring Payment Agreement

to DC Gateway.

The StoreCard operation returns a CardSafeToken element, which may be used as the PaymentInfoKey for a


Invoke the InfoCustomer operation to retrieve stored credit card from the collection of Payment Methods,

which have been saved for a Customer in DC Gateway.

There is no limit to the number of Payment Methods, which may be stored for a Customer in DC Gateway.

Direct Connect provides credit card numbers for use during development and

testing.CreditCardTestAccounts

Parameters

Field Name Type Max








in DC Gateway.




Field Name Type Max


TokenMode enum

(TokenModeType) 10 Required

Type of Token to return: a numeric

CCInfoKey (DEFAULT) or a randomly

generated number in the format of

the payment type (CARDFORMAT).

CardNum string 19 Required

Primary Account Number (PAN) that

uniquely identifies issuer and credit

cardholder account.

ExpDate string 4 Required Expiration Date of credit card account.

CustomerKey string 10 Required

Unique identifier for Customer

(returned from ManageCustomer

operation).


the card.

Street string 25 Optional House number and Street name of a



billing address.


There are no Extended Data

parameters for the StoreCard

operation.

Example

Hyperlink to StoreCard Request/Response example

Response (StoreCard)

Field Name Type Max

Length Description

Result GatewayResultCode 10 Result code returned from DC Gateway.

RespMSG string 150 Message from DC Gateway describing the result of


AuthCode string 10 Authorization/approval code assigned to original

transaction by processor.


Gateway.

ProcessCreditCard

Description

Process a transaction using Credit Card from Card Safe.

Developer Notes


(NOVA Information System), First Data Nashville, First Data North, First Data Omaha, First Data Rapid

Connect, Global Payments, Heartland Payment Systems, Paymentech - Tampa, TSYS Host, TSYS Terminal

(Vital).

Merchant must add a customer to DC Gateway and a customer’s Credit Card in Card Safe before invoking

the ProcessCreditCard operation.

Merchant must successfully make a sale before invoking a ProcessCreditCard Return operation.




Merchant must successfully authorize a transaction or make a sale before invoking a ProcessCreditCard

Void operation.

Merchant must successfully make a sale or force an authorization before invoking a ProcessCreditCard -

CaptureAll operation.

Merchant must successfully authorize a transaction or make a sale – using the same CardToken and

Amount - before invoking a ProcessCreditCard RepeatSale operation.

Notes regarding Level II processing:

o The PONum and TaxAmt extended data elements used to specify Purchase Order Number and Tax

Amount Level II data item for the following processors: First Data Nashville, First Data North, First Data

Omaha, First Data Rapid Connect, Global Payments, Heartland Payment Systems, Paymentech – Tampa,

TSYS Host, TSYS Terminal (Vital).

o Transactions must be processed with Purchasing/Procurement Cards to qualify for Level II interchange

rates.

o The CustCode extended data element used to specify Purchase Order Number Level II data item for the

Global Payments processor.

Notes regarding Level III processing:

o Level III - Line Item detail provided with ProcessCreditCard – Auth operation will be preserved during

ProcessCreditCard – Force and Capture operations.

o Level III – Line Item detail is supported for Visa and MasterCard transactions by the following

processors: First Data North, Heartland Payment Systems.

o Line Item detail should only be provided for transactions processed with Business/Corporate Cards.

Notes regarding Partial Authorization processing:

o The ProcessCredit – Auth (Partial) operation is supported for Visa and MasterCard transactions by the

following processors: First Data Rapid Connect, TSYS Host, TSYS Terminal (Vital).

o Inspect value (for “Partial Approval” or “Approval”) of Message element in Response message received

from ProcessCreditCard – Auth operation when Merchant Account is configured to support Partial

Authorization.


o Include the value of PNRef in the response received from a ProcessCreditCard - Auth operation as the

PNRef parameter to ProcessCredit Card – Force operation.


operation as the PNRef parameter to ProcessCredit Card – Return operation.


operation as the PNRef parameter to ProcessCredit Card – Reversal operation and Void operation.

o Include the value of PNRef in the response received from a ProcessCreditCard – Sale, RepeatSale or Auth

operation as the PNRef parameter to ProcessCredit Card – Capture operation.

The ProcessCreditCard - Auth operation returns a PNRef element to include as a parameter to follow-on

ProcessCreditCard operations, such as Return, Void, Force, RepeatSale and Adjustment.

A value for the CVPresence extended data element is required with ProcessCreditCard operations for the

following processors: First Data Nashville, First Data North, First Data Omaha, First Data Rapid Connect.

Utility Bill Payments are supported (through the BillPayment extended data element) by the following

processors: First Data North, Global Payments, TSYS Terminal (Vital).

Special processing for medical expenses supported for Visa transactions by First Data North processor using

the following extended data elements: IIAS_Indicator, Partial_Indicator, QHP_Amount, RX_Amount,

Vision_Amount, Dental–Amount, Clinical_Amount.

Concord EFS Network processor refuses duplicate transactions (ignores instruction received from DC

Gateway as value of ForceDuplicate extended data element).

The name and address of secondary Merchants (which share a single Merchant Account) are supported for

First Data Rapid Connect processor with the following extended data elements: AltMerchName,

AltMerchAddr, AltMerchCity, AltMerchState, AltMerchZip.




The ProcessCreditCard – Capture and CaptureAll operations are supported by the following processors


Terminal (Vital).

For Sale/Auth transactions, AVS and CVV responses are validated against the fraud filters (if enabled).

For RepeatSale transactions, AVS and CVV responses are not validated against the fraud filters (if

enabled)._Front_End_Processors_Front_End_Processors

Parameters

Field Name Type Max








in DC Gateway.

TransType enum

(CreditCardTransType) 10 Required


credit card payment. Valid TransType

values: Auth; Sale; Force; RepeatSale;


CaptureAll.

CardToken string 10 Required

Unique reference to a Payment

Method stored in DC Gateway Card

Safe.

TokenMode enum

(TokenModeType) 10 Optional

Type of Token: a numeric CCInfoKey

(DEFAULT) or a randomly generated

number in the format of the Payment

Type (CARDFORMAT).


$0.00 > Amount < $1,000,000.00

(DDDDD.CC).


RepeatSale; Force; Return; Reversal;

Optional for TransType = Void;






single invoice).




Required for TransType = Force;

Return; Reversal; Void; Capture


RepeatSale; CaptureAll.


to/from DC Gateway.

ExtData Parameters (ProcessCreditCard)

Field Name Type Max


AltMerchName string 50 Optional

Soft descriptor: name of secondary








Field Name Type Max


AltMerchAddr string 50 Optional

Soft descriptor: address of secondary





AltMerchCity string 50 Optional

Soft descriptor: city of secondary





AltMerchState string 2 Optional

Soft descriptor: state of secondary



website).

AltMerchZip string 10 Optional

Soft descriptor: ZIP Code of secondary







Authentication string 20 Optional Value to authenticate the payment.

BillPayment enum (BooleanType) 1 Optional Indicate (T) transaction accepted for

payment on Utility Bill.

BillToState string 2 Optional State abbreviation of checking

account owner’s billing address.

BypassAvsCvv enum (BooleanType) 1 Optional

Flag used to indicate if the DC

Gateway should bypass AVS and CVV

validation.

City string 50 Optional City of checking account owner’s

billing address.

Clinical_Amount string 13 Optional Subtotal for clinical services


CustCode string Optional




order number.


cardholder.

CustomFields xml CustomerFields Variable Optional User defined Custom fields for


CVNum string 4 Optional Credit card verification number.

CVPresence enum

(CVPresenceType) 1 Optional

Card verification provided for

transaction:

1 – No CV provided

2 – No CV submitted (along with key-

entered card number)

3 – CV submitted

4 – CV illegible

5 – CV not on card.




Field Name Type Max


Dental_Amount string 13 Optional Subtotal for dental services


EntryMode enum

(EntryModeType) 15 Conditional

Indicate how merchant obtained

values from credit card, as follows:

UNKNOWN; MANUAL;

MagneticStripe; ICC; PROXIMITY.

Required when MagData or

EMVData fields are populated.







processor).

IIAS_Indicator enum (BooleanType) Optional

Indication (T) received from an

Inventory Information Approval

System (IIAS) that credit card

payment for eligible medical

expense. Specific to First Data North.

Invoice string Deprecated

Items string Deprecated

Level3Amt string 18 Optional Total amount for line items in order.

LineItemDetail xml LineItemDetail Variable Conditional

XML element. Detail for 1 – 99 line

items which must be provided to

qualify transaction for Level III

interchange. See LineItemDetail

section below for definition.

Required in order to qualify for

Level III transactions.

Partial_Indicator enum (BooleanType) 1 Optional

Processor may (T) authorize partial

amount for medical expense based

on funds available.

PONum string Optional


allow payment processed (by

processor other than Global

Payments) to be traced to purchase

order number.

QHP_Amount string 13 Optional Subtotal for over-the-counter medical

items (DDDD.CC). Decimal included.





RX_Amount string 13 Optional Subtotal for prescribed medical items


SequenceCount string 5 Optional

Total number of payments to be



SequenceNum string 5 Optional

The order in which a payment was








Field Name Type Max


Street string 25 Optional House number and Street name of

cardholder’s billing address.

Target string Optional






TaxAmt string 18 Optional

Fee (added to Amount) to cover cost

of sales tax (DDDDD.CC). Required

for Level II/III transactions.







back testing (T).

TransactionID string Optional




PNRef).

Vision_Amount string 13 Optional Subtotal for vision services


Zip string 10 Optional Zip or postal code of cardholder’s

billing address.

LineItemDetail Parameters (Level III)

Each LineItemDetail record must be enclosed in a <LineItem></LineItem> data tag.

Field Name Type Max


CommodityCode string 12 Conditional

Commodity/Service classification of

item.


Description string 50 Conditional Item description.


DiscountAmount string 50 Conditional Discount applied to item.


DiscountIncluded enum (BooleanType) Conditional

Indicates if Discount is included in Line

Item Total.


LineItemTotal string 50 Conditional

Subtotal for item (Amount –

DiscountAmount + TaxAmount).


ProductCode string 50 Conditional

Product code for item assigned by

merchant.


Quantity string 18 Conditional Number of units of item in order.


TaxAmount string 50 Conditional

Total tax to apply to item (see also

TaxIncluded).





Field Name Type Max


TaxRate string 50 Conditional Tax rate applied to item.


TaxType enum (TaxType) 50 Conditional Tax table applied to item.


UnitOfMeasure enum

(UnitOfMeasureType) Conditional

Division of quantity accepted as

standard for exchange.


UnitPrice string 18 Conditional Cost of item per unit.


CustomFields Parameters

All Custom Fields elements must be enclosed in a <CustomFields></CustomFields> data tag.

Field Name Type Max


“user defined field #1” string 12 Optional Custom field defined by merchant.

“user defined fieldn” where n is

iterative string 12 Optional Custom field defined by merchant.

Returns

Hyperlink to CardSafe Process Credit Card Response structure.

Example

Hyperlink to ProcessCreditCard Request/Response example

Response (ProcessCreditCard)

The ProcessCreditCard Operation returns data in the following structure:

Field Name Type Max

Length Description

AuthorizedAmount string 18 Amount authorized by processor (when value of

Partial_Indicator extended data element = T)

Balance string 18 Balance remaining on method used to process

transaction

Result GatewayResult 10 Numeric value returned from DC Gateway to


RespMSG string 150 Message returned from DC Gateway describing




Message1 string 150 Additional detail returned from DC Gateway to


Message2 string 150 More additional detail returned from DC Gateway to


AuthCode string 20

Six-character alphanumeric authorization code

(from Issuing Bank) used during settlement or an

error message (from Payment Processor)

PNRef string 10 Unique numeric identifier generated by DC Gateway

for a processed transaction.




Field Name Type Max

Length Description

HostCode string 30 Unique identifier generated by the payment

processor for a transaction

HostURL string n/a Unused (returns empty value)

ReceiptURL string n/a Unused (returns empty value)

GetAVSResult AVSResult 10 Address verification result code (returned by

Payment Processor)

GetAVSResultTXT string 25 Address verification result message (returned by

Payment Processor)

GetStreetMatchTXT string 25 Address Verification Service evaluation of ZIP Code


GetZipMatchTXT string 25 Address Verification Service evaluation of street line


GetCVResult CVResult 1 Credit Card Verification result code (returned by

Issuing Bank)

GetCVResultTXT string 25 Credit Card Verification message (returned by

Issuing Bank)

GetGetOrigResult string n/a Unused (returns empty value)

GetCommercialCard string 5 Commercial card indicator (from the Payment

Processor) - True, False.

ExtData string Variable Structure for extended data provided to/from DC

Gateway

ExtData

Field Name Type Max

Length Description

BatchNum string 10 The identifier of the collection containing the

processed transaction

CardType string 10 Payment Type of card used to process payment

ExpDate string 4 Expiration date of card used to process payment

(MMYY)




Recurring Payment Web Service

Name

Make and Manage Recurring Payment.

Description

Manage customers, methods and contracts for recurring payments.

Operations

Name Description

AddRecurringCheck Deprecated in favor of ManageCheckInfo operation

AddRecurringCreditCard Deprecated in favor of ManageCreditCardInfo operation

ManageCheckInfo Store Checking Account in Card Safe

ManageContract Add, Update or Delete terms and interval of a Recurring Payment Agreement

ManageContractAddDaysToNextBillDt Update the NextBillDate attribute of an existing contract

ManageCreditCardInfo Store Credit Card in Card Safe

ManageCustomer Add, Update or Delete a recurring billing customer

ProcessCheck Process payment with Check method stored in Card Safe

ProcessCreditCard Process payment with Credit Card stored in Card Safe

UpdateContractSettings Reset failure and reprocessing settings for existing and future (default) contracts.

Developer Notes

Merchant must add a customer to DC Gateway before storing a payment method (for that customer) in Card

Safe.

Merchant must store a customer’s Checking Account or Credit Card to Card Safe before adding a Recurring

Payment Agreement to DC Gateway.

ManageCustomer

Description

Manage Primary Contact and Billing Address for Customer of Recurring Payment Agreement.

Developer Notes

Merchant must add a customer to DC Gateway before storing a payment method in Card Safe and adding a

Recurring Payment Agreement for that Customer.

The ManageCustomer ADD operation returns a CustomerKey element, which may be used as the

CustomerKey parameter for ManageCustomer - UPDATE Operation, ManageCustomer – DELETE Operation

and Recurring Payment Agreement.

The ManageCustomer web methods contain FirstACH processor support. See ExtData.CustomerType.

Merchant must invoke ManageCustomer – ADD operation before the primary contact and billing address

may be updated with the ManageCustomer – UPDATE operation.

Invoke the InfoCustomer Operation to retrieve existing values to reuse for the primary contact and billing

address to ensure that existing Customer data are not inadvertently overwritten with empty values by a

ManageCustomer UPDATE operation.




Merchant must invoke ManageCustomer – ADD operation before Customer may be deleted with

ManageCustomer – DELETE operation.

Required input parameters to ManageCustomer operations may be assigned empty values.

Parameters

Field Name Type Max








in DC Gateway.

TransType enum

(RecurringTransType) 6 Required

Valid TransType Values: ADD; UPDATE;

DELETE. Manage customer details in

DC Gateway.

Vendor string 10 Required Unique identifier for a merchant in DC

Gateway.

CustomerKey string 10 Conditional

Unique identifier for a customer


Required for TransType = DELETE

and UPDATE;

Not used for TransType = ADD.

CustomerID string 50 Conditional

Identifier for a customer assigned by

Merchant.

Required for TransType = ADD and

UPDATE;

Not used for TransType = DELETE.

CustomerName string 100 Conditional

Customer Name.


UPDATE;


FirstName string 50 Conditional

First Name of Primary Contact for

Customer.


UPDATE;


LastName string 50 Conditional

Last Name of Primary Contact for

Customer.


UPDATE;


Title string 50 Optional

Title of Primary Contact for Customer.

Optional for TransType = ADD and

UPDATE;


Department string 50 Optional

Department Name in Address of

Primary Contact for Customer.


UPDATE;





Field Name Type Max


Street1 string 50 Conditional

House number and street name for

postal address.

Required for processor of First ACH

and TransType = ADD and UPDATE;


Street2 string 50 Optional

Second line of postal address.


UPDATE;



Third line of postal address.


UPDATE;


City string 50 Conditional

City of postal address.




StateID string 2 Conditional

USPS abbreviation for state, province,

district or possession.




Province string 50 Optional

Canadian Province.


UPDATE;


Zip string 10 Conditional

ZIP/Postal code of postal address.




CountryID string 3 Optional

Country code (USA, CAN) of postal

address.


UPDATE;


Email string 100 Optional

Electronic mail address of Primary

Contact for Customer.


UPDATE;


DayPhone string 25 Conditional

Phone number (daytime) of Primary




Not used for TransType = DELETE

(###-###-####).

NightPhone string 25 Optional

Phone number (night time) of Primary



UPDATE;





Field Name Type Max


Fax string 25 Optional

Facsimile phone number of Primary



UPDATE;


Mobile string 25 Optional

Mobile phone number of Primary



UPDATE;


Status enum (StatusType) 8 Optional

Customer must be assigned ACTIVE or

INACTIVE status to be visible in DC

Gateway Virtual Terminal user

interface. Defaults to ACTIVE.


UPDATE;




to/from Recurring Payment Web

Service. Required for First ACH;

CustomerType of customer for

method (CK – Check). Used only for

FirstACH processor. Will enable,

create and sync customer profile

between Gateway and FirstACH host.

ExtData Parameters (ManageCustomer)

Field Name Type Max


CustomerType enum (PaymentType) 2 Conditional

Required for First ACH; Used only for

FirstACH processor with value = “CK”.

Will enable, create and sync customer

profile between Gateway and FirstACH

host.

Returns

Hyperlink to Recurring Web Service Response structure.

Example

Hyperlink to ManageCustomer Request/Response examples.

ManageCheckInfo

Description

Manage secured Check information that is stored in Card Safe.

Developer Notes


Card Safe.

Merchant must store a customer’s Checking Account in Card Safe before adding a Recurring Payment

Agreement to DC Gateway.




The ManageCheckInfo ADD operation returns a CheckInfoKey element, which may be used as the

PaymentInfoKey for a Recurring Payment Agreement.

Invoke the InfoCustomer operation to retrieve CheckInfo from the collection of Payment Methods, which

have been saved for a Customer in DC Gateway.


Direct Connect provides checking account and routing numbers for use during development and testing.

The ManageCheckInfo web methods contain FirstACH processor support. A successful ManageCustomer

ADD operation is required first.

Invoke the InfoCustomer operation to retrieve existing values for the elements of a Payment Method to

ensure that existing data are not overwritten with empty values by a ManageCheckInfo UPDATE operation.

Merchant must store a customer’s Checking Account in Card Safe before it can be updated or deleted.

Include the value of CheckInfoKey in the response received from a ManageCheckInfo - ADD operation as the

CheckInfoKey parameter to ManageCheckInfo - DELETE operation.

Parameters

Field Name Type Max








in DC Gateway.

TransType enum



DELETE. Manage Check processing

details including Checking Account to

Card Safe.


Gateway.

CustomerKey string 10 Required Unique identifier for existing customer

(in DC Gateway).

CheckInfoKey string 10 Conditional

Unique Identifier assigned to a

Checking Account (by DC Gateway).

Required for TransType = UPDATE

and DELETE;


CheckType enum (CheckType) 10 Conditional

Checking Account Type (PERSONAL,

BUSINESS). Required for TransType =

ADD and UPDATE;

Not required for TransType = DELETE.

AccountType enum

(CheckAcctType) 10 Conditional

Account type (CHECKING, SAVINGS).


UPDATE;


CheckNum string 10 Optional Unique identifier for an original check

(on a Checking Account).

MICR string 250 Optional


data line, including routing number of

Bank, checking account number of

customer and check number.




Field Name Type Max


AccountNum string 20 Conditional

Unique identifier of the check owner's

bank account.


UPDATE;


TransitNum string 9 Conditional

A Nine-digit code, used in the United

States to identify the financial

institution on which a check is drawn.


UPDATE;


RawMICR string 250 Optional


received from a check reader:

composed of a transit number

(TransitNum), the letter 'T', an account

number (AccountNum), the letter 'O'

and a check number (CheckNum).

SS string 11 Optional

Nine-digit number issued by the US

Social Security Administration to the

checking account owner.

DOB string 10 Optional Date of Birth of checking account

owner.

BranchCity string 50 Optional City of the checking account bank

branch.

DL string 250 Optional Unique identifier of Driver's License of

Checking account owner.

StateCode string 2 Optional



possession or territory of checking

account owner's billing address.

NameOnCheck string 25 Optional Check account owner's name as it

appears on the check.

Email string 100 Optional Electronic Mail Address of checking

account owner.

DayPhone string 25 Optional Daytime Phone Number of checking

account owner.


House number and Street name of

checking account owner's billing

address.

Street2 string 50 Optional Second line of checking account

owner's billing address.

Street3 string 50 Optional Third line of checking account owner's

billing address.

City string 50 Optional City of the checking account owner's

billing address.

StateID string 2 Optional




Province string 50 Optional

Canadian Province (if applicable) of


address.

PostalCode string 10 Optional ZIP/Postal code of checking account

owner's billing address.




Field Name Type Max


CountryID string 3 Optional

Code (USA, CAN) for country of


address.




Service.


UPDATE;


ExtData (ManageCheckInfo)

Field Name Type Max


SECCType enum (SECCType) 3 Conditional Required for FirstACH processor.

One of: CCD, PPD, ARC, RCK, TEL, WEB

AuthOptionForm enum

(AuthOptionFormType) 25 Conditional

Signed Form authorization option.

Required for SECCType = CCD; PPD.

AuthOptionVoice enum

(AuthOptionVoiceType) 25 Conditional

Recorded Voice authorization option.

Required for SECCType = TEL.

Returns


Example

Hyperlink to ManageCheckInfo Request/Response examples.

ManageCreditCardInfo

Description

Manage secured Credit Card information that is stored in Card Safe.

Developer Notes


Card Safe.

Merchant must store a customer’s Credit Card in Card Safe before adding a Recurring Payment Agreement

to DC Gateway.

The ManageCreditCardInfo ADD operation returns a CCInfoKey element, which may be used as the

PaymentInfoKey for a Recurring Payment Agreement.

Invoke the InfoCustomer operation to retrieve CreditCardInfo from the collection of Payment Methods,

which have been saved for a Customer in DC Gateway.


Direct Connect provides credit card numbers for use during development and testing.

Merchant must store a customer’s Credit Card in Card Safe before it can be updated or deleted.

Use the CCInfoKey element returned by the ManageCreditCardInfo ADD operation as the value of the

CardInfoInfoKey parameter for the ManageCreditCardInfo UPDATE or DELETE operations.




Parameters

Field Name Type Max








in DC Gateway.

TransType enum



DELETE. Manage customer creditcard

processing details in DC Gateway.


Gateway

CustomerKey string 10 Required Unique identifier for existing customer

(in DC Gateway).

CardInfoKey string 10 Conditional

Unique Identifier assigned to a Credit

Card Account (by DC Gateway).

Required for TransType = UPDATE

and DELETE;


CcAccountNum string 19 Conditional

The Primary Acccount Number (PAN)




UPDATE;


CcExpDate string 4 Conditional

Credit card date of expiration (MMYY).


UPDATE;


CcNameOnCard string 25 Optional Name of cardholder (as it appears on

card).

CcStreet string 25 Optional House number and street of


CcZip string 10 Optional ZIP Code of cardholder's billing

address.


There are currently no Extended Data

parameters for the

ManageCreditCardInfo operation.

Returns


Example

Hyperlink to ManageCreditCardInfo Request/Response examples.

UpdateContractSettings

Description

Reset failure and reprocessing settings for existing and future (default) contracts.




Developer Notes

The UpdateContractSettings operation is a function of DC Gateway supported by all processors.

Parameters

Field Name Type Max








in DC Gateway.

Vendor string 10 Required Unique identifier for a Merchant in DC

Gateway.

MaxFailures string 2 Optional

Maximum number (0-10) of attempts

for DC Gateway to reprocess failed

payments.

FailureInterval string 2 Optional

Number (1-28) of days between

reprocessing attempts (after an

unsuccessful payment).




Service.

ExtData Parameters (UpdateContractSettings)

The Extended Data structure of Request message for UpdateContractSettings operation includes a Contract

element enclosed in a Configuration tag.

Field Name Type Max


FailureRetryResultCode xml

FailureRetryResultCode

Variable Optional

Collection of result code values from

unsuccessful payment attempts for

DC Gateway to reprocess

automatically.

MaxBillingCycleRetry string 2 Optional

The number of times a suspended

contract will be reconsidered for

activation by DC Gateway.

RecurringBillingSettings xml

RecurringBillingSettings Variable Optional

DC Gateway uses system setting

(TRUE) for MaxFailures rather than

value provided by Merchant (FALSE)

for Contract.

FailureRetryResultCode Parameters

Field Name Type Max


RC (iterative) string 2 Optional




automatically.




RecurringBillingSettings Parameters

Field Name Type Max


ForceMaxFailure enum



(TRUE) for MaxFailures rather than


for Contract.

ForceFailureInterval enum



(TRUE) for FailureInterval rather than


for Contract.

ForceFailureRetryResultCode enum



(TRUE) for FailureResultCodes rather

than values provided by Merchant

(FALSE) for Contract.

ForceMaxBillingCycleRetry enum



(TRUE) for MaxBillingCycleRetry

rather than value provided by

Merchant (FALSE) for Contract.

Returns


Example

Hyperlink to UpdateContractSettings Request/Response example.

ManageContract

Description

Manage a Recurring Payment Agreement for a Customer with a Payment Method from Card Safe.

Developer Notes

Merchant must save a customer (using ManageCustomer operation) and payment method (with

ManageCheckInfo or ManageCreditCardInfo) before adding a Recurring Payment Agreement to DC

Gateway._ManageCustomer_ManageCheckInfo_-_ADD_ManageCreditCardInfo

DC Gateway requires a valid electronic mail address for a Merchant or Customer to send an electronic mail

notification (to that Merchant or Customer) when the value of EmailCustomer, EmailCustomerFailure,

EmailMerchant or EmailMerchantFailure is ‘T’.

DC Gateway resets the status of a Recurring Payment Agreement to PENDING when an attempted payment

is unsuccessful.

DC Gateway resets the status of a Recurring Payment Agreement to ACTIVE when a payment is reprocessed

successfully after one or more failed attempts.

DC Gateway resets the status of a Recurring Payment Agreement to INACTIVE when the number of failed

attempts to process a payment exceeds the value of the MaxFailures element (of the Recurring Payment

Agreement.)

Merchant must add a Recurring Payment Agreement (with ManageContract ADD operation or from DC

Gateway Virtual Terminal) before it can be updated or deleted._ManageContract_-_ADD

Invoke the InfoContract operation to retrieve existing values for the elements of a Recurring Payment

Agreement, which are required parameters of a ManageContract UPDATE operation._InfoContract




Invoke the ManageContractAddDaysToNextBillDt operation (rather than ManageContract UPDATE

operation) when NextBillDt is the only element of a Recurring Payment Agreement to be updated.

Note that the minimum BillingPeriod for FirstACH is WEEK._ManageContractAddDaysToNextBillDt

DC Gateway determines the frequency with which payments are processed based on the values of BillingPeriod and

PeriodInterval for a Recurring Payment Agreement, as follows:

Billing Period Billing Interval Process Payment

DAY 1 Daily

WEEK 1 Weekly

DAY 14 Every Other Wekk

DAY 21 Every Three Weeks

MONTH 1 Monthly

YEAR 4 Quarterly

YEAR 2 Twice Per Year

YEAR 1 Annually

Parameters

Field Name Type Max








in DC Gateway.

TransType enum



DELETE. Manage customer contract

details in DC Gateway.


Gateway.

CustomerKey string 10 Required Unique identifier for Customer


ContractKey string 10 Conditional

Unique identifier assigned to a

Recurring Payment Agreement

created by DC Gateway.

Required for TransType= UPDATE

and DELETE;


PaymentInfoKey string 10 Conditional


Checking Account or Credit Card

payment method (by DC Gateway).

Required for TransType= ADD and

UPDATE;

Not used for TransType =DELETE.

PaymentType enum (PaymentType) 2 Conditional

Type of payment for method (CC -

Credit Card, CK - Check).


UPDATE;

Not used for TransType =DELETE.

CustomerID string Deprecated If field is populated with a value, the

value will be ignored.

CustomerName string Deprecated If field is populated with a value, the





Field Name Type Max


FirstName string Deprecated If field is populated with a value, the


LastName string Deprecated If field is populated with a value, the


Title string Deprecated If field is populated with a value, the


Department string Deprecated If field is populated with a value, the


Street1 string Deprecated If field is populated with a value, the






City string Deprecated If field is populated with a value, the


StateID string Deprecated If field is populated with a value, the


Province string Deprecated If field is populated with a value, the


Zip string Deprecated If field is populated with a value, the


CountryID string Deprecated If field is populated with a value, the


Email string Deprecated If field is populated with a value, the


DayPhone string Deprecated If field is populated with a value, the


NightPhone string Deprecated If field is populated with a value, the


Fax string Deprecated If field is populated with a value, the


Mobile string Deprecated If field is populated with a value, the


ContractID string 50 Conditional

Unique identifier assigned by

Merchant to the Recurring Payment

Agreement between Merchant and

Customer.


UPDATE;


ContractName string 100 Optional Description for Recurring Payment

Agreement

BillAmt string 18 Conditional

Sales amount for each recurring

payment.


UPDATE;


TaxAmt string 18 Optional Tax amount (for each payment)




Field Name Type Max


TotalAmt string 18 Conditional

Total (Sales + Tax) amount (for each

payment).


UPDATE;


StartDate string 10 Conditional

Date of first payment (MM/DD/YYYY).


UPDATE;

Optional for TransType = DELETE.

EndDate string 10 Optional

Date of termination for Recurring

Payment Agreement (MM/DD/YYYY).


UPDATE;


NextBillDt string 10 Conditional

Date of first payment (MM/DD/YYYY).


UPDATE;


BillingPeriod enum

(BillingPeriodType) 5 Conditional

Unit (DAY, WEEK, MONTH, YEAR) for

billing time period.


UPDATE;


Note that the minimum

BillingPeriod for FirstACH is WEEK.

BillingInterval string 2 Conditional

Number of periods (1, 2, 4, 14, 21, 28)

between payments - used in

combination with BillingPeriod.


UPDATE;


MaxFailures string 2 Optional

Maximum number (0-10) of attempts

for DC Gateway to reprocess failed

payments. The value of MaxFailures

treated as zero if no value is provided

for Recurring Payment Agreement.

FailureInterval string 2 Optional

Indicates the interval (1-28) after

which the failed payment will be

retied. The value of FailureInterval

treated as one if no value is provided

for Recurring Payment Agreement.

EmailCustomer enum


Send (TRUE) electronic mail message

to Customer when an attempted

payment is successful.

EmailMerchant enum



to Merchant when an attempted

payment is successful.

EmailCustomerFailure enum



to Merchant when an attempted

payment is unsuccessful.

EmailMerchantFailure enum


Send (True) electronic mail message to

Merchant when an attempted

payment is unsuccessful.




Field Name Type Max


Status enum (StatusType) 10 Optional

DC Gateway to evaluate Recurring

Payment Agreement each day to

determine whether (ACTIVE) or not

(INACTIVE, CLOSED) a payment to be

processed or reprocessed (PENDING).




Service.

ExtData (ManageContract)

The Extended Data structure of Request message for ManageContract operation includes a Configuration

element enclosed in a Contract tag.

Field Name Type Max


FailureRetryResultCode xml

FailureRetryResultCode

Variable Optional




automatically.

MaxBillingCycleRetry string 2 Optional

The number of times a suspended

contract will be reconsidered for

activation by DC Gateway.

CloneTokens enum


Use this tag with value of TRUE only

when Token Sharing is enabled for

the reseller and the Merchant wants

to clone the customer and payment

information to create the contract.

FailureRetryResultCode Parameters

Field Name Type Max


RC (iterative) string 2 Optional




automatically.

Returns


Example

Hyperlink to ManageContract Request/Response examples.

ManageContractAddDaysToNextBillDt

Description

Update the NextBillDate element of a Recurring Payment Agreement.




Developer Notes

Merchant must add a Recurring Payment Agreement (with the ManageContract ADD operation or from DC

Gateway Virtual Terminal) before its next bill date may be changed._ManageContract_-_ADD

Invoke the ManageContractAddDaysToNextBillDt operation (rather than ManageContract UPDATE operation)

when NextBillDt is the only element of a Recurring Payment Agreement to be updated.

Invoke the ManageContract UPDATE (rather than the ManageContractAddDaysToNextBillDt operation) when

one or more elements (other or in addition to NextBillDt) of a Recurring Payment Agreement are to be

updated._ManageContract_–_UPDATE

Parameters

Field Name Type Max








in DC Gateway.


Gateway.


Gateway).

ContractKey string 10 Required

Unique identifier assigned to a

Recurring Payment Agreement

created by DC Gateway.

NumOfDays string 7 Required The number of days (greater than 0) to

be added to the NextBillDt field.


There are currently no Extended Data

parameters for the


operation.

Returns


Example

Hyperlink to ManageContractAddDaysToNextBillDt Request/Response example.

ProcessCheck

Description

Make a sale with check drawn from Checking Account stored in Card Safe.

Developer Notes

The ProcessCreditCard operation of Recurring Payment Web Service is similar to the ProcessCheck - Sale

operation of the Transaction Processing Web Service.

Merchant must add a Customer and Checking Account to Card Safe before invoking ProcessCheck operation

of Recurring Payment Web Service

The ProcessCheck operation contains FirstACH processor support. Successful ManageCustomer and

ManageCheckInfo ADD operations are required first.




Parameters

Field Name Type Max








in DC Gateway.


Gateway.

CheckInfoKey string 10 Required


Checking Account by

ManageCheckInfo ADD operation.

Amount string 18 Required $0.00 > Amount < $25,000.00

(DDDDD.CC).





single invoice).




Service. Required for FirstACH

processor for first time external

recurring payment.

ExtData (ProcessCheck)

Field Name Type Max






processor).

Frequency enum

(BillingFrequencyType) 15 Conditional

Required for FirstACH processor for

first time external recurring

payment.

One of: Once, Weekly, Biweekly,

Monthly, Quarterly, Semiannually,

Annually.

NumberOfPayments string 4 Conditional


first time external recurring

payment.

1‐9998; Use 9999 for Open‐Ended

Recurring Customer Payments.

RecurringID string 10 Conditional


external recurring payment.

RecurringID of the existing recurring

Payment Series. Received in

ProcessCheck response.




Field Name Type Max


EffecDate string 10 Conditional



Date of the next Customer Payment in

the recurring. Recurring payments

beyond the next chronologically in the

series may not be created in advance.

Payment series: YYYY-MM-DD.

TransType string 4 Conditional



VOID – Void an entire external

recurring payment series.

Returns


Example

Hyperlink to ProcessCheck Request/Response example.

ProcessCreditCard

Description

Process charge with Credit Card.

Developer Notes


(NOVA Information System), First Data Nashville, First Data North, First Data Omaha, First Data Rapid Connect,

Global Payments, Heartland Payment Systems, Paymentech - Tampa, TSYS Host, TSYS Terminal (Vital).

The ProcessCreditCard operation of Recurring Payment Web Service is similar to the ProcessCreditCard –

RepeatSale operation of the Card Safe Web Service._ProcessCreditCard_-_RepeatSale

Merchant must add a Customer and Credit Card to Card Safe before invoking ProcessCreditCard operation of

Recurring Payment Web Service.

For Recurring transactions, AVS and CVV responses are not validated against the fraud filters (if

enabled)._Front_End_Processors_Front_End_Processors

Parameters

Field Name Type Max








in DC Gateway.


Gateway.

CCInfoKey string 10 Required

Unique reference to a Payment

Method stored in DC Gateway Card

Safe.


(DDDDD.CC).




Field Name Type Max






single invoice).




Service.

ExtData (ProcessCreditCard)

Field Name Type Max


CVNum string 4 Optional Credit card verification number.





processor).

Street string 25 Optional House number and Street name of a



billing address.

Returns


Example

Hyperlink to ProcessCreditCard Request/Response example.

AddRecurringCheck

Description

Deprecated in favor of ManageCheckInfo operation._ManageCheckInfo

AddRecurringCreditCard

Description

Deprecated in favor of ManageCreditCardInfo operation_ManageCreditCardInfo

Response (Recurring Web Service)

Field Name Type Max

Length Description

CustomerKey string 10 Unique identifier for a customer assigned by DC

Gateway.

ContractKey string 10 Unique identifier assigned to a Recurring Payment

Agreement created by DC Gateway.

CcInfoKey string 10 Unique Identifier assigned to a Credit Card Account

(by DC Gateway).

CheckInfoKey string 10 Unique Identifier assigned to a Checking Account

(by DC Gateway).





Field Name Type Max

Length Description






Result GatewayResult 10

Numeric value returned from DC Gateway to


AuthCode string 20 Authorization code (from Issuing Bank) used during

settlement or an error message (from Payment

Processor)

PNRef string 10 Unique identifier for a transaction assigned by DC

Gateway



ExtData xml ExtData Variable There are currently no Extended Data parameters

received from operations of the Recurring Payment

Web Service.




Transaction Reporting Web Service

Name

Generate Detail or Summary Transaction Report.

Description

Query transactions processed by DC Gateway for Merchant.

Operations

Name Description

GetCardTrx Query DC Gateway for a list of processed card transactions (single settlement date)

GetCardTrx2 Query gateway for a list of processed card transactions (range of settlement dates)

GetCardTrxSummary Query DC Gateway for a summary of processed card transactions

GetCheckTrx Query DC Gateway for a list of processed check transactions

GetOpenBatchSummary Query DC Gateway for a summary of card and check transactions in the current (unsettled)

batch

Developer Notes

Beginning and Ending dates must be formatted as follows: MM/DD/YYYY, YYYY-MM-DD or YYYY-MM-

DDThh:mm:ss where MM – Month (1-12), YYYY – Year, DD – Date (01-31), h – hour (0-23), m – minute (0-59)

and s – second (0-59): 2016-05-10T17:00:01

GetCardTrx

Description

Query DC Gateway for a list of processed card transactions (single settlement date).

Parameters

Field Name Type Max








in DC Gateway.

RPNum string 10 Required

Unique identifier for a Merchant in DC

Gateway - required to ensure

uniqueness of each User Name in DC

Gateway.

PNRef string 10 Optional Unique identifier for a transaction


BeginDt string 19 Required Date on or after transaction settled.

EndDt string 19 Required Date before transactions settled.

PaymentType enum

(PaymentCardType) Variable Optional

Type(s) of payment to be included in

list of processed transactions (comma-

separated list of single-quoted strings).




Field Name Type Max


ExcludePaymentType enum


Type(s) of Payment to exclude from list

of settled transactions (comma-


TransType enum

(ReportingTransType) Variable Optional

Transaction Type(s) to include from list



ExcludeTransType enum


Transaction Type(s) to exclude from

list of settled transactions (comma-


ApprovalCode string 20 Optional

Six-character alphanumeric

authorization code (from Issuing Bank)

used during settlement or an error

message (from Payment Processor).

Result GatewayResult 10 Optional Result Code (returned from DC

Gateway).

ExcludeResult GatewayResult Variable Optional

Result(s) to exclude from list of settled

transactions (comma-separated list of

integer values).


the card.

CardNum string 19 Optional




CardType N/A Deprecated in favor of PaymentType.

ExcludeCardType N/A Deprecated in favor of

ExcludePaymentType.

ExcludeVoid enum

(BooleanVerboseType) 5 Required

Exclude (TRUE) Voided transactions

from list of settled transactions.

User string 25 Optional DC Gateway User Name with which list

of transactions were processed.

invoiceId string 20 Optional The invoice ID that was included in the

original transaction.

SettleFlag string 1 Optional Include settled (1) or unsettled (0)

transactions in list of transactions.

SettleMsg string 25 Optional The settlement ID or message

returned from the host.

SettleDt string 19 Optional The date of settlement.

TransformType enum

(TransformType) 5 Optional

Format for list of transactions (XML -

Raw XML, XSL - Transformed XML,

DELIM - values enclosed by ColDelim

and records separated by RowDelim).

Xsl string Variable Conditional

XML Style Sheet (or URL reference).

Required when TransformType =

XSL.

ColDelim string 1 Conditional

Column Delimiter.

Required if TransformType = DELIM.

Character used to separate column

values (in a text file).

RowDelim string 1 Conditional

Row Delimiter.


This defines the string that separates

each row.




Field Name Type Max


IncludeHeader enum


Include (TRUE) field headings as first

row of delimited output.




Service.

Returns

The GetCardTrx operation returns a GetCardTrxResult element containing a collection of TrxDetailCard enclosed

in a RichDBDS tag.

Hyperlink to TrxDetailCard Response structure.

Example

Hyperlink to GetCardTrx Request/Response example.

GetCardTrx2

Description

Query DC Gateway for a list of processed card transactions (range of settlement dates).

Parameters

Field Name Type Max








in DC Gateway.





Gateway.





PaymentType enum










TransType enum













Field Name Type Max








Gateway).




integer values).


the card.





CardType N/A Deprecated in favor of PaymentType.

ExcludeCardType N/A Deprecated in favor of

ExcludePaymentType.

ExcludeVoid enum












BeginSettleDt string 19 Optional Beginning of settlement date range.

EndSettleDt string 19 Optional End of settlement date range.

TransformType enum









XSL.


Column Delimiter.





Row Delimiter.



each row.

IncludeHeader enum







Service.




Returns

The GetCardTrx operation returns a GetCardTrxResult element containing a collection of TrxDetailCard enclosed

in a RichDBDS tag.


Example

Hyperlink to GetCardTrx2 Request/Response example.

GetCardTrxSummary

Description

Query DC Gateway for a summary of processed card transactions.

Parameters

Field Name Type Max








in DC Gateway.





Gateway.








Register string 10 Optional

Unique identier for the register,

terminal or computer on which the

transaction was processed.


the card.





CardType enum

(PaymentCardType) 10 Optional




ExcludeVoid enum














Field Name Type Max


TransformType enum









XSL.


Column Delimiter.





Row Delimiter.



each row.

IncludeHeader enum







Service.

Returns

The GetCardTrxSummary operation returns a GetCardTrxSummaryResponse element containing a collection of

PaymentMethod enclosed in a GetCardTrxSummaryResult tag.

Hyperlink to PaymentMethod Response structure.

Example

Hyperlink to GetCardTrxSummary Request/Response example.

GetCheckTrx

Description

Query DC Gateway for a list of processed check transactions.

Parameters

Field Name Type Max








in DC Gateway.





Gateway.







Field Name Type Max



PaymentType enum

(PaymentCheckType) Variable Optional





PaymentCheckType) Variable Optional




TransType enum
















Gateway).




integer values).

NameOnCheck string 25 Optional Cardholder's name as it appears on

the card.

CheckNum string 10 Optional Unique identifier of Check written or

drafted on Checking account.

AcctNum string 20 Optional Unique identifier of checking account.

RouteNum string 9 Optional Unique identifier for Institution

holding checking account.

ExcludeVoid enum













TransformType enum





and records separated by RowDelim)

Xsl String Variable Conditional



XSL.


Column Delimiter.







Field Name Type Max



Row Delimiter.



each row.

IncludeHeader enum







Service.

Returns

The GetCheckTrx operation returns a GetCheckTrxResult element containing a collection of TrxDetailCard

enclosed in a RichDBDS tag.


Example

Hyperlink to GetCheckTrx Request/Response example.

GetOpenBatchSummary

Description

Query DC Gateway for a summary of card and check transactions in the current (unsettled) batch.

Parameters

Field Name Type Max








in DC Gateway.





Gateway.

BeginDt string 19 Optional Date on or after transaction settled.

EndDt string 19 Optional Date before transactions settled.




Service.

Returns

The GetOpenBatchSummary operation returns a GetOpenBatchSummaryResponse element containing a

collection of PaymentMethod (Table tag) enclosed in GetOpenBatchSummaryResult and OpenBatchSummary

tags.

Hyperlink to PaymentMethod Response structure.




Example

Hyperlink to GetOpenBatchSummary Request/Response example.

ExtData Parameters (GetCardTrx; GetCardTrx2; GetCheckTrx)

Field Name Type Max


Image_Type enum (ImageType) 25 Optional Image type attached to a transaction

for reporting purposes.

CustomerID string 50 Optional Identifier assigned to a Customer by a

Merchant.

Amount string 18 Optional Transaction Amount (DDDDD.CC

format).


Unique identifier for the register,

terminal or computer on which

transactions were processed.

Timezone enum (Timezone) 5 Optional Abbreviated timezone.

ExtData Parameters (GetCardTrxSummary; GetOpenBatchSummary)

Field Name Type Max


Timezone enum (Timezone) 5 Optional Abbreviated timezone.

TrxDetailCard (Transaction Reporting Web Service)

Field Name Type Max

Length Description

Account_Type_CH enum

(PaymentTypeIDType) 10

Brand of card used to process transaction.

AccountNum_VC string 20 Checking account number used to process

transaction.

Acct_Num_CH string 19 Card number used to process transaction.

Amount_MN string 18 Check amount.

Approval_Code_CH string 20 Result code returned from the payment processor.

Auth_Amt_MN string 18 Authorized amount for a card transaction.

Authorization string 18 Sum of amounts for pre-authorized transactions.

Authorization_Cnt string 10 Count of pre-authorized transactions.

AVS_Resp_CH AVSResult 1 Response code returned from Address Verification

Service for card used to process transaction.

AVS_Resp_Txt_VC string 25 Response text returned from Address Verification

Service for card used to process transaction.

Batch_Number string 255 Batch number for a transaction (returned by the

payment processor).

Capture string 18 Sum of amounts for captured transactions.

Capture_Cnt string 10 Count of captured transactions.

Card_Info_Key string 10 Unique identifier assigned by DC Gateway to card

used to process transaction.

Cash_Back_Amt_MN string 18 Amount of cash returned for a debit or EBT card

transaction.

CheckNum_CH string 10 Number of check used to process transaction.

Cnt string 10 Count of all transactions (in current batch).

CustomerID string 50 Identifier assigned to a Customer by a Merchant.

CV_Resp_CH CVResult 1 Response code returned by Card Validation (from

payment processor).




Field Name Type Max

Length Description

CV_Resp_Txt_VC string 25 Response text returned by Card Validation (from

payment processor).

Date_DT string 19 Date and time on which transaction processed by

DC Gateway.

ERROR string Variable Message from DC Gateway describing the result of a


Exp_CH string 4 Card expiration date.

ForceCapture string 18 Sum of amounts for transactions captured in batch

that were not processed by DC Gateway.

ForceCapture_Cnt string 10 Count of transactions captured in batch that were

not processed by DC Gateway.

Host_Date_CH string 19 Date on which transaction processed by payment

processor.

Host_Ref_Num_CH string 255 Unique identifier for transaction (assigned by

payment processor).

Host_Time_CH string 255 Time at which transaction processed by payment

processor.

Invoice_ID string 255 Reference to the invoice associated by Merchant

with a processed transaction.

IP_VC string 16 IP address of originator for transaction processing

request.

Last_Update_DT string 19 Date and time on which record of transaction most

recently updated.

Manual enum

BooleanVerboseType 5

Indicator that card information entered by an

operator.

Merchant_Key string 10 Unique identifier for a Merchant.

Name_on_Card_VC string 25 Name of cardholder.

NameOnCheck_VC string 25 Name on check.

Orig_TRX_HD_Key string 10 Identifier of original transaction (with which

transaction is associated).

Payment_Type_ID string 255 Payment Type.

PostAuth string 18 Sum of amounts for transactions authorized and

forced into batch by DC Gateway.

PostAuth_Cnt string 10 Count of transactions authorized and forced by DC

Gateway into batch.

Processor_ID enum

ProcessorIDType 10

Identifier used by DC Gateway to reference

payment processor.

Receipt string 18 Sum of amounts for transactions with receipts.

Receipt_Cnt string 10 Count of transactions with receipts.

Ref_Number_CH string n/a Unused.

Register_Number_CH string 10 Register number for a processed transaction.

RepeatSale string 18 Sum of amounts for repeat sale transactions.

RepeatSale_Cnt string 10 Count of repeat sale transactions.

Reseller_Key string 10 Unique identifier for Direct Connect reseller.

Result_CH string 1 Result code returned by DC Gateway for processed

transaction.

Result_Msg_VC string 150 Result message returned by DC Gateway for check

transaction.

Result_Msg1_VC string 150 Additional text from message returned by DC

Gateway for check transaction.

Result_Msg2_VC string 150 More additional text from message returned by DC

Gateway for check transaction.




Field Name Type Max

Length Description

Result_Txt_VC string 255 Text of message describing result (approval or

decline) for processed transaction.

Return string 18 Sum of amounts for return transactions.

Return_Cnt string 10 Count of return transactions.

Sale string 18 Sum of amounts for sale transactions.

Sale_Cnt string 10 Count of sale transactions.

Settle_Date_DT string 19 Date of transaction settlement.

Settle_Flag_CH string 255 Transaction settlement indicator.

StateCode_CH string 2 State abbreviation for card with which transaction

processed.

Street_CH string 25 Billing street address for credit card.

SureCharge_Amt_MN string 18 Surcharge amount for a processed transaction.

Tip_Amt_MN string 18 Tip amount for a processed transaction.

Trans_Type_ID string 15 Transaction Type.

Transport_Method string 255 Web service transport method.

Transport_EndPoint string 255 Web service endpoint.

TransitNum_VC string 9 Transit code for bank holding checking account.

TRX_Card_Key string 10 Unique identifier assigned by DC Gateway to card

used to process transaction.

TRX_Check_Key string 10 Unique identifier assigned by DC Gateway for

checking account used to process transaction.

TRX_HD_Key string 10 Unique identifier for the header record of a

transaction in DC Gateway database.

TRX_Settle_Key string 10 Unique identifier for the settlement record of a

transaction in DC Gateway database.

TRX_Settle_Msg_VC string 255 Settlement message for a processed transaction.

Type_CH string 10 Card Type.

User_Name_VC string 25 DC Gateway User Name used when transaction

processed.

Void_Flag_CH string 255 Void transaction indicator.

Zip_CH string 10 Billing ZIP Code for card.

PaymentMethod (Transaction Reporting Web Service)

Field Name Type Max

Length Description

Activate string 18 Sum of amounts for activation transactions.

Activate_Cnt string 10 Count of activation transactions.

Authorization string 18 Sum of amounts for pre-authorized transactions.

Authorization_Cnt string 10 Count of pre-authorized transactions.

Capture string 18 Sum of amounts for captured transactions.

Capture_Cnt string 10 Count of captured transactions.

Cnt string 10 Count of all transactions (in current batch).

Deactivate string 18 Sum of amounts for deactivation transactions.

Deactivate_Cnt string 10 Count of deactivation transactions.

ForceCapture string 18 Sum of amounts for transactions captured in batch

that were not processed by DC Gateway.

ForceCapture_Cnt string 10 Count of transactions captured in batch that were

not processed by DC Gateway.

PostAuth string 18 Sum of amounts for transactions authorized and

forced into batch by DC Gateway.

PostAuth_Cnt string 10 Count of transactions authorized and forced by DC

Gateway into batch.




Field Name Type Max

Length Description

Payment_Type_ID enum

ProcessorIDType

Identifier used by DC Gateway to reference

payment processor.

Receipt string 18 Sum of amounts for transactions with receipts.

Receipt_Cnt string 10 Count of transactions with receipts.

Reload string 18 Sum of amounts for reload transactions.

Reload_Cnt string 10 Count of reload transactions.

RepeatSale string 18 Sum of amounts for repeat sale transactions.

RepeatSale_Cnt string 10 Count of repeat sale transactions.

Return string 18 Sum of amounts for return transactions.

Return_Cnt string 10 Count of return transactions.

Sale string 18 Sum of amounts for sale transactions.

Sale_Cnt string 10 Count of sale transactions.




Custom Fields Web Service

Name

Manage Custom Transaction Field.

Description

Add custom field to store a value with each processed transaction.

Operations

Name Description

AddCustomField Create a custom field in which to store a value for each processed transaction

GetCustomFields Retrieve information for custom fields defined for Merchant in DC Gateway.

Developer Notes

The values of custom fields are stored and retrieved to/from DC Gateway in a CustomFields collection of the

Extended Data structure for operations, such as ProcessCreditCard and GetCardTrx, of Transaction

Processing, Recurring Payment, Transaction Reporting and Card Safe web services.

AddCustomField

Description

Create a custom field in which to store a value for each processed transaction.

Parameters

Field Name Type Max







Password string 20 Required Password for the user name

assigned in DC Gateway.


Unique identifier for a Merchant in

DC Gateway - required to ensure

uniqueness of each User Name in

DC Gateway.

FieldName string 50 Required Name of custom field (to be

created).

IsNumeric enum

(BooleanVerboseCLType) 5 Required

Custom field will (true) contain only

numeric values.

DecimalPlaces string 10 Required

The number of digits of decimal

precision to be preserved for values

of Custom Field.

MaxLength string 10 Required Maximum string length allowed in

custom field.

RegEx string Variable Required

Regular expression to use for

validation of values submitted for

custom fields.




Field Name Type Max


IsRequired enum


A value for Custom Field is (true)

required for a transaction to be

processed.

Description string 50 Required

Label of Custom Field to appear in

Virtual Terminal and on Transaction

Receipt.

MinValue string 10 Optional Minimum value for a custom,

numeric field.

MaxValue string 10 Optional Maximum value for a custom,

numeric field.

DisplayOnReceipt enum


Indicates whether (true) or not

(false) the field will display on the

cardholder receipt

ErrorMessage string 50 Optional

Message for DC Gateway to display

when invalid value provided for a

custom field.

Example

Hyperlink to AddCustomField Request/Response example

Response (AddCustomField)

Field Name Type Max

Length Description


RespMSG string 150 Message from DC Gateway describing the result of


ExtData xml ExtData Variable No Extended Data elements returned from Custom

Fields Web Service.

GetCustomFields

Description

Retrieve collection of custom fields defined for Merchant in DC Gateway

Parameters

Field Name Type Max








in DC Gateway.





Gateway.

Example

Hyperlink to GetCustomFields Request/Response example




Response (GetCustomFields)

Field Name Type Max

Length Description


ExtData xml ExtData Variable No Extended Data elements returned from Custom

Fields Web Service.




Card Account Updater Web Service

Name

Manage stored customer card information.

Description

Service to automatically update payment card details stored by the DC Gateway.

Operations

Name Description

UpdateSettings Update user settings to enable or modify Card Account Updater service settings

InfoSettings Retrieve settings information for Card Account Updater defined for Merchant in DC Gateway.

GetCardAdminReport Generate Detailed Card Report for Card Account Updater service.

Developer Notes

Card Account Updater feature must be enabled for the Reseller.

Merchant must be enrolled in Card Account Updater subscription service.

Card Account Updater feature must be enabled for the Merchant.

Merchant Sender ID is required for the Merchant.

UpdateSettings

Description

Update user settings to enable or modify Card Account Updater service settings.

Parameters

Field Name Type Max








in DC Gateway.


Gateway.

RecurringBillingUpdateEnabled enum (BooleanType) 1 Optional If no value is provided, setting will be

set to default value (False).

NonRecurringBillingUpdateEnabled enum (BooleanType) 1 Optional If no value is provided, setting will be


EmailNotificationEnabled enum (BooleanType) 1 Optional If no value is provided, setting will be


NotificationEmailAddresses string Variable Optional

If no value is provided, setting will be

set to default value (empty/null).

Multiple email addresses are

separated by a comma (,).




Response (UpdateSettings)

Field Name Type Max

Length Description






Username string 25

User name assigned in DC Gateway. The account

must be granted a sufficient level of security access

in order to invoke the operation.

Example

Hyperlink to UpdateSettings Request/Response example.

InfoSettings

Description

Returns the current user settings for the Card Account Updater service.

Parameters

Field Name Type Max








in DC Gateway.


Gateway.

Response (InfoSettings)

Field Name Type Max

Length Description

code string 25 Returned from DC Gateway to summarize result

from invoking operation.

error string 50 Message returned from DC Gateway describing


Vendor string 10 Unique identifier for Direct Connect reseller.

Reseller associated with target merchant account.

UserName string 25 merchant account User Name assigned in DC

Gateway used to make the request.

RecurringBillingUpdateEnabled string 1 Value states if cards used for recurring billing will

qualify for updates

NonRecurringBillingUpdateEnabled string 1 Value states if cards stored in the cardsafe will

qualify for the updates

EmailNotificationEnabled string 1 Value states if notification will be enabled

NotificationEmailAddresses string 1000 Electronic Mail Address(es) of Contact Persons to be notified.




Example

Hyperlink to InfoSettings Request/Response example.

GetCardAdminReport

Description

Generate Detail Card Account Update Report.

Developer Notes

Admin Reports for CardAccountUpdater will require the Secure Token generated with the API Password

Generation.

Parameters

Field Name Type Max







SecureToken string Var… Required




requests.


Gateway.

StartDT string 19 Required Date before transactions settled.

EndDT string 19 Required Date before transactions settled.

CardType enum (CardType) Variable Optional Types of payment to be included in list

of processed transactions.

ContractID string 50 Optional

Unique identifier assigned by

Merchant to the Recurring Payment

Agreement between Merchant and

Customer.

CustomerKey string 10 Optional Unique identifier for Customer (in DC

Gateway).

CustomerID string 50 Optional Identifier for a customer assigned by

Merchant.

CardInfoKey string 10 Optional Unique identifier for Customer Card

(in DC Gateway).


the card.



uniquely identifies the issuer and debit

cardholder account.

ReasonCode string 3 Optional

ExcludeInactive enum (BooleanType) 1 Optional

TransformType enum









Field Name Type Max





XSL.


Column Delimiter.





Row Delimiter.



each row.

IncludeHeader enum




Response (GetCardAdminReport)

Field Name Type Max

Length Description

Card_Account_Updates_Key string 25 User name assigned in DC Gateway. The account

must be granted a sufficient level of security access

in order to invoke the operation.

Update_Receive_Date string 20 Password for the user name assigned in DC

Gateway.

Customer_Name_VC string 10 Unique identifier for Direct Connect reseller.

Customer_Key string 10 Unique identifier for Customer.

Customer_ID string 15 Identifier assigned by merchant to cardholder.

Card_Info_Key string 10 Unique identifier for Customer Card.

Payment_Type_ID string Variable Type of Payment.

Name_On_Card string 25 Cardholder’s name as it appears on the card.

Previous_Account_Num string 4 Last 4 digits of previous Primary Account Number of

the credit cardholder account.

Previous_Exp_Date string 4 Expiration Date (MMYY) of the previous Primary

Account Number of the credit cardholder account.

New_Account_Num string 4 Last 4 digits of new Primary Account Number of the


New_Exp_Date string 4 Expiration Date of new Primary Account Number

of the credit cardholder account.

Reason_Code string Variable Reason code for update, cancellation, or error.

Reason_Code_Text string Variable Accompanying text to Reason Code from Processor.

Active_Flag enum (BooleanType) 1 Indicates if values returned are active account

within list of stored card values.

Example

Hyperlink to GetCardAdminReport Request/Response example.




Validate Credit Card Web Service

Name

Validate Credit Card

Description

Credit Card Validation and Card Type Web Service

Operations

Name Description

GetCardType Returns the brand – or Payment Type - for a credit card number.

GetNetworkID Returns the network identifier for a debit card number.

IsCommercialCard Returns true if number is for a commercial card (eligible for preferred discount rate pricing.)

ValidCard Returns true if card type, card number and expiration date are valid.

ValidCardLength Returns true if length of number is consistent with type of card.

ValidExpDate Returns true if a date is valid has not expired.

ValidMod10 Returns true if the remainder after a checksum (calculated from the sequence of digits in a card

number) divided by ten is zero.

Developer Notes

None

GetCardType

Description

Returns the brand for a card number.

Parameters

Field Name Type Max


CardNumber string 19 Required Unique identifier of cardholder

account.

Response (GetCardType)

Field Name Type Max

Length Description

GetCardTypeResult enum

(PaymentCardType) 10

Type(s) of payment to be included in list of

processed transactions (comma-separated list of

single-quoted strings).

Example

Hyperlink to GetCardType Request/Response example.




GetNetworkID

Description

Lookup the Debit Network identifier using a Card Number.

Parameters

Field Name Type Max








in DC Gateway.


account.

Response (GetNetworkID)

Field Name Type Max

Length Description


Numeric value returned from DC Gateway to summarize result from invoking operation (0 – successful).

RespMSG string 150 Full name of Debit Network.

Message string 150 Message returned from DC Gateway to describe result from processing transaction.

Message1 string 150 Debit Network ID and Authorizer number– provided as name/value –pairs.

Message2 string 150 Additional detail returned from DC Gateway to describe result from processing transaction.

AuthCode string 20

3-character Debit Network ID: ACL - Accel, AFN–- AFFN, AKO - Alaska Option, C24 - CU24, ILK - Interlink, JEN - Jeanie, MAC - Star Northeast, MAE - Maestro, NET - NETS, NYC - NYCE, PUL- Pulse, SES - Star Southeast, SHZ - Shazam, STX - Star West, TYM – TYME.

HostCode string 30 Network authorizer number.

Example

Hyperlink to GetNetworkID Request/Response example.

IsCommercialCard

Description

Returns (true/false) if the card is a known commercial card (commercial cards require customer code and sales

tax amount to receive preferred discount rate pricing).

Parameters

Field Name Type Max






account.

Response (IsCommercialCard)

Field Name Type Max

Length Description

IsCommercialCardResult enum


True for False returned from DC Gateway to indicate if card number is a Commercial Card.

Example

Hyperlink to IsCommercialCard Request/Response example.

ValidCard

Description

Validates the credit card by checking the card length based on the card type, performing a mod 10 checksum

and validating the expiration date.

Parameters

Field Name Type Max



account.

ExpDate string 4 Required Expiration Date (MMYY).

Response (ValidCard)

Field Name Type Max

Length Description

ValidCardResult string 5

Returns value indicating one of the follow restuls: 0

– valid card number and expiration date, 1001 -

missing card number, 1002 - missing expiration

date, 1003 - invalid cardtype, 1004 - invalid length

(card number), 1005 - fails mod 10 validation, 1006 -

invalid expiration date.

Example

Hyperlink to ValidCard Request/Response example.

ValidCardLength

Description

Validates the credit card length by checking the card length based on the card type, Returns (true/false).

Parameters

Field Name Type Max



account.

Response (ValidCardLength)




Field Name Type Max

Length Description

ValidCardLengthResult enum


True for False returned from DC Gateway to indicate if card length is valid.

Example

Hyperlink to ValidCardLength Request/Response example.

ValidExpDate

Description

Validates the expiration date by making sure it is a valid date and the card has not expired, Returns (true/false).

Parameters

Field Name Type Max


ExpDate string 4 Required Expiration Date (MMYY).

Response (ValidExpDate)

Field Name Type Max

Length Description

ValidExpDateResult enum


True for False returned from DC Gateway to indicate if card expiration date is valid.

Example

Hyperlink to ValidExpDate Request/Response example.

ValidMod10

Description

Validates the credit card by performing a mod 10 checksum on the card number, Returns (T/F).

Parameters

Field Name Type Max



account.

Response (ValidMod10)

Field Name Type Max

Length Description

ValidMod10Result enum


True for False returned from DC Gateway to indicate if card number has valid Luhn formula Mod 10 checksum.

Example

Hyperlink to ValidMod10 Request/Response example.




Enumerations

Description

The following are enumerated data types that consist of the associated set of named values specific to each

type.

enum Type Values Max

Length

Web

Method Description

enum AuthOptionFormType SinglePaymentSeries 25

UntilRevoked


Length

Web

Method Description

enum AuthOptionVoiceType ConsumerInitiatedCall 25

ExistingRelationship


Length

Web

Method Description

enum BillingFequencyType ONCE 15 Billing Period of once

WEEKLY Billing Period of weekly

BIWEEKLY Billing Period of every 2 weeks.

MONTHLY Billing Period of monthly.

QUARTERLY Billing Period of quarterly.

SEMIANNUALLY Billing Period of twice per year.

ANNUALLY Billing Period of annually.


Length

Web

Method Description

enum BillingPeriodType DAY 5 Billing Period of Day

WEEK Billing Period of Week

MONTH Billing Period of Month

YEAR Billing Period of Year


Length

Web

Method Description

enum BooleanType T 1 “T” = Value of True.

F “F” = Value of False.


Length

Web

Method Description

enum BooleanVerboseType True 5 “True” = Value of True.

False “False” = Value of False.


Length

Web

Method Description

enum BooleanVerboseLCType true 5 All lower case of “true” = Value of True.

false All lower case of “false” = Value of

False.


Length

Web

Method Description

enum CardPresentType TRUE 7 Card is present at time of purchase.

FALSE Card is not present at time of

purchase.

UNKNOWN Card presence is unknown at time of

purchase.





Length

Web

Method Description

enum CardType AMEX 10 American Express card

DISCOVER Discover card

MASTERCARD MasterCard card

VISA Visa card


Length

Web

Method Description

enum CashTransType Sale 6 Process a sale with cash.

Return Return funds from a cash transaction.


Length

Web

Method Description

enum CheckAcctType Checking 10 Checking account specified.

Savings Savings account specified.


Length

Web

Method Description

enum CheckTransType Auth 10 Verify the amount of a check.

Sale Process a sale by check.

Force Force a previous Sale transaction into

the current batch.

Return Return funds from a settled check

transaction to the account holder.

Void Voids a previously processed check

sale, force or return.

Capture Settle a single check transaction in the

current batch

CaptureAll Settle all check transactions in the

current batch.


Length

Web

Method Description

enum CheckType Personal 10 Indicates a personal checking account.

Business Indicates a business checking account.


Length

Web

Method Description

enum CreditCardTransType Auth 10 Verify the amount of a credit card.

Sale Process a sale by credit card.

Adjustment Adjust the total amount of a credit

card transaction.

RepeatSale Process a repeat sale by credit card.


the current batch.

Return

Return funds from a settled credit

card transaction to the account

holder.

Reversal Return funds from a credit card


Void Voids a previously processed credit

card sale, force or return.

Capture Settle a single credit card transaction

in the current batch.

CaptureAll Settle all credit card transactions in

the current batch.





Length

Web

Method Description

enum CVPresenceType 1 1 No CV provided

2 CV not submitted

3 CV submitted

4 CV is illegible

5 CV not present on card


Length

Web

Method Description

enum DebitCardTransType Auth 10 Verify the amount of a debit card.

Sale Process a sale by debit card.


the current batch.

Return Return funds from a settled debit card


Reversal Return funds from a debit card


Capture Settle a single debit card transaction in

the current batch.

CaptureAll Settle all debit card transactions in the

current batch.


Length

Web

Method Description

enum EBTCardTransType FoodStampSale 20 Make a purchase on an EBT

cardholder’s food stamp account.

FoodStampReturn Refund purchase made with EBT Card.

CashBenefitSale Make Sale on Cash Benefit Account

with EBT Card.

EWICAuthorization Authorize sale amount for eWic

transaction using EBT Card.

EWICSale Make an eWic sale using an EBT Card.

EWICCompletion Complete a previously processes eWic

authorization using EBT Card.

EWICVoucherClear Complete a previously voice

authorized eWic voucher.

SNAPVoucherClear Complete a previously voice

authorized SNAP voucher.

Force Make Sale using EBT Card without PIN.

Inquire Check the balance on an EBT card.

Reversal Return funds from an EBT card


Void Voids a previously processed EBT sale,

force or return.

Capture Settle a single EBT Card transaction in

the current batch.

CaptureAll Settle all EBT Card transactions in

current batch.





Length

Web

Method Description

enum EntryModeType UNKNOWN 15 Unable to determine how merchant

obtained values from card.

MANUAL Merchant manually keyed card values.

MagneticStripe Cards stripe was read by swiping it on

a magnetic stripe reader.

ICC Card information was obtained by

Integrated Circuit Card (chip read).

PROXIMITY Card information was obtained by

near field communication reader.


Length

Web

Method Description

enum GiftCardTransType Activate 10 Activate Gift Card.

Deactivate Deactivate Gift Card.

Redeem Make Sale using Gift Card.

Force

Place a Gift Card transaction not

processed through DC Gateway into

the current batch.

Refund Refund purchase made using Gift

Card.

Void Undo unsettled transaction made

using Gift Card.

Inquire Check Gift Card balance.

Reload Increase Gift Card balance.

Capture Settle a single Gift Card transaction in

the current batch.

CaptureAll Settle all Gift Card transactions in

current batch.


Length

Web

Method Description

enum ImageType NO_IMAGE 25 No image included.

ONLY_IMAGE Only include image.

ONLY_IMAGE_INCLUD

E_DATA

Include both image data.

ALL_INCLUDE_DATA Include all data.


Length

Web

Method Description

enum PaymentType CC 2 Credit Card

CK Check


Length

Web

Method Description

enum PaymentCardType AMEX 10 American Express card

CARTBLANCH Cart Blanche card

DEBIT Debit card

DINERS Diners Club card


EBT Electrtonic Benefits Transfer

EGC Electrtonic Gift card

JAL JAL card

JCB Japanese Commercial Bank card


VISA Visa card





Length

Web

Method Description

enum PaymentCheckType ACH 10 Automated Clearing House

ECHECK Electronic Check

SETTLE Transactions that have been finalized

with the processor


Length

Web

Method Description

enum PaymentTypeIDType ACH 10 Automated Clearing House

AMEX American Express card

CARTBLANCH Cart Blanche card

CASH Cash

DEBIT Debit card

DINERS Diners Club card


EBT Electronic Benefits Transfer

ECHECK Electronic Check

EGC Electronic Gift card

FILE Authorization File

GUARANTEE Check Guarantee

IMAGE Check Image

JAL JAL card

JCB Japanese Commercial Bank card

LOYALTY Loyalty card


PAYRECEIPT

Receipt image uploaded to DC

Gateway (Transaction Reporting web

service only).

PL Private Label card.

SETTLE

Request to settle transactions

(Transaction Reporting web service

only).

VERIFY Verify Check

VISA Visa card


Length

Web

Method Description

enum ProcessorIDType FDCN 10 First Data Nashville

FDCISONash First Data ISO 8583 Nashville

FDCNorth First Data North

FDCOmaha First Data Omaha

FDRC First Data Rapid Connect

PayTampa Paymentech Tampa

TSYS_SGMF TSYS Host Capture

VITAL TSYS Sierra Terminal Capture


Length

Web

Method Description

enum RecurringTransType ADD 6 Recurring Add recurring payment

UPDATE Recurring Update recurring payment

DELETE Recurring Delete recurring payment





Length

Web

Method Description

enum ReportingTransType Authorization 20 TrxReporti

ng

Credit TrxReporti

ng

ForceCapture TrxReporti

ng

PostAuth TrxReporti

ng

Purged TrxReporti

ng

RepeatSale

TrxReporti

ng/Transac

t/CardSafe

Sale

TrxReporti

ng/Transac

t/CardSafe

Void

TrxReporti

ng/Transac

t/CardSafe


Length

Web

Method Description

enum SECCType CCD 3 Cash Concentration or Disbursement

PPD Prearranged Payment and Deposit

Entry

ARC Accounts Receivable Entry

RCK Re-presented Check Entry

TEL Telephone Initiated Entry

WEB Internet Initiated Entry


Length

Web

Method Description

Enum SignatureType SignatureType1 14 Lipman credit signature type

SignatureType2 Lipman check signature type

SignatureType4 Signature provided in a vector string

Receipt1 Base64 encoded text string


Length

Web

Method Description

enum TaxType City 14 City tax

Energy Energy tax

Federal Federal tax

Goods/Services Goods/services tax

Local Local tax

Municipal Municipal tax

Occupancy Occupancy tax

Other Other tax

Provincial Provincial tax

Room Room tax

State State tax

Value Added Value added tax





Length

Web

Method Description

enum Timezone AST 5 Atlantic Standard Time

AKST Alaskan Standard Time

CST Central Standard Time

EST Eastern Standard Time

HST Hawaiin Standard Time

MST Mountain Standard Time

AZMST US Mountain Standard Time

PST Pacific Standard Time


Length

Web

Method Description

enum TokenModeType DEFAULT 10 Numeric CCInfoKey value

CARDFORMAT Randomly generated number in

format of a credit card number


Length

Web

Method Description

enum TransformType XML 5 XML file type

XSL Excel spreadsheet file type

DELIM Delimited file type


Length

Web

Method Description

enum UserStatusType 1 1 1 = ACTIVE

2 2 = INACTIVE


Length

Web

Method Description

enum UnitOfMeasureType ACR 3 ACRE

ASM Alcoholic strength by mass

ASV Alcoholic strength by volume

AMP Ampere*

AMH Ampere-hour (3.6kC)*

ARE Are (100 m2)

BAR Bar*

BLL Barrel

BFT Board foot

BQL Becquerel*

BIL Billion EUR

MLD Billion US

BHP Brake horse power (245.7 watts)

BTU British thermal unit (1.055 kilojoules)

BUA Bushel (35.2391 dm3)

BUI Bushel (36.36874 dm3)

CDL Candela*

CCT Carrying capacity in metric tons

CNT Cental GB (45.359237 kg)

CGM Centigram*

CLT Centilitre*

CMT Centimetre*

DTN Centner, metric (100 kg)

WCD Cord (3.63 m3)

COU Coulomb*

CKG Coulomb per kilogram*

CMQ Cubic centimetre*

DMQ Cubic decimetre*




FTQ Cubic foot

INQ Cubic inch

MTQ Cubic metre

MQH Cubic metre per hour*

MQS Cubic metre per second*

MMQ Cubic millimetre*

YDQ Cubic yard

CUR Currie

DAY Day*

DEC Decade (ten years)

DAA Decare

DLT Decilitre*

DMT Decimetre*

DTN Decitonne*

CEL Degree Celsius

FAH Degree Fahrenheit

DPT Displacement tonnage

DZN Dozen

DZP Dozen packs

DZR Dozen pairs

DPC Dozen pieces

DRL Dozen rolls

DRM Drachm GM (3.887935 g)

DRI Dram GB (1.771745 g)

DRA Dram US (3.887935 g)

BLD Dry barrel (115.627 dm3)

GLD Dry gallon (4.404884 dm3)

PTD Dry pint (.55061 dm3)

QTD Dry quart (1.101221 dm3)

FAR Farad*

OZI Fluid ounce (28.413 cm3)

OZA Fluid ounce (29.5735 cm3)

FOT Foot (.3048 m)

GLI Gallon (4.546092 dm3)

GBQ Gigabequerel*

GWH Gigawatt-hour (1 million kW/h)*

GII Gill (.142065 dm3)

GIA Gill (11.8294 cm3)

GRN Grain GB, US (64.798910 mg)

GRM Gram*

GFI Gram of fissile isotopes

GGR Great gross (12 gross)

GRP Gross

GRT Gross GRT

SAN Half year (six months)

HAR Hectare

HBA Hectobar*

HGM Hectogram*

DTH Hectokilogram*

HLT Hectolitre*

HPA Hectolitre of pure alcohol

HMT Hectometre*

HTZ Hertz*

HUR Hour*




CEN Hundred

BHX Hundred boxes

HIU Hundred international units

CLF Hundred leaves

CNP Hundred packs

CWA Hundredweight US (45.3592 kg)

INH Inch (25.4mm)

JOU Joule*

KEL Kelvin*

KBA Kilobar*

KGM Kilogram*

KPH Kilogram of caustic potash

KSH Kilogram of caustic soda

KNS Kilogram of named substance

KNI Kilogram of nitrogen

KPP Kilogram of phosphoric anhydride

KPP Kilogram of phosphoric pentoxide

KPH Kilogram of potassium hydroxide

ATT Technical atmosphere (98066.5 Pa)

DAD Ten days

TPR Ten pairs

MIL Thousand

TAH Thousand ampere-hour*

MBF Thousand board-feet (2.36 m3)

TQD Thousand cubic metres per day*

MBE Thousand standard brick equivalent

TSH Ton of steam per hour

TNS Tonne (1000 kg)*

TSD Tonne of substance 90% dry

TRL Trillion EUR

BIL Trillion US

APZ Troy ounce

LBT Troy pound, US (373.242 g)

VLT Volt*

WTT Watt*

WHR Watt-hour*

WEB Weber

WEE Week

TRD Yard

ANN Year

KPO Kilogram of potassium oxide

KSD Kilogram of substance 90% dry

KUR Kilogram of uranium

KMQ Kilogram per cubic meter*

KGS Kilogram per second*

KHZ Kilohertz*

KJO Kilojoule*

KMT Kilometre*

KMH Kilometre per hour*

KPA Kilopascal*

KTN Kilotonne

KVR Kilovar

KVT Kilovolt*

KVA Kilovolt-ampere*




KWT Kilowatt*

KWH Kilowatt-hour*

KNT Knot (1 nautical mile per hour)

LEF Leaf

GLL Liquid gallon (3.78541 dm3)

PTL Liquid pint (.473176 dm3)

QTL Liquid quart (.946353 dm3)

LTR Litre (1 dm3)*

LPA Litre of pure alcohol

CWI (Long) hundredweight GB (50.802345)

LTN Long ton GB, US (1.0160469 t)

LUM Lumen*

LUX Lux

MHZ Megahertz

MAL Megalitre*

MAM Megametre*

MPA Megapascal*

MVA Megavolt-ampere (1000 KVA)*

MAW Megawatt*

MWH Megawatt-hour (1000kW/h)*

MTR Metre*

MTS Metre per second*

MSK Metre per second squared*

CTM Metric carat (200 mg - 2.10-4kg)

TNE Metric ton (1000 kg)

MLT Mililitre*

MMT Milimetre*

MLD Milliard

MBR Millibar*

MCU Millicurie

MGM Milligram*

MIO Million

HMQ Million cubic metres*

MIU Million international units

MIN Minute*

MON Month

NMI Nautical mile (1852 m)

NTT Net [register] ton

NEW Newton*

NMB Number

NAR Number of articles

NBB Number of bobbins

NCL Number of cells*

NIU Number of international units

NMP Number of packs

NMR Number of pairs

NPL Number of parcels

NPT Number of parts

NRL Number of rolls

OHM Ohm*

ONZ Ounce GB, US (28.349523 g)

APZ Ounce GB, US (31.10348 g)

PAL Pascal*

DWT Pennyweight GB, US (1.555174 g)




PCB Piece

PTI Pint (.568262 dm3)

LBR Pound GB, US (.4559237 kg)

PGL Proof gallon

QTI Quart (1.136523 dm3)

QAN Quarter (of a year)

QTR Quarter, GB (12.700586 kg)

DTN Quintal, metric (1000 kg)

RPM Revolution per minute*

RPS Revolution per second*

SCO Score

SCR Scruple GB, US (1.295982 g)

SEC Second*

SET Set

SHT Shipping ton

SST Short standard (7200 matches)

STN Short ton GB, US (.90718474 t)

SIE Siemens*

CMK Square centimetre*

DMK Square decimetre*

FTK Square foot

INK Square inch

KMK Square kilometre*

MTK Square metre*

MIK Square mile

MHK Square millimetre*

YDK Square yard

WSD Standard

ATM Standard atmosphere (101325 Pa)

SMI (Statute) mile (1609.344 m)

STI Stone GB (6.350293 kg)




Hosted Payment Pages

DC Gateway Hosted Payment Pages are available with the following two layouts:

Name Description Endpoint

Classic The original hosted payment page /ws/hosted.aspx

New The new, tabular layout hosted payment page. Only this page supports

the callback URL

/ws/hosted2.aspx

Developer Notes

The base URL for DC Gateway Web services is https://gateway.1directconnect.com.

Contact Direct Connnect Sales Representative to request custom URL.

Both of the pages support the same parameters and return the exact same data.

Description

This request will generate a hosted payments page and provide options to process payments

Parameters

Field Name Type Max



The Username parameter generated

in the security tab of the Hosted Page

configuration utility.

Password string 500 Required

The Password parameter generated in

the security tab of the Hosted Page

configuration utility.

MerchantKey string 10 Required

This is the Gateway ID of the gateway

account you are trying to connect to.

This value is also referred to as the

Vendor Key or RPNumber.

CustomerName string 100 Optional This is the card holder name value.

ShippingAddress1 string 50 Optional Identifies the first line of the card

holder’s shipping address.

ShippingAddress2 string 50 Optional Identifies the second line of the card


ShippingState string 50 Optional Identifies the State of the card holder’s

shipping address.

ShippingCity string 50 Optional Identifies the City of the card holder’s

shipping address.

ShippingZip string 2 Optional Identifies the Zip code of the card


ShippingIsBilling string Optional

A Boolean field which allows the

integrator to specify that the shipping

address and billing address are

equivalent. If this field is passed in and

set to ‘True’, all billing address

information passed to the hosted

page will be ignored.

BillingAddress1 string 50 Optional Identifies the first line of the card

holder’s billing address.

BillingAddress2 string 50 Optional Identifies the second line of the card


https://gateway.1directconnect.com/




Field Name Type Max


BillingState string 50 Optional Identifies the State of the cardholder’s

billing address.

BillingCity string 50 Optional Identifies the City of the cardholder’s

billing address.

BillingZip string 2 Optional Identifies the Zip code of the card



Amount of the transaction.

Required if customer does not

specify the amount.

InvNum string 20 Optional Invoice Number to be associated with

the current transaction.


The Customer ID value to be

associated with the current

transaction.

TaxAmount string 18 Optional The Tax Amount to be associated

with the current transaction.

ShippingAmount string 18 Optional

The Shipping Amount to be

associated with the current

transaction.

Response (Hosted Payment Page)

Field Name Type Max Length Description


Numeric value returned from DC Gateway

to summarize result from invoking

operation

RespMSG string 150

Message returned from DC Gateway

describing result from processing

transaction

AuthCode string 20

Six-character alphanumeric authorization

code (from Issuing Bank) used during

settlement or an error message (from

Payment Processor)

PNRef string 10 Unique numeric identifier generated by DC

Gateway for a processed transaction.

LastFour string 4

The last four digits of the credit card

number that was collected on the Hosted

Page

ExpDate string 4

The expiration date of the credit card

number that was collected on the Hosted

Page

Amount string 18 Amount authorized by processor

InvNum string 20 The invoice number of the transaction for

reconciliation purposes

CardType string 10 Payment Type of card used to process

payment




Field Name Type Max Length Description

CustomerKey string 10

Unique identifier for Customer token

returned after tokenizing the customer

information provided on Hosted Payment

Page.

Support for tokenization needs to be

enabled for this tag to be returned. If

tokenization was not successful, -1 will be

returned in the response.

CCInfoKey string 10

Unique identifier for Card payment token

returned after tokenizing the card


Page.


enabled for this tag to be returned If



CheckInfoKey string 10

Unique identifier for Check Payment token

returned after tokenizing the check


Page.


enabled for this tag to be returned If






Appendix

Front End Processors

Developer Notes

Use the InfoMerchant operation of the Administration web service to determine the ProcessorID for a

merchant’s payment methods in DC Gateway.

Credit/Debit/EBT

Processor Name Processor ID Settlement Type Notes

First Data Nashville FDCN Terminal Capture Direct Connect Preferred processor.

First Data Nashville ISO8583 FDCISONash Terminal Capture Direct Connect Preferred processor.

First Data North FDCNorth Terminal Capture Direct Connect Preferred processor.

First Data Omaha FDCOmaha Hybrid

Settlement action is required from the

terminal to reconcile the transactions at the

host; Direct Connect Preferred Processor.

First Data Rapid Connect FDRC Host Capture Direct Connect Preferred processor.

Paymentech – Tampa PayTampa Host Capture

Terminal Capture

Used to process all credit, debit and EBT

transactions from DC Gateway test account.

TSYS Host TSYS_SGMF Host Capture Direct Connect Preferred processor.

TSYS Terminal (Vital) VITAL Terminal Capture Direct Connect Preferred processor.

Check/Gift/Loyalty

Processor Name Processor ID Settlement Type Notes

First ACH FirstACH Host Capture

Direct Connect Preferred processor. Used

to process all Check, eCheck transactions

from DC Gateway test account.

Valutec Valutec Host Capture Direct Connect Preferred processor.

Responses

HTTP Status Codes Value Description

2xx Success: Inspect Result/Result Code from DC Gateway to determine outcome of Web Service operation.

4xx Client Error: Reformulate and resubmit request to DC Gateway.

DC Gateway Result Value Description Explanation

-100 Transaction NOT Processed; Generic Host Error DC Gateway failed to reach Processor

0 Approved Request was processed successfully by processor.

1 User Authentication Failed DC Gateway rejected username and/or password

2 Invalid Transaction DC Gateway forwarded request to processor for an

unsupported operation.

3 Invalid Transaction Type Request message included an invalid transaction type for the

specified operation;




Value Description Explanation

4 Invalid Amount

Request message included an amount value that is < 0.01 or

greater than 99999.99;

Request message included an improperly formatted amount

value;

Request message included an amount value containing

alphabetic characters or symbols (other than decimal point)

5 Invalid Merchant Information Processor does not recognize Merchant Account.

7 Field Format Error DC Gateway failed while parsing request message.

8 Not a Transaction Server Gateway unable to reach processor that supports requested

operation.

9 Invalid Parameter Stream Client Application failed to pass all necessary parameters to

requested operation for messaging protocol.

10 Too Many Line Items DC Gateway unable to process payments with more than 99-

line item details.

11 Client Timeout Waiting for Response Processor failed to respond to a request from DC Gateway;

12 Decline Request was declined by processor.

13 Referral Gateway unable to reach processor that supports requested

operation.

14 Transaction Type Not Supported In This Version

Valid transaction types are: Authorization, Capture, Credit,

ForceCapture, GetStatus, PostAuth, Purged, Receipt,

RepeatSale, Sale, Void

19 Original Transaction ID Not Found Request was rejected by DC Gateway.

20 Customer Reference Number Not Found Request was rejected by DC Gateway.

22 Invalid ABA Number Request was rejected by DC Gateway.

23 Invalid Account Number Request was rejected by DC Gateway.

24 Invalid Expiration Date Request was rejected by DC Gateway.

25 Transaction Type Not Supported by Host Gateway unable to reach processor that supports requested

operation.

26 Invalid Reference Number Request was rejected by DC Gateway.

27 Invalid Receipt Information Receipt information is improperly configured in DC Gateway

for Merchant account.

28 Invalid Check Holder Name Request was rejected by the processor.

29 Invalid Check Number Request was rejected by the processor.

30 Check DL Verification Requires DL State Request was rejected by DC Gateway.

40 Transaction did not connect (to NCN because

SecureNCIS is not running on the web server) DC Gateway unable to communicate with processor.

50 Insufficient Funds Available Request was rejected by the processor.

99 General Error Processor failed to respond or responded in an unexpected

way to a valid DC Gateway request

100 Invalid Transaction Returned from Host Gateway forwarded request to processor for an unsupported

operation.

101 Timeout Value too Small or Invalid Time Out

Value Request was rejected by DC Gateway.

102 Processor Not Available DC Gateway failed to reach processor

103 Error Reading Response from Host Processor failed to respond to valid DC Gateway request

104 Timeout waiting for Processor Response Processor failed to respond to valid DC Gateway request within

allotted time duration.

105 Credit Error Return request was rejected by the processor.

106 Host Not Available DC Gateway unable to communicate with processor.

107 Duplicate Suppression Timeout DC Gateway unable to complete request within allotted time

duration.

108 Void Error Request was rejected by DC Gateway.

109 Timeout Waiting for Host Response Processor failed to respond to valid DC Gateway request




Value Description Explanation

110 Duplicate Transaction Request was rejected by DC Gateway.

111 Capture Error Request was rejected by DC Gateway.

112 Failed AVS Check

Request was rejected by processor.

Incomplete or inconsistent address information provided by

Client Application for Card number.

113 Cannot Exceed Sales Cap Request was rejected by DC Gateway.

1000 Generic Host Error Processor failed to respond or responded in an unexpected

way to a valid DC Gateway request

1001 Invalid Login DC Gateway rejected username and/or password

1002 Insufficient Privilege or Invalid Amount DC Gateway refused to process payment request for

username.

1003 Invalid Login Blocked DC Gateway rejected username and/or password

1004 Invalid Login Deactivated DC Gateway refused request received for a valid username

because the account is inactive.

1005 Transaction Type Not Allowed

Valid transaction types are: Authorization, Capture, Credit,

ForceCapture, GetStatus, PostAuth, Purged, Receipt,

RepeatSale, Sale, Void

1006 Unsupported Processor DC Gateway unable to forward request to specified processor.

1007 Invalid Request Message Client Application failed to pass all necessary parameters to


1008 Invalid Version Client Application failed to pass all necessary parameters to


1010 Payment Type Not Supported Gateway forwarded request to processor for an unsupported

operation.

1011 Error Starting Transaction DC Gateway failed to reach processor

1012 Error Finishing Transaction Processor failed to respond within allotted time duration to a

DC Gateway request.

1013 Error Checking Duplicate Request was not processed by DC Gateway.

1014 No Records To Settle (in the current batch) Request was rejected by DC Gateway.

1015 No Records To Process (in the current batch) Request was rejected by DC Gateway.

DC Gateway ResultCode Description Explanation

OK Request was processed successfully by processor

Unknown_Error DC Gateway failed to reach Processor

Access_Denied User does not have required access privileges

Invalid_Login DC Gateway rejected username and/or password

Invalid_User_Status DC Gateway rejected username

Invalid_User DC Gateway rejected username

User_Not_Found DC Gateway rejected username

Username_Already_In_Use DC Gateway cannot add duplicate username for Merchant

Username_Has_Invalid_Characters DC Gateway rejected username

Not_Enough_Privilege User lacks sufficient privileges for requested operation

Invalid_PartnerID DC Gateway rejected PartnerID

Invalid_VendorID DC Gateway rejected VendorID

Invalid_Argument Request was rejected by DC Gateway

Invalid_Record Request was rejected by DC Gateway

Transaction_Type_Not_Supported_By_Host Request message included an invalid transaction type for the specified operation

Internal_Error DC Gateway failed to reach Processor




Address Verification System (AVS) Result Codes Value Description

X Exact: Address and nine-digit Zip match

Y Yes: Address and five-digit Zip match

A Address: Address matches, Zip does not

Z 5-digit Zip: 5-digit Zip matches, address doesn’t

W Whole Zip: 9-digit Zip matches, address doesn’t

N No: Neither address nor Zip matches

U Unavailable: Address information not available

G Unavailable: Address information not available for international transaction

R Retry: System unavailable or time-out

E Error: Transaction unintelligible for AVS or edit error found in the message that prevents AVS from being performed

S Not Supported: Issuer doesn’t support AVS service

B Street Match: Street addresses match for international transaction, but postal code doesn’t

C Street Address: Street addresses and postal code not verified for international transaction

D Match: Street addresses and postal codes match for international transaction

I Not Verified: Address Information not verified for International transaction

M Match: Street addresses and postal codes match for international transaction

P Postal Match: Postal codes match for international transaction, but street address doesn’t

0 No response sent

5 Invalid AVS response

Card Verification System (CVS) Result Codes Value Description

M CVV2/CVC2/CID Match

N CVV2/CVC2/CID No Match

P Not Processed

S Issuer indicates that the CV data should be present on the card, but the merchant has indicated that the CV data is

not present on the card.

U Unknown / Issuer has not certified for CV or issuer has not provided Visa/MasterCard with the CV encryption keys.

X Server Provider did not respond




Examples

Admin Web Service Examples

AddMerchant

Hyperlink to AddMerchant Web Service details

SOAP Request Message:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"

xmlns:ws="http://www.tpisoft.com/Admin/ws">

<soapenv:Header/>

<soapenv:Body>

<ws:AddMerchant>

<ws:Username>[API Username]</ws:Username>

<ws:SecureToken>[API Secure Token]</ws:SecureToken>

<ws:ResellerKey>130</ws:ResellerKey>

<ws:MerchantUsername>AddMerch</ws:MerchantUsername>

<ws:MerchantPassword>AddMerch10</ws:MerchantPassword>

<ws:MerchantID>Test Merchant</ws:MerchantID>

<ws:MerchantID2>Test Merchant ID2</ws:MerchantID2>

<ws:AnnualSales></ws:AnnualSales>

<ws:BusinessStartDate></ws:BusinessStartDate>

<ws:CompanyName>Test Merchant</ws:CompanyName>

<ws:DoingBusinessAs></ws:DoingBusinessAs>

<ws:Url></ws:Url>

<ws:FederalTaxID></ws:FederalTaxID>

<ws:StateTaxID></ws:StateTaxID>

<ws:SalesTaxID></ws:SalesTaxID>

<ws:OwnershipType>Corporation</ws:OwnershipType>

<ws:AutoCloseBatch>True</ws:AutoCloseBatch>

<ws:AutoCloseBatchHour>22</ws:AutoCloseBatchHour>

<ws:ForceDuplicate>True</ws:ForceDuplicate>

<ws:RequirePNRef>True</ws:RequirePNRef>

<ws:ContactFirstName>John</ws:ContactFirstName>

<ws:ContactLastName>Doe</ws:ContactLastName>

<ws:ContactEmail>[email protected]</ws:ContactEmail>

<ws:ContactDayPhone>703-481-7000</ws:ContactDayPhone>

<ws:ContactFax></ws:ContactFax>

<ws:ContactStreet1>123 East Main</ws:ContactStreet1>

<ws:ContactStreet2>Suite 100</ws:ContactStreet2>

<ws:ContactCity>Chantilly</ws:ContactCity>

<ws:ContactState>VA</ws:ContactState>

<ws:ContactPostalCode>20151</ws:ContactPostalCode>

<ws:ContactCountryCode>USA</ws:ContactCountryCode>

<ws:TimeZoneOffset>300</ws:TimeZoneOffset>

<ws:RegistersXml><Registers><Register><RegisterName>Lane1</RegisterName><RegisterNum&

gt;1</RegisterNum><</Register></Registers>

</ws:RegistersXml>

<ws:ReadOnlyRecurringBillingCustomerID>True</ws:ReadOnlyRecurringBillingCustomerID>

<ws:ReadOnlyRecurringBillingContractID>True</ws:ReadOnlyRecurringBillingContractID>

<ws:ReadOnlyCardSafeCustomerID>True</ws:ReadOnlyCardSafeCustomerID>

<ws:PaymentMethodsXml><PaymentMethod><ProcessorID>FDRC</ProcessorID><PaymentTypeID&g

t;VISA</PaymentTypeID><HostBased>True</HostBased><clientNumber></clientNumber> </PaymentMethod></ws:PaymentMethodsXml>




<ws:BypassAvsCvvFiltersEnabled>False</ws:BypassAvsCvvFiltersEnabled>

<ws:ReadOnlyRecurringBillingCustomerID>True</ws:ReadOnlyRecurringBillingCustomerID>

<ws:ReadOnlyRecurringBillingContractID>True</ws:ReadOnlyRecurringBillingContractID>

<ws:ReadOnlyCardSafeCustomerID>True</ws:ReadOnlyCardSafeCustomerID>

<ws:BypassAvsCvvFiltersEnabled>False</ws:BypassAvsCvvFiltersEnabled>

<ws:ExtData><VirtualTerminalAllowRepeat>T</VirtualTerminalAllowRepeat><VirtualTerminalCommercialC

ard>T</VirtualTerminalCommercialCard><VirtualTerminalConvenienceAmount>T</VirtualTerminalConv

enienceAmount><VirtualTerminalCreditAccess>T</VirtualTerminalCreditAccess><VirtualTerminalDutyA

mount>T</VirtualTerminalDutyAmount><VirtualTerminalLevel3Amount>T</VirtualTerminalLevel3Amou

nt><VirtualTerminalShippingAmount>T</VirtualTerminalShippingAmount><VirtualTerminalTaxAmount

>T</VirtualTerminalTaxAmount><VirtualTerminalTipAmount>T</VirtualTerminalTipAmount><CVN

oData>T</CVNoData><AVAddNotVerifiable>F</AVAddNotVerifiable><AVAddNotVerifiableGlobal&g

t;F</AVAddNotVerifiableGlobal><AVAddOnly>F</AVAddOnly><AVExactMatch>F</AVExactMatch&

gt;<AVInvalidAddZip>F</AVInvalidAddZip><AVIssuerUnavail>F</AVIssuerUnavail><AVNoData>

F</AVNoData><AVNoMatch>F</AVNoMatch><AVNotRequested>F</AVNotRequested><AVS

ervUnsupported>F</AVServUnsupported><AVUnregCode>T</AVUnregCode><AVVerUnavail>T&

lt;/AVVerUnavail><AVZipOnly>F</AVZipOnly></ws:ExtData>

</ws:AddMerchant>

</soapenv:Body>

</soapenv:Envelope>

Name/Value Pairs Request Message:

Response Message:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <AddMerchantResponse xmlns="http://www.tpisoft.com/Admin/ws"> <AddMerchantResult> <code>OK</code> <error>A new Merchant was successfully created!</error> <Partner>130</Partner> <Vendor>17282</Vendor> <Username>AddMerch10</Username> </AddMerchantResult> </AddMerchantResponse> </soap:Body> </soap:Envelope>

Hyperlink to AddMerchant Web Service details

UpdateMerchant

Hyperlink to UpdateMerchant Web Service details




<soapenv:Header/>

<soapenv:Body>

<ws:UpdateMerchant>



<ws:MerchantKey>17282</ws:MerchantKey>


<ws:MerchantID>GA Test10</ws:MerchantID>

<ws:MerchantID2>GA Test 10ID2</ws:MerchantID2>




<ws:AnnualSales></ws:AnnualSales>

<ws:BusinessStartDate>1/1/2000</ws:BusinessStartDate>

<ws:CompanyName>GA Test10</ws:CompanyName>

<ws:DoingBusinessAs></ws:DoingBusinessAs>

<ws:Url></ws:Url>

<ws:FederalTaxID>111-11-1111</ws:FederalTaxID>

<ws:StateTaxID>222-22-2222</ws:StateTaxID>

<ws:SalesTaxID>333-33-3333</ws:SalesTaxID>

<ws:OwnershipType>Corporation</ws:OwnershipType>

<ws:AutoCloseBatch>true</ws:AutoCloseBatch>

<ws:AutoCloseBatchHour>22</ws:AutoCloseBatchHour>

<ws:ForceDuplicate>true</ws:ForceDuplicate>

<ws:RequirePNRef>true</ws:RequirePNRef>

<ws:ContactFirstName>John</ws:ContactFirstName>

<ws:ContactLastName>Doe</ws:ContactLastName>

<ws:ContactEmail>[email protected]</ws:ContactEmail>

<ws:ContactDayPhone>703-481-7000</ws:ContactDayPhone>

<ws:ContactFax></ws:ContactFax>

<ws:ContactStreet1>123 East Main</ws:ContactStreet1>

<ws:ContactStreet2>Suite 100</ws:ContactStreet2>

<ws:ContactCity>Chantilly</ws:ContactCity>

<ws:ContactState>VA</ws:ContactState>

<ws:ContactPostalCode>20151</ws:ContactPostalCode>

<ws:ContactCountryCode>USA</ws:ContactCountryCode>

<ws:TimeZoneOffset>300</ws:TimeZoneOffset>

<ws:PaymentMethodsXml><PaymentMethod><ProcessorID>FDRC</ProcessorID><PaymentTypeID&g

t;VISA</PaymentTypeID><HostBased>True</HostBased></PaymentMethod></ws:PaymentMethod

sXml>

<ws:RegistersXml><Registers><Register><RegisterName>Lane1</RegisterName><RegisterNum&

gt;1</RegisterNum><TerminalNum>2</TerminalNum></Register></Registers></ws:Registers

Xml>

<ws:ReadOnlyRecurringBillingCustomerID>true</ws:ReadOnlyRecurringBillingCustomerID>

<ws:ReadOnlyRecurringBillingContractID>true</ws:ReadOnlyRecurringBillingContractID>

<ws:ReadOnlyCardSafeCustomerID>true</ws:ReadOnlyCardSafeCustomerID>

<ws:BypassAvsCvvFiltersEnabled>true</ws:BypassAvsCvvFiltersEnabled>

<ws:ExtData><VirtualTerminalAllowRepeat>T</VirtualTerminalAllowRepeat><VirtualTerminalCommercialC

ard>T</VirtualTerminalCommercialCard><VirtualTerminalConvenienceAmount>T</VirtualTerminalConv

enienceAmount><VirtualTerminalCreditAccess>T</VirtualTerminalCreditAccess><VirtualTerminalDutyA

mount>T</VirtualTerminalDutyAmount><VirtualTerminalLevel3Amount>T</VirtualTerminalLevel3Amou

nt><VirtualTerminalShippingAmount>T</VirtualTerminalShippingAmount><VirtualTerminalTaxAmount

>T</VirtualTerminalTaxAmount><VirtualTerminalTipAmount>T</VirtualTerminalTipAmount><CVN

oData>T</CVNoData><AVAddNotVerifiable>F</AVAddNotVerifiable><AVAddNotVerifiableGlobal&g

t;F</AVAddNotVerifiableGlobal><AVAddOnly>F</AVAddOnly><AVExactMatch>F</AVExactMatch&

gt;<AVInvalidAddZip>F</AVInvalidAddZip><AVIssuerUnavail>F</AVIssuerUnavail><AVNoData>

F</AVNoData><AVNoMatch>F</AVNoMatch><AVNotRequested>F</AVNotRequested><AVS

ervUnsupported>F</AVServUnsupported><AVUnregCode>T</AVUnregCode><AVVerUnavail>T&

lt;/AVVerUnavail><AVZipOnly>F</AVZipOnly></ws:ExtData>

</ws:UpdateMerchant>

</soapenv:Body>

</soapenv:Envelope>

Response Message:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<soap:Body>

<UpdateMerchantResponse xmlns="http://www.tpisoft.com/Admin/ws">




<UpdateMerchantResult>

<code>OK</code>

<error>Merchant was successfully updated!</error>

<Partner>130</Partner>

<Vendor>17282</Vendor>

<Username/>

</UpdateMerchantResult>

</UpdateMerchantResponse>

</soap:Body>

</soap:Envelope>

Hyperlink to UpdateMerchant Web Service details

DeleteMerchant

Hyperlink to DeleteMerchant Web Service details




<soapenv:Header/>

<soapenv:Body>

<ws:DeleteMerchant>





</ws:DeleteMerchant>

</soapenv:Body>

</soapenv:Envelope>

Response Message:



<soap:Body>

<DeleteMerchantResponse xmlns="http://www.tpisoft.com/Admin/ws">

<DeleteMerchantResult>

<code>OK</code>

<error>Merchant 17282 deleted.</error>



<Username/>

</DeleteMerchantResult>

</DeleteMerchantResponse>

</soap:Body>

</soap:Envelope>

Hyperlink to DeleteMerchant Web Service details

InfoMerchant

Hyperlink to InfoMerchant Web Service details







<soapenv:Header/>

<soapenv:Body>

<ws:InfoMerchant>



<ws:VendorKey>17282</ws:VendorKey>

</ws:InfoMerchant>

</soapenv:Body>

</soapenv:Envelope>

Response Message:

<MerchantResult xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-

instance" xmlns="http://www.tpisoft.com/Admin/ws">

<code>OK</code>

<ResellerKey>130</ResellerKey>

<MerchantID>Test Merchant</MerchantID>

<MerchantID2>Test Merchant ID2</MerchantID2>

<AnnualSales>0.00</AnnualSales>

<BusinessStartDate>1/1/0001</BusinessStartDate>

<CompanyName>Test Merchant</CompanyName>

<DoingBusinessAs>Test Merchant</DoingBusinessAs>

<Url/>

<FederalTaxID/>

<StateTaxID/>

<SalesTaxID/>

<OwnershipType>Corporation</OwnershipType>

<AutoCloseBatch>T</AutoCloseBatch>

<AutoCloseBatchHour>22</AutoCloseBatchHour>

<ForceDuplicate>T</ForceDuplicate>

<RequirePNRef>T</RequirePNRef>

<ContactFirstName>John</ContactFirstName>

<ContactLastName>Doe</ContactLastName>

<ContactPostalCode>20151</ContactPostalCode>

<ContactSate>VA</ContactSate>

<ContactCity>Chantilly</ContactCity>

<ContactStreet2>Suite 100</ContactStreet2>

<ContactStreet1>123 East Main</ContactStreet1>

<ContactFax/>

<ContactDayPhone>703-481-7000</ContactDayPhone>

<ContactEmail>[email protected]</ContactEmail>

<ContactCountryCode>USA</ContactCountryCode>

<TimeZoneOffset>-300</TimeZoneOffset>

<PaymentMethodXml/>

<RegistersXml>

<Registers><Register><RegisterName>Lane1</RegisterName><RegisterNum>1</RegisterNum></Register></Registers>

</RegistersXml>

<ReadOnlyCardSafeCustomerID>True</ReadOnlyCardSafeCustomerID>

<ReadOnlyRecurringBillingContractID>True</ReadOnlyRecurringBillingContractID>

<ReadOnlyRecurringBillingCustomerID>True</ReadOnlyRecurringBillingCustomerID>

<BypassAvsCvvFiltersEnabled>False</BypassAvsCvvFiltersEnabled>

<ExtData>

<Merchant><Configuration><VirtualTerminalCreditAccess>F</VirtualTerminalCreditAccess><VirtualTerminalTipAmount>

F</VirtualTerminalTipAmount><VirtualTerminalLevel3Amount>F</VirtualTerminalLevel3Amount><VirtualTerminalTaxA

mount>F</VirtualTerminalTaxAmount><VirtualTerminalConvenienceAmount>F</VirtualTerminalConvenienceAmount><




VirtualTerminalDutyAmount>F</VirtualTerminalDutyAmount><AutoSettleMerchantEmail>F</AutoSettleMerchantEmail>

<InvoiceDuplicate>F</InvoiceDuplicate><VirtualTerminalCommercialCard>F</VirtualTerminalCommercialCard><VirtualT

erminalAllowRepeat>F</VirtualTerminalAllowRepeat><ImageCapture>F</ImageCapture><ReceiptCapture>F</ReceiptCa

pture><VirtualTerminalShippingAmount>F</VirtualTerminalShippingAmount><ReadOnlyRecurringBillingCustomerID>T<

/ReadOnlyRecurringBillingCustomerID><ReadOnlyRecurringBillingContractID>T</ReadOnlyRecurringBillingContractID><

ReadOnlyCardSafeCustomerID>T</ReadOnlyCardSafeCustomerID><EnableRecurringBillingSettings>F</EnableRecurring

BillingSettings><RecurringBillingSettings><ForceMaxFailure>F</ForceMaxFailure><ForceFailureInterval>F</ForceFailureI

nterval><ForceFailureRetryResultCode>F</ForceFailureRetryResultCode><ForceMaxBillingCycleRetry>F</ForceMaxBillin

gCycleRetry><MaxFailure>0</MaxFailure><FailureInterval>1</FailureInterval><FailureRetryResultCode></FailureRetryRe

sultCode><MaxBillingCycleRetry>0</MaxBillingCycleRetry></RecurringBillingSettings><BypassExpiredCardValidationFor

CreditCards>T</BypassExpiredCardValidationForCreditCards><CardVerification><AVAddNotVerifiable>T</AVAddNotVeri

fiable><AVInvalidAddZip>T</AVInvalidAddZip><AVZipOnly>T</AVZipOnly><AVNoMatch>T</AVNoMatch><AVIssuerUnav

ail>T</AVIssuerUnavail><AVVerUnavail>T</AVVerUnavail><AVAddOnly>T</AVAddOnly><AVNotRequested>T</AVNotReq

uested><AVUnregCode>T</AVUnregCode><AVServUnsupported>T</AVServUnsupported><AVExactMatch>T</AVExactM

atch><AVNoData>T</AVNoData><AVAddNotVerifiableGlobal>T</AVAddNotVerifiableGlobal><CVNotPresent>T</CVNotP

resent><CVNoData>T</CVNoData><CVNotProcessed>T</CVNotProcessed><CVNoDataFromIssuer>T</CVNoDataFromIs

suer><CVMatch>T</CVMatch><CVUnregCode>T</CVUnregCode><CVNoMatch>T</CVNoMatch><BypassAvsCvvFiltersEn

abled>F</BypassAvsCvvFiltersEnabled></CardVerification><DailyTransactionSummaryReport><EmailEnabled>F</EmailE

nabled><EmailTime>0</EmailTime></DailyTransactionSummaryReport><CAUEnabled>F</CAUEnabled><CAUMerchantS

enderId></CAUMerchantSenderId></Configuration><Access><DialIn>T</DialIn><BinManagementApi>T</BinManageme

ntApi></Access></Merchant>

</ExtData>

</MerchantResult>

Hyperlink to InfoMerchant Web Service details

AddUser

Hyperlink to AddUser Web Service details




<soapenv:Header/>

<soapenv:Body>

<ws:AddUser>

<ws:adminUserName>[Admin Username]</ws:adminUserName>

<ws:adminPassword>[Admin Password]</ws:adminPassword>

<ws:partner>130</ws:partner>

<ws:vendor>17282</ws:vendor>

<ws:username>NewUser</ws:username>

<ws:password>NewUser1</ws:password>

<ws:contactFirstName>Jane</ws:contactFirstName>

<ws:contactLastName>Doe</ws:contactLastName>

<ws:contactEmail>[email protected]</ws:contactEmail>

<ws:contactDayPhone>703-481-7000</ws:contactDayPhone>

<ws:contactFax></ws:contactFax>

<ws:contactStreet1>123 East Main</ws:contactStreet1>

<ws:contactStreet2>Suite 100</ws:contactStreet2>

<ws:contactCity>Chantilly</ws:contactCity>

<ws:contactState>VA</ws:contactState>

<ws:contactPostalCode>20151</ws:contactPostalCode>

<ws:contactCountryCode>USA</ws:contactCountryCode>

<ws:userSecurityLevel>3</ws:userSecurityLevel>

<ws:timeZoneOffset>300</ws:timeZoneOffset>

<ws:ExtData></ws:ExtData>

</ws:AddUser>




</soapenv:Body>

</soapenv:Envelope>

Response Message:



<soap:Body>

<AddUserResponse xmlns="http://www.tpisoft.com/Admin/ws">

<AddUserResult>

<code>OK</code>

<error>User is created successfully!</error>



<Username>NewUser</Username>

</AddUserResult>

</AddUserResponse>

</soap:Body>

</soap:Envelope>

Hyperlink to AddUser Web Service details

UpdateUser

Hyperlink to UpdateUser Web Service details




<soapenv:Header/>

<soapenv:Body>

<ws:UpdateUser>

<ws:Username>[Reseller Username]</ws:Username>

<ws:SecureToken>[Reseller Secure Token]</ws:SecureToken>


<ws:TargetUsername>NewUser</ws:TargetUsername>

<ws:FirstName>Jane</ws:FirstName>

<ws:LastName>Doe</ws:LastName>

<ws:Email>[email protected]</ws:Email>

<ws:Street1>123 East Main</ws:Street1>

<ws:Street2>Suite 100</ws:Street2>

<ws:City>Chantilly</ws:City>

<ws:State>VA</ws:State>

<ws:Zip>20151</ws:Zip>

<ws:Country>USA</ws:Country>

<ws:DayPhone>703-481-7000</ws:DayPhone>

<ws:Fax></ws:Fax>

<ws:Status>1</ws:Status>

<ws:UserSecurityLevel>4</ws:UserSecurityLevel>

<ws:SysSecurityLevel>1</ws:SysSecurityLevel>

<ws:MerchantGroupXml></ws:MerchantGroupXml>


</ws:UpdateUser>

</soapenv:Body>

</soapenv:Envelope>

Response Message:






<soap:Body>

<UpdateUserResponse xmlns="http://www.tpisoft.com/Admin/ws">

<UpdateUserResult>

<code>OK</code>

<error>OK</error>

</UpdateUserResult>

</UpdateUserResponse>

</soap:Body>

</soap:Envelope>

Hyperlink to UpdateUser Web Service details

InfoUser

Hyperlink to InfoUser Web Service details




<soapenv:Header/>

<soapenv:Body>

<ws:InfoUser>




<ws:TargetUsername>NewUser</ws:TargetUsername>


</ws:InfoUser>

</soapenv:Body>

</soapenv:Envelope>

Response Message:



<soap:Body>

<InfoUserResponse xmlns="http://www.tpisoft.com/Admin/ws">

<InfoUserResult>

<code>OK</code>

<error/>

<FirstName>Jane</FirstName>

<LastName>Doe</LastName>

<Email>[email protected]</Email>

<Street1>123 East Main</Street1>

<Street2>Suite 100</Street2>

<City>Chantilly</City>

<State>VA</State>

<Country>USA</Country>

<DayPhone>703-481-7000</DayPhone>

<Fax/>

<Status>1</Status>

<UserSecurityLevel>4</UserSecurityLevel>

<SysSecurityLevel>1</SysSecurityLevel>

<MerchantGroupXml><MerchantGroup><MerchantKey>4</MerchantKey></MerchantGroup></MerchantGro

upXml>

</InfoUserResult>




</InfoUserResponse>

</soap:Body>

</soap:Envelope>

Hyperlink to InfoUser Web Service details

InfoCustomer

Hyperlink to InfoCustomer Web Service details




<soapenv:Header/>

<soapenv:Body>

<ws:InfoCustomer>



<ws:CustomerKey>1634355</ws:CustomerKey>


</ws:InfoCustomer>

</soapenv:Body>

</soapenv:Envelope>

Response Message:



<soap:Body>

<InfoCustomerResponse xmlns="http://www.tpisoft.com/Admin/ws">

<InfoCustomerResult>

<code>OK</code>




<Department/>


<Fax/>

<FirstName>Jack</FirstName>


<Mobile/>

<NightPhone/>

<State>VA</State>



<Street3/>

<Title/>

<Zip>20151</Zip>

<PaymentMethods><PaymentMethod><CcType>MASTERCARD</CcType><CcZip>20151</CcZip

><CcStreet>123 East Main</CcStreet><CcNameonCard>Jack

Doe</CcNameonCard><CcExpDate>1220</CcExpDate><CcAccountNum>************5454</C

cAccountNum><CardInfoKey>20039926</CardInfoKey></PaymentMethod></PaymentMethods>

</InfoCustomerResult>

</InfoCustomerResponse>

</soap:Body>

</soap:Envelope>

Hyperlink to InfoCustomer Web Service details




InfoContract

Hyperlink to InfoContract Web Service details




<soapenv:Header/>

<soapenv:Body>

<ws:InfoContract>





</ws:InfoContract>

</soapenv:Body>

</soapenv:Envelope>

Response Message:



<soap:Body>

<InfoContractResponse xmlns="http://www.tpisoft.com/Admin/ws">

<InfoContractResult>

<code>OK</code>




<Department/>


<Fax/>

<FirstName>Jack</FirstName>


<Mobile/>

<NightPhone/>

<State>VA</State>



<Street3/>

<Title/>

<Zip>20151</Zip>

<Contracts/>

</InfoContractResult>

</InfoContractResponse>

</soap:Body>

</soap:Envelope>

Hyperlink to InfoContract Web Service details

GetAPIUser

Hyperlink to GetAPIUser Web Service details







<soapenv:Header/>

<soapenv:Body>

<ws:GetAPIUser>

<ws:userName>[Merchant Username]</ws:userName>

<ws:secureToken>[Merchant Secure Token]</ws:secureToken>

<ws:merchantKey>17282</ws:merchantKey>

</ws:GetAPIUser>

</soapenv:Body>

</soapenv:Envelope>

Response Message:



<soap:Body>

<GetAPIUserResponse xmlns="http://www.tpisoft.com/Admin/ws">

<GetAPIUserResult>

<UserName>NewAPIUser</UserName>

<Password>pG7m8x4JGMnedPzntqtxjaiOYmS7Q2p3yAkwXBzHYESW1i71qZ8rcNlUiLKvLC3K</Password>

<SecurePassword/>

<Domain>17282</Domain>

</GetAPIUserResult>

</GetAPIUserResponse>

</soap:Body>

</soap:Envelope>

Hyperlink to GetAPIUser Web Service details

Login

Hyperlink to Login Web Service details




<soapenv:Header/>

<soapenv:Body>

<ws:Login>

<ws:Username>[Username]</ws:Username>

<ws:Password>{Password]</ws:Password>

</ws:Login>

</soapenv:Body>

</soapenv:Envelope>

Response Message:



<soap:Body>

<LoginResponse xmlns="http://www.tpisoft.com/Admin/ws">

<LoginResult>

<code>OK</code>

<error>Login Successful</error>

</LoginResult>

</LoginResponse>

</soap:Body>

</soap:Envelope>




Hyperlink to Login Web Service details

Transact Web Service Examples

GetInfo

Hyperlink to GetInfo Web Service details



xmlns:ws="http://TPISoft.com/SmartPayments/">

<soapenv:Header/>

<soapenv:Body>

<ws:GetInfo>

<ws:UserName>[API Username]</ws:UserName>

<ws:Password>[API Password]</ws:Password>

<ws:TransType>StatusCheck</ws:TransType>

<ws:ExtData/>

</ws:GetInfo>

</soapenv:Body>

</soapenv:Envelope>

Response Message:



<soap:Body>

<GetInfoResponse xmlns="http://TPISoft.com/SmartPayments/">

<GetInfoResult>

<Result>0</Result>

<RespMSG>Approved</RespMSG>

<Message/>

<Message1/>

<Message2/>

<AuthCode/>

<PNRef/>

<HostCode/>

<HostURL/>

<GetGetOrigResult/>

<ExtData>OK</ExtData>

</GetInfoResult>

</GetInfoResponse>

</soap:Body>

</soap:Envelope>

Hyperlink to GetInfo Web Service details

ProcessCash

Hyperlink to ProcessCash Web Service details



xmlns:smar="http://TPISoft.com/SmartPayments/">

<soapenv:Header/>

<soapenv:Body>




<ws:ProcessCash>



<ws:TransType>Sale</ws:TransType>

<ws:Amount>1</ws:Amount>

<ws:InvNum></ws:InvNum>

<ws:PNRef></ws:PNRef>

<ws:RegisterNum></ws:RegisterNum>


</ws:ProcessCash>

</soapenv:Body>

</soapenv:Envelope>

Response Message:



<soap:Body>

<ProcessCashResponse xmlns="http://TPISoft.com/SmartPayments/">

<ProcessCashResult>

<Result>0</Result>

<Message>CAPTURED</Message>

<AuthCode>CH3437</AuthCode>

<PNRef>23023437</PNRef>

</ProcessCashResult>

</ProcessCashResponse>

</soap:Body>

</soap:Envelope>

Hyperlink to ProcessCash Web Service details

ProcessCheck

Hyperlink to ProcessCheck Web Service details




<soapenv:Header/>

<soapenv:Body>

<ws:ProcessCheck>




<ws:CheckNum>0002</ws:CheckNum>

<ws:TransitNum>111111118</ws:TransitNum>

<ws:AccountNum>123457890</ws:AccountNum>

<ws:Amount>1.00</ws:Amount>

<ws:NameOnCheck>Test Check</ws:NameOnCheck>

<ws:StateCode>VA</ws:StateCode>

<ws:CheckType>Personal</ws:CheckType>

<ws:ExtData><AccountType>Savings</AccountType><SECCType>WEB</SECCType><BillToStreet

>3901 Centerview

Drive</BillToStreet><BillToCity>Chantilly</BillToCity><BillToPostalCode>20151</BillToPostalCod

e><Phone>703-481-

7000</Phone><AuthOptionForm>SinglePaymentSeries</AuthOptionForm></ws:ExtData>

</ws:ProcessCheck>




</soapenv:Body>

</soapenv:Envelope>

Response Message:



<soap:Body>

<ProcessCheckResponse xmlns="http://TPISoft.com/SmartPayments/">

<ProcessCheckResult>

<Result>0</Result>

<Message>SUCCESS. The Payment was created successfully</Message>

<Message2>Success</Message2>

<AuthCode>1826409</AuthCode>


<HostCode>1826409</HostCode>

</ProcessCheckResult>

</ProcessCheckResponse>

</soap:Body>

</soap:Envelope>


ProcessCreditCard

Hyperlink to ProcessCreditCard Web Service details




<soapenv:Header/>

<soapenv:Body>

<ws:ProcessCreditCard>




<ws:CardNum>5454545454545454</ws:CardNum>

<ws:ExpDate>1225</ws:ExpDate>

<ws:MagData>;5454545454545454=25122010123409172000?</ws:MagData>

<ws:NameOnCard/>


<ws:InvNum/>

<ws:PNRef/>

<ws:Zip/>

<ws:Street/>

<ws:CVNum/>

<ws:ExtData><EntryMode>MagneticStripe</EntryMode></ws:ExtData>

</ws:ProcessCreditCard>

</soapenv:Body>

</soapenv:Envelope>

Response Message:



<soap:Body>




<ProcessCreditCardResponse xmlns="http://TPISoft.com/SmartPayments/">

<ProcessCreditCardResult>

<Result>0</Result>


<Message>APPROVED</Message>

<Message1/>

<Message2/>




<HostURL/>

<GetGetOrigResult/>

<GetCommercialCard>False</GetCommercialCard>

<ExtData>CardType=MASTERCARD,BatchNum=000000,BatchNum=000000<BatchNum>000000</BatchNum></Ext

Data>

</ProcessCreditCardResult>

</ProcessCreditCardResponse>

</soap:Body>

</soap:Envelope>


ProcessDebitCard

Hyperlink to ProcessDebitCard Web Service details

SOAP Request Message: TBA

Response Message: TBA

Cardsafe Web Service Examples

StoreCard

Hyperlink to StoreCard Web Service details


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://pmn.payment-

gate.net/ws/">

<soapenv:Header/>

<soapenv:Body>

<ws:StoreCard>



<ws:TokenMode>DEFAULT</ws:TokenMode>

<ws:CardNum>5454545454545454</ws:CardNum>



<ws:NameOnCard>John Doe</ws:NameOnCard>

<ws:Street></ws:Street>

<ws:Zip></ws:Zip>


</ws:StoreCard>

</soapenv:Body>

</soapenv:Envelope>




Response Message:



<soap:Body>

<StoreCardResponse xmlns="http://pmn.payment-gate.net/ws/">

<StoreCardResult>

<Result>0</Result>

<RespMSG>Token generated successfully</RespMSG>

<AuthCode/>

<ExtData><CardSafeToken> 19927618</CardSafeToken></ExtData>

</StoreCardResult>

</StoreCardResponse>

</soap:Body>

</soap:Envelope>

ProcessCreditCard



<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://pmn.payment-

gate.net/ws/">

<soapenv:Header/>

<soapenv:Body>

<ws:ProcessCreditCard>




<ws:CardToken>19927618</ws:CardToken>

<ws:TokenMode>DEFAULT</ws:TokenMode>


<ws:InvNum></ws:InvNum>

<ws:PNRef></ws:PNRef>

<ws:ExtData><CVNum>123</CVNum></ws:ExtData>

</ws:ProcessCreditCard>

</soapenv:Body>

</soapenv:Envelope>

Response Message:



<soap:Body>

<ProcessCreditCardResponse xmlns="http://pmn.payment-gate.net/ws/">

<ProcessCreditCardResult>

<Result>0</Result>


<Message>APPROVED</Message>

<Message1/>

<Message2/>







<HostURL/>

<GetCVResult>N</GetCVResult>

<GetCVResultTXT>No Match</GetCVResultTXT>

<GetGetOrigResult/>

<GetCommercialCard>False</GetCommercialCard>

<ExtData>CardType=MASTERCARD,BatchNum=000000,BatchNum=000000<BatchNum>000000</BatchNum&g

t;<CardType>MASTERCARD</CardType><LastFour>5454</LastFour><ExpDate>1220</Exp

Date></ExtData>

</ProcessCreditCardResult>

</ProcessCreditCardResponse>

</soap:Body>

</soap:Envelope>

Recurring Web Service Examples

ManageCustomer (ADD)

Hyperlink to ManageCustomer Web Service details




<soapenv:Header/>

<soapenv:Body>

<ws:ManageCustomer>



<ws:TransType>ADD</ws:TransType>

<ws:Vendor>17198</ws:Vendor>

<ws:CustomerKey></ws:CustomerKey>

<ws:CustomerID>0003</ws:CustomerID>

<ws:CustomerName>ApiTes2t</ws:CustomerName>

<ws:FirstName>Api</ws:FirstName>

<ws:LastName>Test2</ws:LastName>

<ws:Title></ws:Title>

<ws:Department></ws:Department>

<ws:Street1></ws:Street1>



<ws:City></ws:City>

<ws:StateID></ws:StateID>

<ws:Province></ws:Province>

<ws:Zip></ws:Zip>

<ws:CountryID></ws:CountryID>

<ws:Email></ws:Email>

<ws:DayPhone></ws:DayPhone>

<ws:NightPhone></ws:NightPhone>

<ws:Fax></ws:Fax>

<ws:Mobile></ws:Mobile>

<ws:Status></ws:Status>


</ws:ManageCustomer>

</soapenv:Body>

</soapenv:Envelope>

Response Message:






<soap:Body>

<ManageCustomerResponse xmlns="http://www.tpisoft.com/Admin/ws">

<ManageCustomerResult>

<CustomerKey>1672974</CustomerKey>

<code>OK</code>

<error>OK</error>

<Partner/>


<Username>gate9376</Username>

</ManageCustomerResult>

</ManageCustomerResponse>

</soap:Body>

</soap:Envelope>

ManageCustomer (UPDATE)





<soapenv:Header/>

<soapenv:Body>

<ws:ManageCustomer>



<ws:TransType>UPDATE</ws:TransType>



<ws:CustomerID>0003</ws:CustomerID>

<ws:CustomerName>ApiTes2t</ws:CustomerName>

<ws:FirstName>Api</ws:FirstName>

<ws:LastName>Test2</ws:LastName>



<ws:Street1>123 East Main Street</ws:Street1>




<ws:StateID>VA</ws:StateID>


<ws:Zip>20151</ws:Zip>





<ws:Fax></ws:Fax>





</soapenv:Body>

</soapenv:Envelope>




Response Message:



<soap:Body>




<code>OK</code>

<error>OK</error>

<Partner/>





</soap:Body>

</soap:Envelope>

ManageCustomer (DELETE)





<soapenv:Header/>

<soapenv:Body>

<ws:ManageCustomer>



<ws:TransType>DELETE</ws:TransType>





</soapenv:Body>

</soapenv:Envelope>

Response Message:



<soap:Body>




<code>OK</code>

<error>OK</error>

<Partner/>





</soap:Body>

</soap:Envelope>




ManageCheckInfo (ADD)

Hyperlink to ManageCheckInfo Web Service details




<soapenv:Header/>

<soapenv:Body>

<ws:ManageCheckInfo>






<ws:CheckInfoKey></ws:CheckInfoKey>

<ws:CheckType>PERSONAL</ws:CheckType>

<ws:AccountType>CHECKING</ws:AccountType>

<ws:CheckNum></ws:CheckNum>

<ws:MICR></ws:MICR>



<ws:RawMICR></ws:RawMICR>

<ws:SS></ws:SS>

<ws:DOB></ws:DOB>

<ws:BranchCity></ws:BranchCity>

<ws:DL></ws:DL>

<ws:StateCode></ws:StateCode>

<ws:NameOnCheck></ws:NameOnCheck>






<ws:City></ws:City>



<ws:PostalCode></ws:PostalCode>


<ws:ExtData><SECCType>CCD</SECCType><AuthOptionForm>UntilRevoked</AuthOptionForm></

ws:ExtData>

</ws:ManageCheckInfo>

</soapenv:Body>

</soapenv:Envelope>

Response Message:



<soap:Body>

<ManageCheckInfoResponse xmlns="http://www.tpisoft.com/Admin/ws">

<ManageCheckInfoResult>


<ContractKey/>

<CcInfoKey/>




<CheckInfoKey>2928</CheckInfoKey>

<code>OK</code>

<error>OK</error>




</ManageCheckInfoResult>

</ManageCheckInfoResponse>

</soap:Body>

</soap:Envelope>

ManageCheckInfo (UPDATE)





<soapenv:Header/>

<soapenv:Body>







<ws:CheckInfoKey>2928</ws:CheckInfoKey>

<ws:CheckType>PERSONAL</ws:CheckType>

<ws:AccountType>CHECKING</ws:AccountType>

<ws:CheckNum>1</ws:CheckNum>

<ws:MICR></ws:MICR>



<ws:RawMICR></ws:RawMICR>

<ws:SS>999-99-9999</ws:SS>

<ws:DOB>01/01/1963</ws:DOB>

<ws:BranchCity></ws:BranchCity>

<ws:DL>123456789</ws:DL>

<ws:StateCode>VA</ws:StateCode>

<ws:NameOnCheck>Jack Doe</ws:NameOnCheck>



<ws:Street1>123 East Main Street</ws:Street1>




<ws:StateID>VA</ws:StateID>


<ws:PostalCode>20151</ws:PostalCode>


<ws:ExtData><SECCType>CCD</SECCType><AuthOptionForm>UntilRevoked</AuthOptionForm></

ws:ExtData>


</soapenv:Body>

</soapenv:Envelope>




Response Message:



<soap:Body>




<ContractKey/>

<CcInfoKey/>


<code>OK</code>

<error>OK</error>






</soap:Body>

</soap:Envelope>

ManageCheckInfo (DELETE)





<soapenv:Header/>

<soapenv:Body>







<ws:CheckInfoKey>2929</ws:CheckInfoKey>



</soapenv:Body>

</soapenv:Envelope>

Response Message:



<soap:Body>




<ContractKey/>

<CcInfoKey/>


<code>OK</code>

<error>OK</error>









</soap:Body>

</soap:Envelope>

ManageCreditCardInfo (ADD)

Hyperlink to ManageCreditCardInfo Web Service details




<soapenv:Header/>

<soapenv:Body>

<ws:ManageCreditCardInfo>






<ws:CardInfoKey></ws:CardInfoKey>

<ws:CcAccountNum>5454545454545454</ws:CcAccountNum>

<ws:CcExpDate>1220</ws:CcExpDate>

<ws:CcNameOnCard></ws:CcNameOnCard>

<ws:CcStreet></ws:CcStreet>

<ws:CcZip></ws:CcZip>


</ws:ManageCreditCardInfo>

</soapenv:Body>

</soapenv:Envelope>

Response Message:



<soap:Body>

<ManageCreditCardInfoResponse xmlns="http://www.tpisoft.com/Admin/ws">

<ManageCreditCardInfoResult>


<ContractKey/>

<CcInfoKey>20281232</CcInfoKey>

<CheckInfoKey/>

<code>OK</code>

<error>OK</error>




</ManageCreditCardInfoResult>

</ManageCreditCardInfoResponse>

</soap:Body>

</soap:Envelope>




ManageCreditCardInfo (UPDATE)





<soapenv:Header/>

<soapenv:Body>







<ws:CardInfoKey>20281232</ws:CardInfoKey>

<ws:CcAccountNum>5454545454545454</ws:CcAccountNum>

<ws:CcExpDate>1220</ws:CcExpDate>

<ws:CcNameOnCard>Jack Doe</ws:CcNameOnCard>

<ws:CcStreet>123 East Main Street</ws:CcStreet>

<ws:CcZip>20151</ws:CcZip>



</soapenv:Body>

</soapenv:Envelope>

Response Message:



<soap:Body>




<ContractKey/>


<CheckInfoKey/>

<code>OK</code>

<error>OK</error>






</soap:Body>

</soap:Envelope>

ManageCreditCardInfo (DELETE)





<soapenv:Header/>




<soapenv:Body>







<ws:CardInfoKey>20281325</ws:CardInfoKey>



</soapenv:Body>

</soapenv:Envelope>

Response Message:



<soap:Body>




<ContractKey/>


<CheckInfoKey/>

<code>OK</code>

<error>OK</error>






</soap:Body>

</soap:Envelope>

UpdateContractSettings

Hyperlink to UpdateContractSettings Web Service details




<soapenv:Header/>

<soapenv:Body>

<ws:UpdateContractSettings>




<ws:MaxFailures>2</ws:MaxFailures>

<ws:FailureInterval>1</ws:FailureInterval>

<ws:ExtData><Contract><Configuration><FailureRetryResultCode><RC>12</RC><RC>13

</RC></FailureRetryResultCode><MaxBillingCycleRetry>1</MaxBillingCycleRetry><RecurringBilli

ngSettings><ForceMaxFailure>True</ForceMaxFailure><ForceFailureInterval>True</ForceFailureInt

erval><ForceFailureRetryResultCode>True</ForceFailureRetryResultCode><ForceMaxBillingCycleRetry&

gt;True</ForceMaxBillingCycleRetry></RecurringBillingSettings></Configuration></Contract></ws:E

xtData>

</ws:UpdateContractSettings>




</soapenv:Body>

</soapenv:Envelope>

Response Message:



<soap:Body>

<UpdateContractSettingsResponse xmlns="http://www.tpisoft.com/Admin/ws">

<UpdateContractSettingsResult>

<CustomerKey/>

<ContractKey/>

<CcInfoKey/>

<CheckInfoKey/>

<code>OK</code>

<error>OK</error>

<Partner/>



<Message>Merchant recurring billing setting(s) and all of the existing contracts have been Updated.</Message>

</UpdateContractSettingsResult>

</UpdateContractSettingsResponse>

</soap:Body>

</soap:Envelope>

ManageContract (Check ADD)

Hyperlink to ManageContract Web Service details




<soapenv:Header/>

<soapenv:Body>

<ws:ManageContract>






<ws:ContractKey></ws:ContractKey>

<ws:PaymentInfoKey>2928</ws:PaymentInfoKey>

<ws:PaymentType>CK</ws:PaymentType>

<ws:CustomerID></ws:CustomerID>

<ws:CustomerName></ws:CustomerName>

<ws:FirstName></ws:FirstName>

<ws:LastName></ws:LastName>






<ws:City></ws:City>






<ws:Zip></ws:Zip>





<ws:Fax></ws:Fax>


<ws:ContractID>1203</ws:ContractID>

<ws:ContractName>ApiTest3 CK Contract</ws:ContractName>

<ws:BillAmt>5</ws:BillAmt>

<ws:TaxAmt>0</ws:TaxAmt>

<ws:TotalAmt>100</ws:TotalAmt>

<ws:StartDate>11/08/2016</ws:StartDate>

<ws:EndDate>03/08/2017</ws:EndDate>

<ws:NextBillDt>11/08/2016</ws:NextBillDt>

<ws:BillingPeriod>WEEK</ws:BillingPeriod>

<ws:BillingInterval>1</ws:BillingInterval>

<ws:MaxFailures></ws:MaxFailures>

<ws:FailureInterval></ws:FailureInterval>

<ws:EmailCustomer></ws:EmailCustomer>

<ws:EmailMerchant></ws:EmailMerchant>

<ws:EmailCustomerFailure></ws:EmailCustomerFailure>

<ws:EmailMerchantFailure></ws:EmailMerchantFailure>



</ws:ManageContract>

</soapenv:Body>

</soapenv:Envelope>

Response Message:



<soap:Body>

<ManageContractResponse xmlns="http://www.tpisoft.com/Admin/ws">

<ManageContractResult>


<ContractKey>56668</ContractKey>

<CcInfoKey/>


<code>OK</code>

<error>OK</error>




<Message>Merchant has enabled Force Recurring Billing Settings option. Default recurring settings are applied to the

contract.</Message>

</ManageContractResult>

</ManageContractResponse>

</soap:Body>

</soap:Envelope>

ManageContract (Check UPDATE)








<soapenv:Header/>

<soapenv:Body>

<ws:ManageContract>






<ws:ContractKey>56668</ws:ContractKey>












<ws:City></ws:City>



<ws:Zip></ws:Zip>





<ws:Fax></ws:Fax>



<ws:ContractName>ApiTest3 CK Contract</ws:ContractName>







<ws:BillingPeriod>WEEK</ws:BillingPeriod>




<ws:EmailCustomer>True</ws:EmailCustomer>

<ws:EmailMerchant>True</ws:EmailMerchant>

<ws:EmailCustomerFailure>True</ws:EmailCustomerFailure>

<ws:EmailMerchantFailure>True</ws:EmailMerchantFailure>




</soapenv:Body>

</soapenv:Envelope>

Response Message:






<soap:Body>





<CcInfoKey/>


<code>OK</code>

<error>OK</error>





contract.</Message>



</soap:Body>

</soap:Envelope>

ManageContract (Check DELETE)





<soapenv:Header/>

<soapenv:Body>

<ws:ManageContract>












</soapenv:Body>

</soapenv:Envelope>

Response Message:



<soap:Body>





<CcInfoKey/>

<CheckInfoKey>-1</CheckInfoKey>




<code>OK</code>

<error>OK</error>





contract.</Message>



</soap:Body>

</soap:Envelope>

ManageContract (CreditCard ADD)





<soapenv:Header/>

<soapenv:Body>

<ws:ManageContract>






<ws:ContractKey></ws:ContractKey>


<ws:PaymentType>CC</ws:PaymentType>










<ws:City></ws:City>



<ws:Zip></ws:Zip>





<ws:Fax></ws:Fax>



<ws:ContractName>ApiTest3 CC Contract</ws:ContractName>










<ws:BillingPeriod>DAY</ws:BillingPeriod>




<ws:EmailCustomer></ws:EmailCustomer>

<ws:EmailMerchant></ws:EmailMerchant>

<ws:EmailCustomerFailure></ws:EmailCustomerFailure>

<ws:EmailMerchantFailure></ws:EmailMerchantFailure>




</soapenv:Body>

</soapenv:Envelope>

Response Message:



<soap:Body>






<CheckInfoKey/>

<code>OK</code>

<error>OK</error>





contract.</Message>



</soap:Body>

</soap:Envelope>

ManageContract (CreditCard UPDATE)





<soapenv:Header/>

<soapenv:Body>

<ws:ManageContract>





















<ws:City></ws:City>



<ws:Zip></ws:Zip>





<ws:Fax></ws:Fax>



<ws:ContractName>ApiTest3 CC Contract</ws:ContractName>







<ws:BillingPeriod>DAY</ws:BillingPeriod>




<ws:EmailCustomer>True</ws:EmailCustomer>

<ws:EmailMerchant>True</ws:EmailMerchant>

<ws:EmailCustomerFailure>True</ws:EmailCustomerFailure>

<ws:EmailMerchantFailure>True</ws:EmailMerchantFailure>




</soapenv:Body>

</soapenv:Envelope>

Response Message:



<soap:Body>






<CheckInfoKey/>

<code>OK</code>

<error>OK</error>








contract.</Message>



</soap:Body>

</soap:Envelope>

ManageContract (CreditCard DELETE)





<soapenv:Header/>

<soapenv:Body>

<ws:ManageContract>












</soapenv:Body>

</soapenv:Envelope>

Response Message:



<soap:Body>





<CcInfoKey>-1</CcInfoKey>

<CheckInfoKey/>

<code>OK</code>

<error>OK</error>





contract.</Message>



</soap:Body>

</soap:Envelope>





Hyperlink to ManageContractAddDaysToNextBillDt Web Service details


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://www.tpisoft.com/Admin/ws"> <soapenv:Header/> <soapenv:Body> <ws:ManageContractAddDaysToNextBillDt> <ws:UserName>[API Username]</ws:UserName>


<ws:Vendor>17198</ws:Vendor> <ws:CustomerKey>1673117</ws:CustomerKey> <ws:ContractKey>56667</ws:ContractKey> <ws:NumOfDays>10</ws:NumOfDays> <ws:ExtData></ws:ExtData> </ws:ManageContractAddDaysToNextBillDt> </soapenv:Body> </soapenv:Envelope>

Response Message:



<soap:Body>

<ManageContractAddDaysToNextBillDtResponse xmlns="http://www.tpisoft.com/Admin/ws">

<ManageContractAddDaysToNextBillDtResult>



<CcInfoKey/>

<CheckInfoKey/>

<code>OK</code>

<error>NextBillDate=11/18/2016</error>

<Partner/>

<Vendor/>


</ManageContractAddDaysToNextBillDtResult>

</ManageContractAddDaysToNextBillDtResponse>

</soap:Body>

</soap:Envelope>

ProcessCheck



<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://www.tpisoft.com/Admin/ws"> <soapenv:Header/> <soapenv:Body> <ws:ProcessCheck> <ws:UserName>[API Username]</ws:UserName>


<ws:Vendor>17198</ws:Vendor> <ws:CheckInfoKey>2928</ws:CheckInfoKey>




<ws:Amount>5.00</ws:Amount> <ws:InvNum></ws:InvNum>

<ws:ExtData><Frequency>Once</Frequency><NumberOfPayments>1</NumberOfPayments></ws:ExtData>

</ws:ProcessCheck> </soapenv:Body> </soapenv:Envelope>

Response Message:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <ProcessCheckResponse xmlns="http://www.tpisoft.com/Admin/ws"> <ProcessCheckResult> <code>OK</code> <error>APPROVED</error> <Result>0</Result> <AuthCode>1826444</AuthCode> <PNRef>23240648</PNRef> <Message>SUCCESS. The Payment was created successfully. This payment is an AP DUP</Message> </ProcessCheckResult> </ProcessCheckResponse> </soap:Body> </soap:Envelope>

ProcessCreditCard



<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://www.tpisoft.com/Admin/ws"> <soapenv:Header/> <soapenv:Body> <ws:ProcessCreditCard> <ws:UserName>[API Username]</ws:UserName>


<ws:Vendor>17198</ws:Vendor> <ws:CcInfoKey>20281232</ws:CcInfoKey> <ws:Amount>5.00</ws:Amount> <ws:InvNum></ws:InvNum> <ws:ExtData></ws:ExtData> </ws:ProcessCreditCard> </soapenv:Body> </soapenv:Envelope>

Response Message:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <ProcessCreditCardResponse xmlns="http://www.tpisoft.com/Admin/ws"> <ProcessCreditCardResult> <code>OK</code> <error>APPROVED</error>




<Result>0</Result> <AuthCode>198806</AuthCode> <PNRef>23240746</PNRef> <Message>APPROVED</Message>

<ExtData><CardType>MASTERCARD</CardType><LastFour>5454</LastFour><ExpDate>1220</ExpDate></ExtData>

</ProcessCreditCardResult> </ProcessCreditCardResponse> </soap:Body> </soap:Envelope>

TrnDetail Web Service Examples

GetCardTrx

Hyperlink to GetCardTrx Web Service details


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://www.namespaceuri.com/Admin/ws"> <soapenv:Header/> <soapenv:Body> <ws:GetCardTrx> <ws:UserName>[API Username]</ws:UserName>


<ws:RPNum>17198</ws:RPNum> <ws:PNRef></ws:PNRef> <ws:BeginDt>11/07/2016</ws:BeginDt> <ws:EndDt>11/07/2016</ws:EndDt> <ws:PaymentType></ws:PaymentType> <ws:ExcludePaymentType></ws:ExcludePaymentType> <ws:TransType></ws:TransType> <ws:ExcludeTransType></ws:ExcludeTransType> <ws:ApprovalCode></ws:ApprovalCode> <ws:Result></ws:Result> <ws:ExcludeResult></ws:ExcludeResult> <ws:NameOnCard></ws:NameOnCard> <ws:CardNum></ws:CardNum> <ws:CardType></ws:CardType> <ws:ExcludeCardType></ws:ExcludeCardType> <ws:ExcludeVoid>True</ws:ExcludeVoid> <ws:User></ws:User> <ws:invoiceId></ws:invoiceId> <ws:SettleFlag></ws:SettleFlag> <ws:SettleMsg></ws:SettleMsg> <ws:SettleDt></ws:SettleDt> <ws:TransformType></ws:TransformType> <ws:Xsl></ws:Xsl> <ws:ColDelim></ws:ColDelim> <ws:RowDelim></ws:RowDelim> <ws:IncludeHeader></ws:IncludeHeader> <ws:ExtData></ws:ExtData> </ws:GetCardTrx> </soapenv:Body> </soapenv:Envelope>




Response Message:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <GetCardTrxResponse xmlns="http://www.namespaceuri.com/Admin/ws"> <GetCardTrxResult><RichDBDS> <TrxDetailCard> <TRX_HD_Key>23240746</TRX_HD_Key> <Date_DT>2016-11-07T18:56:24+00:00</Date_DT> <Merchant_Key>17198</Merchant_Key> <User_Name_VC>gate9376 </User_Name_VC> <Reseller_Key>130</Reseller_Key> <Payment_Type_ID>MASTERCARD</Payment_Type_ID> <Trans_Type_ID>RepeatSale </Trans_Type_ID> <Processor_ID>PayTampa </Processor_ID> <TRX_Settle_Key>19815826</TRX_Settle_Key> <Void_Flag_CH>0</Void_Flag_CH> <Settle_Flag_CH>0</Settle_Flag_CH> <Last_Update_DT>2016-11-07T18:56:24.64+00:00</Last_Update_DT> <TRX_Card_Key>19711753</TRX_Card_Key> <Card_Info_Key>20284612</Card_Info_Key> <Auth_Amt_MN>5.0000</Auth_Amt_MN> <Tip_Amt_MN>0.0000</Tip_Amt_MN> <Total_Amt_MN>5.0000</Total_Amt_MN> <Cash_Back_Amt_MN>0.0000</Cash_Back_Amt_MN> <SureCharge_Amt_MN>0.0000</SureCharge_Amt_MN> <Account_Type_CH>MASTERCARD</Account_Type_CH> <Result_CH>0 </Result_CH> <Result_Txt_VC>APPROVED</Result_Txt_VC> <Approval_Code_CH>198806</Approval_Code_CH> <Host_Ref_Num_CH>00000000</Host_Ref_Num_CH> <AVS_Resp_CH>Z</AVS_Resp_CH> <Host_Date_CH>110716 </Host_Date_CH> <Host_Time_CH>065625 </Host_Time_CH> <Acct_Num_CH>************5454</Acct_Num_CH> <Exp_CH>1220 </Exp_CH> <Type_CH>MASTERCARD</Type_CH> <Name_on_Card_VC>Jack Doe </Name_on_Card_VC> <Street_CH>123 East Main Street </Street_CH> <Zip_CH>20151 </Zip_CH> <Manual>true</Manual> <TRX_Receipt_key>0</TRX_Receipt_key> <IP_VC>172.19.0.5</IP_VC> <Batch_Number>0</Batch_Number> <Level3_Amt_MN>0.0000</Level3_Amt_MN> <TRX_Receipt_Cnt>0</TRX_Receipt_Cnt> <Auth_Date_DT>2016-11-07T18:56:24+00:00</Auth_Date_DT> <Reversal_Flag_CH>0</Reversal_Flag_CH> </TrxDetailCard> </RichDBDS></GetCardTrxResult> </GetCardTrxResponse> </soap:Body> </soap:Envelope>

GetCardTrx2




Hyperlink to GetCardTrx2 Web Service details


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://www.namespaceuri.com/Admin/ws"> <soapenv:Header/> <soapenv:Body> <ws:GetCardTrx2> <ws:UserName>[API Username]</ws:UserName>


<ws:RPNum>17198</ws:RPNum> <ws:PNRef>23240746</ws:PNRef> <ws:BeginDt>11/07/2016</ws:BeginDt> <ws:EndDt>11/07/2016</ws:EndDt> <ws:PaymentType></ws:PaymentType> <ws:ExcludePaymentType></ws:ExcludePaymentType> <ws:TransType></ws:TransType> <ws:ExcludeTransType></ws:ExcludeTransType> <ws:ApprovalCode></ws:ApprovalCode> <ws:Result></ws:Result> <ws:ExcludeResult></ws:ExcludeResult> <ws:NameOnCard></ws:NameOnCard> <ws:CardNum></ws:CardNum> <ws:CardType></ws:CardType> <ws:ExcludeCardType></ws:ExcludeCardType> <ws:ExcludeVoid>True</ws:ExcludeVoid> <ws:User></ws:User> <ws:invoiceId></ws:invoiceId> <ws:SettleFlag></ws:SettleFlag> <ws:SettleMsg></ws:SettleMsg> <ws:BeginSettleDt></ws:BeginSettleDt> <ws:EndSettleDt></ws:EndSettleDt> <ws:TransformType></ws:TransformType> <ws:Xsl></ws:Xsl> <ws:ColDelim></ws:ColDelim> <ws:RowDelim></ws:RowDelim> <ws:IncludeHeader></ws:IncludeHeader> <ws:ExtData></ws:ExtData> </ws:GetCardTrx2> </soapenv:Body> </soapenv:Envelope>

Response Message:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <GetCardTrx2Response xmlns="http://www.namespaceuri.com/Admin/ws"> <GetCardTrx2Result><RichDBDS> <TrxDetailCard> <TRX_HD_Key>23240746</TRX_HD_Key> <Date_DT>2016-11-07T18:56:24+00:00</Date_DT> <Merchant_Key>17198</Merchant_Key> <User_Name_VC>gate9376 </User_Name_VC> <Reseller_Key>130</Reseller_Key> <Payment_Type_ID>MASTERCARD</Payment_Type_ID>




<Trans_Type_ID>RepeatSale </Trans_Type_ID> <Processor_ID>PayTampa </Processor_ID> <TRX_Settle_Key>19815826</TRX_Settle_Key> <Void_Flag_CH>0</Void_Flag_CH> <Settle_Flag_CH>0</Settle_Flag_CH> <Last_Update_DT>2016-11-07T18:56:24.64+00:00</Last_Update_DT> <TRX_Card_Key>19711753</TRX_Card_Key> <Card_Info_Key>20284612</Card_Info_Key> <Auth_Amt_MN>5.0000</Auth_Amt_MN> <Tip_Amt_MN>0.0000</Tip_Amt_MN> <Total_Amt_MN>5.0000</Total_Amt_MN> <Cash_Back_Amt_MN>0.0000</Cash_Back_Amt_MN> <SureCharge_Amt_MN>0.0000</SureCharge_Amt_MN> <Account_Type_CH>MASTERCARD</Account_Type_CH> <Result_CH>0 </Result_CH> <Result_Txt_VC>APPROVED</Result_Txt_VC> <Approval_Code_CH>198806</Approval_Code_CH> <Host_Ref_Num_CH>00000000</Host_Ref_Num_CH> <AVS_Resp_CH>Z</AVS_Resp_CH> <Host_Date_CH>110716 </Host_Date_CH> <Host_Time_CH>065625 </Host_Time_CH> <Acct_Num_CH>************5454</Acct_Num_CH> <Exp_CH>1220 </Exp_CH> <Type_CH>MASTERCARD</Type_CH> <Name_on_Card_VC>Jack Doe </Name_on_Card_VC> <Street_CH>123 East Main Street </Street_CH> <Zip_CH>20151 </Zip_CH> <Manual>true</Manual> <TRX_Receipt_key>0</TRX_Receipt_key> <IP_VC>172.19.0.5</IP_VC> <Batch_Number>0</Batch_Number> <Level3_Amt_MN>0.0000</Level3_Amt_MN> <TRX_Receipt_Cnt>0</TRX_Receipt_Cnt> <Auth_Date_DT>2016-11-07T18:56:24+00:00</Auth_Date_DT> <Reversal_Flag_CH>0</Reversal_Flag_CH> </TrxDetailCard> </RichDBDS></GetCardTrx2Result> </GetCardTrx2Response> </soap:Body> </soap:Envelope>

GetCardTrxSummary

Hyperlink to GetCardTrxSummary Web Service details


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://www.namespaceuri.com/Admin/ws"> <soapenv:Header/> <soapenv:Body> <ws:GetCardTrxSummary> <ws:UserName>[API Username]</ws:UserName>


<ws:RPNum>17198</ws:RPNum> <ws:BeginDt>11/07/2016</ws:BeginDt> <ws:EndDt>11/07/2016</ws:EndDt>




<ws:ApprovalCode></ws:ApprovalCode> <ws:Register></ws:Register> <ws:NameOnCard></ws:NameOnCard> <ws:CardNum></ws:CardNum> <ws:CardType></ws:CardType> <ws:ExcludeVoid>True</ws:ExcludeVoid> <ws:User></ws:User> <ws:SettleFlag></ws:SettleFlag> <ws:SettleMsg></ws:SettleMsg> <ws:SettleDt></ws:SettleDt> <ws:TransformType></ws:TransformType> <ws:Xsl></ws:Xsl> <ws:ColDelim></ws:ColDelim> <ws:RowDelim></ws:RowDelim> <ws:IncludeHeader></ws:IncludeHeader> <ws:ExtData></ws:ExtData> </ws:GetCardTrxSummary> </soapenv:Body> </soapenv:Envelope>

Response Message:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <GetCardTrxSummaryResponse xmlns="http://www.namespaceuri.com/Admin/ws"> <GetCardTrxSummaryResult><CardTrxSummary> <PaymentMethod> <Payment_Type_ID>MASTERCARD</Payment_Type_ID> <Authorization>0.0000</Authorization> <Capture>0.0000</Capture> <ForceCapture>0.0000</ForceCapture> <PostAuth>0.0000</PostAuth> <Return>0.0000</Return> <Sale>0.0000</Sale> <Receipt>0.0000</Receipt> <RepeatSale>115.0000</RepeatSale> <Activate>0.0000</Activate> <Deactivate>0.0000</Deactivate> <Reload>0.0000</Reload> <Authorization_Cnt>0</Authorization_Cnt> <Capture_Cnt>0</Capture_Cnt> <ForceCapture_Cnt>0</ForceCapture_Cnt> <PostAuth_Cnt>0</PostAuth_Cnt> <Return_Cnt>0</Return_Cnt> <Sale_Cnt>0</Sale_Cnt> <Receipt_Cnt>0</Receipt_Cnt> <RepeatSale_Cnt>3</RepeatSale_Cnt> <Activate_Cnt>0</Activate_Cnt> <Deactivate_Cnt>0</Deactivate_Cnt> <Reload_Cnt>0</Reload_Cnt> <Cnt>3</Cnt> </PaymentMethod> </CardTrxSummary></GetCardTrxSummaryResult> </GetCardTrxSummaryResponse> </soap:Body>




</soap:Envelope>

GetCheckTrx

Hyperlink to GetCheckTrx Web Service details


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://www.namespaceuri.com/Admin/ws"> <soapenv:Header/> <soapenv:Body> <ws:GetCheckTrx> <ws:UserName>[API Username]</ws:UserName>


<ws:RPNum>17198</ws:RPNum> <ws:PNRef>23240648</ws:PNRef> <ws:BeginDt>11/07/2016</ws:BeginDt> <ws:EndDt>11/07/2016</ws:EndDt> <ws:PaymentType></ws:PaymentType> <ws:ExcludePaymentType></ws:ExcludePaymentType> <ws:TransType></ws:TransType> <ws:ExcludeTransType></ws:ExcludeTransType> <ws:ApprovalCode></ws:ApprovalCode> <ws:Result></ws:Result> <ws:ExcludeResult></ws:ExcludeResult> <ws:NameOnCheck></ws:NameOnCheck> <ws:CheckNum></ws:CheckNum> <ws:AcctNum></ws:AcctNum> <ws:RouteNum></ws:RouteNum> <ws:ExcludeVoid>True</ws:ExcludeVoid> <ws:User></ws:User> <ws:invoiceId></ws:invoiceId> <ws:SettleFlag></ws:SettleFlag> <ws:SettleMsg></ws:SettleMsg> <ws:SettleDt></ws:SettleDt> <ws:TransformType></ws:TransformType> <ws:Xsl></ws:Xsl> <ws:ColDelim></ws:ColDelim> <ws:RowDelim></ws:RowDelim> <ws:IncludeHeader></ws:IncludeHeader> <ws:ExtData></ws:ExtData> </ws:GetCheckTrx> </soapenv:Body> </soapenv:Envelope>

Response Message:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <GetCheckTrxResponse xmlns="http://www.namespaceuri.com/Admin/ws"> <GetCheckTrxResult><RichDBDS> <TrxDetailCheck> <TRX_HD_Key>23240648</TRX_HD_Key> <Date_DT>2016-11-07T18:50:10.303+00:00</Date_DT>




<Merchant_Key>17198</Merchant_Key> <User_Name_VC>gate9376 </User_Name_VC> <Reseller_Key>130</Reseller_Key> <Payment_Type_ID>ECHECK </Payment_Type_ID> <Trans_Type_ID>Sale </Trans_Type_ID> <Processor_ID>FirstACH </Processor_ID> <TRX_Settle_Key>19815729</TRX_Settle_Key> <Void_Flag_CH>0</Void_Flag_CH> <Settle_Flag_CH>0</Settle_Flag_CH> <Last_Update_DT>2016-11-07T18:50:11.317+00:00</Last_Update_DT> <TRX_Check_Key>3504823</TRX_Check_Key> <CheckNum_CH>1 </CheckNum_CH> <AccountNum_VC>******7890</AccountNum_VC> <TransitNum_VC>111111118</TransitNum_VC> <DL_VC>123456789</DL_VC> <SS_CH>999-99-9999</SS_CH> <DOB_CH>01/01/1963</DOB_CH> <StateCode_CH>VA </StateCode_CH> <NameOnCheck_VC>Jack Doe</NameOnCheck_VC> <EMail_VC>[email protected]</EMail_VC> <Phone_VC>703-555-1212</Phone_VC> <Amount_MN>5.0000</Amount_MN> <Result_CH>0 </Result_CH> <Result_Txt_VC>Success1826444</Result_Txt_VC> <Host_Approval_CH>1826444</Host_Approval_CH> <Host_Ref_Num_CH>1826444</Host_Ref_Num_CH> <Result_Msg_VC>SUCCESS. The Payment was created successfully. Thi</Result_Msg_VC> <Result_Msg1_VC /> <Result_Msg2_VC>Success</Result_Msg2_VC> <TRX_Receipt_key>0</TRX_Receipt_key> <IP_VC>172.19.0.4</IP_VC> <Account_Type_Key>CHECKING</Account_Type_Key> <Check_Type_Key>PERSONAL</Check_Type_Key> <TRX_Receipt_Cnt>0</TRX_Receipt_Cnt> <Auth_Date_DT>2016-11-07T18:50:10.303+00:00</Auth_Date_DT> <Reversal_Flag_CH>0</Reversal_Flag_CH> </TrxDetailCheck> </RichDBDS></GetCheckTrxResult> </GetCheckTrxResponse> </soap:Body> </soap:Envelope>

GetOpenBatchSummary

Hyperlink to GetOpenBatchSummary Web Service details


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://www.namespaceuri.com/Admin/ws"> <soapenv:Header/> <soapenv:Body> <ws:GetOpenBatchSummary> <ws:UserName>[API Username]</ws:UserName>


<ws:rpNum>17198</ws:rpNum> <ws:beginDt></ws:beginDt>




<ws:endDt></ws:endDt> <ws:extData></ws:extData> </ws:GetOpenBatchSummary> </soapenv:Body> </soapenv:Envelope>

Response Message:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <GetOpenBatchSummaryResponse xmlns="http://www.namespaceuri.com/Admin/ws"> <GetOpenBatchSummaryResult><OpenBatchSummary> <Table> <Payment_Type_ID>MASTERCARD</Payment_Type_ID> <Authorization>0.0000</Authorization> <Capture>0.0000</Capture> <ForceCapture>0.0000</ForceCapture> <PostAuth>0.0000</PostAuth> <Return>0.0000</Return> <Sale>0.0000</Sale> <Receipt>0.0000</Receipt> <RepeatSale>5.0000</RepeatSale> <Activate>0.0000</Activate> <Deactivate>0.0000</Deactivate> <Reload>0.0000</Reload> <Authorization_Cnt>0</Authorization_Cnt> <Capture_Cnt>0</Capture_Cnt> <ForceCapture_Cnt>0</ForceCapture_Cnt> <PostAuth_Cnt>0</PostAuth_Cnt> <Return_Cnt>0</Return_Cnt> <Sale_Cnt>0</Sale_Cnt> <Receipt_Cnt>0</Receipt_Cnt> <RepeatSale_Cnt>1</RepeatSale_Cnt> <Activate_Cnt>0</Activate_Cnt> <Deactivate_Cnt>0</Deactivate_Cnt> <Reload_Cnt>0</Reload_Cnt> <Cnt>1</Cnt> </Table> <Table> <Payment_Type_ID>VISA </Payment_Type_ID> <Authorization>0.0000</Authorization> <Capture>0.0000</Capture> <ForceCapture>0.0000</ForceCapture> <PostAuth>0.0000</PostAuth> <Return>0.0000</Return> <Sale>0.0000</Sale> <Receipt>0.0000</Receipt> <RepeatSale>1.0000</RepeatSale> <Activate>0.0000</Activate> <Deactivate>0.0000</Deactivate> <Reload>0.0000</Reload> <Authorization_Cnt>0</Authorization_Cnt> <Capture_Cnt>0</Capture_Cnt> <ForceCapture_Cnt>0</ForceCapture_Cnt> <PostAuth_Cnt>0</PostAuth_Cnt>




<Return_Cnt>0</Return_Cnt> <Sale_Cnt>0</Sale_Cnt> <Receipt_Cnt>0</Receipt_Cnt> <RepeatSale_Cnt>1</RepeatSale_Cnt> <Activate_Cnt>0</Activate_Cnt> <Deactivate_Cnt>0</Deactivate_Cnt> <Reload_Cnt>0</Reload_Cnt> <Cnt>1</Cnt> </Table> </OpenBatchSummary></GetOpenBatchSummaryResult> </GetOpenBatchSummaryResponse> </soap:Body> </soap:Envelope>

CustomFields Web Service Examples

AddCustomField

Hyperlink to AddCustomField Web Service details


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://tempuri.org/">

<soapenv:Header/>

<soapenv:Body>

<ws:AddCustomField>



<ws:RPNum>17198</ws:RPNum>

<ws:FieldName>Custom1</ws:FieldName>

<ws:IsNumeric>false</ws:IsNumeric>

<ws:DecimalPlaces></ws:DecimalPlaces>

<ws:MaxLength>5</ws:MaxLength>

<ws:RegEx></ws:RegEx>

<ws:IsRequired>false</ws:IsRequired>

<ws:Description>Custom Field</ws:Description>

<ws:MinValue></ws:MinValue>

<ws:MaxValue></ws:MaxValue>

<ws:DisplayOnReceipt>false</ws:DisplayOnReceipt>

<ws:ErrorMessage></ws:ErrorMessage>

</ws:AddCustomField>

</soapenv:Body>

Response Message:



<soap:Body>

<AddCustomFieldResponse xmlns="http://tempuri.org/">

<AddCustomFieldResult>

<Result>0</Result>

<RespMSG>Field added successfully.</RespMSG>

</AddCustomFieldResult>

</AddCustomFieldResponse>

</soap:Body>

</soap:Envelope>




GetCustomField

Hyperlink to GetCustomFields Web Service details


CardAccountUpdater Web Service Examples

UpdateSettings

Hyperlink to UpdateSettings Web Service details




<soapenv:Header/>

<soapenv:Body>

<ws:UpdateSettings>




<ws:RecurringBillingUpdateEnabled>T</ws:RecurringBillingUpdateEnabled>

<ws:NonRecurringBillingUpdateEnabled>T</ws:NonRecurringBillingUpdateEnabled>

<ws:EmailNotificationEnabled>T</ws:EmailNotificationEnabled>

<ws:NotificationEmailAddresses>[email protected]; [email protected]</ws:NotificationEmailAddresses>

</ws:UpdateSettings>

</soapenv:Body>

</soapenv:Envelope>

Response Message:



<soap:Body>

<UpdateSettingsResponse xmlns="http://www.tpisoft.com/Admin/ws">

<UpdateSettingsResult>

<code>OK</code>

<error>Merchant settings were successfully updated!</error>



</UpdateSettingsResult>

</UpdateSettingsResponse>

</soap:Body>

</soap:Envelope>

InfoSettings

Hyperlink to InfoSettings Web Service details




<soapenv:Header/>

<soapenv:Body>

<ws:InfoSettings>







</ws:InfoSettings>

</soapenv:Body>

</soapenv:Envelope>

Response Message:



<soap:Body>

<InfoSettingsResponse xmlns="http://www.tpisoft.com/Admin/ws">

<InfoSettingsResult>

<code>OK</code>



<RecurringBillingUpdateEnabled>T</RecurringBillingUpdateEnabled>

<NonRecurringBillingUpdateEnabled>T</NonRecurringBillingUpdateEnabled>

<EmailNotificationEnabled>T</EmailNotificationEnabled>

<NotificationEmailAddresses>[email protected]; [email protected]</NotificationEmailAddresses>

</InfoSettingsResult>

</InfoSettingsResponse>

</soap:Body>

</soap:Envelope>

GetCardAdminReport

Hyperlink to GetCardAdminReport Web Service details




<soapenv:Header/>

<soapenv:Body>

<ws:GetCardAdminReport>




<ws:StartDT>2016-09-15</ws:StartDT>

<ws:EndDT>2016-11-07</ws:EndDT>

<ws:CardType></ws:CardType>

<ws:ContractID></ws:ContractID>

<ws:CustomerKey></ws:CustomerKey>


<ws:NameOnCard></ws:NameOnCard>

<ws:CardNum></ws:CardNum>

<ws:ReasonCode></ws:ReasonCode>

<ws:ExcludeInactive></ws:ExcludeInactive>

<ws:TransformType></ws:TransformType>

<ws:Xsl>?</ws:Xsl>

<ws:ColDelim></ws:ColDelim>

<ws:RowDelim></ws:RowDelim>

<ws:IncludeHeader></ws:IncludeHeader>

</ws:GetCardAdminReport>

</soapenv:Body>

Response Message:






<soap:Body>

<GetCardAdminReportResponse xmlns="http://www.tpisoft.com/Admin/ws">

<GetCardAdminReportResult><CardAccountUpdater>

<CardAccountUpdate>

<Card_Account_Updates_Key>2694</Card_Account_Updates_Key>

<Update_Receive_Date>2016-11-07T19:57:12.07+00:00</Update_Receive_Date>

<Customer_Name_VC>CardSafe</Customer_Name_VC>

<Customer_Key>1616732</Customer_Key>

<Customer_ID>0001</Customer_ID>

<Card_Info_Key>19927618</Card_Info_Key>

<Payment_Type_ID>MASTERCARD</Payment_Type_ID>

<Name_On_Card>John Doe </Name_On_Card>

<Previous_Account_Num>5454</Previous_Account_Num>

<Previous_Exp_Date>1220 </Previous_Exp_Date>

<New_Account_Num>5454</New_Account_Num>

<New_Exp_Date>1220 </New_Exp_Date>

<Reason_Code>500</Reason_Code>

<Reason_Code_Text>Initial Submission From Gateway</Reason_Code_Text>

<Active_Flag>true</Active_Flag>

</CardAccountUpdate>

<CardAccountUpdate>







<Payment_Type_ID>VISA </Payment_Type_ID>

<Name_On_Card>Jane Doe </Name_On_Card>









<CardAccountUpdate>







<Payment_Type_ID xml:space="preserve"> </Payment_Type_ID>

<Name_On_Card xml:space="preserve"> </Name_On_Card>












<CardAccountUpdate>



<Customer_Name_VC>ApiTest</Customer_Name_VC>





<Name_On_Card xml:space="preserve"> </Name_On_Card>









<CardAccountUpdate>



<Customer_Name_VC>ApiTest3</Customer_Name_VC>





<Name_On_Card>Jack Doe </Name_On_Card>









</CardAccountUpdater></GetCardAdminReportResult>

</GetCardAdminReportResponse>

</soap:Body>

</soap:Envelope>

Validate Web Service Examples

GetCardType

Hyperlink to GetCardType Web Service details



xmlns:ws="http://localhost/SmartPayments/">

<soapenv:Header/>

<soapenv:Body>

<ws:GetCardType>

<ws:CardNumber>5454545454545454</ws:CardNumber>

</ws:GetCardType>

</soapenv:Body>

</soapenv:Envelope>




Response Message:



<soap:Body>

<GetCardTypeResponse xmlns="http://localhost/SmartPayments/">

<GetCardTypeResult>MASTERCARD</GetCardTypeResult>

</GetCardTypeResponse>

</soap:Body>

</soap:Envelope>

GetNetworkID

Hyperlink to GetNetworkID Web Service details




<soapenv:Header/>

<soapenv:Body>

<ws:GetNetworkID>




</ws:GetNetworkID>

</soapenv:Body>

</soapenv:Envelope>

Response Message:



<soap:Body>

<GetNetworkIDResponse xmlns="http://localhost/SmartPayments/">

<GetNetworkIDResult>

<Result>120</Result>

<RespMSG>ERR - network not found</RespMSG>

</GetNetworkIDResult>

</GetNetworkIDResponse>

</soap:Body>

</soap:Envelope>

IsCommercialCard

Hyperlink to IsCommercialCard Web Service details




<soapenv:Header/>

<soapenv:Body>

<ws:IsCommercialCard>


</ws:IsCommercialCard>

</soapenv:Body>

</soapenv:Envelope>




Response Message:



<soap:Body>

<IsCommercialCardResponse xmlns="http://localhost/SmartPayments/">

<IsCommercialCardResult>false</IsCommercialCardResult>

</IsCommercialCardResponse>

</soap:Body>

</soap:Envelope>

ValidCard

Hyperlink to ValidCard Web Service details




<soapenv:Header/>

<soapenv:Body>

<ws:ValidCard>



</ws:ValidCard>

</soapenv:Body>

</soapenv:Envelope>

Response Message:



<soap:Body>

<ValidCardResponse xmlns="http://localhost/SmartPayments/">

<ValidCardResult>0</ValidCardResult>

</ValidCardResponse>

</soap:Body>

</soap:Envelope>

ValidCardLength

Hyperlink to ValidCardLength Web Service details




<soapenv:Header/>

<soapenv:Body>

<ws:ValidCardLength>


</ws:ValidCardLength>

</soapenv:Body>

</soapenv:Envelope>

Response Message:



<soap:Body>




<ValidCardLengthResponse xmlns="http://localhost/SmartPayments/">

<ValidCardLengthResult>true</ValidCardLengthResult>

</ValidCardLengthResponse>

</soap:Body>

</soap:Envelope>

ValidExpDate

Hyperlink to ValidExpDate Web Service details




<soapenv:Header/>

<soapenv:Body>

<ws:ValidExpDate>


</ws:ValidExpDate>

</soapenv:Body>

</soapenv:Envelope>

Response Message:



<soap:Body>

<ValidExpDateResponse xmlns="http://localhost/SmartPayments/">

<ValidExpDateResult>true</ValidExpDateResult>

</ValidExpDateResponse>

</soap:Body>

</soap:Envelope>

ValidMod10

Hyperlink to ValidMod10 Web Service details




<soapenv:Header/>

<soapenv:Body>

<ws:ValidMod10>


</ws:ValidMod10>

</soapenv:Body>

</soapenv:Envelope>

Response Message:



<soap:Body>

<ValidMod10Response xmlns="http://localhost/SmartPayments/">

<ValidMod10Result>true</ValidMod10Result>

</ValidMod10Response>

</soap:Body>

</soap:Envelope>




Document Revisions Version Date Notes

2.1 December 2016 Updated layout, corrected web methods, added hyperlilnks for navigation and

reordered document to reflect more efficient process flow.

2.0.05 September 2016 Corrected typographical errors and formatting issues.

2.0.04 August 2016 Updated developer notes and extended data for Recurring Payment Web

Service web methods:

ManageCheckInfo (ADD, UPDATE, DELETE)

ManageCustomer (ADD, UPDATE, DELETE)

ProcessCheck

2.0.03 August 2016 Merchant Configuration section under Administration Web Service is updated.

2.0.02 July 2016 Recurring Payment Web Service- ManageContract web method, ADD, UPDATE

and Delete sections updated.

Modified example for GetCheckTrx method.

Modified Footer.

2.0.01 July 2016 Modified example for InfoMerchant method.

Removed Check Payment Types (GUARANTEE, PAYRECEIPT, VERIFY) for

GetCheckTrx method.

Modified example for GetCheckTrx method.

Updated Developer Notes for Recurring ProcessCheck method.

Updated Developer Notes and Parameter description–s for ProcessCheck -

Auth method.

Updated Developer Notes, Parameter descriptions, a–d Example for

ProcessCheck - Sale method.

Updated Developer Notes, Parameter descriptions, an– Example for

ProcessCheck - Return method.

Updated Developer Notes and Parameter descriptions for ProcessCheck -

Force method.

Updated Developer Notes, Parameter descriptions, and Example for

ProcessCheck - Void method.


Capture method.


CaptureAll method.




Version Date Notes

Modified Check/Gift/Loyalty table for Front End Processors section of

Appendix.

Added FirstACH Account Numbers table.

Removed GETI Account Numbers and Trigger Amounts tables.

DC Gateway API Developer's Guide -...

Documents

Transcript of DC Gateway API Developer's Guide -...