SequelPay User Guide

SOAP And XML Web

Services

For UI 2.0

© SequelPay 2019

1
Chapters
Ch 1: Implementation Guide 5
Ch 2: Transaction Processing Web Services 7
Ch 3: Recurring Billing Web Services 52
Ch 4: Reporting Web Services 68
Ch 5: Card Safe Web Services 94
Ch 6: Response Field Definitions 98

2
Table of Contents
Ch 1: Implementation Guide 5
SOAP Implementation 5
Name-Value Pairs Implementation 5
Ch 2: Transaction Processing Web Services 7
ProcessCreditCard 7
ProcessDebitCard 18
ProcessCheck 27
ProcessEBTCard 34
ProcessGiftCard 41
ProcessSignature 45
ProcessCheck (Recurring Billing) 48
ProcessCreditCard (Recurring Billing) 50
Custom Fields Documentation 51
Ch 3: Recurring Billing Web Services 52
ManageCustomer 52
ManageCreditCardInfo 55
ManageCheckInfo 56
ManageContract 59
ManageContractAddDaysToNextBillDt 66
Ch 4: Reporting Web Services 68
AddCustomField 68
GetCardTrx 70
GetCardTrxSummary 78
GetCheckTrx 83
GetOpenBatchSummary 91

3
Ch 5: Card Safe Web Services 94
StoreCard 94
ProcessCreditCard (CardSafe) 95
Ch 6: Response Field Definitions 98
Reporting (TrxDetail.asmx) 98
Processing Services (transact.asmx) 113
Result Response Field Definition 117
ExtData Field Definitions 120
AVS Response Field Definitions 120
CV Response Field Definitions 121

4
Ch 1: Implementation Guide

SOAP Implementation
The SOAP interface is most easily accessed through a .NET application. If you are developing in
.Net, simply add the URL of the web service WSDL file at
https://gateway.sequelpay.com/ws/transact.asmx?wsdl – or of the specific service method – you
are attempting to consume as a service reference in Visual Studio. Once you have added the
service reference, Visual Studio will handle the bulk of the heavy lifting and will create a class
for the web service and/or method you are attempting to access which will build the SOAP
object for you and return a response in the form of an object.

It is important to note that we use ssl accelerators in our infrastructure. As such, the endpoint
URL’s included in the WSDL file generated by the web reference to the service will be set to
‘http://’ by default. Simply change them to ‘https://’ in whatever IDE you are working in, and
you should have no trouble communicating with the web service.

If you are using a program language other than VB.NET or C#, and are not familiar with
interacting with .NET web services, it is recommended that you integrate using HTTPS as it is
far less complicated then building SOAP objects outside of an IDE, and will save a tremendous
amount of time and headache. If you are familiar and comfortable using SOAP to consume .NET
web services, navigate to the URL for each web service method you plan to consume for
additional details regarding the XML SOAP schema.

Most integrators will only need to concern themselves with the ProcessCreditCard web service.
However, if additional functionality is required, our web services have been labeled intuitively,
and the functionality exposed in each service is implied in the title.

The API is broken up into categories according to functionality to ease this further.

If you have any development specific questions, please contact our technical support center.

Name-Value Pairs Implementation

The Name-Value Pairs implementation relies on the .NET framework’s built in HTTP to SOAP
translation layer. As a result, there are a few idiosyncracies that an integrator must be aware of
when implementing using HTTPS.

5
 1. The .NET framework is taking the HTTPS request and building a SOAP object using
the fields that it receives.

2. As a result, regardless of whether or not a field’s VALUE is required, the field name
must be sent along with the request.

3. Although this may seem counter intuitive, the .NET web service will simply build the
SOAP object using only the fields that are passed to it.

4. If a field name is not included in the request, the SOAP object will be built without that
parameter, thus resulting in an improperly formed SOAP object that will be rejected by the
web service.

5. To avoid this, each field name must be sent even if you are not passing a value to the
service. You must send the field EVEN if the API indicates that the field is not required, but
send the field with a ‘NULL’ value. Eg; “CustomerName=”

6. Remember, the request MUST include all field names, but when deciding whether to
send a value in a specific field you can rely on the API to indicate whether a specific field
requires a value in order to return a valid result

When calling a service using HTTPS, you must also use a slightly different URL. This URL is
displayed for each web service in the API under the heading ‘Service Location’. Please make
sure that when implementing using Name-Value Pairs over HTTPS that you are sending the
request to the URL labeld ‘For standard HTTPS connections’.

For additional detail regarding HTTPS GET or POST format, navigate to the service url labeled
‘For SOAP connections and scroll down to view properly formed GET and POST requests for
each service.

Most integrators will only need to concern themselves with the ProcessCreditCard web service.
However, if additional functionality is required, our web services have been labeled intuitively,
and the functionality exposed in each service is implied in the title.

The API is broken up into categories according to functionality type to ease this further.

If you have any development specific questions, please contact our technical support center at
the following email address: [email protected]

The WSDL file for the SOAP implementation (for use by Visual Studio service reference) can be
found at: https://gateway.sequelpay.com/ws/transact.asmx?wsdl

Table of contents for test forms can be located at: https://gateway.sequelpay.com/ws/

6
Ch 2: Transaction Processing Web Services

ProcessCreditCard
Service Location:

For SOAP connections:

https://gateway.sequelpay.com/ws/transact.asmx?op=ProcessCreditCard

For standard HTTPS connections:

https://gateway.sequelpay.com/ws/transact.asmx/ProcessCreditCard?

Description:

This web service is used whenever a transaction is completed via customer credit card.

The transaction types supported by this web service include:

• Sale - make a purchase using a credit card

• Auth – authorize the amount on a credit card
• Return – credits the card holder’s account
• Void – undo an unsettled transaction
• Force – force an Auth transaction in to the current batch (PostAuth) or place a transaction not
processed through the payment server into the current batch (ForceAuth)
• RepeatSale – perform a recurring billing or installment payment transaction

Processors supporting the restaurant or ‘retail tip’ adjustment function only:

• Adjustment – used to modify an existing tip amount for an original sale

Terminal-based processors only:

• Capture – settle a single transaction in the current batch

Terminal-based processors and host-based processors supporting the batch release feature only:

• CaptureAll – settle all transactions in the current batch

Global, TSYS, and First Data North only:

7
 • Reversal – perform a manual full reversal on a credit card or repeat sale within 24 hours of the
original transaction

Developer Notes:

Invalid Characters: Some parameters and XML tags contain data that will automatically remove
invalid characters from the user-entered data. These parameters and tags include:

• MagData
• NameOnCard
• InvNum
• Zip
• Street
• ExtData: <CustCode>
• Extdata: <RegisterNum>
• ExtData: <City>
• ExtData: <BillToState>
• ExtData: <PONum>

Reversal Transactions: Reversal is only supported for payment processors: TSYS, Global and
First Data North (CES).

• For TSYS: Supported for Visa and MasterCard transactions made within the direct marketing
and ecommerce industries. Reversals must be processed within 24 hours of the original credit
card transaction.

• For First Data North: Supported industries are retail and restaurant. Reversals must be
processed within 24 hours of the original credit card transaction.

• For Global: Supported for all credit card issuers for transactions made within all industries.
Reversals must be processed within the open batch time period. Completed reversals will act as
a void host.

Input Parameters:

O = Optional, R = Required, R* = Required except in Capture and CaptureAll transactions, R# =

Required except for CaptureAll transactions, R1 = Required on Force and Capture transactions,
R$ = Required on all swiped card transactions

Parameter Opt/
Description
Name Req
User name assigned in the payment server. The user must have an appropriate
UserName R
level of access within the system in order to utilize the web service.
Password R Password associated with the user name provided.

8
 Identifies the type of credit card transaction being made. Valid values are:

• Sale - make a purchase using a credit card

• Auth – authorize the amount on a credit card
• Return – credits the card holder’s account
• Void – undo an unsettled transaction
• Force – force an Auth transaction in to the current batch (PostAuth) or place a
transaction not processed through the payment server into the current batch
(ForceAuth).

Note: When using this transaction type for a ForceAuth, you must include an
AuthCode under the ExtData parameter.

• RepeatSale – perform a recurring billing or installment payment transaction

Processors supporting the restaurant adjustment function only:

TransType R
• Adjustment – used to modify an existing tip amount for an original sale To call
the service

Terminal-based processors only:

• Capture – settle a single transaction in the current batch

Terminal-based processors and host-based processors supporting batch release

feature only:

• CaptureAll – settle all transactions in the current batch

• Reversal – perform a manual full reversal on a credit card or repeat sale within
24 hours of the original transaction. See ‘Developer Notes’ for additional details
on support for reversals.

CardNum R$ Credit card number used to uniquely identify the card owner’s account.
ExpDate R$ Credit card date of expiration in MMYY format.
Track data encoded in the magnetic stripe of a credit card. The data will follow
the following format:

%B5149612222222229^FDCS/TEST CHECK
CARD^12041011234567 440?;5149612222222229=12041011234567440?
MagData R#
This parameter must contain the full magnetic read in order to be classified as a
‘card present’ transaction

Note: This input is required for processing swiped/card present transactions.

9
 Card owner’s name as it appears on the card. See ‘Developer Notes’ for invalid
character processing.
NameOnC
O
ard
Note: This parameter may be required depending on the merchant’s processor
setup.
Amount R$ Total transaction amount in DDDD.CC format.
The invoice ID is assigned by the merchant. This identifier can be used to locate a
InvNum O specific transaction or multiple transactions grouped under a single invoice. See
‘Developer Notes’ for invalid character processing.
Unique payment reference number used to identify a single transaction within the
PNRef R1 system. The payment reference number (PNRef) is assigned by the payment
server at the time the transaction is created.
Card owner’s billing address five-digit postal/zip code. See ‘Developer Notes’ for
invalid character processing.
Zip O
Note: This parameter may be required depending on the merchant’s setup.
Card owner’s billing address street name and number. See ‘Developer Notes’ for
invalid character processing.
Street O
Note: This parameter may be required depending on the merchant’s setup.
Card verification number.
CVNum O
Note: This parameter may be required depending on the merchant’s setup.

10
 The ExtData parameter allows you to pass additional information to the web
service that is not covered under the input parameters. ExtData values need not be
placed in any particular order; however, they must be properly formatted using
XML tags.

The following information may be added via the ExtData parameter:

Authorization Code: (required when TransType = Force) Original

authorization/approval code. Valid format is:

• <AuthCode>AuthorizationCode</AuthCode> where Authorization Code is the

original authorization or approval code.

Customer Code: (optional) Customer or purchase order (PO) number used with
Level II information for Global Payments only (if using another processor that
supports Level II, use the PO Number to pass this information instead). See
‘Developer Notes’ for invalid character processing. Valid format is:

• <CustCode>CustomerCode</CustCode> where Customer Code is the number

assigned to identify the customer or the PO number.

Convenience Amount: (optional) Allows the merchant to add a flat fee to the total
ExtData O
transaction to recoup the costs of offering the credit card transaction convenience.
This function may be used by utility companies, government agencies, and
schools. Valid format is:

• <ConvenienceAmt>Amount</ConvenienceAmt> where Amount is the value to

be added to the total transaction in DDDD.CC format.

Tip Amount: (optional) Allows the customer to specify a dollar amount that is
already included in the total amount for the purpose of tipping. Valid format is:

• <TipAmt>Amount</TipAmt> where Amount is the value of the tip already

included in the total transaction in DDDD.CC format.

Tax Amount: (optional) Allows the merchant to add a dollar amount to the total
transaction to cover sales tax. Valid format is:

• <TaxAmt>Amount</TaxAmt> where Amount is the value to be added to the

total transaction in DDDD.CC format.

Surcharge Amount: (optional) Allow a merchant to send the surcharge amount for
a transaction. Currently works for TsysL3. Valid format is:

11
 • <SurchargeAmount>Amount</SurchargeAmount> where Amount is the value to
be added to the total transaction in DDDD.CC format.

Sequence Number: (optional) Identifies the payment order with a repeat sale or
installment transaction. For example, payment 1 of 4. Valid format is:

• <SequenceNum>SequenceNum</SequenceNum> where SequenceNum is any

positive integer less than or equal to the SequenceCount.

Sequence Count: (optional) Identifies the total number of charges that will be
made for a repeat sale or installment transaction. For example, 4 payments must
be made to complete the payment. Valid format is:

• <SequenceCount>SequenceCount</SequenceCount> where SequenceCount is

any positive integer greater than or equal to the SequenceNum.

Server ID: (optional) Unique server identification number. See ‘Developer Notes’
for invalid character processing. Valid format is:

• <ServerID>ServerID</ServerID> where ServerID uniquely identifies the payment

server used.

Time out: (optional) Processor time out value in seconds. The default value for
the parameter is 30 seconds for a transaction and 300 seconds for a settlement
transaction. Valid format is:

• <TimeOut>TimeOut</TimeOut> where TimeOut is the processor time out value

in seconds.

Training Mode: (optional) This is an indicator that specifies whether transactions

will be processed for local loop back testing or treated normally. Valid formats
are:

• <TrainingMode>T</TrainingMode> where T (true) indicates that training mode

is active and transactions are processed for local loop back testing.
• <TrainingMode>F</TrainingMode> where F (false) indicates that training mode
is inactive and transactions should be treated normally.

Transaction ID: (optional) Merchant-assigned numerical string passed along with

an original transaction that can be used for identification and voids. Valid format
is:

• <TransactionID>TransactionIdentifierValue</TransactionID>
where TransactionIdentifierValue is a numerical string.

12
Target: (optional) Identifies the target transaction ID for the original transaction
you wish to void without the use of a PNRef. Valid format is:

• <Target>TransactionIdentifierValue</Target>
where TransactionIdentifierValue is a numerical string identifying the original
transaction.

Force: (optional) This is an indicator that specifies whether or not duplicate

transactions will be processed. Valid formats are:

• <Force>T</Force> where T (true) indicates that duplicate transactions are

accepted.
• <Force>F</Force> where F (false) indicates that duplicate transactions are not
accepted.

Note: Some processors, including Concord EFS, will not recognize this tag and
delete duplicate transactions.

Register Number: (optional) Unique identifier for a specific register. See

‘Developer Notes’ for invalid character processing. Valid format is:

• <RegisterNum>RegisterNum</RegisterNum> where RegisterNum is a valid

unique identifier assigned to a specific register.

City (Depending on processor used, this may be required) City name for the card
owner’s billing address. See ‘Developer Notes’ for invalid character processing.
Valid format is:

• <City>City</City> where City is the card owner’s city name.

Bill-To State: (Depending on processor used, this may be required) Two-

character state code for the card owner’s bill-to address. See ‘Developer Notes’
for invalid character processing. Valid format is:

• <BillToState>BillToState</BillToState> where BillToState is the two-character

state code for the card owner’s bill-to address.

Customer ID: (optional) Identification number assigned to the customer by the

merchant. Valid Format is:

• <CustomerID>CustomerID</CustomerID> where CustomerID is the customer’s

assigned customer ID.

13
Purchase Order (PO) Number: (optional) Customer or PO number used with
Level II information. See ‘Developer Notes’ for invalid character processing.
Valid format is:

• <PONum>PONum</PONum> where 'PONum' is the number assigned to identify

the customer or the PO.

Note: If using Level II with Global Payments, use the CustCode to pass this
information instead.

Bill Payment: (optional) This is an indicator that specifies whether or not the
transaction is being used to pay a utility bill. It is only supported when TransType
= Sale or RepeatSale. Valid formats are:

• <BillPayment>T</BillPayment> where T (true) indicates that the transaction is

being used to pay a utility bill.
• <BillPayment>F</BillPayment> where F (false) indicates that the transaction is
being used for something other than a utility bill.

Note: This tag is only relevant to Retail, MOTO, and ecommerce markets. The
information is currently supported by Vital, First Data North, and Global
Payments processors. Other processors may be supported in the future.

Card Verification Presence: (optional except for First Data transactions) Indicates
whether card verification (CV, CVV2, CVC2, or CID) has been sent along with
the request. Valid formats are:

• <CVPresence>1</CVPresence> where 1 indicates that no CV was provided.

• <CVPresence>2</CVPresence> where 2 indicates that the CV was not submitted
(i.e., the card was key entered).
• <CVPresence>3</CVPresence> where 3 indicates that the CV was submitted.
• <CVPresence>4</CVPresence> where 4 indicates that the CV is illegible.
• <CVPresence>5</CVPresence> where 5 indicates that the CV was not present
on the card.

Card Presence: (optional) Indicates whether the card was present for the
transaction. Valid formats are:

• <Presentation><CardPresent>True</CardPresent></Presentation>
where True indicates that the card was present at the time of the transaction.
• <Presentation><CardPresent>False</CardPresent></Presentation>
where False indicates that the card was not present at the time of the
transaction.

14
 • <Presentation><CardPresent>Unknown</CardPresent></Presentation>
where Unknown indicates that the card may or may not have been present at
the time of the transaction.

Entry Mode: (optional) Indicates how the values for payment information were
obtained. Valid formats are:

• <EntryMode>UNKNOWN</EntryMode> where unknown indicates that the

mode of entry is unknown.
• <EntryMode>MANUAL</EntryMode> where manual indicates that the payment
values were manually entered.
• <EntryMode>MagneticStripe</EntryMode> where MagneticStripe indicates
that the payment values were entered via magnetic stripe card reader (swiped
card).
• <EntryMode>ICC</EntryMode> where ICC indicates that the mode of entry is
Integrated Circuit Chip.
• <EntryMode>PROXIMITY</EntryMode> where proximity indicates that the
payment values were entered via proximity card reader.

AMEX Batch Phase: When working with AMEX batch settlement, the Phase
value can be used to determine the phase of the settlement file. Valid formats are:

• <Phase>Confirm</Phase> where Confirm indicates that the batch is ready to

settle
• <Phase>Submit</Phase> where Submit indicates that the batch has been
submitted to the payment processor
• <Phase>None</Phase> where None indicates that no action has occurred

Note: Batches must be submitted before they can be settled (Confirm). If you
send a “confirm” only, the most recently submitted batch will be settled.

External IP: (optional) When using the Transact web service, the IP address
defaults to the calling computer's IP. If the request is coming from an external
source, the external IP address can be substituted for the purpose of logging and
fraud control.

To implement this IP pass through functionality, the following XML node should
be included in the external data field of the web service call

• <ExternalIP>IP Address Here</ExternalIP>

If the ExternalIP node is not included in the external data field, then the default
behavior of using the callers IP address is used.

IIAS Fields specific to First Data North

15
IIAS Indicator: (optional) Identifies whether the current transaction was
authorized for submission by an auto substantiation database. For the indicator to
be recognized the merchant must be set up for retail and the card type must be
Visa or MasterCard. Valid formats are:

• <IIAS_Indicator>T</IIAS_Indicator> where T (true) indicates that the transaction

was authorized.
• <IIAS_Indicator>F</IIAS_Indicator> where F (true) indicates that the transaction
was not authorized.
• <IIAS_Indicator></IIAS_Indicator> where a blank value indicates that the
transaction not was authorized.

Note: False or blank indicators will disqualify the transaction for IIAS and any
other IIAS fields will be ignored.

Partial Indicator: (optional) Indicates whether a transaction is partially approved

by the host. Valid formats are:

• <Partial_Indicator>T</PartialIndicator> where T (true) indicates that the host

may process the transaction as a partial authorization for available funds.
• <Partial_Indicator>F</Partial_Indicator> where F indicates that the transaction
does not qualify for partial approval.
• <Partial_Indicator></Partial_Indicator> where a blank value indicates that the
transaction does not qualify for partial approval.

Note: The Partial Indicator will return three fields in the response as received
from the host (First Data North):

• Requested Amount: Decimal dollar amount as requested for authorization

• Approved Amount: Decimal dollar amount as approved by the host
• Balanced Amount: Decimal dollar amount remaining on the balance on the
account.

Optional Amounts: All optional amounts should include the decimal. They are all
13 character fields with explicit decimal. The total of the sub amounts must
match to the total authorization amount of the transaction. Optional subtotal
amount for qualified medical expenses (over-the-counter medical items). This
applies to Visa transactions only.

• <QHP_Amount>Value</QHP_Amount>
• <RX_Amount>Value</RX_Amount> - where Value is the optional
prescription/RX subtotal in DDDD.CC format
• <Vision_Amount>Value</Vision_Amount> - where Value is the optional
Vision/Optical subtotal in DDDD.CC format
• <Dental_Amount>Value</Dental_Amount> - where Value is the optional dental
subtotal in DDDD.CC format

16
 • <Clinical_Amount>Value</Clinical_Amount> - where Value is the optional
clinical subtotal in DDDD.CC format

If a partial reversal is required by an integrator, certain fields must be passed. The

TransType passed with this request is the Reversal. You must also pass the
PNRef and IIAS_Indicator = T

The response will have the Partial_Reversal_Flag field set to T (true) and a
Total_Amount field will show what amount is to be settled after requesting the
partial reversal transaction.

Full reversals are also supported. To request a full reversal, the IIAS_Indicator
must be set to T (true).

Level 3 fields specific to First Data North

These fields are required to qualify transactions for level 3 processing and must
be passed with the LineItem xml in ExtData. These are used in conjunction with
other fields (address, customer number, PO Num, etc.), which are collected
elsewhere. Please consult the following table for required fields per card type.

Field Name Card Type Required/Optional

Quantity Visa/MC Required
UnitCost Visa/MC Required for Visa, Optional for MC
CommodityCode Visa Optional
Description Visa/MC Optional for Visa, Required for MC
DiscountAmount Visa/MC Optional
ProductCode Visa/MC Optional for Visa, Required for MC
TaxAmount Visa/MC Optional for Visa, Required for MC
TaxRate Visa/MC Optional for Visa, Required for MC
Total Visa/MC Optional for Visa, Required for MC
Units Visa/MC Optional for Visa, Required for MC
TaxType MC Required

Here is an example of what the fields would look like included in ExtData:

<LineItemDetail><LineItem><Amount>3.00</Amount><CommodityCode>Com
modity</CommodityCode><Description>Description</Description><DiscountA
mount>.50</DiscountAmount><DiscountIncluded>True</DiscountIncluded><Pr

17
 oductCode>1234</ProductCode><Quantity>1.00</Quantity><TaxAmount>0</T
axAmount><TaxInvoiceNumber></TaxInvoiceNumber><TaxRate>0</TaxRate>
<TaxIncluded>False</TaxIncluded><UnitOfMeasure>BushelUS</UnitOfMeasu
re><UnitPrice>3.5100</UnitPrice><UPC>8675309</UPC></LineItem></LineIt
emDetail>

Developer note: Level 3 data is only sent to the processor at time of settlement,
so you could send the fields with an authorization, then force the authorization
without having to include the fields.

Contactless and Soft Descriptors are currently specific to RapidConnect

Contactless transactions:

You will need to pass in the entry mode of ‘Proximity’ with the EntryMode tag:

• <EntryMode>Proximity</EntryMode>

Soft Descriptors:

Soft descriptors can be sent in using the following tags:

• AltMerchName – Alternate name

• AltMerchAddr – Alternate address
• AltMerchCity – Alternate city
• AltMerchState – Alternate state
• AltMerchZip – Alternate zip code

The completed string would look like the example below:

<AltMerchName>Alternate Name</AltMerchName><AltMerchAddr>123
Different
St</AltMerchAddr><AltMerchCity>Seattle</AltMerchCity><AltMerchState>W
A</AltMerchState><AltMerchZip>98102</AltMerchZip>

ProcessDebitCard
Service Location:

For SOAP connections:

18
https://gateway.sequelpay.com/ws/transact.asmx?op=ProcessDebitCard

For standard HTTPS connections:

https://gateway.sequelpay.com/ws/transact.asmx/ProcessDebitCard?

Description:

This web service is used whenever a transaction is completed via customer debit card. The
processes supported by this web service include:

• Sale - make a purchase using a debit card

• Return – credits the card holder’s account

BuyPass fuel transactions only:

• Auth – authorize the amount on a debit card

• Force – force an Auth transaction in to the current batch (PostAuth)

Terminal-based processors only:

• Capture – settle a single transaction in the current batch

Terminal-based processors and host-based processors supporting the batch release feature only:

• CaptureAll – settle all transactions in the current batch

Global Canadian Debit only:

• AddReversal - used when the host sends a response and the information is validated through
the pin pad, if the information is found to be invalid. This transaction type can reverse the
transaction sent to the host. The PNREF number of the original transaction can be sent along
with the AddReversal transaction type to perform the reversal of that transaction.

Global, TSYS, and First Data North only:

• Reversal – perform a manual full reversal on a debit card sale within 24 hours of the original
transaction. The expected behavior of this transaction type is defined by the type of the
payment processor the merchant account is configured for. See ‘Developer Notes’ for additional
information.

Developer Notes:

Invalid Characters: Some parameters and XML tags contain data that will automatically remove
invalid characters from the user-entered data. These parameters and tags include:

• MagData

19
 • NameOnCard
• InvNum
• RegisterNum

Reversal Transactions: Reversal is only for the following payment processors: TSYS, GlobalEast
and First Data North (CES). All reversals must be processed as card-present transactions.

• For TSYS: The supported issuers for all debit card issuers. The supported industries are only retail
and restaurant. Reversals must be processed within 2 hours of the original debit card
transaction. TIP: TSYS requires the debit card number and expiration date along with the original
sale PNREF number to process reversals.

• For First Data North: The supported industries are retail and restaurant. This is also supported
for retail and restaurant and reversals must be processed within 24 hours of the original credit
card transaction.

• For Global East: This is supported for all debit card issuers. It is supported retail and restaurant
industries. It is required that the reversal be processed within the open batch time period. It
restores debit bank account funds immediately.

PIN-less Debit Transactions: In some cases, debit transactions can be processed without the
customer’s entering a PIN number (a “PIN-less” debit transaction). Essentially, the same
information is sent as in a typical PIN-based debit transaction, with the exception of the
encrypted PIN-block and key serial number. This transaction type is currently only available with
BuyPass and Global Payments processors.

If the designated processor is BuyPass or Global, the transaction will be accepted either with
both the PIN-block and key serial number (interpreted as a PIN-based debit transaction) or
accepted with neither piece of data (interpreted as a PIN-less debit transaction).

If the above requirements are met for a transaction, PIN-less debit transactions will be allowed
through the Payment Server. However, when working with BuyPass, additional setup is required
to ensure that the transaction is accepted by the processor:

Application ID Setup: To process PIN-less debit through BuyPass, the application ID sent must
identify the application in use. Contact your administrator for additional details.

Register Number and Terminal ID Setup: When processing transactions with BuyPass, the
Payment Server will attempt to match the RegisterNum passed from the client-side with the
register number set up in the merchant account. Once it has made the match, it will send the
corresponding terminal ID assigned to that register number to BuyPass. When no terminal ID is
sent to BuyPass, the default value is sent (usually terminal ID “01”).

If you are also doing VRU (phone-originated) transactions, a separate terminal ID must be set up
in the registers on the merchant account and submitted in your request through the web service.

20
If the merchant will be doing both internet and VRU transactions at the same time, the terminal
ID value will be required to differentiate between the two. For example, you may set up “01” for
Internet and “02” for VRU. The request sent through the ProcessDebitCard operation must then
send the appropriate register number to reflect the appropriate transaction type.

Fuel Purchases: Debit Card Use: Debit card processing for fuel purchases is now available
through BuyPass only. This functionality allows for fuel purchases with standard debit cards
(Visa, MasterCard, etc.). Debit fuel purchases (TransTypes Sale and Force) require item-level
purchase information. If all the required information for a certain purchase is not provided, the
transaction will be rejected and an error message generated. The main implication for the
developer is that additional data must be passed to the gateway in order for fuel purchases to
process correctly.

Item-level debit fuel purchase information is passed inside the <Items> tag in ExtData. Fuel
purchases are differentiated at the gateway from other purchases by the Fuel designation placed
within the <Category> tag in item. In effect, a transaction will only be treated as a fuel
transaction if at least one of the items within <Items> is designated as category Fuel.

Input Parameters:

O = Optional, R = Required, R* = Required except in Capture and CaptureAll transactions, R# =

Required except for CaptureAll transactions, R1 = Required on Force and Capture transactions,
R$ = Required on all swiped card transactions

Parameter
Opt/Req Description
Name
User name assigned in the payment server. The user must have an
UserName R
appropriate level of access in order to utilize the web service.
Password R Password associated with the user name provided.

21
 Identifies the type of debit card transaction being made. Valid
values are:

• Sale - make a purchase using a debit card

• Return – credits the card holder’s account

BuyPass fuel transactions only:

• Auth – authorize the amount on a debit card

• Force – force an Auth transaction in to the current batch
(PostAuth)

Terminal-based processors only:

• Capture – settle a single transaction in the current batch

Terminal-based processors and host-based processors supporting

the batch release feature only:
TransType R
• CaptureAll – settle all transactions in the current batch

Global Canadian Debit only:

• AddReversal - used when the host sends a response and the

information is validated through the pin pad, if the information
is found to be invalid. This transaction type can reverse the
transaction sent to the host. The PNREF number of the original
transaction can be sent along with the AddReversal transaction
type to perform the reversal of that transaction.

Global, TSYS, and First Data North only:

• Reversal – perform a manual full reversal on a debit card sale

within 24 hours of the original transaction. The expected
behavior of this transaction type is defined by the type of the
payment processor the merchant account is configured for. See
‘Developer Notes’ for additional information.

CardNum R* Debit card number used to uniquely identify the owner’s account.
ExpDate R* Debit card date of expiration in MMYY format.

22
 Data located the magnetic strip on the back of the card. The format
of the MagData is CardNum=ExpDate followed by the service date
MagData R$ and checksum. For example:

36438999960016=05121015432112345678
NameOnCard O Card owner’s name as it appears on the card
Total transaction amount in DDDD.CC format.
Amount R#
Note: This amount includes the CashBackAmt and
SureChargeAmt.
The invoice ID is assigned by the merchant. This identifier can be
InvNum O used to locate a specific transaction or multiple transactions
grouped under a single invoice.
Unique payment reference number used to identify a single
transaction within the system. The payment reference number
PNRef R1
(PNRef) is assigned by the payment server at the time the
transaction is created.
The encrypted PIN-block returned by the PIN pad.

Note: The transaction will fail if an unencrypted PIN is used.

*
Pin R
Note: This information is not required for PIN-less debit
transactions. See ‘Developer Notes’ for additional information on
pin-less debit transactions.
A string that uniquely identifies the register, terminal, or computer
RegisterNum O
on which the transaction was performed.
The amount, in DDDD.CC format, charged by a merchant in
SureChargeAmt O
exchange for processing a debit card transaction.
The amount, in DDDD.CC format, requested by the card holder in
CashBackAmt O
cash back from the debit transaction.

23
 The ExtData parameter allows you to pass additional information
to the web service that is not covered under the input parameters.
ExtData values need not be placed in any particular order;
however, they must be properly formatted using XML tags.

The following information may be added via the ExtData

parameter:

Time out: (optional) Processor time out value in seconds. The

default value for the parameter is 30 seconds for a transaction and
300 seconds for a settlement transaction. Valid format is:

• <TimeOut>TimeOut</TimeOut> where TimeOut is the processor

time out value in seconds.

Training Mode: (optional) This is an indicator that specifies

whether transactions will be processed for local loop back testing
or treated normally. Valid formats are:

• <TrainingMode>T</TrainingMode> where T (true) indicates that

training mode is active and transactions are processed for local
loop back testing.
• <TrainingMode>F</TrainingMode> where F (false) indicates that
ExtData O
training mode is inactive and transactions should be treated
normally.

Key Serial Number: (required for all non-PIN-less debit

transactions) PIN pad serial number. Valid format is:

• <KeySerialNumber>KeySerialNumber</KeySerialNumber>
where KeySerialNumber is the PIN pad serial number used in
managing DUKPT PIN pads.

Force: (optional) This is an indicator that specifies whether or not

duplicate transactions will be processed. Valid formats are:

• <Force>T</Force> where T (true) indicates that duplicate

transactions are accepted.
• <Force>F</Force> where F (false) indicates that duplicate
transactions are not accepted.

Note: Some processors, including BuyPass, will not recognize this

tag and reject duplicate transactions.

GLOBAL Interac Specific Tags

24
The Global Canadian platform and does not require the US
standard KeySerialNumber tag. In its place, this platform uses the
Canadian MAC specific tags listed below. All of the tags within the
<MAC></MAC> tags are required to process Canadian debit
transactions.

Tag Format Opt/Req Description

<MAC> R
TID or terminal Identification number
is configured based on the PIN pad
used as assigned by the processor.
<TID>TID
R These tags are required by the
Value</TID>
AddReversal transaction type.

POS sequence number is the point of

sale sequence number which follows a
range between values of 001 to 999
and is specifically maintained by the
<PSN>PSN
R Smart Payments Client application
Value</PSN>
that allows for use with the Global
Canadian Debit.

Continued, next page.

Tag Format Opt/Req Description

Allows for the submission of
data specific to
Interac/Global Canada
based transactions. The
Terminal ID is required with
all the Interac based
<Value>MAC</Value> R
transactions. This value is
obtained from the Global
PIN Pad device. This value
is also supported in the
response field that will
contain the MAC key, POS

25
 Sequence Number
Information and PIN Key.

Valid Values are English or

French. This value dictates
what language is used in
<Language>Language
R facilitating the Canadian
Value</Language>
debit transaction.

</MAC>

Account Type: (required for submission with the MAC related

values for Canadian Debit) This value identifies the type of account
being debited. Valid format is:

• <AccountType>Checking</AccountType>
where Checking indicates that a checking account is being used
for the debit transaction.
• <AccountType>Saving</AccountType> where Saving indicates
that a savings account is being used for the debit transaction.

External IP: (optional) When using the Transact web service, the IP
address defaults to the calling computer's IP. If the request is
coming from an external source, the external IP address can be
substituted for the purpose of logging and fraud control.

To implement this IP pass through functionality, the following

XML node should be included in the external data field of the web
service call...

• <ExternalIP>IP Address Here</ExternalIP>

26
 If the ExternalIP node is not included in the external data field,
then the default behavior of using the callers IP address is used.

ProcessCheck
Service Location:

For SOAP connections:

https://gateway.sequelpay.com/ws/transact.asmx?op=ProcessCheck

For standard HTTPS connections:

https://gateway.sequelpay.com/ws/transact.asmx/ProcessCheck?

Description:

This web service is used whenever a transaction is completed via customer check.

The processes supported by this web service include:

• Sale - make a purchase using a check (manually keyed or scanned)

• Auth (Verify) - authorizes or verifies the amount of a check
• Return - return the money of a settled check transaction to the check holder
• Void - undo a settled check transaction
• Force - (ForceSale) force a previous Sale transaction into the current batch

Terminal-based processors only:

• Capture - settle a single transaction in the current batch

• CaptureAll - settle all transactions in the current batch

Developer Notes:

Invalid Characters: Some parameters and XML tags contain data that will automatically remove
invalid characters from the user-entered data. These parameters and tags include:

27
 • NameOnCheck
• DL
• SS
• DOB
• StateCode
• ExtData: <Phone>
• Extdata: <Email>
• ExtData: <CityOfAccount>
• ExtData: <BillToStreet>
• ExtData: <BillToState>
• ExtData: <BillToPostalCode>
• ExtData: <BillToCountry>
• ExtData: <CustomerID>

Date Formats: Valid entry formats are:

• MM/DD/YYYY
• YYYY-MM-DD

Input Parameters:

O = Optional, R = Required, R* = Required except in Capture and CaptureAll transactions, R# =

Required except for CaptureAll transactions, R1 = Required on Force and Capture transactions,
R$ = Required on all swiped card transactions

Parameter
Opt/Req Description
Name
User name assigned in the payment server. The user must have an
UserName R
appropriate level of access in order to utilize the web service.
Password R Password associated with the user name provided.

28
 Identifies the type of check transaction being made. Valid values
are:

• Sale - make a purchase using a check

• Auth (Verify) - authorizes or verifies the amount of a check
• Return - return the money of a settled check transaction to the
check holder
• Void - undo a settled check transaction
• Force - (ForceSale) force a previous Sale transaction into the
current batch

TransType R Terminal-based Processors Only:

• Capture - settle a single transaction in the current batch

• CaptureAll - settle all transactions in the current batch

Note: If using the Return, Void, Force, or Capture TransTypes, you

must include a PNRef using the ExtData parameter.

Note: If using the Sale or Return TransTypes, you may be required

to include city of account, bill-to street, and bill-to postal code using
the ExtData parameter.
CheckNum R* Uniquely identifies an individual’s check.
Uniquely identifies the bank holding funds. Also called routing
TransitNum R*
number.
AccountNum R* Uniquely identifies the check owner’s bank account.
Amount R* Total transaction value in DDDD.CC format.

29
 Magnetic Ink Check Reader data line. This data string includes the
TransitNum and AccountNum.

Note: This input is required for processing check/consumer present

transactions.

MICR R$

Note: The formats of the MICR is processor specific and if the

developer is not sure about what format your Check processor
accepts, pass the RAW MICR as well in the TOAD format and
details of this are described in the extended data. If the developer is
sure about the precise format for MICR that is supported by the
Check processor, then there is no need to pass the Raw MICR in
TOAD format.
Check owner’s name as it appears on the check. See ‘Developer
Notes’ for invalid character processing.
NameOnCheck R*
Note: This parameter may be required depending on the merchant’s
processor setup.
Check owner’s driver’s license number. See ‘Developer Notes’ for
DL O
invalid character processing.
Check owner’s Social Security number. See ‘Developer Notes’ for
SS O
invalid character processing.
Check owner’s date of birth. See ‘Developer Notes’ for date
DOB O
formats.
Check owner’s two-character state code. See ‘Developer Notes’ for
invalid character processing.
StateCode O
Note: This parameter may be required depending on the merchant’s
processor setup.
Identifies the type of check used in the transaction. Valid values are:

• Personal
CheckType O
• Corporate
• Government

30
 The ExtData parameter allows you to pass additional information to
the web service that is not covered under the input parameters.
ExtData values need not be placed in any particular order; however,
they must be properly formatted using XML tags.

The following information may be added via the ExtData parameter:

Time out: (optional) Processor time out value in seconds. The

default value for the parameter is 30 seconds. Valid format is:

• <TimeOut>TimeOut</TimeOut> where TimeOut is the processor

time out value in seconds.

PNRef: (required for TransType = Return, Void, Force, or Capture)

Unique payment reference number used to identify a single
transaction within the system. The payment reference number
(PNRef) is assigned by the payment server at the time the
transaction is created. Valid format is:

• <PNRef>PNRef</PNRef> where PNRef is the valid payment

reference number assigned to the transaction that is to be
returned, voided, forced, or captured.
ExtData O
Phone: (optional) Check owner’s phone number. See ‘Developer
Notes’ for invalid character processing. Valid format is:

• <Phone>Phone</Phone> where Phone is the check owner’s

phone number.

Email Address: (optional) Check owner’s email address. See

‘Developer Notes’ for invalid character processing. Valid format is:

• <Email>Email</Email> where Email is the check owner’s email

address.

Raw MICR: (Required for check/consumer present transactions)

Raw Magnetic Ink Check Reader data line from the check reader.
Valid format is:

• <RawMICR>RawMICR</RawMICR> where RawMICR is the transit

number, account number, and check number in the following
format:TransitNumTAccountNumOCheckNum

Note: TOAD format is the accepted default format for raw MICR
for all check processors supported.

31
Invoice Number: (optional) The invoice ID is assigned by the
merchant. This identifier can be used to locate a specific transaction
or multiple transactions grouped under a single invoice. Valid
format is:

• <InvNum>InvNum</InvNum> where InvNum is the merchant-

assigned invoice number.

Note: Many merchants use the invoice ID to store other values in

the database. The exact nature of the value stored will vary by
merchant.

Training Mode: (optional) This is an indicator that specifies whether

transactions will be processed for local loop back testing or treated
normally. Valid formats are:

• <TrainingMode>T</TrainingMode> where T (true) indicates that

training mode is active and transactions are processed for local
loop back testing.
• <TrainingMode>F</TrainingMode> where F (false) indicates that
training mode is inactive and transactions should be treated
normally.

Alliance Number: (optional) Check alliance number. Valid format

is:

• <AllianceNum>AllianceNum</AllianceNum>
where AllianceNum is the check’s alliance number.

Account Type: (optional) Identifies the bank account for the check
as a checking account or savings account. Valid formats are:

• <AccType>Checking</AccType> to indicate a checking account

• <AccType>Savings</AccType> to indicate a savings account

City of Account (Depending on merchant setup, this may be

required for TransType = Sale or Return) City name for the check
owner’s residential address. See ‘Developer Notes’ for invalid
character processing. Valid format is:

• <CityOfAccount>CityOfAccount</CityOfAccount>
where CityOfAccountis the check owner’s city name.

Bill-To Street: (Depending on merchant setup, this may be required

for TransType = Sale or Return) Street address for the check

32
owner’s bill-to address. See ‘Developer Notes’ for invalid character
processing. Valid format is:

• <BillToStreet>BillToStreet</BillToStreet> where BillToStreet is the

street name for the check owner’s bill-to address.

Bill-To City: (optional) City name for the check owner’s bill-to
address. See ‘Developer Notes’ for invalid character processing.
Valid format is:

• <BillToCity>BillToCity</BillToCity> where BillToCity is the city

name for the check owner’s bill-to address.

Bill-To State: (optional) Two-character state code for the check

owner’s bill-to address. See ‘Developer Notes’ for invalid character
processing. Valid format is:

• <BillToState>BillToState</BillToState> where BillToState is the

two-character state code for the check owner’s bill-to address.

Bill-To Postal Code: (Depending on merchant setup, this may be

required for TransType = Sale or Return) Postal/Zip code for the
check owner’s bill-to address. See ‘Developer Notes’ for invalid
character processing. Valid format is:

• <BillToPostalCode>BillToPostalCode</BillToPostalCode> where
BillToPostalCode is the street name for the check owner’s bill-to
address.

Bill-To-Country: (optional) Country name for the check owner’s

bill-to address. See ‘Developer Notes’ for invalid character
processing. Valid format is:

• <BillToCountry>BillToCountry</BillToCountry>
where BillToCountry is the country name for the check owner’s
bill-to address.

Customer ID: (optional) Identification number assigned to the

customer by the merchant. Valid Format is:

• <CustomerID>CustomerID</CustomerID> where CustomerID is

the customer’s assigned customer ID.

Card Type: (optional) For use with image uploads specific to the
processor RDM_ITMS. Valid format is:

33
 • <CardType>IMAGE<CardType>

External IP: (optional) When using the Transact web service, the IP
address defaults to the calling computer's IP. If the request is
coming from an external source, the external IP address can be
substituted for the purpose of logging and fraud control.

To implement this IP pass through functionality, the following

XML node should be included in the external data field of the web
service call...

• <ExternalIP>IP Address Here</ExternalIP>

If the ExternalIP node is not included in the external data field, then
the default behavior of using the callers IP address is used.

ProcessEBTCard
Service Location:

For SOAP connections:

https://gateway.sequelpay.com/ws/transact.asmx?op=ProcessEBTCard

For standard HTTPS connections:

https://gateway.sequelpay.com/ws/transact.asmx/ProcessEBTCard?

Description:

EBT is used in all U.S. states to issue government benefits to recipients. Benefits are
automatically deposited onto the card by the state and recipients are issued an “EBT card”
(similar to a bank ATM or debit card) to receive their food stamp and/or cash benefits.
Recipients with food stamp benefits can use their EBT cards for eligible food purchases at most
grocery stores and some other retailers.

This web service is used whenever a transaction is completed via customer EBT card. The
processes supported by this web service include:

• FoodStampSale – make a purchase on an EBT cardholder’s food stamp account

• FoodStampReturn – credit to an EBT cardholder’s food stamp account

34
 • CashBenefitSale – make a purchase on an EBT cardholder’s cash benefit account
• Inquire – check the balance on an EBT card
• Capture – settle a single transaction in the current batch; only for terminal-based processors
• CaptureAll – settle all transactions in the current batch; only for terminal-based processors or
host-based processors that support a batch release feature
• Force (Voucher Clear) – allow a merchant to pass a voucher number which is a reference
number on the voucher slip to clear the transaction along with the authorization code obtained
via a voice approval. This means that you can perform a pin-less EBT sale with the authorization
code along with the voucher reference number.

The following transaction types apply to eWic processing.

• EWICAUTHORIZATION – Authorize amount for eWic transaction

• EWICCOMPLETION – Complete or capture the amount for an eWic authorization
• EWICVOID - Clears unsettled transaction eWic card. This does the same thing as a reversal
• EWICSALE – Perform an eWic Sale
• EWICVOUCHERCLEAR - Allow a merchant to pass a voucher number which is a reference
number on the voucher slip to clear the transaction along with the authorization code obtained
via a voice approval. This means that you can perform a pin-less
• EWICINQUIRE - Balance Check for an eWic card

Developer Notes:

Invalid Characters: Some parameters and XML tags contain data that will automatically remove
invalid characters from the user-entered data. These parameters and tags include:

• MagData
• NameOnCard
• InvNum
• RegisterNum

Register Number and Terminal ID Setup: When processing transactions with BuyPass, the
Payment Server will attempt to match the RegisterNum passed from the client-side with the
register number set up in the merchant account. Once it has made the match, it will send the
corresponding terminal ID assigned to that register number to BuyPass. When no terminal ID is
sent to BuyPass, the default value is sent (usually terminal ID “01”).

If you are also doing VRU (phone-originated) transactions, a separate terminal ID must be set up
in the registers on the merchant account and submitted in your request through the web service.

If the merchant will be doing both internet and VRU transactions at the same time, the terminal
ID value will be required to differentiate between the two. For example, you may set up “01” for
Internet and “02” for VRU. The request sent through the ProcessEBTCard operation must then
send the appropriate register number to reflect the appropriate transaction type.

Input Parameters:

35
O = Optional, R = Required, R* = Required except in Capture and CaptureAll transactions, R# =
Required except for CaptureAll transactions, R1 = Required on Force and Capture transactions,
R$ = Required on all swiped card transactions

Parameter
Opt/Req Description
Name
User name assigned in the payment server. The user must have an
UserName R
appropriate level of access in order to utilize the web service.
Password R Password associated with the user name provided.

36
 Identifies the type of debit card transaction being made. Valid
values are:

• FoodStampSale – make a purchase on an EBT cardholder’s food

stamp account
• FoodStampReturn – credit to an EBT cardholder’s food stamp
account
• CashBenefitSale – make a purchase on an EBT cardholder’s cash
benefit account
• Inquire – check the balance on an EBT card
• Capture – settle a single transaction in the current batch; only
for terminal-based processors
• CaptureAll – settle all transactions in the current batch; only for
terminal-based processors or host-based processors that
support a batch release feature
• Force (Voucher Clear) – allow a merchant to pass a voucher
number along with authorization code to perform a pin-less EBT
sale. The voucher reference number is a reference number on
TransType R the voucher slip to clear the transaction along with the
authorization code obtained via a voice approval.

The following transaction types apply to eWic processing.

• EWICAUTHORIZATION – Authorize amount for eWic transaction

• EWICCOMPLETION – Complete or capture the amount for an
eWic authorization
• EWICVOID - Need to pass along the reference number or PNREF
of the transaction to void
• EWICSALE – Perform an eWic Sale
• EWICVOUCHERCLEAR - The Original Authorization ID and
Voucher Number fields are both required. Allows a merchant to
pass a voucher number which is a reference number on the
voucher slip to clear the transaction along with the
authorization code obtained via a voice approval. This means
that you can perform it pin-less
• EWICINQUIRE - Checks the balance on an eWic card

CardNum R* EBT card number used to uniquely identify the owner’s account.
ExpDate R* EBT card date of expiration in MMYY format.
Data located on the magnetic strip on the back of the card. The
format of the MagData is CardNum=ExpDate followed by the
MagData O service code and checksum. For example:

36438999960016=05121015432112345678

37
 Card owner’s name as it appears on the card. See ‘Developer
Notes’ for invalid character processing.

Note: This parameter may be required depending on the

NameOnCard O
merchant’s processor setup.

Note: Invalid characters will be removed from this entry. See

‘Developer Notes’ for invalid character processing.
Total transaction amount in DDDD.CC format.
Amount R*
Note: This amount includes the CashBackAmt and
SureChargeAmt.
The invoice ID is assigned by the merchant. This identifier can be
InvNum O used to locate a specific transaction or multiple transactions
grouped under a single invoice.
Unique payment reference number used to identify a single
transaction within the system. The payment reference number
PNRef R$
(PNRef) is assigned by the payment server at the time the
transaction is created.
The encrypted PIN-block returned by the PIN pad.
*
Pin R
Note: The transaction will fail if an unencrypted PIN is used.
A string that uniquely identifies the register, terminal, or computer
RegisterNum O
on which the transaction was performed.
The amount, in DDDD.CC format, charged by a merchant in
SureChargeAmt O
exchange for processing a debit card transaction.
The amount, in DDDD.CC format, requested by the card holder in
CashBackAmt O
cash back from the debit transaction.

38
 The ExtData parameter allows you to pass additional information
to the web service that is not covered under the input parameters.
ExtData values need not be placed in any particular order;
however, they must be properly formatted using XML tags.

The following information may be added via the ExtData

parameter:

Time out: (optional) Processor time out value in seconds. The

default value for the parameter is 30 seconds for a transaction and
300 seconds for a settlement transaction. Valid format is:

• <TimeOut>TimeOut</TimeOut> where TimeOut is the processor

time out value in seconds.

Training Mode: (optional) This is an indicator that specifies

whether transactions will be processed for local loop back testing
or treated normally. Valid formats are:

• <TrainingMode>T</TrainingMode> where T (true) indicates that

training mode is active and transactions are processed for local
loop back testing.
• <TrainingMode>F</TrainingMode> where F (false) indicates that
ExtData O
training mode is inactive and transactions should be treated
normally.

Key Serial Number: (required for all non-PIN-less debit

transactions) PIN pad serial number. Valid format is:

• <KeySerialNumber>KeySerialNumber</KeySerialNumber>
where KeySerialNumber is the PIN pad serial number used in
managing DUKPT PIN pads.

Force: (optional) This is an indicator that specifies whether or not

duplicate transactions will be processed. Valid formats are:

• <Force>T</Force> where T (true) indicates that duplicate

transactions are accepted.
• <Force>F</Force> where F (false) indicates that duplicate
transactions are not accepted.

Note: Some processors, including BuyPass, will not recognize this

tag and reject duplicate transactions.

External IP: (optional) When using the Transact web service, the IP
address defaults to the calling computer's IP. If the request is

39
coming from an external source, the external IP address can be
substituted for the purpose of logging and fraud control.

To implement this IP pass through functionality, the following

XML node should be included in the external data field of the web
service call...

• <ExternalIP>IP Address Here</ExternalIP>

If the ExternalIP node is not included in the external data field,

then the default behavior of using the callers IP address is used.

eWic transactions (Specific to RapidConnect):

For eWic transactions, you can supply eWic detail using the
following parameters and must be contained in the EWicDetail
group:

• UPCPLUInd – Indicator for UPC/PLU, 0 for UPC, 1 for PLU

• UPCPLUData – Can be up to 16 characters
• UPCPrice – Can only be up to 6 digits, which includes two
implied decimals
• UPCQty – Number of Items or total weight of items, Can only be
up to 5 digits, which includes two implied decimals

Below is an examples of what the string would look like without

data:

<EWicDetails><EWicDetail><UPCPLUInd>1</UPCPLUInd
><UPCPLUData></ UPCPLUData ><UPCPrice>100</ UPCPrice
><UPCQty>100</ UPCQty ></EWicDetail></EWicDetails>

EWICDISCOUNT - This additional amount type is only applicable

when a transaction is a eWic type. It is used as a discount or
coupon. Below is an example of what the string would look like
without data:

<EWicDiscount></EWicDiscount>

Merchant FNS:

For a Food benefit/snap transaction you can provide the Merchant

FNS Number in the MerchantFNS tag:

• <MerchantFNS>12345</MerchantFNS>

40
ProcessGiftCard
Service Location:

For SOAP connections:

https://gateway.sequelpay.com/ws/transact.asmx?op=ProcessGiftCard

For standard HTTPS connections:

https://gateway.sequelpay.com/ws/transact.asmx/ProcessGiftCard?

Description:

This web service is used to process gift card transactions for a merchant.

The processes supported by this web service include:

• Redeem – make a purchase on a gift card

• Reload – increase the balance on a gift card
• Refund – refund money back to a gift card
• Activate – activate a gift card
• Deactivate – deactivate a gift card
• Inquire – check the balance on a gift card
• Void – undo an unsettled transaction

Paymentech/Tampa only:

• Force – place a transaction not processed through the payment server into the current batch
(ForceAuth).

Terminal-based processors only:

• Capture – settle a single transaction in the current batch.

Processors supporting the batch release feature only:

• CaptureAll – settle all transactions in the current batch.

Developer Notes:

41
Invalid Characters: Some parameters and XML tags contain data that will automatically remove
invalid characters from the user-entered data. These parameters and tags include:

• MagData
• InvNum
• ExtData: RegisterNum

Input Parameters:

O = Optional, R = Required, R* = Required except in Capture and CaptureAll transactions, R# =

Required except for CaptureAll transactions, R1 = Required on Force and Capture transactions,
R$ = Required on all swiped card transactions

Parameter
Opt/Req Description
Name
User name assigned in the payment server. The user must have an
UserName R
appropriate level of access in order to utilize the web service.
Password R Password associated with the user name provided.
Identifies the type of gift card transaction being made. Valid values are:

• Redeem – make a purchase on a gift card

• Reload – increase the balance on a gift card
• Refund – refund money back to a gift card
• Activate – activate a gift card
• Deactivate – deactivate a gift card
• Inquire – check the balance on a gift card
• Void – undo an unsettled transaction

Paymentech/Tampa only:
TransType R • Force – place a transaction not processed through the payment server
into the current batch (ForceAuth).

Terminal-based processors only:

• Capture – settle a single transaction in the current batch; only for

terminal-based processors

Processors supporting the batch release feature only:

• CaptureAll – settle all transactions in the current batch.

CardNum R Gift card number used to uniquely identify the owner’s account.

42
ExpDate R Gift card date of expiration in MMYY format.
Data located the magnetic strip on the back of the card. The format of
the MagData is CardNum=ExpDate followed by the service code and
MagData R$ checksum. For example:

36438999960016=05121015432112345678
Total transaction amount in DDDD.CC format.
#
Amount R
Note: This amount includes the CashBackAmt and SureChargeAmt.
The invoice ID is assigned by the merchant. This identifier can be used
InvNum O to locate a specific transaction or multiple transactions grouped under a
single invoice.
Unique payment reference number used to identify a single transaction
1
PNRef R within the system. The payment reference number (PNRef) is assigned
by the payment server at the time the transaction is created.

43
 The ExtData parameter allows you to pass additional information to the
web service that is not covered under the input parameters. ExtData
values need not be placed in any particular order; however, they must be
properly formatted using XML tags.

The following information may be added via the ExtData parameter:

Training Mode: (optional) This is an indicator that specifies whether

transactions will be processed for local loop back testing or treated
normally. Valid formats are:

• <TrainingMode>T</TrainingMode> where T (true) indicates that

training mode is active and transactions are processed for local loop
back testing.
• <TrainingMode>F</TrainingMode> where F (false) indicates that
training mode is inactive and transactions should be treated normally.

Force: (optional) This is an indicator that specifies whether or not

duplicate transactions will be processed. Valid formats are:

• <Force>T</Force> where T (true) indicates that duplicate transactions

are accepted.
xtData O • <Force>F</Force> where F (false) indicates that duplicate transactions
are not accepted.

Note: Some processors, including BuyPass, will not recognize this tag
and reject duplicate transactions.

Time out: (optional) Processor time out value in seconds. The default
value for the parameter is 30 seconds for a transaction and 300 seconds
for a settlement transaction. Valid format is:

• <TimeOut>TimeOut</TimeOut> where TimeOut is the processor time

out value in seconds.

Register Number: (optional) This is unique identifier for the register,

terminal or computer used to process the gift card transaction. Valid
format is:

• <RegisterNum>RegisterNum</RegisterNum> where RegisterNum is

equal to the register identification number stored on the merchant’s
account record.

Paymentech/Tampa Only

44
 Force Authorization: (optional) Places a previously authorized
transaction (TransType = Redeem, Reload, or Activate) into the current
batch.

Tag Format Opt/Req Description

<ForceAuth>
Where AuthCode is
the previously
obtained authorization
<AuthCode>AuthCode</AuthCode> R code from
Paymentech/Tampa

<ForceAuth>

External IP: (optional) When using the Transact web service, the IP
address defaults to the calling computer's IP. If the request is coming
from an external source, the external IP address can be substituted for
the purpose of logging and fraud control.

To implement this IP pass through functionality, the following XML

node should be included in the external data field of the web service
call...

• <ExternalIP>IP Address Here</ExternalIP>

If the ExternalIP node is not included in the external data field, then the
default behavior of using the callers IP address is used.

ProcessSignature
Service Location:

For SOAP connections:

https://gateway.sequelpay.com/ws/transact.asmx?op=ProcessSignature

For standard HTTPS connections:

45
https://gateway.sequelpay.com/ws/transact.asmx/ProcessSignature?

Description:

The ProcessSignature web service allows you to capture customer signatures from an input
device.

This web service is used to capture a customer signature electronically and store that data on the
virtual terminal. Transactions with captured signatures appear in the Payment Server with a small
icon to the left of the transaction ID.

Developer Notes:

It is possible to send a receipt image file through the ProcessSignature web service operation
from a client-side application in order to associate it with a transaction. Due to the overall
complexity of creating a receipt image with ProcessSignature, here is a general list of steps your
client-side application must perform in order to send images to the payment server.

1. Get image file from hardware device, etc. and convert image to TIFF image format, if
it isn’t already in that format.

2. Perform an LZW compression on the image data to reduce the file size (the payment
server will only accept image data up to 25KB).

Note: LZW compression decompresses and decompresses without information loss,

achieving compression ratios up to 5:1. It may be somewhat slower to compress and
decompress than the PackBits scheme.

3. Compress the file itself with Zip compression to reduce the file size. Any PKZip-
compatible Zip compressor and decompressor will work.

Note: IPWorks (www.ipworks.com) is a third-party provider of software tools and they have
a product called “IPWorks! Zip” that can simplify the programmatic compression.

4. Base64 encode the image. This ensures that the binary-based information transported
can be converted properly into text-based characters to send in the SignatureData parameter
of ProcessSignature

5. Input the compressed/base64 encoded image data into the SignatureData parameter of
ProcessSignature, and send it to the Payment Server

Input Parameters:

O = Optional, R = Required

46
Parameter
Opt/Req Description
Name
User name assigned in the payment server. The user must have an
UserName R
appropriate level of access in order to utilize the web service.
Password R Password associated with the user name provided.
Identifies the format of the signature data being provided. Valid
values are:

• Signature1 – Lipman credit

SignatureType R • Signature2 – Lipman check
• Signature3 – no longer used
• Signature4 – signature provided in a vector string
• Receipt1 – TIFF file (compressed and encoded Base64)

This parameter holds the data string containing the signature data.

If SignatureType = Signature4, the SignatureData will contain a

string value of vector coordinates, delimited with a ^ character in the
following format:

x1,y1^x2,y2^xN,yN^~

SignatureData R Where ^ is the coordinate delimiter, ~ is the ending delimiter, and a

comma (,) is the vector delimiter.

If there is a pen up event, use the coordinate 0,65535 to signal a

break in the line.

If SignatureType = Receipt1, you must compress and Base64 encode

the image data. For additional information on compression and
encoding, see the ‘Developer Notes’.
Unique payment reference number used to identify a single
transaction within the system. The payment reference number
PNRef R
(PNRef) is assigned by the payment server at the time the
transaction is created.
Indicator that specifies whether the transaction was approved. Valid
entries are:
Result O
• 1 (true) – transaction was approved
• 0 (false) – transaction was not approved

47
 The approval code is a 6-character string (alphanumeric) generated
AuthCode O by the issuing bank. The code is used the card issuer to verify the
specific authorization when transactions are being settled.
The ExtData parameter allows you to pass additional information to
the web service that is not covered under the input parameters.
ExtData values need not be placed in any particular order; however,
they must be properly formatted using XML tags.

The following information may be added via the ExtData parameter:

Training Mode: This is an indicator that specifies whether

ExtData O transactions will be processed for local loop back testing or treated
normally. Valid formats are:

• <TrainingMode>T</TrainingMode> where T (true) indicates that

training mode is active and transactions are processed for local
loop back testing.
• <TrainingMode>F</TrainingMode> where F (false) indicates that
training mode is inactive and transactions should be treated
normally.

ProcessCheck (Recurring Billing)

Service Location:

For SOAP connections:

https://gateway.sequelpay.com/vt/ws/recurring.asmx?op=ProcessCheck

For standard HTTPS connections:

https://gateway.sequelpay.com/vt/ws/recurring.asmx/ProcessCheck?

Description:

This web service allows an integrator to process a Check Transaction against a checking account
that has been ManageCheckInfo

This web service is for processing ‘Sale’ transactions only.

48
Developer Notes:

See Recurring Billing Web Services for more information on Check Data storage.

Input Parameters:

O = Optional, R = Required, R* = Required except when a payment reference number (PNRef)

is provided

Parameter
Opt/Req Description
Name
User name assigned in the payment server. The user must have an
UserName R
appropriate level of access in order to utilize the web service.
Password R Password associated with the user name provided.
Unique numeric value used to identify a specific gateway account.

Vendor R Note: Vendor key may also be called Merchant ID, Merchant
Number, or RPNum. To locate your Vendor key on the virtual
terminal, click Password under the Preferences menu.
Numerical key value assigned to the payment method when it was
added to the system.

CheckInfoKey R This value appears in the return result when a new payment method
is added using ManageCheckInfo (see
<CheckInfoKey></CheckInfoKey> tags) or can be found in the
result set from the InfoCustomer web service.
Amount R Total transaction amount in DDDD.CC format.
The invoice ID is assigned by the merchant. This identifier can be
InvNum O used to locate a specific transaction or multiple transactions grouped
under a single invoice.
ExtData O Reserved for future use.

49
ProcessCreditCard (Recurring Billing)
Service Location:

For SOAP connections:

https://gateway.sequelpay.com/vt/ws/recurring.asmx?op=ProcessCreditCard

For standard HTTPS connections:

https://gateway.sequelpay.com/vt/ws/recurring.asmx/ProcessCreditCard?

Description:

This web service allows an integrator to process a Credit Card Transaction against a checking
account that has been stored using ManageCreditCardInfo

This web service is for processing ‘Sale’ transactions only.

Developer Notes:

See Recurring Billing Web Services for more information on Credit Card Data storage.

Input Parameters:

O = Optional, R = Required, R* = Required except when a payment reference number (PNRef)

is provided

Parameter
Opt/Req Description
Name
User name assigned in the payment server. The user must have an
UserName R
appropriate level of access in order to utilize the web service.
Password R Password associated with the user name provided.
Unique numeric value used to identify the merchant for the query. The
Vendor key is assigned by the gateway and acts as the primary key for
the merchant table.
Vendor R
Note: Vendor key may also be called Merchant ID, Merchant Number,
or RPNum. To locate your Vendor key on the virtual terminal, click
Password under the Preferences menu.

50
 Numerical key value assigned to the payment method when it was
added to the system.
CCInfoKey R
This value appears in the return result when a new payment method is
added (see <CcInfoKey></CcInfoKey> tags) or can be found in the
result set from the InfoCustomer web service.
Amount R Total transaction amount in DDDD.CC format.
The invoice ID is assigned by the merchant. This identifier can be
InvNum O used to locate a specific transaction or multiple transactions grouped
under a single invoice
ExtData O Reserved for future use.

Custom Fields Documentation

To pass in custom field data to any transactional web service, please observe the following field
format:

*The following example assumes that the integrator has stored 2 custom fields, one named
‘SampleFieldName1’ and the other named ‘SampleFieldName2’

<CustomFields>

<SampleFieldName1>Sample String Data</SampleFieldName1>

<SampleFieldName2>8675309</SampleFieldName2>

</CustomFields>

All data passed through the custom fields parameters will be returned in the GetCardTrx web
service call following the same format.

In order for the data to be passed in correctly, the FieldName must reflect EXACTLY the field
name of the custom field as it was added via the AddCustomField web service (see the Reporting
Web Services portion of the API for additional information) or the Custom Fields menu in the
virtual terminal.

The < /CustomFields> tag must be passed in the ExtData field of the web service you are
consuming. The < /CustomFields> tag must contain no spaces, and must conform to XML
standards.

51
Ch 3: Recurring Billing Web Services

ManageCustomer
Service Location:

For SOAP connections:

https://gateway.sequelpay.com/vt/ws/recurring.asmx?op=ManageCustomer

For standard HTTPS connections:

https://gateway.sequelpay.com/vt/ws/recurring.asmx/ManageCustomer?

Description:

This service is used to add, update, or delete a recurring billing customer record. Calling this
service is the first step towards succesfully storing and initiating recurring payments.

Developer Notes:

It is very important to understand that this web service is used for storing data, and is not for
querying previously stored data. It is the responsibility of the integrator to store and maintain all
returned ‘Info Keys’ for later use.

When calling this service with a TransType value of ‘UPDATE’ it is also important to note that
any values that are left ‘NULL’ will overwrite existing data with a ‘NULL’ value.

Input Parameters:

O = Optional, R = Required, R* = Required only when TransType = UPDATE

Parameter
Opt/Req Description
Name
User name assigned in the payment server. The user must have an
UserName R appropriate level of access within the system in order to utilize the
web service.
Password R Password associated with the user name provided.

52
 Indicates whether the contract is being added, updated, or deleted.
Valid entries are:

• ADD
• UPDATE
TransType R • DELETE

*Note: Passing in ‘NULL’ values to this service with a TransType

of ‘UPDATE’ will override existing values to ‘NULL’. It is very
important that all data be updated when making this web service
call.
Unique numeric value used to identify the merchant.

Vendor R Note: Vendor key may also be called Merchant ID, Merchant
Number, or RPNum. To locate your Vendor key on the virtual
terminal, click Password under the Preferences menu.
Unique identifier assigned to the customer record by the system at
the time the customer record is created.

CustomerKey R* Note: The CustomerKey value can be found on the virtual terminal
by accessing the View Customers option under the Recurring
Billing menu. Display a list of customers by entering search criteria.
The CustomerKey appears in the Key column.
Unique identifier assigned to the customer by the merchant at the
time the customer record is created.

Customer ID R Note: The CustomerID value can be found on the virtual terminal
by accessing the View Customers option under the Recurring
Billing menu. Display a list of customers by entering search criteria.
The CustomerID appears in the Customer ID column.
Individual or customer business name.

Note: The CustomerName can be found on the virtual terminal by

CustomerName R
accessing the View Customers option under the Recurring Billing
menu. Display a list of customers by entering search criteria. The
CustomerName appears in the Customer Name column.
FirstName O Customer contact first name.
LastName O Customer contact last name.
Customer contact job or professional title. For example, “Business
Title O
Unit Manager,” or “Dr.”

53
 Customer contact department. For example, “Sales,” or
Department O
“Operations.”
Street1 O Customer contact street address – line 1.
Street2 O Customer contact street address – line 2.
Street3 O Customer contact street address – line 3.
City O Customer contact city.
Customer contact’s standard U.S. postal service two-character state
code (U.S. customers only).
StateID O
Note: Valid entries are standard U.S. Postal service two-character
state codes. For more information, see
http://www.usps.com/ncsc/lookups/usps_abbreviations.html
Province O Customer contact’s province (countries outside the U.S., only).
Zip O Customer contact’s zip or postal code.
Customer contact’s three-character country code. For example,
CountryID O
USA = United States or CAN = Canada.
DayPhone O Customer contact’s daytime phone number.
NightPhone O Customer contact’s after-hours phone number.
Fax O Customer contact’s fax number.
Email O Customer contact’s email address.
Mobile O Customer contact’s mobile phone number.
Indicates whether the customer record is currently active or
inactive. Valid values are:

• ACTIVE
Status O
• INACTIVE
• PENDING
• CLOSED

ExtData O Reserved for future use.

54
ManageCreditCardInfo
Service Location:

For SOAP connections:

https://gateway.sequelpay.com/vt/ws/recurring.asmx?op=ManageCreditCardInfo

For standard HTTPS connections:

https://gateway.sequelpay.com/vt/ws/recurring.asmx/ManageCreditCardInfo?

Description:

This service allows you to store a credit card number securely within the Payment Server
database. Calling this service is the second step towards succesfully storing and initiating
recurring payments if a credit card is to be the preferred method of payment.

Developer Notes:

The service returns a CCInfoKey value which takes the place of the cardholder data with which
it is associated. It is the responsibility of the integrator to keep track of and store these keys.

An unlimited number of credit card profiles can be stored for any given customer.

Input Parameters:

O = Optional, R = Required

Parameter
Opt/Req Description
Name
User name assigned in the payment server. The user must have an
UserName R appropriate level of access within the system in order to utilize the
web service.
Password R Password associated with the user name provided.
Indicates whether the payment type is being added, updated, or
deleted. Valid entries are:

TransType R • ADD
• UPDATE
• DELETE

55
 Unique numeric value used to identify the merchant.

Vendor R Note: Vendor key may also be called Merchant ID, Merchant
Number, or RPNum. To locate your Vendor key on the virtual
terminal, click Password under the Preferences menu.
Unique identifier assigned to the customer record by the system at
the time the customer record is created.

CustomerKey R Note: The CustomerKey value can be found on the virtual terminal
by accessing the View Customers option under the Recurring
Billing menu. Display a list of customers by entering search
criteria. The CustomerKey appears in the Key column.
Numerical key value assigned to the payment method when it was
CardInfoKey O
added to the system.
Credit card number used to uniquely identify the card owner’s
CcAccountNum O
account.
CcExpDate O Credit card date of expiration in MMYY format.
CcNameOnCard O Card owner’s name as it appears on the card.
CcStreet O Card owner’s billing address street name and number.
CCZip O Card owner’s billing address postal/zip code.
ExtData O Reserved for future use.

ManageCheckInfo
Service Location:

For SOAP connections:

https://gateway.sequelpay.com/vt/ws/recurring.asmx?op=ManageCheckInfo

For standard HTTPS connections:

https://gateway.sequelpay.com/vt/ws/recurring.asmx/ManageCheckInfo?

Description:

56
This service allows you to store a checking account number securely within the Payment Server
database. Calling this service is the second step towards succesfully storing and initiating
recurring payments if ACH or ECHECKs are to be the preferred method of payment.

Developer Notes:

The service returns a CheckInfoKey value which takes the place of the checking account data
with which it is associated. It is the responsibility of the integrator to keep track of and store
these keys.

An unlimited number of checking account profiles can be stored for any given customer.

Input Parameters:

O = Optional, R = Required, R* = Required for TransType values of UPDATE and DELETE

Parameter
Opt/Req Description
Name
User name assigned in the payment server. The user must have an
UserName R appropriate level of access within the system in order to utilize the
web service.
Password R Password associated with the user name provided.
Unique numeric value used to identify the merchant.

Vendor R Note: Vendor key may also be called Merchant ID, Merchant
Number, or RPNum. To locate your Vendor key on the virtual
terminal, click Password under the Preferences menu.
Indicates whether the payment type is being added, updated, or
deleted. Valid entries are:

TransType R • ADD
• UPDATE
• DELETE

Unique identifier assigned to the customer record by the system at

the time the customer record is created.

CustomerKey R Note: The CustomerKey value can be found on the virtual terminal
by accessing the View Customers option under the Recurring
Billing menu. Display a list of customers by entering search criteria.
The CustomerKey appears in the Key column.

57
 Numerical key value assigned to the payment method when it was
CheckInfoKey R*
added to the system.
Identifies the type of check as a personal or business check. Valid
values are:

CheckType R • PERSONAL – Check is made from an individual (personal)

checking account
• BUSINESS – Check is made from a business checking account

Indicates whether the funds come from a checking or savings

account. Valid values are:

AccountType R • CHECKING – Check is made from a standard checking account or

ACH
• SAVINGS – Check is made from a savings account

CheckNum O Uniquely identifies an individual’s check.

Magnetic Ink Check Reader data line. This data string includes the
TransitNum and AccountNum.

Note: This parameter should be used if the developer knows the

MICR O
precise format for the MICR that is supported by the check
processor. If the precise format is unknown, the raw MICR should
also be included with the transaction. See the <RawMICR> tag
under the ExtData parameter for additional information.
AccountNum R Uniquely identifies the check owner’s bank account.
Uniquely identifies the bank holding funds. Also called routing
TransitNum R
number.
RawMICR O The raw MICR format certain check readers produce.
SS O Check owner’s Social Security number.
DOB O Check owner’s date of birth.
BranchCity O City where the issuing bank branch is located.
DL O Check owner’s driver’s license number.

58
 Check owner’s standard U.S. postal service two-character state
code or other standard province code.

Note: Valid entries should follow USPS two-character state code

StateCode O
standards. For more information, see
http://www.usps.com/ncsc/lookups/usps_abbreviations.html

Note: See Developer Notes for invalid character processing.

Check owner’s name as it appears on the check.
NameOnCheck O
Note: See Developer Notes for invalid character processing.
Email O Customer contact’s email address.
DayPhone O Customer contact’s phone number.
Street1 O Customer contact street address – line 1.
Street2 O Customer contact street address – line 2.
Street3 O Customer contact street address – line 3.
City O Customer contact city.
Customer contact’s standard U.S. postal service two-character state
StateID O
code (U.S. customers only).
Customer contact’s province (countries outside the U.S.,
Province O
only).
PostCode O Customer contact’s zip or postal code.
Customer contact’s three-character country code. For example, USA
CountryID O
= United States or CAN = Canada
ExtDate O Reserved for future use.

ManageContract
Service Location:

For SOAP connections:

https://gateway.sequelpay.com/vt/ws/recurring.asmx?op=ManageContract

59
For standard HTTPS connections:

https://gateway.sequelpay.com/vt/ws/recurring.asmx/ManageContract?

Description:

This service allows the integrator to add, update, or delete the terms and interval of a recurring
billing contract.

Developer Notes:

It is very important to understand that this web service is used for storing data, and is not for
querying previously stored data. It is the responsibility of the integrator to store and maintain all
returned ‘Info Keys’ for later use.

When calling this service with a TransType value of ‘UPDATE’ it is also important to note that
any values that are left ‘NULL’ will overwrite existing data with a ‘NULL’ value.

If the desired effect is to simply update the next bill date, call
ManageContractAddDaysToNextBillDt.

Input Parameters:

O = Optional, R = Required, R* = Required for TransType = UPDATE or DELETE, R$ =

Required for TransType = ADD or UPDATE

Parameter Name Opt/Req Description

User name assigned in the payment server. The user must
UserName R have an appropriate level of access within the system in
order to utilize the web service.
Password R Password associated with the user name provided.
Indicates whether the contract is being added, updated, or
deleted. Valid entries are:

TransType R • ADD
• UPDATE
• DELETE

Unique numeric value used to identify the merchant.

Vendor R Note: Vendor key may also be called Merchant ID, Merchant
Number, or RPNum. To locate your Vendor key on the
virtual terminal, click Password under the Preferences menu.

60
 Unique identifier assigned to the customer record by the
system at the time the customer record is created.

Note: The CustomerKey value can be found on the virtual

CustomerKey R
terminal by accessing the View Customers option under the
Recurring Billing menu. Display a list of customers by
entering search criteria. The CustomerKey appears in the
Key column.
Unique identifier assigned to the contract by the system at
the time the contract record is created.
ContractKey R*
Note: The ContractKey value appears in the return results
(see <ContractKey></ContractKey> tags) when a new
contract is added to the system.
Information passed in the PaymentInfoKey parameter will
vary depending on the PaymentType value passed.

• If a PaymentType of CC (credit card) is passed, send the

PaymentInfoKey R$
CardInfoKey value
• If a PaymentType of CK (check) is passed, send the
CheckInfoKey value

Identifies the type of payment method used. Valid values

are:

• CC – Credit card
PaymentType R$
• CK – Check/ACH

Note: This parameter is case sensitive. Lower case entries

will result in an error.
Unique identifier assigned to the customer by the merchant
at the time the customer record is created.

Note: The CustomerID value can be found on the virtual

Customer ID R
terminal by accessing the View Customers option under the
Recurring Billing menu. Display a list of customers by
entering search criteria. The CustomerID appears in the
Customer ID column.

61
 Individual or customer business name.

Note: The CustomerName can be found on the virtual

CustomerName R terminal by accessing the View Customers option under the
Recurring Billing menu. Display a list of customers by
entering search criteria. The CustomerName appears in the
Customer Name column.
FirstName O Customer contact first name.
LastName O Customer contact last name.
Customer contact job or professional title. For example,
Title O
“Business Unit Manager,” or “Dr.”
Customer contact department. For example, “Sales,” or
Department O
“Operations.”
Street1 O Customer contact street address – line 1.
Street2 O Customer contact street address – line 2.
Street3 O Customer contact street address – line 3.
City O Customer contact city.
Customer contact’s standard U.S. postal service two-
character state code (U.S. customers only).
StateID O
Note: Valid entries should follow USPS two-character state
code standards. For more information, see
http://www.usps.com/ncsc/lookups/usps_abbreviations.html
Customer contact’s province (countries outside the U.S.,
Province O
only).
Zip O Customer contact’s zip or postal code.
Customer contact’s three-character country code. For
CountryID O
example, USA = United States or CAN = Canada.
DayPhone O Customer contact’s daytime phone number.
NightPhone O Customer contact’s after-hours phone number.
Customer contact’s fax number.
Fax O

Email O Customer contact’s email address.

Mobile O Customer contact’s mobile phone number.

62
 Unique identifier assigned to the contract by the merchant at
the time the contract record is created.

Note: The ContractKey value can be found on the virtual

ContractID R
terminal by accessing the View Contracts option under the
Recurring Billing menu. Display a list of contracts by
entering search criteria. The ContractKey appears in the
Contract ID column.
Name assigned to the contract (used for easier
ContractName O
identification).
Amount billed each time the contract comes due in
BillAmt R
DD.CCCC format.
Additional tax amount applied to the BillAmt each time the
TaxAmt O
contract comes due in DD.CCCC format.
Total amount billed each time the contract comes due in
DD.CCCC format.
TotalAmt R
BillAmt + TaxAmt = TotalAmt
Date that the contract becomes effective in MM/DD/YYYY
format. The start date must be greater than today’s date.
StartDate R
The StartDate represents the first time the customer will be
billed per the contract. Future bill dates are calculated using
the BillingPeriod and BillingInterval parameters.
Date that the contract is completed in MM/DD/YYYY
EndDate R
format. The end date must be greater than the start date.
Identifies the next time the contract will come due in
MM/DD/YYYY format.

Note: The NextBillDe can be found on the contract detail in

the virtual terminal. Click View Contracts under the
Recurring Billing menu and search for the contract you want
NextBillDt R$
to work with. Click the linked Contract ID and locate the
Next Bill Date field.

See also ManageContractAddDaysToNextBillDt for

simplified processing where only NextBillDt will be
updated.

63
 This value is used in conjunction with the BillingInterval to
compute the next bill date for a contract. Valid values are:

• DAY
• WEEK
• MONTH
• YEAR

Note: The system will automatically account for 31 day

months and/or leap years. For example:

• Recurring billing is set to run once monthly

• The contract start date is set for the 31st

If the next month only has 30 days, recurring billing will

automatically run the transaction on the 30th.
BillingPeriod R
Note: This parameter is case sensitive.

Examples of billing cycles and how are shown in this table:

Billing Cycle BillingPeriod BillingInterval

Weekly WEEK 1
Every Two Weeks DAY 14
Every Four Weeks DAY 28
Monthly MONTH 1
Quarterly YEAR 4
Twice Yearly YEAR 2
Yearly YEAR 1

This value is used in conjunction with the BillingPeriod to

compute the next bill date for a contract. Valid values are:

• 1
• 2
BillingInterval R
• 4
• 14
• 21
• 28

64
 The number of times the system will try to re-process a
failed payment before the contract is placed in suspended
state. Valid entries are integers 0-10.

If left blank, the default value is zero (0). A MaxFailure = 0

means that the system will not try to reprocess a failed
MaxFailures O payment.

IMPORTANT: When a payment fails to process and the

MaxFailures parameter is set to a value greater than zero
(0), all future payments will be ignored until the failed
payment is either successfully processed or the contract is
suspended.
FailureInterval O Note: This parameter has been deprecated.
Indicates whether the system will send an email to the
customer after successfully processing a scheduled payment.
Valid values are:

• TRUE – Email is sent to the customer after successful

EmailCustomer O payment
• FALSE – (default) Customer is not notified after successful
payment

Note: Email notifications can only be sent if a valid customer

contact email has been provided in the customer record.
Indicates whether the system will send an email to the
merchant after successfully processing a scheduled payment.
Valid values are:

EmailMerchant O • TRUE – Email is sent to the merchant after successful

payment
• FALSE – (default) Merchant is not notified after successful
payment

Indicates whether the system will send an email to the

customer after failing to process a scheduled payment. Valid
values are:

• TRUE – Email is sent to the customer after failed payment

EmailCustomerFailure O
• FALSE – (default) Customer is not notified after failed
payment

Note: mail notifications can only be sent if a valid customer

contact email has been provided in the customer record.

65
 Indicates whether the system will send an email to the
merchant after failing to process a scheduled payment. Valid
values are:

• TRUE – Email is sent to the merchant after failed payment

EmailMerchantFailure O • FALSE – (default) Merchant is not notified after failed
payment

Note: Email notifications can only be sent if a valid

merchant contact email has been provided in the merchant
record.
Indicates whether the contract is currently active (reviewed
each day for pending payments due) or inactive. Valid values
are:

• ACTIVE – Contract is reviewed each day for pending

payments
Status O
• INACTIVE – Contract is not reviewed for pending
payments
• PENDING – Payment had failed to process
• CLOSED – contract has been programmatically closed and
is no longer used

ExtData O Reserved for future use.

ManageContractAddDaysToNextBillDt
Service Location:

For SOAP connections:

https://gateway.sequelpay.com/vt/ws/recurring.asmx?op=ManageContractAddDaysToNextBill
Dt

For standard HTTPS connections:

https://gateway.sequelpay.com/vt/ws/recurring.asmx/ManageContractAddDaysToNextBillDt?

Description:

66
This web service allows the integrator to update the NextBillDate in the event that a payment
was declined and a contract suspended.

Developer Notes:

Call this service in place of ManageContract if the NextBillDate is the only value being updated
to minimize the possibility of overwriting data.

Input Parameters:

O = Optional, R = Required

Parameter
Opt/Req Description
Name
User name assigned in the payment server. The user must have an
UserName R appropriate level of access within the system in order to utilize the
web service.
Password R Password associated with the user name provided.
Unique numeric value used to identify the merchant for the query.

Vendor R Note: Vendor key may also be called Merchant ID, Merchant
Number, or RPNum. To locate your Vendor key on the virtual
terminal, click Password under the Preferences menu.
Unique identifier assigned to the customer record by the system at
the time the customer record is created.

CustomerKey R Note: The CustomerKey value can be found on the virtual terminal
by accessing the View Customers option under the Recurring Billing
menu. Display a list of customers by entering search criteria. The
CustomerKey appears in the Key column.
Unique identifier assigned to the contract by the system at the time
the contract record is created.
ContractKey R
Note: The ContractKey value appears in the return results (see
<ContractKey></ContractKey> tags) when a new contract is added
to the system.
The number of days to be added to the NextBillDt field. This value
NumOfDays R
must be a positive integer.
ExtData O Reserved for future use.

67
Ch 4: Reporting Web Services

AddCustomField
Service Location:

For SOAP connections:

https://gateway.sequelpay.com/ws/customfields.asmx?op=AddCustomField

For standard HTTPS connections:

https://gateway.sequelpay.com/ws/customfields.asmx/AddCustomField?

Description:

This web service allows an integrator to add custom fields programmatically to a gateway
account. The data in these fields is not passed to the processor.

Developer Notes:
Adding a custom field creates a new column in the Transaction Reports grid and any data passed
into this field by an integrator or in the virtual terminal will be stored in that column and
accessible through the GetCardTrx web service. To pass data into a field an integrator must build
an XML string which conforms to the following format:

*The following example assumes that the integrator has stored 2 custom fields, one named
‘SampleFieldName1’ and the other named ‘SampleFieldName2’

<CustomFields>

<SampleFieldName1>Sample String Data</SampleFieldName1>

<SampleFieldName2>8675309</SampleFieldName2>

</CustomFields>

All data passed through the custom fields parameters will be returned in the GetCardTrx web
service call following the same format.

Input Parameters:

O = Optional, R= Required, R* = Required based on dependencies

68
 Parameter Opt/Req Description
User name assigned in the payment server. The user must have
UserName R the apporpriate security permissions in order for the system to
return transaction records.
Password R Password for the user name assigned in the payment server.
Unique value assigned to each gateway account used as a third
credential to ensure security and
RPNum R
Note: RPNum may also be called Merchant ID, Merchant
Number, or Vendor Key.
The name of the field. This value must be unique and will be
FieldName R used to programmatically access the field when passing
additional data using the ProcessCreditCard web service
This is a boolean parameter. It is only necessary to pass in a
IsNumeric O value if the integrator wishes to allow only numeric data to be
passed as input values.
Integer value indicating the number of decimal places the
integrator wishes this field to contain. For accurate storage of the
value “2.79” the integrator would want to pass in a value of ‘2’.
DecimalPlaces O For accurate storage of the value “2.99999” the integrator would
want to pass in a value of ‘5’.

Leave this field ‘Null’ if not keeping track of numeric values

Maximum string length allowed in the field being added. Default
MaxLength O
value is ‘25’
Enter any regular expressions needed to validate that the values
RegEx O being submitted to this field conform to a specific data type
and/or format
Boolean indicating whether or not the integrator wishes this field
IsRequired R to be required for all transactions. Valid values are ‘True’ and
‘Falese’
This is the human readable description that will display in the
Description R
virtual terminal and on the cardholder receipt
MinValue O Minimum numeric value
MaxValue O Maximum numeric value
This is a boolean parameter. Indicates whether or not the field
DisplayOnReceipt O
will display on the cardholder receipt

69
GetCardTrx
Service Location:

For SOAP connections:

https://gateway.sequelpay.com/vt/ws/trxdetail.asmx?op=GetCardTrx

For standard HTTPS connections:

https://gateway.sequelpay.com/vt/ws/trxdetail.asmx/GetCardTrx?

Description:

This web service returns one or more card transactions (with details) for a specific merchant.

In addition to the basic transaction search function, the GetCardTrx web service can help you:

• Build a variety of custom reports, from customer billing histories to reports that help locate
duplicate transactions.
• Build data mining applications. For example, determining what percentage of sales derive from
specific users or payment types. If you have multiple gateway accounts, you can compile the
data from multiple sources into your own customized and aggregated reports.
• Automate the reconciliation process between the payment server and the point-of-sale (POS)
system or register.

Developer Notes:
Date Formats: Dates entered through input parameters are automatically formatted to YYYY-MM-
DDThh:mm:ss (time is in 24-hour format using Coordinated Universal Time (UTC). Valid entry
formats are:

• MM/DD/YYYY
• YYYY-MM-DD
• YYYY-MM-DDThh:mm:ss

Date Query String: The query string used to obtain transactions in a date range is constructed as
follows:

(Date DT >=BeginDt) AND (Date DT <EndDt)

*Date DT is the transaction timestamp.

Parameters Accepting Multiple Values: Some parameters (for example, PaymentType and
TransType) will accept multiple values and return results using an either/or filter. When
inputting multiple parameter values, use the following format:

70
’VALUE1’,’VALUE2’,’VALUE3’

Important: When entering any values in parameters accepting multiple entries, the values must
be enclosed in single quotes (‘ ‘) to be accepted. Values are not case sensitive.

For example, the following values entered in the PaymentType parameter would return results
with either the PayReceipt or Settle payment types:

’PAYRECEIPT’,’SETTLE’

Input Parameters:

O = Optional, R= Required, R* = Required unless a value of PNRef is provided

Parameter Opt/Req Description

User name assigned in the payment server. The user must
UserName R have the apporpriate security permissions in order for the
system to return transaction records.
Password R Password for the user name assigned in the payment server.
Unique value assigned to each gateway account used as a
third credential to ensure security and
RPNum R
Note: RPNum may also be called Merchant ID, Merchant
Number, or Vendor Key.
The unique payment reference number assigned to the
PNRef O transaction. If this field is provided,all other query fields will
be ignored when using PNRef parameter to query the system.
BeginDt R* Beginning date of the transaction record query.
EndDt R* End date of the transaction record query.

71
 If provided, only those transactions matching the
PaymentType will be included. Valid values are:

• 'AMEX' American Express card

• 'CARTBLANCH' Carte Blanch card
• 'DEBIT' Debit card
• 'DINERS' Diners Club card
• 'DISCOVER' Novus Discover card
• 'EBT' Electronic Benefit Transfer
• 'JAL' JAL card
• 'JCB' Japanese Commercial Bank card
• 'MASTERCARD' Master card
PaymentType O • 'VISA' Visa card
• ‘EGC’ Gift card
• 'PAYRECEIPT' to retrieve receipt images that were
uploaded to the payment server
• 'SETTLE' to retrieve requests to settle transactions

Note: The default value for this field is “All”. If no value is

set, all payment types will be returned in the result set.

Or any permutation of the above values, e.g.

"'PAYRECEIPT','SETTLE'" will pull all transactions with
either PayReceipt or Settle payment types.
The ExcludePaymentType parameter allows you to exclude
certain payment types from the result set. Any valid entry (or
combination) listed under the PaymentType parameter may
be used.
ExcludePaymentType O
Note: If you pass the same value in the PaymentType and
ExcludePaymentType parameters, the entry in the
ExcludePaymentType parameter will override the
PaymentType and results of that type will be excluded.

72
 If provided, only those transactions matching the TransType
will be included. Valid values are

• 'Authorization' to retrieve previously-authorized (pre-

auth) transactions
• 'Capture' to retrieve captured transactions
• 'Credit' to retrieve return transactions
• 'ForceCapture' to retrieve force-auth transactions
• 'GetStatus' to make an inquiry to the EBT or gift card’s
balance
• 'PostAuth' to retrieve post-auth transactions
TransType O
• 'Purged' to remove a transaction from the current batch
due to an error
• 'Receipt' to retrieve receipt images that were uploaded to
the payment server
• 'RepeatSale' to retrieve repeat-sale transactions
• 'Sale' to retrieve sale transactions
• 'Void' to retrieve void transactions

Or any permutation of the above values, e.g. "'Credit','Sale'"

will pull all transactions with either Credit or Sale transaction
types.
The ExcludeTransType parameter allows you to exclude
certain transaction types from the result set. Any valid entry
(or combination) listed under the TransType parameter may
be used.

Note: If you pass the same value in the TransType and

ExcludeTransType parameters, the entry in the
ExcludeTransType O ExcludeTransType parameter will override the TransType
and results of that type will be excluded.

Note: A value of ‘Void’ in the ExcludeTransType parameter

will be overridden by the ExcludeVoid if both parameters are
used.

This parameter accepts multiple values.

73
 The approval code is a 6-character string (alphanumeric)
generated by the issuing bank. The code is used the card
issuer to verify the specific authorization when transactions
are being settled. This field may also be used by payment
ApprovalCode O processors to return error messages.

Note: You may only query one approval code at a time;

however, approval codes are not necessarily unique and there
is potential (rare) for more than one record to be returned.
If provided, only those transactions matching the Result will
be included. Valid values are:

• ‘NULL’ returns both approved and declined transactions

• ‘0’ returns only approved transactions
Result O
• Any other value for Result will return transactions
matching that Result code.

Note: to return only declined transactions do not pass a value

for this parameter and instead set ExcludeResult = 0
If provided, any transactions matching the ExcludeResult will
be excluded.
ExcludeResult O
Note: To return a only declined transactions, set
ExcludeResult = 0
Cardholder’s name as it is appears on the card. If provided,
only those transactions with cardholder’s name matching
NameOnCard O
NameOnCard will be included. Matching is done using wild
cards: e.g. "test" will match "test", "1test" and "1test234"
A card number. If provided, only those transactions with the
CardNum O card number matching CardNum will be included. Matching
is done using wild cards.
This field has been deprecated. Please use the PaymentType
CardType O
field to specify the type of card used in a transaction.
This field has been deprecated. Please use the
ExcludeCardType O ExcludePaymentType field to specify the type of cards you
wish to be excluded from the result set.

74
 The ExcludeVoid parameter allows you to exclude voided
transactions from the result set. Valid entries are:

• ‘TRUE’ – voided transactions are excluded

ExcludeVoid R* • ‘FALSE’ – voided transactions are included

Note: A value of ‘Void’ in the ExcludeTransType parameter

will be overridden by the ExcludeVoid if both parameters are
used.
The user who originated the transactions. If provided, only
those transactions created by the matching User will be
User O
included. Matching is done using wild cards: e.g. "test" will
match "test", "1test" and "1test234"
The invoice ID that was included in the original transaction.
If provided, only those transactions with matching invoiceId
InvoiceId O
will be included. Matching is done using wild cards: e.g.
"test" will match "test", "1test" and "1test234"
The SettleFlag parameter allows you to choose whether
settled or unsettled transactions are included in the results.
Valid entries are:
SettleFlag O
• Unused/blank returns all transactions
• ‘1’ - returns only settled transactions
• ‘0’ - returns only transactions that are not yet settled

SettleMsg O The settlement ID or message returned from the host.

SettleDt O The date of settlement.
The type of format to transform the data into. Leave the field
blank to default to XML

• ‘XML’ will output the plain XML string

TransformType O
• ‘XSL’ will use XSL to transform the XML output
• ‘DELIM’ uses ColDelim and RowDelim to format the
output

75
 This field is used only if the TransformType is XSL.

If provided, the resulting dataset will be transformed using

this XSL. You may pass in a URL to the XSL file, or the
XSL string itself. If this field is not empty, the Web Services
will try to locate the file from the URL. If that also fails, it
will treat it as an XSL string. In any case, the final XSL string
Xsl O will be loaded and validated against the XSL schema; if it
passes, then that XSL will be used for transformation. A
sample predefined XSL is included with this Web Services:

• ‘https://<PMN assigned host

name>/admin/ws/TabDelim.xsl’ for a tab delimited
transformation

This field is used only if the TransformType is DELIM. This

defines the string that separates each column:
ColDelim O
e.g. a value of ‘@’, would separate each column value with
‘@’
This field is used only if the TransformType is DELIM. This
defines the string that separates each row
RowDelim O
e.g. a value of ‘!’ would start each row with ‘!’
This field is used only if the TransformType is DELIM. If
TRUE, then field headers will be included in the first row
IncludeHeader O
using the same delimiter strings; must either be TRUE or
FALSE

76
 The ExtData parameter allows you to pass additional
information to the web service that is not covered under the
input parameters. ExtData values need not be placed in any
particular order; however, they must be properly formatted
using XML tags.

Extended data in XML format. Valid values are:

• ‘<IMAGE_TYPE>NO_IMAGE</IMAGE_TYPE>’ – Will only

return transaction data that does not include image data
(to include signature data and check images)
• ‘<IMAGE_TYPE>ONLY_IMAGE</IMAGE_TYPE>’ – Will only
return transaction data that includes image data (to
include signature data and check images)
• ‘<IMAGE_TYPE>ALL</IMAGE_TYPE>’- will return
transaction with or without image data
• ‘<CustomerID>CustomerID</CustomerID>’ – specifies the
customer ID value to search by. Matching is done using
wild cards: e.g. "test" will match "test", "1test" and
"1test234"
• ‘<Amount>Amount</Amount>’ – specifies the amount
value of the transactions being searched for. In
DDDDDD.CC format
ExtData O • ‘<RegisterNum>RegisterNum</RegisterNum>’ - apecifies
the register number, originally passed with the
transaction, to search by
• <Timezone>Timezone</Timezone> - Used to convert the
input and output (where applicable) date/time values to
the desired timezone. When specified, the same timezone
is used to convert the begin/end date parameters as well
as the Date and Last Update output values. This field is
optional, and if omitted all date/time values are treated as
UTC. Daylight savings time adjustments, where
applicable, are handled automatically. Accepted values
are:

§ AKST – Alaskan Standard Time

§ CST – Central Standard Time

§ EST – Eastern Standard Time

§ HST – Hawaiian Standard Time

§ MST – Mountain Standard Time

77
 § AZMST – Arizona

§ PST – Pacific Standard Time

GetCardTrxSummary
Service Location:

For SOAP connections:

https://gateway.sequelpay.com/vt/ws/trxdetail.asmx?op=GetCardTrxSummary

For standard HTTPS connections:

https://gateway.sequelpay.com/vt/ws/trxdetail.asmx/GetCardTrxSummary?

Description:
The GetCardTrxSummary web service allows you to view summary data for one or more card
transactions within a given date range. Optional filters allow you to collect summary data by card
type, card owner, account number, register, settle or approval status, user, etc.

Developer Notes:

Date Formats: Dates entered through input parameters are automatically formatted to YYYY-MM-
DD. Valid entry formats are:

• MM/DD/YYYY
• YYYY-MM-DD

Date Query String: The query string used to obtain transactions in a date range is constructed as
follows:

(Date DT >=BeginDt) AND (Date DT <EndDt)

*Date DT is the transaction timestamp.

Input Parameters:

O = Optional, R= Required, R* = Required unless a value of PNRef is provided

78
Parameter
Opt/Req Description
Name
User name assigned in the payment server. The user must have an
UserName R appropriate level of access within the system in order to return
records.
Password R Password associated with the user name provided.
Unique numeric value used to identify the merchant for the query.
The RPNum is assigned by the gateway and acts as the primary key
for the merchant table.
RPNum R
Note: RPNum may also be called Merchant ID, Merchant Number,
or Vendor Key.
BeginDt R Identifies the beginning date range for a group of transactions.
EndDt R Identifies the ending date range for a group of transactions.
The approval code is a 6-character string (alphanumeric) generated
by the issuing bank. The code is used the card issuer to verify the
specific authorization when transactions are being settled. This field
may also be used by payment processors to return error messages.
ApprovalCode O
Note: You may only query one approval code at a time; however,
approval codes are not necessarily unique and there is potential
(rare) for more than one record to be returned.
The register is a unique string used to identify the register where the
Register O transaction took place. If used, only transactions made with the
matching register number will be returned.
If a card holder name is provided for this parameter, only those
transactions with matching cardholder names will be
NameOnCard O
returned. Matching is done using wild cards: e.g. "test" will match
"test", "1test" and "1test234"
If a card number is provided for this parameter, only those
transactions with matching card numbers will be returned. Matching
CardNum O
is done using wild cards: e.g. "test" will match "test", "1test" and
"1test234"

79
 The card type identifies the type of card used to make the
transaction. If one or more card types are provided, only
transactions with matching CardType will be included in the results.
Valid entries are:

• Unused/blank returns summary information for all card types

• ‘AMEX’ - American Express card
• ‘CARTBLANCH’ - Carte Blanch card
• ‘DEBIT’ - Debit card
• ‘DINERS’ - Diners club card
CardType O • ‘DISCOVER’ - Discover card
• ‘EBT’ - Electronic benefit transfer
• ‘JAL’ - Japanese Airlines card
• ‘JCB’ - Japanese Commercial Bank card
• ‘MASTERCARD’ - Master card
• ‘VISA’ - Visa card
• ‘EGC’ - Gift card

Or any permutation of the above values, e.g.

"’AMEX’,’MASTERCARD’" will pull all transactions with either
AMEX or MASTERCARD payment types.
The ExcludeVoid parameter allows you to exclude voided
transactions from the result set. Valid entries are

• ‘TRUE’ - voided transactions are excluded from summary

ExcludeVoid R
information
• ‘FALSE’ - voided transactions are included from summary
information

If provided, only transactions generated by users with a matching

User O user ID will be included in the results. Matching is done using wild
cards: e.g. "test" will match "test", "1test" and "1test234"
The SettleFlag parameter allows you to choose whether settled or
unsettled transactions are included in the results. Valid entries are:

• Unused/blank returns summary information for settled and

SettleFlag O unsettled transactions
• ‘1’ - returns only summary information for settled transactions
• ‘0’ - return only summary information for transactions that are
not yet settled

The settlement message is an ID or message returned from the host

SettleMsg O upon settlement of a transaction. If provided, only the transaction
that exactly matches the SettleMsg provided will be returned.

80
 If provided, only transactions that were settled on the same date will
SettleDt O
be included in the results.
Indicates how the result set should be formatted. Valid entries are:

• ‘XML’ - outputs a plain XML string

• ‘XSL’ - uses XSL to format the XML output. If ‘XSL’ is selected, use
the Xsl parameter to identify the XSL string that will be used to
TransformType O
format the output.
• ‘DELIM’ - outputs records in a delimited format. If ‘DELIM’ is
selected, you may also pass values for the ColDelim, RowDelim,
and IncludeHeader parameters.

This field is used only if the TransformType is XSL.

If provided, the resulting dataset will be transformed using this

XSL. You may pass in a URL to the XSL file, or the XSL string
itself. If this field is not empty, the Web Services will try to locate
the file from the URL. If that also fails, it will treat it as an XSL
string. In any case, the final XSL string will be loaded and validated
Xsl O
against the XSL schema; if it passes, then that XSL will be used for
transformation. A sample predefined XSL is included with this Web
Services:

• ‘https://<PMN assigned host name>/admin/ws/TabDelim.xsl’ for

a tab delimited transformation

This field is used only if the TransformType is DELIM. This

defines the string that separates each column:
ColDelim O
e.g. a value of ‘@’, would separate each column value with ‘@’
This field is used only if the TransformType is DELIM. This
defines the string that separates each row
RowDelim O
e.g. a value of ‘!’ would start each row with ‘!’
This field is used only if the TransformType is DELIM. If TRUE,
IncludeHeader O then field headers will be included in the first row using the same
delimiter strings; must either be TRUE or FALSE

81
 The ExtData parameter allows you to pass additional information to
the web service that is not covered under the input parameters.
ExtData values need not be placed in any particular order; however,
they must be properly formatted using XML tags.

Extended data in XML format. Valid values are:

• ‘<IMAGE_TYPE>NO_IMAGE</IMAGE_TYPE>’ – Will only return

transaction data that does not include image data (to include
signature data and check images)
• ‘<IMAGE_TYPE>ONLY_IMAGE</IMAGE_TYPE>’ – Will only return
transaction data that includes image data (to include signature
data and check images)
• ‘<IMAGE_TYPE>ALL</IMAGE_TYPE>’- will return transaction with
or without image data
• ‘<CustomerID>CustomerID</CustomerID>’ – specifies the
customer ID value to search by. Matching is done using wild
cards: e.g. "test" will match "test", "1test" and "1test234"
• ‘<Amount>Amount</Amount>’ – specifies the amount value of
the transactions being searched for. In DDDDDD.CC format
• ‘<RegisterNum>RegisterNum</RegisterNum>’ - apecifies the
register number, originally passed with the transaction, to search
ExtData O by
• <Timezone>Timezone</Timezone> - Used to convert the input
and output (where applicable) date/time values to the desired
timezone. When specified, the same timezone is used to convert
the begin/end date parameters as well as the Date and Last
Update output values. This field is optional, and if omitted all
date/time values are treated as UTC. Daylight savings time
adjustments, where applicable, are handled
automatically. Accepted values are:

§ AKST – Alaskan Standard Time

§ CST – Central Standard Time

§ EST – Eastern Standard Time

§ HST – Hawaiian Standard Time

§ MST – Mountain Standard Time

§ AZMST – Arizona

§ PST – Pacific Standard Time

82
GetCheckTrx
Service Location:

For SOAP connections:

https://gateway.sequelpay.com/vt/ws/trxdetail.asmx?op=GetCheckTrx

For standard HTTPS connections:

https://gateway.sequelpay.com/vt/ws/trxdetail.asmx/GetCheckTrx?

Description:
This web service returns one or more check transactions (with details) for a specific merchant.

In addition to the basic transaction search function, the GetCheckTrx web service can help you to
build a variety of custom reports, aid in data mining applications, and help to automate
reconciliation. Custom reports, from customer billing histories to reports that help locate
duplicate transactions, and data mining applications – for example, determining what percentage
of sales come through a given payment type, are easily constructed by filtering for only the data
that is needed.

GetCheckTrx can also be used to automate the reconciliation process between the payment
server and the point-of-sale (POS) system or register.

Developer Notes:
Date Formats: Dates entered through input parameters are automatically formatted to YYYY-MM-
DDThh:mm:ss (time is in 24-hour format using Coordinated Universal Time (UTC). Valid entry
formats are:

• MM/DD/YYYY
• YYYY-MM-DD
• YYYY-MM-DDThh:mm:ss

Date Query String: The query string used to obtain transactions in a date range is constructed as
follows:

(Date DT >=BeginDt) AND (Date DT <EndDt)

*Date DT is the transaction timestamp.

Parameters Accepting Multiple Values: Some parameters (for example, PaymentType and
TransType) will accept multiple values and return results using an either/or filter. When
inputting multiple parameter values, use the following format:

83
’VALUE1’,’VALUE2’,’VALUE3’

Important: When entering any values in parameters accepting multiple entries, the values must
be enclosed in single quotes (‘ ‘) to be accepted. Values are not case sensitive.

For example, the following values entered in the PaymentType parameter would return results
with either the PayReceipt or Settle payment types:

’PAYRECEIPT’,’SETTLE’

Input Parameters:

O = Optional, R= Required, R* = Required unless a value of PNRef is provided

Parameter Name Opt/Req Description

User name assigned in the payment server. The user must
UserName R have an appropriate level of access within the system in order
to return records.
Password R Password associated with the user name provided.
Unique numeric value used to identify the merchant for the
query. The RPNum is assigned by the gateway and acts as the
primary key for the merchant table.
RPNum R
Note: RPNum may also be called Merchant ID, Merchant
Number, or Vendor Key.
Unique payment reference number used to identify a single
transaction within the system. The payment reference number
(PNRef) is assigned by the payment server at the time the
PNRef O transaction is created.

Note: If a PNRef is provided, all other query fields will be

ignored.
Identifies the beginning date range for a group of
BeginDt R*
transactions.
EndDt R* Identifies the ending date range for a group of transactions.

84
 The payment type identifies the payment venue. If one or
more payment types are provided, only transactions with
matching PaymentType will be included in the results; all
other PaymentType values will be excluded. Valid entries
are:

• ‘ACH’ - Automated Clearing House

• ‘ECHECK’ - Electronic check
• ‘GUARANTEE’ - Guarantee check
• ‘PAYRECEIPT’ - receipt images uploaded to the server
PaymentType O • ‘SETTLE’ - transactions that have been finalized with the
payment host
• ‘VERIFY’ - Pre-authorized checks

Note: The default value for this field is “All”. If no value is

set, all payment types will be returned in the result set.

Or any permutation of the above values, e.g.

"’ACH’,’ECHECK’" will pull all transactions with either
ACH or ECHECK payment types.
The ExcludePaymentType parameter allows you to exclude
certain payment types from the result set. Any valid entry (or
combination) listed under the PaymentType parameter may
be used.

ExcludePaymentType O Note: If you pass the same value in the PaymentType and
ExcludePaymentType parameters, the entry in the
ExcludePaymentType parameter will override the
PaymentType and results of that type will be excluded.

This parameter accepts multiple values.

85
 If provided, only those transactions matching the TransType
will be included. Valid values are

• 'Authorization' to retrieve previously-authorized (pre-

auth) transactions
• 'Capture' to retrieve captured transactions
• 'Credit' to retrieve return transactions
• 'ForceCapture' to retrieve force-auth transactions
• 'GetStatus' to make an inquiry to the EBT or gift card’s
balance
• 'PostAuth' to retrieve post-auth transactions
TransType O
• 'Purged' to remove a transaction from the current batch
due to an error
• 'Receipt' to retrieve receipt images that were uploaded to
the payment server
• 'RepeatSale' to retrieve repeat-sale transactions
• 'Sale' to retrieve sale transactions
• 'Void' to retrieve void transactions

Or any permutation of the above values, e.g. "'Credit','Sale'"

will pull all transactions with either Credit or Sale transaction
types.
The ExcludeTransType parameter allows you to exclude
certain transaction types from the result set. Any valid entry
(or combination) listed under the TransType parameter may
be used.

Note: If you pass the same value in the TransType and

ExcludeTransType parameters, the entry in the
ExcludeTransType O ExcludeTransType parameter will override the TransType
and results of that type will be excluded.

Note: A value of ‘Void’ in the ExcludeTransType parameter

will be overridden by the ExcludeVoid if both parameters are
used.

This parameter accepts multiple values.

The approval code is a 6-character string (alphanumeric)
generated by the issuing bank. The code is used the card
issuer to verify the specific authorization when transactions
are being settled.
ApprovalCode O
Note: You may only query one approval code at a time;
however, approval codes are not necessarily unique and there
is potential (rare) for more than one record to be returned.

86
 The result indicates whether a transaction was approved
(Result = 0) or declined (Result ≠ 0). Valid entries are:

• Unused/blank returns both approved and declined

Result O transactions
• 0 - returns only approved transactions

Note: To return only declined transactions, leave this

parameter blank and use the ExcludeResult parameter.
The result indicates whether a transaction was approved
(Result = 0) or declined (Result ≠ 0). If provided, any
transactions matching the ExcludeResult input will be
ExcludeResult O excluded.

Note: To return a only declined transactions, set

ExcludeResult = 0
If an owner’s name is provided for this parameter, only those
transactions with matching names will be returned. Matching
NameOnCheck O
is done using wild cards: e.g. "test" will match "test", "1test"
and "1test234"
If a check number is provided for this parameter, only those
CheckNum O
transactions with a matching check number will be returned.
If a checking account number is provided, only those
transactions with matching account numbers will be
AcctNum O
returned. Matching is done using wild cards: e.g. "test" will
match "test", "1test" and "1test234"
If a route number (transit number) is provided, only those
transactions with matching route numbers will be
RouteNum O
returned. Matching is done using wild cards: e.g. "test" will
match "test", "1test" and "1test234"
The ExcludeVoid parameter allows you to exclude voided
transactions from the result set. Valid entries are:
ExcludeVoid O
• ‘TRUE’ - voided transactions are excluded
• ‘FALSE’ - voided transactions are included

If provided, only transactions generated by users with a

matching user ID will be included in the results. Matching is
User O
done using wild cards: e.g. "test" will match "test", "1test"
and "1test234"

87
 The invoice ID is assigned by the merchant. This identifier
can be used to locate a specific transaction or multiple
transactions grouped under a single invoice. If provided, only
InvoiceID O
transactions with a matching invoice ID will be included in
the results. Matching is done using wild cards: e.g. "test" will
match "test", "1test" and "1test234"
The SettleFlag parameter allows you to choose whether
settled or unsettled transactions are included in the results.
Valid entries are:
SettleFlag O
• Unused/blank returns all transactions
• ‘1’ - returns only settled transactions
• ‘0‘- return only transactions that are not yet settled

The settlement message is an ID or message returned from

the host upon settlement of a transaction. If provided, only
SettleMsg O the transaction that exactly matches the SettleMsg provided
will be returned. Matching is done using wild cards: e.g.
"test" will match "test", "1test" and "1test234"
If provided, only transactions that were settled on the same
SettleDt O
date will be included in the results.
Indicates how the result set should be formatted. Valid entries
are:

• ‘XML’ - outputs a plain XML string

• ‘XSL’ - uses XSL to format the XML output. If ‘XSL’ is
TransformType O selected, use the Xsl parameter to identify the XSL string
that will be used to format the output.
• ‘DELIM’ - outputs records in a delimited format. If ‘DELIM’
is selected, you may also pass values for the ColDelim,
RowDelim, and IncludeHeader parameters.

88
 This field is used only if the TransformType is XSL.

If provided, the resulting dataset will be transformed using

this XSL. You may pass in a URL to the XSL file, or the
XSL string itself. If this field is not empty, the Web Services
will try to locate the file from the URL. If that also fails, it
will treat it as an XSL string. In any case, the final XSL string
Xsl O will be loaded and validated against the XSL schema; if it
passes, then that XSL will be used for transformation. A
sample predefined XSL is included with this Web Services:

• https://<PMN assigned host

name>/admin/ws/TabDelim.xsl’ for a tab delimited
transformation

This field is used only if the TransformType is DELIM. This

defines the string that separates each column:
ColDelim O
e.g. a value of ‘@’, would separate each column value with
‘@’
This field is used only if the TransformType is DELIM. This
defines the string that separates each row
RowDelim O
e.g. a value of ‘!’ would start each row with ‘!’
This field is used only if the TransformType is DELIM. If
TRUE, then field headers will be included in the first row
IncludeHeader O
using the same delimiter strings; must either be TRUE or
FALSE

89
 The ExtData parameter allows you to pass additional
information to the web service that is not covered under the
input parameters. ExtData values need not be placed in any
particular order; however, they must be properly formatted
using XML tags.

Extended data in XML format. Valid values are:

• ‘<IMAGE_TYPE>NO_IMAGE</IMAGE_TYPE>’ – Will only

return transaction data that does not include image data
(to include signature data and check images)

• ‘<IMAGE_TYPE>ONLY_IMAGE</IMAGE_TYPE>’ – Will only

return transaction data that includes image data (to
include signature data and check images)

• ‘<IMAGE_TYPE>ALL</IMAGE_TYPE>’- will return

transaction with or without image data

• ‘<CustomerID>CustomerID</CustomerID>’ – specifies the

customer ID value to search by. Matching is done using
wild cards: e.g. "test" will match "test", "1test" and
ExtData O "1test234"

• ‘<Amount>Amount</Amount>’ – specifies the amount

value of the transactions being searched for. In
DDDDDD.CC format

• ‘<RegisterNum>RegisterNum</RegisterNum>’ - apecifies
the register number, originally passed with the
transaction, to search by
• <Timezone>Timezone</Timezone> - Used to convert the
input and output (where applicable) date/time values to
the desired timezone. When specified, the same timezone
is used to convert the begin/end date parameters as well
as the Date and Last Update output values. This field is
optional, and if omitted all date/time values are treated as
UTC. Daylight savings time adjustments, where
applicable, are handled automatically. Accepted values
are:

§ AKST – Alaskan Standard Time

§ CST – Central Standard Time

90
 § EST – Eastern Standard Time

§ HST – Hawaiian Standard Time

§ MST – Mountain Standard Time

§ AZMST – Arizona

§ PST – Pacific Standard Time

GetOpenBatchSummary
Service Location:

For SOAP connections:

https://gateway.sequelpay.com/vt/ws/trxdetail.asmx?op=GetOpenBatchSummary

For standard HTTPS connections:

https://gateway.sequelpay.com/vt/ws/trxdetail.asmx/GetOpenBatchSummary?

Description:
This web service retrieves a payment type transaction summary of the current open batch for a
specified merchant.

Developer Notes:
Date Formats: Dates entered through input parameters are automatically formatted to YYYY-MM-
DD. Valid entry formats are:

• MM/DD/YYYY
• YYYY-MM-DD

Date Query String: The query string used to obtain transactions in a date range is constructed as
follows:

(Date DT >=BeginDt) AND (Date DT <EndDt)

*Date DT is the transaction timestamp.

Input Parameters:
91
O = Optional, R = Required

Parameter
Opt/Req Description
Name
User name assigned in the payment server. The user must have an
UserName R
appropriate level of access within the system in order to return records.
Password R Password associated with the user name provided.
Unique numeric value used to identify the merchant for the query. The
RPNum is assigned by the gateway and acts as the primary key for the
merchant table.
RPNum R
Note: RPNum may also be called Merchant ID, Merchant Number, or
Vendor Key.
BeginDt R Identifies the beginning date range for a group of transactions.
EndDt R Identifies the ending date range for a group of transactions.

92
 The ExtData parameter allows you to pass additional information to the
web service that is not covered under the input parameters. ExtData
values need not be placed in any particular order; however, they must be
properly formatted using XML tags.

Extended data in XML format. Valid values are:

• <Timezone>Timezone</Timezone> - Used to convert the input and

output (where applicable) date/time values to the desired timezone.
When specified, the same timezone is used to convert the begin/end
date parameters as well as the Date and Last Update output values.
This field is optional, and if omitted all date/time values are treated
as UTC. Daylight savings time adjustments, where applicable, are
handled automatically. Accepted values are:
ExtData
§ AKST – Alaskan Standard Time

§ CST – Central Standard Time

§ EST – Eastern Standard Time

§ HST – Hawaiian Standard Time

§ MST – Mountain Standard Time

§ AZMST – Arizona

§ PST – Pacific Standard Time

93
Ch 5: Card Safe Web Services

StoreCard
Service Location:

For SOAP connections:

https://gateway.sequelpay.com/ws/cardsafe.asmx?op=StoreCard

For standard HTTPS connections:

https://gateway.sequelpay.com/ws/cardsafe.asmx/StoreCard?

Description:

This service is used to add a stored payment method to an existing customer record. Calling this
service is the first step towards succesfully storing and initiating recurring payments.

Developer Notes:

It is very important to understand that this web service is used for storing payment methods, and
is not for querying previously stored data. It is the responsibility of the integrator to store and
maintain all returned ‘Info Keys’ for later use.

It should also be noted that all information stored via the CardSafe will be accessible through the
Recurring web services and vice versa.

Input Parameters:

O = Optional, R = Required

Parameter
Opt/Req Description
Name
User name assigned in the payment server. The user must have an
UserName R appropriate level of access within the system in order to utilize the
web service.
Password R Password associated with the user name provided.

94
 Indicates what type of token will be returned when calling the
service.

• DEFAULT - Returns a numeric CcInfoKey

TokenMode R
• CARDFORMAT – Returns a randomly generated number in the
format of a credit card matching the card type of the actual card

Credit card number used to uniquely identify the card owner’s

CardNum R
account.
ExpDate R Credit card date of expiration in MMYY format.
Unique identifier assigned to the customer record by the system at
the time the customer record is created.

CustomerKey R Note: The CustomerKey value can be found on the virtual terminal
by accessing the View Customers option under the Recurring Billing
menu. Display a list of customers by entering search criteria. The
CustomerKey appears in the Key column.
NameOnCard O Card owner’s name as it appears on the card.
Street O Card owner’s billing address street name and number.
Zip O Card owner’s billing address postal/zip code.
ExtData O Reserved for future use.

ProcessCreditCard (CardSafe)
Service Location:

For SOAP connections:

https://gateway.sequelpay.com/ws/cardsafe.asmx?op=ProcessCreditCard

For standard HTTPS connections:

https://gateway.sequelpay.com/ws/cardsafe.asmx/ProcessCreditCard?

Description:

95
This web service allows an integrator to process a Credit Card Transaction against an account
that has been stored using AddCard

Developer Notes:

See Recurring Billing Web Services for more information on Credit Card Data storage.

Input Parameters:

O = Optional, R = Required, R* = Required for TransTypes Return, Void, Force, RepeatSale,

and Adjustment

Parameter
Opt/Req Description
Name
User name assigned in the payment server. The user must have an
UserName R
appropriate level of access in order to utilize the web service.
Password R Password associated with the user name provided.
Identifies the type of credit card transaction being made. Valid values
are:

• Sale - make a purchase using a credit card

• Auth – authorize the amount on a credit card
• Return – credits the card holder’s account
• Void – undo an unsettled transaction
• Force – force an Auth transaction in to the current batch (PostAuth)
or place a transaction not processed through the payment server
into the current batch (ForceAuth).
TransType R
Note: When using this transaction type for a ForceAuth, you must
include an AuthCode under the ExtData parameter.

• RepeatSale – perform a recurring billing or installment payment

transaction

Processors supporting the restaurant adjustment function only:

• Adjustment – used to modify an existing tip amount for an original

sale To call the service

Numerical key value assigned to the payment method when it was

CardToken R
added to the system.

96
 The type of token that is being used for the transaction.

• DEFAULT - Returns a numeric CcInfoKey

TokenMode R
• CARDFORMAT – Returns a randomly generated number in the
format of a credit card matching the card type of the actual card

Amount R Total transaction amount in DDDD.CC format.

The invoice ID is assigned by the merchant. This identifier can be
InvNum O used to locate a specific transaction or multiple transactions grouped
under a single invoice
Unique payment reference number used to identify a single
transaction within the system. The payment reference number
PNRef R*
(PNRef) is assigned by the payment server at the time the transaction
is created.
ExtData O Reserved for future use.

97
Ch 6: Response Field Definitions

Reporting (TrxDetail.asmx)
The following response fields may be part of the return value for web services using
transact.asmx operations. These web services include:

Applicable Web Services

• GetCardTrx
• GetCardTrxSummary
• GetCheckTrx
• GetOpenBatchSummary

Response Field Definitions:

Response Field Data Type Value Description Remarks

Returns the card type
A string value up to 10
Account_Type_CH of the transaction, e.g.
characters
VISA, Diners, EBT
This field will be
masked out with
asterisk (*) characters
A string value up to Returns the check
AccountNum_VC except for the last 4
200 characters account number
digits if the System
Security Level of the
user is set to 1
This field will be
masked out with
asterisk (*) characters
A string value up to Returns credit card
Acct_Num_CH except for the last 4
200 characters number
digits if the System
Security Level of the
user is set to 1
A string value
Returns the check’s
Amount_MN representing a signed
total amount
64-bit real number

98
 Returns the response
A string value up to 50
Approval_Code_CH code from the
characters
payment processor
A string value Returns the
Auth_Amt_MN representing a signed authorized amount of
64-bit real number a card transaction
Returns the dollar
A string value
amount of all
Authorization representing a signed
Authorization
64-bit real number
(PreAuth) transactions
Returns the
A string value
transaction count of
Authorization_Cnt representing a signed
all Authorization
32-bit integer
(PreAuth) transactions
Returns the address
A string value up to 1 verification result
AVS_Resp_CH
character code from the
payment processor
Returns the formatted
response message
A string value up to 25
AVS_Resp_Txt_VC when address
characters
verification is
performed
Returns the batch
Not all payment
number for the
A string value up to 10 processors support
Batch_Number transaction that was
characters returning this data
returned by the
element
payment processor
A string value Returns the dollar
This value will
Capture representing a signed amount of all Capture
always return “0”
64-bit real number transactions
Returns the
A string value
transaction count of This value will
Capture_Cnt representing a signed
all Capture always return “0”
32-bit integer
transactions
A string value Returns the primary
Card_Info_Key representing a signed key of the CC_Info_T
32-bit integer table in the database

99
 A string value Returns the cash back
Cash_Back_Amt_MN representing a signed amount for a debit or
64-bit real number EBT transaction
A string value up to 10 Returns the check
CheckNum_CH
characters number
A string value Returns the
Cnt representing a signed transaction count of
32-bit integer all transactions
Returns the Customer
A string value up to 50 ID of a customer to
CustomerID
characters which the transaction
belongs to
Returns the card
A string value up to 1 verification result
CV_Resp_CH
character code from the
payment processor
Returns the formatted
A string value up to 25 response message
CV_Resp_Txt_VC
characters when card verification
is performed
A string value Returns the date on
Date_DT representing a date and which the transaction
time is first made
Returns an error
message when a
A string value up to
ERROR problem occurs
200 characters
during the transaction
processing
A string value up to 10 Returns the credit
Exp_CH
characters card expiration date
Returns the dollar
A string value amount of all
ForceCapture representing a signed ForceCapture
64-bit real number (ForceAuth)
transactions
Returns the
A string value transaction count of
ForceCapture_Cnt representing a signed all ForceCapture
32-bit integer (ForceAuth)
transactions

100
 Returns the payment
A string value up to 10 processor’s date on
Host_Date_CH
characters which the transaction
is performed
Returns a number
which uniquely
A string value up to 30
Host_Ref_Num_CH identifies the
characters
transaction for the
payment processor
Returns the payment
A string value up to 10 processor’s time at
Host_Time_CH
characters which the transaction
was performed
Returns the
A string value up to
Invoice_ID transaction’s Invoice
100 characters
number
Returns the IP address
of the client machine
A string value up to 15
IP_VC from which the
characters
transaction was
processed
Returns the date and
A string value
time on which the
Last_Update_DT representing a date and
transaction is last
time
modified
A string value
Returns the card was
Manual representing a Boolean
swiped or not
value
A string value Returns a number
Merchant_Key representing a signed which uniquely
32-bit integer identifies a merchant
A string value up to 25 Returns the name of
Name_on_Card_VC
characters the cardholder
Returns the check
A string value up to 25
NameOnCheck_VC payer’s name on the
characters
check
Returns the
A string value
TRX_HD_Key on
Orig_TRX_HD_Key representing a signed
which the current
32-bit integer
transaction is based

101
 A string value up to 10 Returns the payment
Payment_Type_ID
characters type, e.g. ECHECK
A string value Returns the dollar
PostAuth representing a signed amount of all
64-bit real number PostAuth transactions
Returns the
A string value
transaction count of
PostAuth_Cnt representing a signed
all PostAuth
32-bit integer
transactions
Returns the name the
A string value up to 10
Processor_ID payment processor,
characters
e.g. Vital
Returns the dollar
A string value
amount of all This value will
Receipt representing a signed
transactions with a always return “0”
64-bit real number
Receipt
Returns the
A string value
transaction count of This value will
Receipt_Cnt representing a signed
all transactions with a always return “0”
32-bit integer
Receipt
This field is not the
unique transaction
identifier (also called
PNRef) of the
Ref_Number_CH A string Not currently used
Payment Server. See
the field
TRX_HD_Key for
the PNRef value
Returns the register
A string value up to 10
Register_Number_CH number of a
characters
transaction
Returns the dollar
amount of all
A string value
RepeatSale
RepeatSale representing a signed
(Recurring
64-bit real number
Billing/Installment)
transactions

102
 Returns the
transaction count of
A string value
all RepeatSale
RepeatSale_Cnt representing a signed
(Recurring
32-bit integer
Billing/Installment)
transactions
A string value Returns the primary
Reseller_Key representing a signed key of the Reseller_T
32-bit integer table in the database
Returns the
transaction processing
A string value up to 50
Result_CH result, e.g. 0, 12. “0”
characters
for approval, “12” for
decline
Returns the check
A string value up to 50
Result_Msg_VC transaction’s
characters
processing result
Returns an extra
formatted response
A string value up to 50
Result_Msg1_VC message giving more
characters
information about the
processed transaction
Returns an extra
formatted response
A string value up to 50
Result_Msg2_VC message giving more
characters
information about the
processed transaction
Returns the text
message of either
A string value up to
Result_Txt_VC approval or decline
150 characters
for the transaction
processing result
A string value Returns the dollar
Return representing a signed amount of all Return
64-bit real number (Credit) transactions
Returns the
A string value
transaction count of
Return_Cnt representing a signed
all Return (Credit)
32-bit integer
transactions

103
 A string value Returns the dollar
Sale representing a signed amount of all Sale
64-bit real number transactions
A string value Returns the
Sale_Cnt representing a signed transaction count of
32-bit integer all Sale transactions
A string value Returns the date on
Settle_Date_DT representing a date and which the transaction
time is settled
A string value
representing a value of
Returns if the
0=Not Settled,
Settle_Flag_CH transaction is settled
1=Settled, 2=Rolled
or not
Back/Indeterminate,
5=In Progress
A string value up to 10
StateCode_CH Returns the state code
characters
Returns the billing
A string value up to 25
Street_CH street address of the
characters
credit card
A string value Returns the sure
SureCharge_Amt_MN representing a signed charge amount of a
64-bit real number transaction
A string value Returns the tip
Tip_Amt_MN representing a signed amount of a
64-bit real number transaction
Returns the
A string value up to 20
Trans_Type_ID transaction type, e.g.
characters
Sale, Credit
Returns the
Only for use with
Transport_Method A string Transportation
Dial-up transactions
Method
Returns the
Only for use with
Transport_EndPoint A string Transportation’s
Dial-up transactions
Ending Destination

104
 This field will be
masked out with
asterisk (*) characters
A string value up to Returns the
TransitNum_VC except for the last 4
200 characters transit/routing number
digits if the System
Security Level of the
user is set to 1
Returns the primary
A string value
key of the
TRX_Card_Key representing a signed
TRX_Card_T table in
32-bit integer
the database
Returns the primary
A string value
key of the
TRX_Check_Key representing a signed
TRX_Check_T table
32-bit integer
in the database
This field is the
unique transaction
identifier (also called
PNRef) of the
Returns the primary Payment Server. Use
A string value
key of the its value when
TRX_HD_Key representing a signed
TRX_Header_T table submitting
32-bit integer
in the database transactions based on
a previous transaction
(i.e. Voids) through
the Transact.asmx
Web Service
Returns the primary
A string value
key of the
TRX_Settle_Key representing a signed
TRX_Settle_T table
32-bit integer
in the database
Returns the
A string value up to 25
TRX_Settle_Msg_VC transaction’s
characters
settlement message
Returns the credit
A string value up to 10
Type_CH card type, e.g. VISA,
characters
MASTERCARD
Returns the username,
A string value up to 25 under which the
User_Name_VC
characters transactions were
made

105
 A string value Returns the
Void_Flag_CH representing a Boolean transaction is voided
value or not
A string value up to 10 Returns the billing zip
Zip_CH
characters code of the credit card
A string value Returns the
Auth_Amt_MN representing a signed authorized amount of
64-bit real number a card transaction
Returns the dollar
A string value
amount of all
Authorization representing a signed
Authorization
64-bit real number
(PreAuth) transactions
Returns the
A string value
transaction count of
Authorization_Cnt representing a signed
all Authorization
32-bit integer
(PreAuth) transactions
Returns the address
A string value up to 1 verification result
AVS_Resp_CH
character code from the
payment processor
Returns the formatted
response message
A string value up to 25
AVS_Resp_Txt_VC when address
characters
verification is
performed
Returns the batch
Not all payment
number for the
A string value up to 10 processors support
Batch_Number transaction that was
characters returning this data
returned by the
element
payment processor
A string value Returns the dollar
This value will
Capture representing a signed amount of all Capture
always return “0”
64-bit real number transactions
Returns the
A string value
transaction count of This value will
Capture_Cnt representing a signed
all Capture always return “0”
32-bit integer
transactions
A string value Returns the primary
Card_Info_Key representing a signed key of the CC_Info_T
32-bit integer table in the database

106
 A string value Returns the cash back
Cash_Back_Amt_MN representing a signed amount for a debit or
64-bit real number EBT transaction
A string value up to 10 Returns the check
CheckNum_CH
characters number
A string value Returns the
Cnt representing a signed transaction count of
32-bit integer all transactions
Returns the Customer
A string value up to 50 ID of a customer to
CustomerID
characters which the transaction
belongs to
Returns the card
A string value up to 1 verification result
CV_Resp_CH
character code from the
payment processor
Returns the formatted
A string value up to 25 response message
CV_Resp_Txt_VC
characters when card verification
is performed
A string value Returns the date on
Date_DT representing a date and which the transaction
time is first made
Returns an error
message when a
A string value up to
ERROR problem occurs
200 characters
during the transaction
processing
A string value up to 10 Returns the credit
Exp_CH
characters card expiration date
Returns the dollar
A string value amount of all
ForceCapture representing a signed ForceCapture
64-bit real number (ForceAuth)
transactions
Returns the
A string value transaction count of
ForceCapture_Cnt representing a signed all ForceCapture
32-bit integer (ForceAuth)
transactions

107
 Returns the payment
A string value up to 10 processor’s date on
Host_Date_CH
characters which the transaction
is performed
Returns a number
which uniquely
A string value up to 30
Host_Ref_Num_CH identifies the
characters
transaction for the
payment processor
Returns the payment
A string value up to 10 processor’s time at
Host_Time_CH
characters which the transaction
was performed
Returns the
A string value up to
Invoice_ID transaction’s Invoice
100 characters
number
Returns the IP address
of the client machine
A string value up to 15
IP_VC from which the
characters
transaction was
processed
Returns the date and
A string value
time on which the
Last_Update_DT representing a date and
transaction is last
time
modified
A string value
Returns the card was
Manual representing a Boolean
swiped or not
value
A string value Returns a number
Merchant_Key representing a signed which uniquely
32-bit integer identifies a merchant
A string value up to 25 Returns the name of
Name_on_Card_VC
characters the cardholder
Returns the check
A string value up to 25
NameOnCheck_VC payer’s name on the
characters
check
Returns the
A string value
TRX_HD_Key on
Orig_TRX_HD_Key representing a signed
which the current
32-bit integer
transaction is based

108
 A string value up to 10 Returns the payment
Payment_Type_ID
characters type, e.g. ECHECK
A string value Returns the dollar
PostAuth representing a signed amount of all
64-bit real number PostAuth transactions
Returns the
A string value
transaction count of
PostAuth_Cnt representing a signed
all PostAuth
32-bit integer
transactions
Returns the name the
A string value up to 10
Processor_ID payment processor,
characters
e.g. Vital
Returns the dollar
A string value
amount of all This value will
Receipt representing a signed
transactions with a always return “0”
64-bit real number
Receipt
Returns the
A string value
transaction count of This value will
Receipt_Cnt representing a signed
all transactions with a always return “0”
32-bit integer
Receipt
This field is not the
unique transaction
identifier (also called
PNRef) of the
Ref_Number_CH A string Not currently used
Payment Server. See
the field
TRX_HD_Key for
the PNRef value
Returns the register
A string value up to 10
Register_Number_CH number of a
characters
transaction
Returns the dollar
amount of all
A string value
RepeatSale
RepeatSale representing a signed
(Recurring
64-bit real number
Billing/Installment)
transactions

109
 Returns the
transaction count of
A string value
all RepeatSale
RepeatSale_Cnt representing a signed
(Recurring
32-bit integer
Billing/Installment)
transactions
A string value Returns the primary
Reseller_Key representing a signed key of the Reseller_T
32-bit integer table in the database
Returns the
transaction processing
A string value up to 50
Result_CH result, e.g. 0, 12. “0”
characters
for approval, “12” for
decline
Returns the check
A string value up to 50
Result_Msg_VC transaction’s
characters
processing result
Returns an extra
formatted response
A string value up to 50
Result_Msg1_VC message giving more
characters
information about the
processed transaction
Returns an extra
formatted response
A string value up to 50
Result_Msg2_VC message giving more
characters
information about the
processed transaction
Returns the text
message of either
A string value up to
Result_Txt_VC approval or decline
150 characters
for the transaction
processing result
A string value Returns the dollar
Return representing a signed amount of all Return
64-bit real number (Credit) transactions
Returns the
A string value
transaction count of
Return_Cnt representing a signed
all Return (Credit)
32-bit integer
transactions

110
 A string value Returns the dollar
Sale representing a signed amount of all Sale
64-bit real number transactions
A string value Returns the
Sale_Cnt representing a signed transaction count of
32-bit integer all Sale transactions
A string value Returns the date on
Settle_Date_DT representing a date and which the transaction
time is settled
A string value Returns if the
Settle_Flag_CH representing a Boolean transaction is settled
value or not
A string value up to 10
StateCode_CH Returns the state code
characters
Returns the billing
A string value up to 25
Street_CH street address of the
characters
credit card
A string value Returns the sure
SureCharge_Amt_MN representing a signed charge amount of a
64-bit real number transaction
A string value Returns the tip
Tip_Amt_MN representing a signed amount of a
64-bit real number transaction
A string value Returns the total
Total_Amt_MN representing a signed amount of a
64-bit real number transaction
Returns the
A string value up to 20
Trans_Type_ID transaction type, e.g.
characters
Sale, Credit
Returns the
Only for use with
Transport_Method A string Transportation
Dial-up transactions
Method
Returns the
Only for use with
Transport_EndPoint A string Transportation’s
Dial-up transactions
Ending Destination

111
 This field will be
masked out with
asterisk (*) characters
A string value up to Returns the
TransitNum_VC except for the last 4
200 characters transit/routing number
digits if the System
Security Level of the
user is set to 1
Returns the primary
A string value
key of the
TRX_Card_Key representing a signed
TRX_Card_T table in
32-bit integer
the database
Returns the primary
A string value
key of the
TRX_Check_Key representing a signed
TRX_Check_T table
32-bit integer
in the database
This field is the
unique transaction
identifier (also called
PNRef) of the
Returns the primary Payment Server. Use
A string value
key of the its value when
TRX_HD_Key representing a signed
TRX_Header_T table submitting
32-bit integer
in the database transactions based on
a previous transaction
(i.e. Voids) through
the Transact.asmx
Web Service
Returns the primary
A string value
key of the
TRX_Settle_Key representing a signed
TRX_Settle_T table
32-bit integer
in the database
Returns the
A string value up to 25
TRX_Settle_Msg_VC transaction’s
characters
settlement message
Returns the credit
A string value up to 10
Type_CH card type, e.g. VISA,
characters
MASTERCARD
Returns the username,
A string value up to 25 under which the
User_Name_VC
characters transactions were
made

112
 A string value Returns the
Void_Flag_CH representing a Boolean transaction is voided
value or not
A string value up to 10 Returns the billing zip
Zip_CH
characters code of the credit card

Processing Services (transact.asmx)

The following response fields may be part of the return value for web services using
transact.asmx operations. These web services include:

Applicable Web Services

• GetInfo
• ProcessCheck
• ProcessCreditCard
• ProcessDebitCard
• ProcessEBTCard
• ProcessGiftCard
• ProcessSignature

Response Field Definitions:

Value
Response Field Data Type Descriptio Remarks
n
Returns
the
A string
transaction This value can be either an approval code, for
value up to
AuthCode result code approved transactions, or an error code, for
50
from the declined transactions
characters
payment
processor

113
 The value of ExtData will be in a specific
format. The format typically consists of the
name of the data field, an equal sign, and then
Returns
A string the value for the data field. Multiple data fields
extra data
value up to are separated with a comma. See the “Web
ExtData from the
500 Service ExtData Response Field Data Elements”
processed
characters for full description of data elements that can be
transaction
returned. The following is an example of the
format: ExtName1=ExtValue1,ExtName2=ExtVa
lue2
Returns
the overall
address
When programmatically validating an AVS
A string verificatio
Result, this value should ALWAYS be used
GetAVSResult value up to n result
instead of any formatted response message
1 character code from
describing the result
the
payment
processor
Returns
the
formatted
A string response
Do NOT use this when programmatically
GetAVSResultTX value up to message
validating a transaction’s AVS result; please see
T 25 when
GetAVSResult field
characters address
verificatio
n is
performed
Returns
the
This value is only applicable to credit card
payment
transactions. The card verification number is
A string processor'
typically printed on the back of the card and not
value s response
embossed on the front. It is used as an extra
GetCommercialCa representin indicator
authentication method for "card not present"
rd ga that
transactions. When programmatically validating
Boolean specifies if
a CV Result, this value should ALWAYS be
value the card is
used instead of any formatted response message
a
describing the result
commerci
al card

114
 This value is only applicable to credit card
Returns
transactions. The card verification number is
the card
typically printed on the back of the card and not
verificatio
A string embossed on the front. It is used as an extra
n result
GetCVResult value up to authentication method for "card not present"
code from
1 character transactions. When programmatically validating
the
a CV Result, this value should ALWAYS be
payment
used instead of any formatted response message
processor
describing the result
Returns
the
formatted
A string This value is only applicable to credit card
response
value up to transactions. Do NOT use this when
GetCVResultTXT message
25 programmatically validating a transaction’s CV
when card
characters result; please see GetCVResult field
verificatio
n is
performed
Returns
the
formatted
response
A string message
This value will typically be “Match”, for
GetStreetMatchTX value up to when
correctly matching the street address, or “No
T 25 street
Match”, for an incorrect street address
characters number
address
verificatio
n is
performed
Returns
the
formatted
response
A string
message This value will typically be “Match”, for
value up to
GetZipMatchTXT when zip correctly matching the zip code, or “No Match”,
25
code for an incorrect zip code
characters
address
verificatio
n is
performed

115
 Typically
returns a
number
which
A string
uniquely
value up to This value may not be returned for all payment
HostCode identifies
30 processors
the
characters
transaction
in the
payment
processor
Returns a
formatted
This value will typically be “APPROVAL”, for
A string response
approved transactions, or an error message, for
value up to message
Message declined transactions. Do NOT use this when
50 concernin
programmatically validating a transaction’s
characters g the
result; please see Result field below
processed
transaction
Returns an
extra
formatted
response
A string message
The Payment Server will only populate this field
value up to giving
Message1 when there is applicable information from the
50 more
payment processor to return
characters informatio
n about
the
processed
transaction
Returns an
extra
formatted
response
A string message
The Payment Server will only populate this field
value up to giving
Message2 when there is applicable information from the
50 more
payment processor to return
characters informatio
n about
the
processed
transaction

116
 Returns a
number
A string which
value uniquely
representin identifies
PNRef
g a signed the
32-bit transaction
integer in the
payment
gateway
Returns
the
A string response This value is typically either Approved or
value up to message Declined. Do NOT use this when
RespMSG
50 concernin programmatically validating a transaction’s
characters g the result; please see Result field below
processed
transaction
Returns
the
transaction
result code
from the
A string payment When programmatically validating a
value gateway transaction’s result, this value should ALWAYS
representin which be used instead of any response message
Result
g a signed signifies describing the result. See the “Result Response
32-bit the result Fields Definitions” section for a full list of result
integer of the values and descriptions
transaction
(i.e.
approved,
decline,
etc.)

Result Response Field Definition

Value Description

117
-100 Transaction NOT Processed; Generic Host Error
0 Approved
1 User Authentication Failed
2 Invalid Transaction
3 Invalid Transaction Type
4 Invalid Amount
5 Invalid Merchant Information
7 Field Format Error
8 Not a Transaction Server
9 Invalid Parameter Stream
10 Too Many Line Items
11 Client Timeout Waiting for Response
12 Decline
13 Referral
14 Transaction Type Not Supported In This Version
19 Original Transaction ID Not Found
20 Customer Reference Number Not Found
22 Invalid ABA Number
23 Invalid Account Number
24 Invalid Expiration Date
25 Transaction Type Not Supported by Host
26 Invalid Reference Number
27 Invalid Receipt Information
28 Invalid Check Holder Name
29 Invalid Check Number
30 Check DL Verification Requires DL State
Transaction did not connect (to NCN because SecureNCIS is not running on the web
40
server)
50 Insufficient Funds Available

118
99 General Error
100 Invalid Transaction Returned from Host
101 Timeout Value too Small or Invalid Time Out Value
102 Processor Not Available
103 Error Reading Response from Host
104 Timeout waiting for Processor Response
105 Credit Error
106 Host Not Available
107 Duplicate Suppression Timeout
108 Void Error
109 Timeout Waiting for Host Response
110 Duplicate Transaction
111 Capture Error
112 Failed AVS Check
113 Cannot Exceed Sales Cap
1000 Generic Host Error
1001 Invalid Login
1002 Insufficient Privilege or Invalid Amount
1003 Invalid Login Blocked
1004 Invalid Login Deactivated
1005 Transaction Type Not Allowed
1006 Unsupported Processor
1007 Invalid Request Message
1008 Invalid Version
1010 Payment Type Not Supported
1011 Error Starting Transaction
1012 Error Finishing Transaction
1013 Error Checking Duplicate
1014 No Records To Settle (in the current batch)

119
1015 No Records To Process (in the current batch)

ExtData Field Definitions

Response
Description Notes
Field
Not all payment processors
Current batch number for transactions, settlement,
BatchNum support returning this data
and batch inquiries.
element.
Credit card type (VISA, MASTERCARD, etc) or
This value is not returned for
CardType payment method (Debit, EBT, or EGC) for card-
Check/ACH payments.
based payments.
Invoice number for the transaction that was
InvNum originally sent in the request to the Payment
Server.

AVS Response Field Definitions

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

120
 R Retry: System unavailable or time-out
Error: Transaction unintelligible for AVS or edit error found in the message that
E
prevents AVS from being performed
S Not Supported: Issuer doesn’t support AVS service
Street Match: Street addresses match for international transaction, but postal code
B
doesn’t
Street Address: Street addresses and postal code not verified for international
C
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
Postal Match: Postal codes match for international transaction, but street address
P
doesn’t
0 No response sent
5 Invalid AVS response

CV Response Field Definitions

Value Description
M CVV2/CVC2/CID Match
N CVV2/CVC2/CID No Match
P Not Processed
Issuer indicates that the CV data should be present on the card, but the merchant has
S
indicated that the CV data is not present on the card.
Unknown / Issuer has not certified for CV or issuer has not provided Visa/MasterCard
U
with the CV encryption keys.
X Server Provider did not respond

121