Академический Документы
Профессиональный Документы
Культура Документы
Version: 7.4.8
05.20.2018
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
ADDED:
- Credit Voucher and Merchandise Return Authorization Messages
UPDATED:
- Include Discover Stored Credential / Cardholder Initiated
Transaction/Merchant Initiated Transaction (CIT/MIT) framework
- Support for design change for CIT/MIT framework
- Table - VBN for CAVV Processing Changes
- Table – Chilean Peso Exponent value from 2 to 0
- Description for Level 2 Data Summary fields.
- To reflect field requirement for TAA Records from mandatory to
optional.
- Expanded description for Level 3 Data Summary fields: Detail
Description and Detail Product Code
- Pinless Debit Codes
Legal Notice
©2018 Chase Paymentech Solutions, LLC. All rights reserved. All trademarks, registered trademarks,
product names and logos identified or mentioned herein are the property of Paymentech, LLC, Chase
Paymentech Solutions, LLC, Chase Paymentech Europe Limited, or their respective owners.
This edition of the Spectrum Developers Guide contains information available at the time of publication
and supersedes, in its entirety, all previously published documents by Chase Paymentech.
ALL INFORMATION IS PROVIDED BY PAYMENTECH, LLC, CHASE PAYMENTECH SOLUTIONS,
LLC, CHASE PAYMENTECH EUROPE LIMITED, AND THEIR RESPECTIVE AFFILIATES
(COLLECTIVELY “CHASE PAYMENTECH”) ON AN "AS IS" AND “AS AVAILABLE” BASIS ONLY AND
WITHOUT CONDITION, ENDORSEMENT, GUARANTEE, REPRESENTATION, OR WARRANTY OF
ANY KIND BY CHASE PAYMENTECH.
Chase Paymentech does not guarantee or assume responsibility for any typographical, technical or other
inaccuracies, errors or omissions in this document. Recipient’s use of this document is at the recipient’s
own risk. Chase Paymentech reserves the right to periodically change information contained in this
document, however, Chase Paymentech is under no obligation to provide any such changes, revisions,
updates, enhancements, or other additions to this document to recipient in a timely manner or at all.
This document contains confidential and proprietary information of Chase Paymentech Solutions, LLC
and Paymentech, LLC (collectively referred to as “Chase Paymentech”). No disclosure or duplication of
any portion of these materials may be made without the express written consent of Chase Paymentech.
These materials must be used solely for the operation of Chase Paymentech programs and for no other
use.
This document may contain references to third party sources of information, hardware, software, products
or services (“Third Party Content”). Chase Paymentech does not control and is not responsible for any
Third Party Content.
This document is intended to support technical requirements for processing transactions only. It is not
intended to be a guarantee that merchants will qualify for the best interchange rates from the payment
brands or that merchant’s transactions are in compliance with applicable Payment Brand Rules.
CHASE PAYMENTECH PROVIDES NO REPRESENTATIONS AND WARRANTIES, EXPRESS,
IMPLIED, STATUTORY OR OTHERWISE, INCLUDING WITHOUT LIMITATION ANY WARRANTY OR
CONDITION REGARDING QUALITY, SUITABILITY, MERCHANTABILITY, FITNESS FOR USE OR
FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT OR OTHERWISE (REGARDLESS
OF ANY COURSE OF DEALING, CUSTOM OR USAGE OF TRADE).
IN NO EVENT WILL CHASE PAYMENTECH BE LIABLE TO ANY PARTY FOR ANY TYPES OF
DAMAGES RELATED TO THIS DOCUMENT OR ITS USE, OR PERFORMANCE OR NON-
PERFORMANCE OF ANY SOFTWARE, HARDWARE, SERVICE OR ANY THIRD PARTY PRODUCTS
AND SERVICES REFERENCED HEREIN INCLUDING WITHOUT LIMITATION ANY DIRECT,
INDIRECT, SPECIAL, CONSEQUENTIAL, EXEMPLARY, PUNITIVE OR AGGRAVATED DAMAGES
FOR ANY USE OF THIS DOCUMENT OR THE INFORMATION CONTAINED HEREIN, INCLUDING,
WITHOUT LIMITATION, ANY LOST PROFITS, LOSS OF BUSINESS OPPORTUNITY, BUSINESS
INTERRUPTION, CORRUPTION OR LOSS OF DATA OR PROGRAMS, FAILURE TO TRANSMIT OR
RECEIVE DATA OR DOWNTIME COSTS, WHETHER OR NOT SUCH DAMAGES WERE FORESEEN
OR UNFORESEEN, AND EVEN IF CHASE PAYMENTECH HAS BEEN EXPRESSLY ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
THE LIMITATIONS, EXCLUSIONS, AND DISCLAIMERS HEREIN APPLY IRRESPECTIVE OF THE
NATURE OF THE CAUSE OF ACTION, DEMAND OR ACTION BY RECIPIENT INCLUDING WITHOUT
LIMITATION BREACH OF CONTRACT, NEGLIGENCE, TORT, STRICT LIABILITY OR ANY OTHER
LEGAL THEORY.
Table of Contents
1. Introduction 9
2. Certification 10
2.1 Mandatory Certification Requirements 10
2.2 Gateway servers 10
2.3 Authentication 10
2.3.1 Connection Username/Password Format 11
2.4 Data Encryption 12
3. Installation Process 13
3.1 Installation Types 13
3.2 “Complete” SDK Installation 13
3.2.1 Prerequisite for Installing the “Complete” SDK 13
3.2.2 “Complete” SDK Installation Instructions 13
3.2.3 Required SDK Resources at Run 14
3.2.4 Environment Settings 14
3.2.5 Upgrading or Re-Installing 14
3.3 “Template-Only” SDK Installation 15
3.3.1 “Template-Only” Installation Instructions 15
Chase Orbital Gateway COM and .NET SDK Developer’s Guide iii
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
6.1 Overview 27
6.2 Transaction 27
6.2.1 TransactionProcessor in COM 27
6.2.2 Transaction in C# 28
6.3 Request 28
6.3.1 Request in COM 28
6.3.2 Request in .NET 29
6.4 Response 29
6.4.1 Response in COM 29
6.4.2 Response in .NET 29
6.5 Exception 30
6.5.1 Exception in COM and .NET 30
7. Samples 31
9. SDK Functionality 35
9.1 Certification 35
9.2 Account Verification 36
9.3 Reversals 37
9.4 Inquiry 38
9.5 Retry Logic 39
9.5.1 Overview 39
9.5.2 Business Rules 39
9.5.3 TraceNumber rules: 39
9.5.4 Enabling Automatic Retries in the Orbital Gateway SDK 39
9.6 Cardholder Authentication 41
9.6.1 Address Verification 41
9.6.2 Card Verification Numbers 41
9.6.3 Verified By Visa and MasterCard SecureCode 43
9.6.4 MasterCard SecureCode 44
9.6.5 Merchant Requirements 45
9.6.6 Business Rules 45
9.6.7 Chargeback Liability Sift Exclusions 46
9.7 MasterPass Wallet 46
9.7.1 How it works 46
9.7.2 Transaction Flow 47
9.7.3 Business Rules 47
9.7.4 MasterPass Incentive Program 47
9.7.5 Additional Notes 47
9.8 Profiles and Managed Billing 48
9.8.1 Supports both Recurring and non-Recurring charges 48
9.8.2 Benefits 48
9.8.3 Setup Information 48
9.8.4 Business Rules 49
9.8.5 How it works 49
9.8.6 Customer Reference Number Options 49
9.8.7 Setting the Customer Reference Number 50
9.8.8 Salem Hierarchy 51
Chase Orbital Gateway COM and .NET SDK Developer’s Guide vii
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide viii
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
1. Introduction
Chase Paymentech’s Software Development Kit (SDK) for the Orbital Gateway includes a powerful
Application Programming Interface (API) that enables developers to create and integrate real-time
electronic payment transactions with eCommerce applications. Orbital supports a wide variety of
electronic payment options that are continuously evolving. To keep pace with this dynamic environment,
the SDK’s modular design enables integration of new transaction types by simply performing “Template
Library Updates”. This eliminates the need to reinstall and/or recompile the SDK. If enhancements to
other SDK modules occur, Published Interfaces are used to provide programmatic consistency across
versions to minimize coding impact.
For convenience the Orbital SDK includes dll files that are not developed and/or maintained by Chase.
Management of these components, like other components (Operating System, AVM, Language, etc.), is
considered a standard system administration process and is the responsibility of the administrator.
2. Certification
Before aggregators, software vendors, or merchants can utilize any of the functionality in this section, the
implementation must go through the appropriate certification process with Chase Paymentech. Please
work with your Chase Paymentech Representative to schedule testing and certification as necessary.
2.1 Mandatory Certification Requirements
The following list includes items that are required for all certification and recertification requests. This list is not
necessarily all inclusive. Please speak with your Chase Paymentech Integration Consultant to discuss further.
ChaseNet – All new certifications must validate the ability to handle all current ChaseNet methods of
payment.
Retry Logic – Mandatory for all merchants who process PINless Debit. For all merchants, in general,
Retry Logic is highly recommended and a best practice when processing over the Internet.
Profile Fetch, Profile Update, Profile Delete – If using Orbital Gateway’s Profile Management or Managed
Billing features, supporting Profile Fetch/Update/Delete requests is highly recommended to maintain the
merchant’s repository of profiles on the Orbital Gateway system.
2.2 Gateway servers
The hostname setting is either the name or IP address of the Orbital Gateway. Chase Paymentech
maintains two Orbital Gateway systems.
Testing and certification system. The address for this system is:
o URL: orbitalvar1.chasepaymentech.com and orbitalvar2.chasepaymentech.com
o Port: 443
Production system. The address for this system is:
o URL: orbital1.chasepaymentech.com and orbital2.chasepaymentech.com
o Port: 443
Notes:
The Orbital Gateway Certification Platform is only monitored for availability and supported during
business hours [8:00am ET – 5:00pm ET Monday – Friday].
Caching IP Addresses of NetConnect servers is strongly discouraged. For load balancing and
redundancy reasons, Orbital Gateway processing is divided across multiple data centers. Therefore,
the DNS service should be used to determine the destination IP address for each transaction.
The testing and certification hostname is the default setting. Prior to going live, please make sure this
addressing configuration is changed to the production hostname.
2.3 Authentication
The Orbital Gateway supports Connection Username/Password authentication for incoming requests.
This means:
The Username and Password are passed in the message payload. Each must match what is
registered on the Orbital Gateway in order to process transactions in the Test or Production
environments.
An HTTP 412 error is returned for all activity wherein the Connection Username/Password is not
registered in the Orbital Gateway. The accompanying XML payload contains a ProcStatus 20412
error (See Table Process Status and Process Status Message values in Appendix for definition of
these error fields for more information).
In addition, the Connection Username must be affiliated with the Client’s Merchant IDs:
This allows Third-Party Hosting service organizations presenting on behalf of other merchants to
submit transactions. However, each time a new customer is added, the merchant or third-party
hosting organization must ensure that the new Merchant IDs or Chain IDs are affiliated with the
hosting company's Connection Username.
If the merchant expects to have more than one merchant account with the Orbital Gateway, it
should have its Connection Username affiliated at the Chain-level hierarchy within the Orbital
Gateway.
Each time a new Merchant ID (MID) is added, as long as it is placed within the same Chain, it will
simply work. If it is not placed within the same Chain, the additional MIDs must be affiliated with
the Connection Username. For example, we generally affiliate all Salem accounts (BIN 000001)
with their Company Number (formerly called MA #), so all MIDs or Divisions under that Company
are automatically affiliated.
MID-Association Failures
1. If a Connection Username is registered, but the client presents a MID that has NOT been
associated with the Username, the Orbital Gateway will return a ProcStatus 20412.
Note For existing merchants using IP-based authentication, please be advised that IP-based
authentication and Connection Username/Password authentication are exclusive of each
other. If a merchant is set up for both IP-based authentication and Connection
Username/Password authentication, request messages are authenticated based on
whether the Connection Username and/or Connection Password elements exist within the
payload.
If either element does exist, the Orbital Gateway will attempt to validate the
Username/Password values. If the authentication fails (for example, due to an invalid
Password), the Orbital Gateway will NOT revert to IP-based authentication.
3. Installation Process
This section describes the process used to install the Orbital Software Development Kit (SDK).
Procedures provided address a “Complete” SDK installation as well as “Template Library Updates”.
3.1 Installation Types
Beginning with version 7.4.x, a “Template Library Update” micro release approach is implemented to take
advantage of the SDK’s modular design and simplify the upgrade process. As a result, two installation
procedures are available that address “Complete” and “Template-Only” SDK installations. The “Complete”
installation procedure is used for all major and minor SDK releases, while the “Template-Only” installation
procedure is used for updating a major or minor release with a new Template Library directory. Below is a
description of each SDK release type and the associated installation.
The PAYMENTECH_LOGDIR environment variable is used by the logging mechanism to determine the
destination directory for log files. This environment variable is optional. If it is not set, log files will be
created in the directory specified by PAYMENTECH_HOME or in the system’s TEMP directory.
3.2.5 Upgrading or Re-Installing
If you decide to reinstall the same version of the SDK, you can do so easily by going into Add/Remove
Programs, choose the SDK, and pick Change or Repair. This will let you reinstall the product.
Note: Before reinstalling, you should always back up your linehandler.properties file to ensure that it is
not overwritten.
You can install a new version of the Orbital Gateway SDK without removing the old one. All versions of
the SDK can co-exist on the same system. Simply run the new installer and choose a different destination
directory. The installer will not allow you to install the product on top of an existing SDK installation.
Note: The install will reset the environment variables to point to the new installation. To swap back and
forth between instances of the SDK, you must change the paths in %PAYMENTECH_HOME% and
%PAYMENTECH_LOGDIR%.
2. Extract the “Template Library Update” jar file into %PAYMENTECH_HOME%. This will add a new
xml directory with the new templates
Example:
DTDVersion=PTI70
# This is a comment
Notes:
The SDK will not automatically detect changes made to the linehandler.properties file. The
application or web server using the SDK will need to be restarted before changes will take effect.
The values used within the linehandler.properties file are case sensitive.
4.1 Response Object Setting
The SDK provides a parameter setting for configuring the Response objects behavior with respect to the
Authorization Host Response Code value and AVS Response Code values.
Gateway – If the SDK is configured in the ‘gateway’ mode, the response objects methods will report
on the Orbital Gateway normalized response codes. This is the recommended approach especially if
there is any possibility that the interface could process against both the Salem and Tampa host
platforms.
Host – If the SDK is configured in the ‘host’ mode, the response objects methods will report on the
host response codes.
Note: The SDK will default to the gateway.
##########################################################################
# Response code configuration ('gateway' or 'host')
##########################################################################
Response.response_type=gateway
Non-blocking: In this instance as soon as any transaction is passed to the SDK that exceeds the
defined number of threads supported, the SDK will throw an exception and not process that
transaction. This might be the preferred configuration for those implementations in which the desire
is to return immediate results, even if that result is a “resource was unavailable” response.
The amount of concurrent threads, and therefore the number of concurrent requests, supported by this
SDK are defined at startup using the following linehandler.properties settings:
###########################################
# Bound the number of Concurrent Requests
###########################################
Resource.maxConcurrentRequests=10
Resource.limit_mode=blocking
#########################################################
# Specify the gateway host and port
#########################################################
LineHandlerFactory.LineHandler.hostname= orbital1.chasepaymentech.com
LineHandlerFactory.LineHandler.port=443
The SDK automatically enters “failover mode” when all restart attempts have failed against the primary
hostname/port, and both the failover hostname/port have been configured in the linehandler.properties as
above. When failover mode is triggered, a timer is started. While the timer is active, all subsequent
transactions will be sent to the failover hostname/port. When the timer expires, the SDK will attempt to
resume processing against the primary hostname/port.
Below are the failover mode entries for the ‘linehandler.properties’ file:
##############################################
# Specify the failover gateway host and port
##############################################
LineHandlerFactory.LineHandler.failover.hostname=orbital2.chasepaymentech.com
LineHandlerFactory.LineHandler.failover.port=443
LineHandlerFactory.LineHandler.failover.timerSeconds=1200
###########################################
# (COM and .NET Specific)
#
# Specify the runtime mode (service|dll)
#
# service -- Out of process
# dll -- In process (default)
###########################################
DotNet.Transaction.EngineType=dll
All or most transactions are created by and used in the same process.
All or most transactions are processed through IIS
4.5.2 EngineType as Service
With this option, the core engine is loaded into its own separate process, as Windows Service.
Transactions sent from a client process are proxied through this separate process via .NET remote
process. This configuration is recommended when a high volume of transactions are generated from
multiple processes. The following table lists the pros, cons, and recommendation for the Service runtime
mode.
Pros:
Minimal Initialization Overhead (Once Service is Running)
Minimal Server Resources Required for Additional Processes
More Runtime Tuning Flexibility.
Cons:
Inter-Process Marshalling Overhead.
More Server Resources Required for Low Transaction Volumes.
Added Complexities in Configuration
Recommended if:
A high volume of transactions are being generated from different processes.
A very low volume of transactions is being processed, but the transaction speed is more
important than server resources.
4.5.3 .NET Service Parameters
The .NET Service Parameters of the configuration file specifies parameters specific to the operation of
the .NET SDK in service mode and configure the communications between the SDK and the service.
Note: These parameters are ignored if the SDK is running in DLL (default) mode.
###########################################
# .NET Service Parameters
###########################################
DotNet.Transaction.Service.Port=9900
DotNet.Transaction.Service.URI=TransactionProcessor
DotNet.Transaction.Service.ServerName=localhost
The DotNet.Transaction.Service.Port specifies the TCP port through which the SDK and the service will
communicate. It may become necessary to modify this value in the case of a port conflict. In the case of
a port conflict, set this value to an available port number, and restart the service as well as the client.
Note: It should not be necessary to modify the URI and the ServerName settings.
To enable proxy support, uncomment and set the values of the configuration entries below to the proxy
hostname and proxy port number. Proxy support is disabled by default.
####################################################################
# Uncomment the following two lines in order to enable HTTPS proxy
# support.
#The SSL port of the proxy server
#####################################################################
#LineHandlerFactory.LineHandler.proxyHostname=my.proxy.somecompany.com
#LineHandlerFactory.LineHandler.proxyPort=443
####################################################################
# Timeout setting.
#
# This setting determines how long the SDK will wait for a response.
# This timer begins once a connection has been established and the
# transaction request has been sent on the wire.
####################################################################
LineHandlerFactory.LineHandler.timeout_seconds=90
####################################################################
# Restart settings.
#
# A "restart" will occur when a connection attempt to the gateway
# cannot be established, or an error occurs trying to send a
# transaction to the gateway, and it is ensured that the transaction.
# was not sent. To avoid duplicate transaction processing, a
# restart will never occur if there is a chance that the transaction
# was sent to the gateway.
####################################################################
LineHandlerFactory.LineHandler.restart_attempts=2
The SDK supports the Orbital Gateway Retry Protocol through a combination of the below listed
linehandler.properties file setting and programmer-generated trace numbers sent with a transaction. If
the transaction response is lost because of a network error or timeout, the programmer may resend the
same transaction with the same trace number. If the original transaction had indeed been processed,
then the original response corresponding to the trace number will be returned instead of re-processing the
transaction, thereby avoiding duplicate transaction processing.
The SDK is configured by default to perform up to 2 retry transactions automatically on the programmer’s
behalf in cases where the programmer has passed a retry trace number with a transaction, and the
transaction response is lost (see note below).
In order for automatic retry to be enabled, the transaction timeout setting must be set to at least 90
seconds (see Section 3.5). If the timeout value is set to less than 90 seconds, then automatic retry is
disabled regardless of whether the ‘LineHandlerFactory.LineHandler.auto_retry_enable’ entry is set to
‘true’.
NOTE: Please note the difference between network “restarts” and transaction “retries”.
####################################################################
# Auto-Retry settings.
####################################################################
LineHandlerFactory.LineHandler.auto_retry_enable=true
LineHandlerFactory.LineHandler.auto_retry_attempts=1
4.10 Logging
The Chase Paymentech Orbital Gateway SDK provides a logging feature to make it easy to track down
potential configuration or communication issues. The logging feature is enabled (or true) by default. The
SDK uses the %PAYMENTECH_LOGDIR% system environment variable value for determining the
location of the log files. This variable is created upon installation and points to
%PAYMENTECH_HOME%\logs by default. If the environment variable is unset, the SDK will create the
log files in the directory specified by %PAYMENTECH_HOME% or systems TEMP directory. The logging
configuration properties are defined in log4net.xml which is under the etc directory.
The following is an excerpt is from logging.xml file:
</logger>
<logger name="ECommerceLogger">
<level value="INFO" />
<appender-ref ref="ECommerce" />
</logger>
</log4net>
</configuration>
Note: For security purposes, the SDK will not log consumer account numbers, CVV information, or
passwords in the clear. Source values will be masked using “X” notation.
Notes:
The SDK will not automatically detect changes made to the linehandler.properties file. The
application or web server using the SDK will need to be restarted before changes will take effect.
The values used within the linehandler.properties file are case sensitive.
5.1 General Properties
The Orbital Gateway validates incoming requests against a published XML Document Template
Description (DTD). For an https request, this value is sent to the Orbital Gateway as part of the MIME
header. The DTD version should not be changed unless instructed to do so by Chase Paymentech
support.
############################################
# MIME header settings
############################################
LineHandlerFactory.LineHandler.mimeheader.DTDVersion=PTI57
The Chase Paymentech Gateway SDK ships with samples that may be used to verify the installation of
the SDK. The source code for these samples has also been supplied and maybe used as reference for
application development.
5.2 XML Templates Configuration
The Orbital Gateway SDK, versions 4.0 and higher, forms its XML requests using a set of templates. The
location of these templates is specified in this section of the linehandler.properties file.
The SDK automatically substitutes the PAYMENTECH_HOME setting for the
“%PAYMENTECH_HOME%” pattern wherever it appears in the linehandler.properties file.
##########################################################################
# XTTF Configuration: DO NOT EDIT!
##########################################################################
# Common Transactions
XTTF.Request.NewOrder=%PAYMENTECH_HOME%\xml\NewOrder.xml
XTTF.Request.EOD=%PAYMENTECH_HOME%\xml\EOD.xml
XTTF.Request.FlexCache=%PAYMENTECH_HOME%\xml\GiftCard.xml
XTTF.Request.GiftCard=%PAYMENTECH_HOME%\xml\GiftCard.xml
XTTF.Request.MFC=%PAYMENTECH_HOME%\xml\MFC.xml
XTTF.Request.Profile=%PAYMENTECH_HOME%\xml\Profile.xml
XTTF.Request.Reverse=%PAYMENTECH_HOME%\xml\Reverse.xml
XTTF.Request.Inquiry=%PAYMENTECH_HOME%\xml\Inquiry.xml
XTTF.Request.AccountUpdater=%PAYMENTECH_HOME%\xml\AccountUpdater.xml
XTTF.Request.SafetechFraudAnalysis=%PAYMENTECH_HOME%\xml\SafetechFraudAnalysi
s.xml
5.2.1 FieldNotFoundExceptions
This version will work with older versions of the SDK (allowing for plenty of upgrade time). The newer
templates are a simplified structure and do not contain all of the same fields as the older templates. By
default, the SDK will throw a FieldNotFoundException when it encounters a field name that is not defined
in the specified XML template.
If you are upgrading from a pre-PTI40 version, you have the option of changing this behavior to just write
a WARN message to the logs (as opposed to stopping the transaction). Please note that this feature is
only advisable for pre-PTI40 SDK users with existing code. New implementations should leave this
feature commented out.
5.3 The Sample Program
By default (Development Mode option), Orbital Gateway SDK install the samples (executables) under
%PAYMENTECH_HOME%\samples\bin.
Before running the samples, make sure to update linehandler.properties and SampleData.xml file is
updated with appropriate data elements
Make sure PAYMENTECH_HOME and PAYMENTECH_LOGDIR is pointing to the correct Gateway
install directory.
Sample application uses SamplesData.xml for its runtime data element. Make sure to edit the dataset
within SamplesData.xml with appropriate data for the test case.
Example: The following XML data block is used in Auth Sample test case.
<CustomerProfileFromOrderInd>A</CustomerProfileFromOrderInd>
<CustomerRefNum>8994</CustomerRefNum>
<CustomerProfileOrderOverrideInd>NO</CustomerProfileOrderOverrideInd>
<Comments>This is COM SDK </Comments>
<ShippingRef>FEDEX WB12345678 Pri 1</ShippingRef>
</NewOrder>
</SampleData>
Select the desired test case. If the SDK is installed properly and able to make the connection to GW, the samples
print out the XML associated with the transaction’s request and response.
6.1 Overview
The Chase Paymentech Orbital Gateway SDK Applications is designed for use by programmers to
integrate real-time payment processing into commerce applications.
Users of the SDK are expected to have working knowledge of the appropriate programming environment
(.NET/COM). A background in object-oriented programming is also beneficial. The SDK is designed to
shield the application programmer from having to understand low-level details of socket, and TLS/SSL
programming.
The Chase Paymentech Orbital Gateway SDK classes have been named for ease of SDK understanding
and usage. The Appendix contains much summary information for correctly creating and populating
various transaction types and may be regarded as a programmer’s quick-reference.
The Developers Reference material has been broken into the following categories:
TransactionProcessor object
Request object
Response object
Exception object
6.2 Transaction
The Transaction class encapsulates the inner workings of the TLS/SSL communication engine in order to
provide an easy-to-use interface for creating, sending, and evaluating the results of a secure electronic
payment transaction. The Transaction object uses configuration information, which is located in your
%PAYMENTCH_HOME%\etc\linehandler.properties file, to configure the TLS/SSL engine as needed to
suit your environment.
The Transaction object allows you to perform the following functions:
Set the desired transaction type (i.e. Authorization, Capture, …etc)
Populate the transaction with runtime information (i.e. Customers name, CC Number …etc)
Send the transaction over the internet to the Orbital Gateway and create the Response object
The engine is designed with configurable multithreading so that it can be tuned for optimal performance.
6.2.1 TransactionProcessor in COM
The Transaction requires a transaction type to be passed into the constructor. See Section 11 for a list of
valid transaction types. An exception is thrown if the transaction type is invalid or there is an error
creating the transaction.
Set trans = CreateObject("Paymentech.Transaction")
trans.Type = "NewOrder"
6.2.1.2 Process a Transaction
Set Resp = trans.Process
6.2.2 Transaction in C#
The Transaction requires a transaction type to be passed into the constructor. See Section 11 for a list of
valid transaction types. An exception is thrown if the transaction type is invalid or there is an error
creating the transaction.
6.3 Request
The Request class encapsulates a Chase Paymentech Internet Gateway transaction request. The Chase
Paymentech Internet Gateway uses a flexible XML message payload encrypted via TLS/SSL for sending
and retrieving transaction information. The Request class provides an easy-to-use interface for
populating request data without having to deal with the intricacies of XML. It also incorporates light-
weight client-side validation rules to ensure that the request has been populated correctly
As part of the COM implementation, the Transaction object is used as the Request object, create a
Transaction processor object as mentioned in “Transaction in COM” and use Type and the Field()
function to set the required field values
The Request object’s xml data structure can be displayed using asXML function.
6.4 Response
The Response class encapsulates a Chase Paymentech Internet Gateway transaction response. The
Response class provides an easy-to-use interface for retrieving the results of a transaction without having
to deal with the intricacies of XML. The Chase Paymentech Internet Gateway uses a flexible XML
message payload encrypted via TLS/SSL for sending and retrieving transaction information. The
Response object is created as the result of the Transaction sending a request to the Chase Paymentech
Internet Gateway.
Always use the combination of Good, Error and ProcStatus of the response object to determine the
validity of the transaction
The Response object’s xml data structure can be displayed using asXML() function.
7. Samples
When the “Development” option is selected, Orbital Gateway SDK installer installs the appropriate source
code of the samples under %PAYMENTECH_HOME%/samples directory. The SDK provides samples
for most of the unique transactions including PC3 and PriorAuth complex transaction types.
8.1.1.1 For VB
The Chase Paymentech COM component needs to be added to your project before you can start coding.
To add the Paymentech Type Library click on “Projects”->”References…” and then check the
Paymentech Type Library, which should be in the list of Available References.
Note: if the Paymentech Type Library does not appear as an available reference you will have to
register the Paymentech.dll that is located in your %PAYMENTECH_HOME%\lib directory and restart
Visual Basic.
8.1.1.2 For ASP
The progid for the Chase Paymentech SDK component is Paymentech.Transaction. Here is an
example of how to create an object:
You could also use an <Object> tag, if you prefer that technique.
</OBJECT>
8.1.1.3 A Simple ASP Example
Once you object has been created, you can start using it to process the desired eCommerce transaction.
The following is an illustration of an Authorize request:
<HTML><BODY>
<%
<!— Declare and Create a Chase Paymentech eCommerce transaction -->
Dim trans
Set trans = Server.CreateObject ("Paymentech.Transaction")
<!— Set the transaction type. This must be done before populating the
transaction' -->
trans.Type = "NewOrder"
<!— Populate the Transaction. Use the Chase Paymentech Transaction Appendix to
help you populate the transaction -->
trans.Field("MerchantID") = Request("MerchantID")
trans.Field("BIN") = Request("BIN")
trans.Field("AccountNum") = Request("AccountNum")
trans.Field("OrderID") = Request("OrderID")
trans.Field("Amount") = Request("Amount")
trans.Field("Exp") = Request("ExpDate")
trans.Field("AVSname") = Request("AVSName")
trans.Field("AVSaddress1") = Request("AVSAddress1")
trans.Field("AVScity") = Request("AVScity")
trans.Field("AVSstate") = Request("AVSstate")
trans.Field("AVSzip") = Request("AVSzip")
trans.Field("Comments") = Request("Comments")
trans.Field("ShippingRef") = Request("ShippingRef")
<!— Send the transaction to the Chase Paymentech Internet Gateway for processing.
The response object can be used to evaluate the results of the transaction -->
Set Resp = trans.Process ()
%>
<table align="center">
<tr><th colspan=2 align=center>Results</th></tr>
<tr><td>Good</td><td><%=Resp.Good%></td></tr>
<tr><td>Error</td><td><%=Resp.Error%></td></tr>
<tr><td>Status</td><td><%=Resp.Status%></td></tr>
<tr><td>AuthCode</td><td><%=Resp.AuthCode%></td></tr>
<tr><td>Approved</td><td><%=Resp.Approved%></td></tr>
<tr><td>Declined</td><td><%=Resp.Declined%></td></tr>
<tr><td>Message</td><td><%=Resp.Message%></td></tr>
<tr><td>TxRefNum</td><td><%=Resp.TxRefNum%></td></tr>
<tr><td colspan=2><a href="javascript:history.back ()">Back</a></td></tr>
</table>
<%
<!— Set the trans and resp objects to nothing, this is good practice -->
set trans = nothing
set resp = nothing
%>
</BODY></HTML>
Trans.Field("CurrencyCode") = "840"
Trans.Field("CurrencyExponent") = "2"
Trans.setField"CustomerProfileFromOrderInd","A"
Trans.setField"OrderID","ABC def123"
Trans.setField "Amount","98765"
9. SDK Functionality
This section outlines some of the unique functionality available through the Orbital Gateway.
9.1 Certification
Before aggregators or merchants can utilize any of the functionality in this section, the implementation
must go through the appropriate certification process with Chase Paymentech. Please work with your
Chase Paymentech Representative to schedule testing and certification as necessary.
Account Verification provide the ability to verify accounts without financially impacting the accountholder’s open-
to-buy. Address Verification Service (AVS) and Card Security Value can be verified along with the account
number.
9.3 Reversals
The Reversal message is used to void a transaction either in the full amount or partial amount. It can be
extended to also reverse the authorization at the issuer.
A void does not reverse the original authorization for any card type other than Gift Card and PINless
Debit. An authorization reversal frees-up the accountholder’s open-to-buy, which has been reserved by
the original authorization. This is done at the Issuer’s discretion.
To indicate that an authorization reversal is being requested in addition to the void, the Online Reversal
Indicator element must be submitted in the Reversal message. A value of 'N' or NULL indicates that a
void is being requested. A value of 'Y' extends the void request to also include the authorization reversal.
Merchants can submit the Online Reversal Indicator element via the Reversal request or they can be
configured at the Host to allow the Gateway to submit the indicator on their behalf.
When allowing the Gateway to submit the indicator, the Gateway will attempt an authorization reversal
wherever applicable. In the event the original authorization doesn't meet the requirements for an
authorization reversal or an error occurs while attempting an authorization reversal, the Gateway will
perform a void instead. For each occurrence where the indicator is sent in the Reversal request by the
merchant, the indicator value in the message will take precedence over the indicator selection that is
configured on the Gateway.
The following requirements must be met when extending the void request to include an authorization
reversal:
- The original authorization must have been obtained through Chase Paymentech, or the transaction will
decline
- The original authorization cannot be greater than 72 hours old
- Reversal must be for full amount that was received in the authorization
9.4 Inquiry
An Inquiry transaction returns the response of any specified request. This is useful when a merchant
needs to know the result of a transaction in the case of, for example, a communication error or
unexpected reult. An InquiryRetryNumber value, which corresponds to the Retry Trace Number of the
originating transaction, must be passed in the Inquiry request message in order to obtain the response. If
there is no matching result, an error message is returned. Similar to the Retry Trace Number, the Inquiry
Retry Number is valid within a 48-hour window from the time of the original transaction.
For more information about the implementation of Retry Trace Numbers, please see the Retry Logic
section of this manual.
The Issuer ACS retrieves the authentication information and compares it against the data that was
registered during the initial registration process. If the data matches, a success page is presented to the
cardholder and the Issuer ACS sends a message through the browser to the merchant, thus providing
evidence of cardholder authentication. Using the Issuer’s encryption keys and transaction data, the
Issuer server calculates the Cardholder Authentication Verification Value (CAVV), which will be included
with the Electronic Commerce Indicator (ECI), as provided at the time of authentication by the MPI, in the
response to the Merchant.
The Issuer ACS creates, digitally signs, and sends a Payer Authentication Response to the cardholder’s
browser, and sends transaction information to the Visa Authentication History Server (AHS) for storage.
All Payer Authentication Response messages (successful, unable to authenticate, failed, and attempted
authentications) are transmitted and stored in the AHS. The browser routes the Payer Authentication
Response back to the MPI, which validates the digital signature in the response, verifying that it is from a
valid participating Issuer. If the digital signature is verified and the Issuer has sent an approved Payer
Authentication Response, the cardholder is deemed authenticated and the MPI returns the transaction to
the storefront software. The Merchant starts processing the order, determining whether it can be fulfilled,
and calculating taxes and shipping for the total transaction amount.
The Merchant will send the CAVV, ECI of 5 (authenticated transaction) or 6 (attempted authentication) to
the Orbital Gateway. The CAVV must be sent in Base 64 encoding within the XML Document. If the
CAVV is not submitted in Base 64 encoding or if the CAVV is sent with a non-eCommerce transaction, a
response code of 37 in the respCode field will be returned.
Chase Paymentech will pass the CAVV and ECI along to Visa with the authorization request. These
fields are used during authorization processing to verify that authentication, or attempted authentication,
was performed and to qualify for the eCommerce Customer Payment Services.
The Issuer receives the authorization request, validates the CAVV and responds with a CAVV Response
Code as well as an approval or a decline of the authorization. If the CAVV does not match, the Issuer
should decline the transaction.
Visa has not implemented any new decline codes for Verified by Visa. The standard decline codes
should apply.
Notes: A Merchant may not submit for authorization a purchase transaction that has failed
authentication.
9.6.4 MasterCard SecureCode
1. MasterCard SecureCode is a solution designed to authenticate cardholders when paying online.
SecureCode offers a mechanism for securing the Internet channel by strongly authenticating the
cardholder at the point of interaction by providing a unique transaction-specific token that provides
evidence that the cardholder originated the transaction. SecureCode uses MasterCard’s Universal
Cardholder Authentication Field (UCAF) infrastructure to communicate the authentication information
among the cardholder, Issuer, merchant and Acquirer.
2. MasterCard SecureCode supports the 3-D Secure Protocol (same as Verified by Visa). MasterCard
SecureCode requires merchants to install a 3-D Secure v1.0.2 compliant Merchant Server Plug-in (MPI)
software.
Transaction Flow
The cardholder shops at a participating SecureCode Internet Merchant with no changes to the shopping
or checkout. The cardholder selects the merchandise to be purchased and proceeds to the checkout. At
the checkout, the cardholder may complete the purchase and payment information in a variety of ways,
including self-entered, an electronic wallet; Merchant one-click, or using other checkout capabilities.
After the purchase and payment information is entered, the cardholder selects the “buy” button. The
customer shopping experience is the same for both of the Issuer platforms up until the time that the
Merchant Order Confirmation page is displayed.
The MPI activates and checks its local cache and the MC Directory Server to determine if the customer
card number is part of a participating MasterCard SecureCode BIN range. If so, a Verify Enrollment
Request message will be sent from the MPI, to the MC Directory Server and forwarded to the Issuer
Access Control Server (ACS) to determine if authentication is available for the cardholders account
number. The MC Directory Server sends the ACS response to the MPI. If authentication is available, the
message response provides the web address for the Issuer ACS where the cardholder can be
authenticated. If authentication is not available, the Merchant server receives an “authentication not
available” message and returns the transaction to the Merchant’s commerce server to proceed with a
standard Authorization Request. There is no “attempted SecureCode” transaction type unlike Verified by
Visa [ECI = 6].
The MPI sends a message and script directing the cardholder’s browser to establish an inline web page
session with the Issuer ACS. The window displays Issuer-specific and MasterCard branding, transaction
details – including Merchant name and amount, and prompts the cardholder to enter their SecureCode
(e.g. password). If the password is entered correctly, the transaction continues. The cardholder is
allowed a limited number of password attempts, typically 3 to 5, as defined by the Issuer ACS. If unable
to correctly enter the password, the cardholder may access the password hint that was established during
the registration. If the password is incorrectly entered more times than the Issuer limit, a failed Payer
Authentication Response is returned to the Merchant.
The Issuer ACS retrieves the authentication information and compares it against the data that was
registered during the initial cardholder registration process. If the data matches, a success page is
presented to the cardholder and the Issuer ACS sends a message through the browser to the Merchant
providing evidence of cardholder authentication, including a 28-byte Account AAV. This AAV is
generated cryptographically using Issuer-specific secret keys that are synchronized with keys at the
Issuer’s authorization platform.
9.6.5 Merchant Requirements
Merchant Plug-in Software
Install a Certified 3-D Secure Merchant Plug-in Software Application or code to the 3-D Secure Protocol.
Verify that Merchant Plug-in will provide the CAVV and or AAV in Base 64 encoding before sending to
Chase Paymentech. If not, Merchant will need to convert to Base 64 before sending to Chase
Paymentech.
9.6.6 Business Rules
There are a number of business rules in terms of when a CAVV and or AAV should be presented on aged
transaction, reauthorizations, split transactions, etc. The Orbital Gateway abstracts your interface from
many of these issues. This section will outline what these rules are and what is necessary to understand
from an Interface Perspective.
Authorizations
Merchants are required to request authorization for all Verified by Visa and MasterCard SecureCode
eCommerce transactions. Merchants must supply the CAVV and ECI on all Visa authorization attempts
and the AAV on all MasterCard Authorization attempts.
Failed Authorizations
Merchants are prohibited from submitting transactions for authorization that have failed authentication.
Late Fulfillment
When a participating merchant splits the shipment of an order, each authorization component may be
submitted with the authentication data (ECI of 5 or 6 [6 is for VbV only] and the CAVV or AAV) of the
original purchase. In the event of a dispute, the Acquirer must be able to establish that the authorization
requests were related to a single customer authenticated purchase. Furthermore, if a Deposit record is
sent for the subsequent shipment, the authorization will already have been tagged as “used”, therefore, in
order to receive the full benefit of Verified by Visa and MC SecureCode, a merchant must send the
authentication data with the subsequent deposit record so that when Chase Paymentech reauthorizes,
the authentication data can be sent as well.
MasterCard SecureCode
Initial SecureCode authorization requests with AAV’s older than 30 calendar days may be
declined by the Issuer.
Recurring Transactions
When a participating Merchant offers services of an ongoing nature to a cardholder for whom the
cardholder pays on a recurring basis (for example, insurance premiums, subscriptions, Internet service
provider fees, membership fees, tuition, or utility charges), the cardholder payments are considered
recurring payments.
If the first payment originated as an Electronic Commerce Transaction via the Internet, it must be
submitted with the appropriate Electronic Commerce Indicator (ECI) value, including Verified by Visa or
MasterCard Secure Code authentication data (CAVV or AAV respectively), if applicable.
All subsequent payments must be submitted as Recurring transactions [see Orbital Gateway Interface
Specification and Message Templates documents). The merchant must not store and submit the CAVV
with any subsequent transaction.
Currencies Supported
All Currencies
9.6.7 Chargeback Liability Sift Exclusions
Verified by Visa
There are certain exclusions from the Chargeback provisions related to attempted authentications. They
are:
All Visa Commercial Cards (Visa Business, Visa Purchasing and Visa Corporate Cards), anonymous
Prepaid Cards (such as gift cards), and transactions from new channels (such s mobile devices) are
excluded from chargeback protections for attempted authentications. If these cards are enrolled in
Verified by Visa and the Issuer authenticates the cardholder, the Issuer is not permitted to submit a
chargeback for unauthorized usage disputes (reason codes 23, 61, 75, and 83). Either the Issuer
ACS or Visa may designate excluded transactions; however, the Visa Directory Server will over-ride
excluded responses from an Issuer ACS if the BINs are not also designated as excluded BINs in the
Visa Directory. The designation of BINs as Commercial or anonymous Prepaid Cards must be
consistent with VisaNet.
Transactions conducted in new channels (such as mobile or wireless devices).
Merchants named in the Global Merchant Chargeback Monitoring Program are not eligible for
Chargeback protection for attempted authentications during the time that they are required to
participate in the program and three months thereafter. Visa will work with Acquirers to ensure
compliance with this requirement. There are no additional steps for Issuers regarding this provision.
9.7 MasterPass Wallet
9.7.1 How it works
MasterPass™ (formerly known as MasterCard® PayPass™ Online) is an e-wallet service that enables
consumers to store, manage, and securely share their payment, shipping, and rewards information with
the websites and mobile apps they use for transactions.
The MasterPass technology allows consumers to readily make purchases on any participating merchant’s
website, since their payment and shipping information is already stored.
With MasterPass, participating merchants can embed functionality into their customized store apps and
websites, to provide consumers a quicker a simpler checkout experience.
By using MasterPass™-connected wallets, a consumer can transact with merchants, banks, and
partners, while their card information is securely stored by an entity they trust.
Notes:
- All Profile Setups are performed at a Merchant ID. So this cross Chain ID sharing can only be
facilitated via Orbital Setup.
- In addition, given that all setup and usage of Profile ID’s is done using a specific Merchant ID, there is
requirement that the Chain ID be known to take advantage if this feature. As long as all the Merchant
ID’s are properly linked to the same chain, it will simply work. If the Merchant ID’s are not correctly
mapped to the same Chain ID, Merchant ID’s can be remapped to new Chain ID’s easily. If this
feature will be used, it is recommended that the correct chaining be validated prior to going live.
- Whatever level is defined as the Storage level, there can only be one version of a Customer
Reference Number. Therefore if two different Merchant ID’s have different customers who share the
same Customer ID, it would be recommended that the Profile storage and usage be maintained at the
Merchant ID level as opposed to the Chain level. If the second store tried to establish the same
Customer Reference Number and the setup dictated a chain level storage, then a Duplicate
Customer Reference Number error [<ProfileProcStatus> error code of 9582].
Not ChaseNet CC CC
There are new response data elements that need to be interpreted to determine the success of this Add
request.
Adding Profiles during an Auth
Given that in many circumstances, the fist time a customer is setup an authorization needs to be
performed, the Orbital Gateway has extended the traditional Authorization transaction to enable adding a
Profile in the same request.
- Any data included in the Authorization that can be saved as a part of the profile will be.
- The minimum data to create a profile must be included or no profile will be created.
- The result of the authorization is separate from the result of the profile add step. As such, an
authorization can be successful and the Profile Add component can be an error on the same
transaction and vice-versa. These results are mutually exclusive and should be interpreted from a
response management process as such.
- Add profiles can only be included with Auth Only, Auth-Capture , Prior Auth [i.e. Force] and Refund
transactions. It cannot be completed as a part of a Void or Mark for Capture.
Information saved in a profile
Whether a Profile is added via a Profile Add transaction or added via an authorization or updated later via
a Profile Update transaction, the following list of items defines what data elements can be saved as a part
of a Profile.
- Customer Reference Number – Required and un-editable (Also referred to as Profile ID)
- Customer Name
- Customer Email – NOTE: Only Available as a Profile Add or Update. This XML element does not
exist yet in the Authorization message set and cannot be sent as a part of an Auth Request profile
Add as a result.
- Address Information:
o Address 1
o Address 2
o City
o State
o ZIP
o AVS Country Code
o Phone
o Amount
o Description: This can be set in two ways. Either by sending a specific description
message or by setting the <CustomerProfileOrderOverideInd> to populate the
<Comments> tag, which is the Order Description.
o All Order # fields: This can be accomplished by setting the
<CustomerProfileOrderOverideInd>
o Payment Information:
Card Type:
Credit Card
o Card #
o Expiration Date
ECP (Salem Host Only – BIN 000001)
o DDA
o R/T
o Account Type
o Payment Delivery Method
- For example, if the Customer Profile included an amount and update was sent with the Amount Tag
present, but filled with a Tilde character, the amount stored in the profile would be changed to null in
the database.
- If an XML tag is sent with a Null value [such as <CCExpireDate></CCExpireDate>], it will be ignored
as a part of the update process [i.e. no update would occur on the CCExpireDate value from the
example].
- When changing Card Types, such as from an ECP to a Credit Card what is required is:
o Send the XML tag representing the new card type
o Submit the appropriate data for that card type.
o Null the old card type data elements using the Tilde process described above. For example,
changing from an ECP transaction type to a Credit Card type, the Profile Update message
should:
Have the Card Type defined as Credit.
The Update message should include the Credit Card # and Exp Date
And it should send a Tilde for the four ECP data elements [DDA, R/T, Account Type,
and Payment Delivery Method]
o Merchants supporting ChaseNet methods of payment can request an update of the account
type by either designating the new value, and optionally any of the profile data, by requesting
that the account type be auto assigned (AA). The gateway assigns the account type based on
the card number BIN and the methods of payment that are enabled on the merchant account.
9.8.14 Retrieving a Profile
At any given time, there may be a need to retrieve the data on an existing Profile. There is a very simple
Retrieve Profile transaction type available to perform this action.
9.8.15 Deleting a Profile
Any Profile can be deleted at any time with a Delete Profile transaction.
At this stage, even after a Profile has been deleted a Customer Profile Reference Number still may not be
used again.
9.8.16 Using Profiles
One of the key transaction types is using a Profile to process a transaction. This is accomplished by:
- Inserting the Customer Reference Number into one of the existing message types.
- All data that can be pre-populated by the Profile will be.
- Any relevant data, such as CVD for eCommerce transactions, should be included in the request.
- The transaction request should be completed per the normal spec in terms of which tags are
mandatory. If the data exists in the Profile and the Tag is mandatory, simply null fill the tag.
- This means that the correct XML Message type should be used based on the card type of the profile.
For example, if the card type of a Profile is a credit card, then the base credit card message structure
should be used to use the profile. The credit card data, again, would simply be null filled.
9.8.17 Overriding Profile Data
Almost any data set in the Profile can be overridden during a transaction that is using the Profile. For
instance, if a Profile included a fixed amount, but a particular transaction was for a different amount, it
could be changed for that transaction by including a specific amount in the use profile request.
The one exception to the override rule is the payment type, such as Credit Card versus ECP, cannot be
overridden. If the Payment is different, then the Profile should either be Updated [if that change is
permanent] or not used [if it is temporary].
By the same token, if the payment type is the same, but the data is different, it can be overridden on a
single transaction, if desired.
Finally, overriding Profile data does not update the profile. If the change is permanent, an Update Profile
request should be sent in.
Overriding an Expiration Date
One scenario to take into consideration when overriding data has to do with the usage of expiration dates.
As defined in the spec, for a Salem customer, a null Expiration date is one mechanism to submit
transactions for authorization when the expiration date is unknown. By the same token, Expiration Date
is a required tag for credit card transactions and must be present when Using Profile. And it must be null
filled to not override the expiration date that might be set in the profile.
As such, if an Expiration date is saved in a Profile, and the desire is to override that, but submit nothing
because the new expiration date is unknown, the transaction should use one of the other two supported
mechanisms for supporting unknown expirations dates:
- Send four spaces - <Exp> </Exp>
- Zero fill the XML Element - <Exp>0000</Exp>
9.8.18 Transaction Types
Profiles may be used on Authorization, Authorization-Capture, Prior Authorizations, Refund, and Saftech
Fraud Analysis. It is not functional (or necessary) for Voids, Mark for Capture, or End of Day transactions.
Monthly
First day of each month “1 * ?”
First day of every other month (odd "1 1,3,5,7,9,11 ?"
months)
First day of every other month (even “1 2,4,6,8,10,12 ?”
months)
15th day of every month “15 * ?”
Last day of every month “L * ?”
Last Friday of every month “? * 6L” or “? * FRIL”
Third Friday of every month “? * 6#3”
Nearest weekday to the first of the month “1W * ?”
Last weekday of the month “LW * ?”
Yearly
1st of January “1 JAN ?”
1st weekday of January “1W JAN ?”
1st of January, every 2 years
1st of January, every 3 years
Last day of May, every year “L MAY ?” or “L 5 ?”
9.9 GiftCard
9.9.1 Transaction Types
This section defines all the GiftCard transaction types supported by the Orbital Gateway.
9.9.2 Card Activation Transaction Types
Activate - This transaction is used to activate one individual card for the first time.
o Merchants processing to the PNS Host can process Prior Activation Transactions by
additionally passing the correct prior approval code. If the valid Prior Approval code is not
passed, it will be treated as a new Activation request.
o Salem Merchants attempting to process a Prior Activation will receive an error response.
Block Activate - Block activation provides for the ability to activate more than one card at a time. The
maximum number of cards that can be activated at a time is 100. In a Block Activate request, the
card number of the first card in a series is defined, plus the number of additional sequential cards.
o If the Block Activation fails, none of the cards in the block will be activated. And the first card
number that caused the Block Activation failure will be returned in the response.
o The Virtual Terminal supports the ability to perform a Block Activation of 10,000 in a single
request. However, as indicted above the On-Line interface maximum is only 100 cards per
request.
Deactivate - This transaction is for the deactivation of a live card. Passing an amount is not required
for this transaction type.
Reactivate - There are two mechanisms for reactivating a card once it has been deactivated:
o Reversing the deactivation transaction - this will return the initial balance prior to the
deactivation transaction.
o Or the card can be reactivated. In a reactivation transaction, a dollar amount must be
passed for how much the card for which will be reactivated.
NOTE: The Orbital Gateway supports $0 activation transactions for PNS [BIN 000002].
o Once the item has been shipped, performing a Redemption Completion can complete the
transaction, see below.
o Generally speaking, an authorization will hold the requested funds for seven (“7”) days, after
which the funds will be available again.
o As stated above, this transaction type is only supported for Merchants processing
through the Salem Platform.
Redemption Completion
Partial Redemption
The Chase Paymentech Gift Card solution supports a functionality called Partial Redemption. If, for any
reason, the amount of the original authorization exceeds the available balance when the Redemption
Completion is submitted, the merchant has two options on how to treat this transaction, which is managed
by submitting the element <FlexPartialRedemptionInd>.If the available balance on the card is less than
the Redemption Completion Amount:
The transaction can be declined with no amount redeemed from the card. If this is the desired
behavior on a particular transaction, either do not submit this element or null-fill it.
The transaction can be approved, with the maximum amount of the Redemption Completion
fulfilled, even though it is less. The response in this circumstance would include both the
requested amount and the actual redeemed amount. The behavior can be implemented by
passing the <FlexPartialRedemptionInd> element with a value of Y.
Redemption
Refund
9.9.5 Reversals
All transaction types, excluding Balance Inquiries, can be reversed, thus returning a transaction to the
state it was in prior to the action being reversed. There are two restrictions as it relates to processing
Reversals:
For Salem customers, the reversal must be performed within seven [“7”] days of the original
transaction.
For PNS based customers, the reversal must be performed before the next batch close. Batch closes
for GiftCard are usually automatically at 5:00am ET, regardless of what the Auto-settle time is on the
Gateway.
Another action has not occurred that no longer makes the reversal possible.
o For example, a card, that is activated, can no longer have the activation reversed once a
transaction has been processed. The card can only be deactivated at that point, if desired.
A reversal is accomplished by simply processing a ‘Void’ FlexAction type using the merchant
information and the Transaction reference number of the original. This is true of all reversal
transaction types. Unlike other transactions, the Complex Type ‘Reversal’ is not used for GiftCard
Void/reversal actions
Using the same GiftCard element for the request and setting the FlexAction to “Reversal” and passing
the transaction reference number of the original accomplish a reversal. This is true of all reversal
transaction types.
The response on a Reversal will provide the same information as any other response [Current Balance,
Previous Balance, Response Codes, etc]. In addition, it will identify specifically what transaction type is
being reversed, such as “Reversal – Redemption” in the <FlexAction> tag.
9.9.8 Settlement
Since transactions affect the balance of a card real time, GiftCard transactions are not affected by the
End of Day process options. Instead transactions will automatically fall into one of two buckets when
viewed through the virtual terminal:
Open GiftCard items: This will include all un-settled activity:
o Authorizations that been redeemed [Redemption Completion]
o Declined transactions
o Errors
In the Review section of the VT, all Redeemed items will be viewable. These items will be grouped
on a daily basis on the same timing as the GiftCard System reports activity, which is 5am – 5am.
9.9.9 Reporting
All standard Gift Card reporting is available from the Gift Card system, including Resource Online. Any
questions about available reports should be directed to your Account Manager.
The Virtual Terminal should not be used for Gift Card reconciliation.
International Maestro card numbers are between 13 and 19 digits. International Maestro also supplies a
standard expiration date on all cards.
Associations support AVS validation for United Kingdom (UK) issued International Maestro cards only. CVV
validation is supported for all International Maestro cards where a CVV is printed on the card. Response
codes and rules are identical to MasterCard credit transactions.
NOTE Merchants who domicile in the UK must submit the SW method of payment when cards qualify as UK
Maestro. These cards should not be submitted as International Maestro.
The static AAV value may be stored in the Orbital Gateway. To apply the static AAV stored by the
Gateway to a transaction, set the useStoredAAVInd element to Y. Otherwise, the AAV must be provided
in the request message.
9.12 ChaseNet
ChaseNet is a proprietary payment platform for select JPMorgan Chase-issued, Visa branded credit and debit
cards. Participating merchants may choose to direct all eligible JPMorgan Chase Visa Signature Debit (mnemonic
CR) and Credit (mnemonic CZ) Card transactions to ChaseNet in lieu of sending them to Visa for processing.
ChaseNet supports all authorization, refund and deposit transactions for eligible payment cards.
9.12.1 Processing
There are two ways to utilize the ChaseNet product.
1. BIN File Management
Merchants use the ChaseNet BIN File to identify the specific method of payment (CR or CZ)
with the transaction.
2. Method of Payment Reassignment
The reassignment of the method of payment is enabled by a merchant flag on the Global or
NAP platform.
If:
the method of payment (MOP) reassignment flag is enabled;
the ChaseNet methods of payment are enabled;
a credit card transaction is submitted with either a Visa method of payment value (VI) or a null
value; and,
the account number falls within an eligible ChaseNet BIN:
Then:
the transaction is sent to ChaseNet; and
the ChaseNet method of payment, either a CR or CZ, is returned in the transaction response.
Subsequent processing of contextual transactions, such as the mark for capture for an authorized transaction, is
processed with the method of payment returned by the host system in the initial authorization response.
The table below reflects the method of payment returned in the response based on the merchant flags enabled
and assuming the transaction falls into a ChaseNet category.
VI VI CZ
CR CR CR
CZ CZ CZ
The following table reflects the method of payment returned in the response based on whether the merchant is
enabled for ChaseNet methods of payments and if they do not specify the method of payment in the transaction
request, assuming the transaction falls in to a ChaseNet category.
1. Adding a Profile
If a specific ChaseNet method of payment mnemonic is populated in the Card Type/Brand field, for
either a standalone Profile Add or as part of a financial transaction, the profile is created with the
submitted method of payment.
If the Card Type/Brand field is null the profile is created with the method of payment returned by
the host platform.
If the Card Type/Brand field is populated with the value AA, the Orbital Gateway will assign the
appropriate mnemonic based on BIN file data and merchant settings.
2. The same rules apply when updating a profile. An AA value can also be used with a profile update
request.
Please see the Error! Reference source not found. section for further details.
9.12.3 Supported Currencies
U.S. Currency
Please review Orbital Virtual Terminal Users Manual for further details
With the introduction of the Stored Credential and Merchant Initiated Transaction Framework, data is presented
with authorizations and transactions to identify stored credentials and indicate cardholder consent was obtained.
Within these frameworks, transactions are presented as either a Cardholder Initiated Transaction (CIT) or
Merchant Initiated Transaction (MIT). These changes apply to all regions: AP, Canada, CEMEA, LAC, Europe,
and U.S. (October 2017)
Note: Within this Framework, Merchants are responsible for receiving and retaining the Transaction ID
(TXID) for use on subsequent transactions.
The following table illustrates the parameters when using both Credentials and Stored Credentials
within the Framework.
PAN(Primary Account Number) or Payment Token A stored credential can be used by either a cardholder
or merchant
Merchant must follow cardholder disclosure and
consent requirements
Typically, an initial CIT is performed using payment credentials to establish an account on file and the Stored
Credential. When a CIT is performed using payment credentials, additional cardholder data such as CVV2 or
chip data (as applicable) is recommended as part of the validation process to demonstrate that the cardholder is
involved in the transaction. Once the account on file is created, the cardholder can also perform CITs using the
Stored Credential. These Stored Credential CITs would not use CVV2 or chip data.
A CIT can be initiated to complete a purchase or create a stored credential.
1. If an amount is due at the time credentials are stored, the CIT is submitted as an authorization for a
purchase transaction
2. If no amount is due when the credentials are stored, submit the CIT as an Account Verification
9.13.4.2 Merchant-Initiated Transaction (MIT)
An MIT is a transaction that relates to a previous CIT but is conducted without the consumer involvement and
without cardholder validation performed. The MIT must refer to a consumer’s original transaction and include the
information from a prior CIT. Through an MIT, a merchant can initiate a transaction without the cardholder’s
participation.
Categories for MITs include:
Standing-Instruction MITs support pre-agreed cardholder instructions for ongoing purchases of goods or
services. Standing Instruction MITs are a follow-up to a CIT; for example, an Unscheduled Credential-
on-File (COF) Transaction such as adding funds to a wallet account.
Recurring MIT Transaction signifies a transaction in a series of transactions processed at fixed, regular
intervals. These transactions represent an agreement between a cardholder and a merchant to initiate
future transactions for the purchase of goods or services provided at regular intervals; for example, a
magazine publisher charges the cardholder for a monthly subscription.
Industry-Specific Business Practice MITs support transaction types that are a follow-up to an original
cardholder-merchant interaction that was not completed with one single transaction; for example, a
Reauthorization (Split Shipment) Transaction.
9.13.4.2.1 Merchant Obligations for Managing Transaction ID (TXID) for VISA or Network
Reference Id (NRID) for Discover
In order to properly process a transaction within the Framework, merchant identification of an authorization as a
CIT or MIT is required in order to receive additional data back in the authorization response message. This data
includes the Transaction ID (TXID)/Network Reference ID (NRID), a value created by the Payment Brand at the
time of authorization. Merchant support of the receipt of authorization Transaction IDs / Network Reference IDs,
fields and data not previously provided in authorization response messages is required. Depending on the type of
message, one or two Transaction IDs (TXIDs)/Network Reference IDs (NRIDs) will be provided in authorization
response messages.
In addition, merchant storage of these TXIDs/NRIDs is required for future use to supply to Chase when completing
an MIT authorization message. The Transaction ID/Network Reference ID generated at the time of a CIT is
provided with a subsequent corresponding MIT; this TXID/NRID will "link" the CIT and MIT together. With the MIT,
merchant identification of a MIT, the type of MIT message, and the TXID/NRID previously supplied with the CIT in
ongoing MIT authorization messages is required. With an initial CIT authorization response sent back to the
merchant, a TXID/NRID is included in the Response TXID field. This Response TXID/NRID must be stored by the
merchant and included in the Submitted TXID field when submitting a MIT transaction.
9.13.5 Profile Use Within CIT/MIT Framework
There are two types of Orbital merchants:
Those who rely on Orbital for profile management,
Others who maintain their own profiles.
9.13.5.1 Profiles managed by Orbital
Orbital will maintain CIT/MIT related data on behalf of the merchants. MIT Type together with the MIT TXID/NRID
will be stored in the Profile and will be visible to merchants. MIT TXID/NRID will be used by Orbital to tie subsequent
MIT transactions to the very first one (the CIT Transaction), which initiated the CIT/MIT sequence set.
The diagram below depicts the relationship between the submitted initial transaction type and subsequent
transaction type submissions. Note the initial submissions are all customer initiated followed by merchant
initiated transactions except for an unscheduled CIT (CUSE).
CUSE
CIT Unscheduled
CSTO
CSTO Credential on File
(CIT
(CITStored
Stored
Credential)
Credential)
MUSE
MITUnscheduled
Credential on File
CREC MREC
(CIT Recurring) MIT Stored
Credential
CINS MINS
(CIT Installment) (MIT Installment)l
MRSB
(MIT Resubmission)l
CGEN
(CIT Generall
MRAU
MIT Reauthorization
A merchant can initiate any CIT transaction (CSTO, CREC, CINS, CGEN) using a customer’s
payment credentials to establish a credential on file. This stored credential can later be used to
perform any subsequent MIT transaction as well as CUSE as shown in the diagram above.
NOTE: Discover supports the following CIT/MIT types –
The following table contains details about each message type depicted in the flow diagram above.
CINS Cardholder- Signifies a cardholder initiating the first of a series of installment Cardholder
Initiated payments.
Installments
Example: A cardholder sets up an agreement with a merchant
to initiate one or more future transactions over a period of time
for a single purchase of a good or service.
MINS Merchant- Signifies a transaction in a series of transactions that use a Merchant
Initiated stored credential and that represents a cardholder agreement
Installment for the merchant to initiate one or more future transactions over
Transaction a period of time for a single purchase of a good or service.
Example: A furniture retailer allows a cardholder to pay for
goods purchased in installments over a pre-agreed period of
time.
CGEN Cardholder- Signifies cardholder-initiated transactions that can support Cardholder
Initiated General various merchant-initiated transactions.
Transaction
Visa Recurring (CREC and MREC) – New Relationship with Framework, (Continued)
*The above example is applicable to merchants who are maintaining their own profiles and therefore are responsible for storing
the TXIDs.
Orbital will assume the responsibility in storing the TXID in cases where profile is stored.
Industry types of MOTO (MO), eCommerce (EC), Recurring (RC), and IVR (IV) are
allowed for the PINless Debit method of payment.
Approved PINless Debit transactions may return a Blank or N/A authorization code.
9.14.3 Profiles and Managed Billing
Profiles now have the ability to store and use PINless Debit information. The Biller Reference Number is
required for all profiles using PINless Debit as a method of payment. The expiration date is optional.
There are two types of eligibility verification that are done against new and existing profiles that contain
PINless Debit information:
When updating a profile containing PINless Debit method of payment, the Gateway checks against the
most current eligibility file to verify that the card information is still eligible.
If so, the profile is updated.
If it is no longer eligible, a check is performed against the Auto Update option, which, if selected,
automatically converts a non-eligible PINless debit card to Visa/MasterCard Debit.
If the merchant has opted YES for Auto Update, the card information is converted to
Visa/MasterCard Debit.
If the merchant has opted NO for Auto Update, an error message is returned stating that the
update was unsuccessful.
Each time the Gateway obtains the most current eligibility file, a check is done against all existing PINless
Debit profiles.
If the Auto Update flag is set to YES, those profiles that are no longer eligible to process as
PINless Debit are converted to Visa/MasterCard Debit.
If the profiles are not able to be updated to Visa/MasterCard Debit or the Auto Update flag is
set to NO, the status of those profiles is changed to Auto Suspend-PINless. Merchants will
not be able to process Sale transactions against profiles that are in this status, and Refund
attempts will generate decline error messages.
Merchants can convert the card information for existing profiles from PINless Debit to Visa/MasterCard
(and vice versa) by performing a profile update.
For Profiles containing Managed Billing information, PINless Debit is only supported for Recurring
Profiles. Per Visa/MasterCard Association rules, Installment or Deferred profiles do not support PINless
Debit.
9.14.4 Supported Currencies
U.S. Currency
The City Field allows the merchant to identify the business location or provides the cardholder with a
Customer Service Phone Number or URL. This is a requirement to qualify for Visa’s lowest Direct
Marketing interchange rate.
If the merchant submits a backslash (\) in the merchant descriptor, then it will be converted into a hyphen
(-) on the cardholder statement. If the merchant submits a question mark (?) in the merchant descriptor,
then it will be converted into a space on the cardholder statement.
There are certain American Express card types/programs that ignore the descriptors sent using Soft
Descriptors. The Optima card is one of these types. The merchant should contact their American
Express representative for more details.
Non-eCommerce sent with a URL will not qualify for the best interchange.
For MasterCard MOTO (Transaction Type 1) and Recurring (Transaction Type 2), if the City/Phone field
at the division level is not a Customer Service Phone Number, then a Customer Service Phone Number
must be populated in the Merchant city/Customer Phone Number field or the transaction will reject with
Response Reason Code BP (“Customer Service Phone reqd. on Tran Types 1(MO/TO) and 2(Recurring).
MC Only”).
The Orbital Gateway will apply the asterisks [‘*’] in the necessary locations. Please do not add these to
the request.
9.15.3.2 Rules and Guidelines – ECP
The Automated Clearing House (ACH) uses two fields to describe the transaction to the consumer. The
Merchant Name, 15 bytes, will always appear on the consumer’s statement, and the Entry Description, 10
bytes, will appear on the consumer’s statement a majority of the time. Both are required fields.
Chase Paymentech recommends that the Merchant Name be used for the Doing Business As (DBA)
description and the Company Entry field be used for the product description.
When utilizing the Soft Descriptor for ECP transactions, both the Merchant Name and the Entry
Description are mandatory. All other soft descriptor fields are not supported.
9.15.4 A couple of different examples of Soft Descriptors are:
3 Byte Merchant Descriptor with Phone #
<SDMerchantName>XYZ</SDMerchantName>
<SDProductDescription>PAYMENT1OF3</SDProductDescription>
<SDMerchantCity/>
<SDMerchantPhone>888-888-8888</SDMerchantPhone>
<SDMerchantURL/>
<SDMerchantEmail/>
ECP
<SDMerchantName>XYZCOMPANY12345</SDMerchantName>
<SDProductDescription>PRODUCT123</SDProductDescription>
<SDMerchantCity/>
<SDMerchantPhone/>
<SDMerchantURL/>
<SDMerchantEmail/>
NOTE Level 2 and Level 3 data sets were initially supported for the subset of procurement cards known as
Purchasing Cards. Orbital Gateway expanded that support to include the superset of procurement
cards known as Commercial Cards. Purchasing and Commercial Cards should not vary with respect
to Level 2 and Level 3 requirements. To maintain support of legacy integrations, Level 2 and Level 3
data elements are referenced in this API as Purchasing Card data.
Level 2 can be sent with Sales and Refunds for both Salem and PNS merchants. Level 3 can be sent with Sales
and Refunds for Salem merchants, but only on Sale transactions by PNS merchants.
Additional Information
Each card brand has subtle differences in the data requirements to properly qualify for Level 2 and Level 3
transactions. There are also a few differences in data formats between our Salem and PNS hosts. These are
identified in the Chapter 4 message definitions, and in the Appendix summary tables. Please see: Level 2 & 3
Data Reference for further information.
Virtual Terminal
All of the functionality supported through this interface for Level 2 and 3 is additionally available through the Orbital
Gateway Virtual Terminal.
Enable a more accurate and transparent management of the card account’s “open-to-buy”, in
order to improve cardholder satisfaction and address regulatory concerns with the current
situation
Redefine the issuer payment guarantee that is engaged when authorizing a transaction by
introducing a maximum time limit in place of the currently unlimited duration and by defining it
based on characteristics of the authorization or pre-authorization request
Permit acquirers and issuers to identify and clearly distinguish a preauthorization from a final
authorization, thus giving them the option to treat them differently, to the ultimate benefit of their
cardholders.
NOTE: Previously this was only applicable for European merchants processing MasterCard and International
Maestro transactions, but got expanded to US, US Territory (Puerto Rico, US Virgin Islands and Guam) and
Canada.
Authorization requests can be identified as Pre or Final Authorization by submitting the <PaymentActionInd> field
in the New Order request. Submitting this value will override any host level system defaults established for the
merchant account.
9.17.1 Pre-Authorization
A pre-authorization is an authorization for an amount greater than zero which meets one or both of the following
conditions:
MasterCard and International Maestro pre-authorizations can be reversed. MasterCard pre-authorizations are
valid for 30 days. International Maestro pre-authorizations are valid for 7 days.
These transactions are exempt from the authorization misuse reversal product.
9.17.2 Final Authorization
A final authorization is an authorization for an amount greater than zero and is the final transaction amount. It
cannot be reversed except for reasons of technical failure.
MasterCard and International Maestro final authorizations are valid for 7 days. The authorization should be settled
within 4 business days.
The risk of technical failures should not be taken into account in order to determine if an authorization must be
coded as a final authorization.
These transactions are exempt from the authorization misuse reversal product.
9.17.3 Orbital Gateway Initiated Authorizations
When performing split shipments on open authorizations, any subsequent capture request after the initial capture
results in the transaction request being submitted as a final authorization.
For profiles that are stored with MasterCard or International Maestro account numbers and are set up for
recurring schedules via the Managed Billing system, the recurring transactions are submitted as final
authorizations.
Transactions that move into the Authorization Recycling system are resubmitted using the payment indicator
received with the initial request.
9.18 European Direct Debit
9.18.1 Overview
European Direct Debit [EUDD] is a popular method of payment for merchants marketing in Europe. While
any merchant may want to accept direct debit payments, it is most important and cost effective for those
merchants collecting recurring payments. Unlike in the US, many EU customers prefer to pay for
recurring services by direct debit to their bank accounts.
9.18.2 How it works
Prior to February 2014, each country in Europe operated its own direct debit network. Merchants wishing
to accept direct debit throughout Europe faced the requirement to establish banking relationships and
technical integration for each country in which they wish to market.
As of February 2014, the Single Euro Payments Area (SEPA) replaces these debit networks for the Euro-
zone, while the Automated Direct Debit Instruction Service (AUDDIS) is utilized for the United Kingdom.
Chase Paymentech Solutions has created a single technical interface for direct debit processing for
multiple countries, based on the guidelines provided by the two governing bodies.
9.18.3 Processing Requirements:
Merchants must contract with Chase Paymentech Solutions for acceptance of European Direct Debit.
Certain guidelines must be followed to take advantage of this method of payment. These guidelines vary
based on the merchant’s currency; SEPA guidelines are followed for Euro merchants, while AUDDIS
guidelines are followed for Pound Sterling merchants. This section provides a high level overview of both
the data elements and business rules for each.
Additional information is found in ‘European Direct Debit Processing – A Merchant User Guide’. This
document describes the direct debit processes in European countries supported by Chase Paymentech,
including requirements, returns, mandates, available reporting, etc. Please contact your Account
Executive for a copy of the document.
9.18.4 Account Details
Currency Code = EUR (Euro)
Legacy EUDD details for Euro merchants include a Basic Bank Account Number (BBAN) and an
associated Bank Sort Code. As of February 2014, the International Bank Account Number (IBAN) and
Bank Identified code (BIC) are used for processing a transaction.
BBAN and Bank Sort Code details are still supported for transaction requests beyond February 2014.
However, these details are converted to the corresponding IBAN and BIC during processing. Transaction
responses may contain the IBAN/BIC account details, in addition to the BBAN. This is determined in the
setup of your merchant account on the downstream host platform: Please check with your account
executive for additional information.
Currency Code = GBP (Pound Sterling)
The Basic Bank Account Number (BBAN) and associated Bank Sort Code are used.
9.18.5 Mandate Information
Currency Code = EUR (Euro) or GBP (Pound Sterling)
Effective February 2014, three new fields involving mandate information are required to process an
EUDD sale transaction. The mandate is the permission obtained to debit the customer’s account.
It is strongly recommended that merchants provide the three data elements below. However, Chase
Paymentech will create this data on your behalf if no mandate data is present in the transaction request.
All three elements must be submitted or all three omitted. The transaction fails when partial mandate data
is submitted.
Mandate
The date the mandate was approved by the consumer.
Signature Date
GBP merchants may submit ‘prenote’ requests, which transmit mandate information without a
corresponding financial transaction. This is supported by submitting full mandate information, a
MessageType of ‘FC’, and an ECPActionCode of ‘ND’.
9.18.6 Virtual Terminal
All of the functionality supported through this interface for European Direct Debit is additionally available
through the Orbital Gateway Virtual Terminal.
9.18.7 Platforms
The Orbital Gateway only supports the European Direct Debit method of payment through the Salem host
platform [BIN 000001]. This method of payment is not supported on the PNS host [BIN 00002].
9.18.8 Pre and Final Authorizations
Please reference MasterCard Pre and Final Authorizations section for information regarding regulations
pertaining to MasterCard and International Maestro transactions.
Authorization An Authorization and Capture request will perform the same operation as an
and Capture Authorization, and will also prepare the transaction to be included with the
(AC) next settlement if the Authorization is successful.
Force and A Force and Capture request prepares a transaction for settlement without
Capture (FC) submitting a validation or verification request at the time of the request.
Refund (R) Refund requests prepare a return of the funds to a consumer's account for
settlement. Authorization is not performed, but validation is still done at
settlement.
All ECP activity must pass a second validation process at the time of settlement for funding to occur. This
process includes the internal negative file, Notification of Change file, and Thompson file verifications.
Salem merchants whose transactions fail these checks will see the transactions listed in the Rejected Batch
of the Virtual Terminal.
Force and Capture Validate and A Validate and Prenote Debit request prepare a prenote
(FC) Prenote Debit (ND) transaction for the purposes of a future deposit of funds
from a consumer's account for settlement.
Authorization is not performed, but validation is still done
at settlement.
Refund (R) Validate and A Validate and Prenote Credit request prepares a prenote
Prenote Credit (NC) transaction for the purposes of a future refund of funds to
a consumer's account for settlement.
Authorization is not performed, but validation is still done
at settlement.
Once a Prenote request has confirmed the consumer’s account is valid, a live (non-zero) transaction will
be required to collect any funds from the consumer.
WARNING Per ECP regulations, six days must pass before processing a non-zero dollar
deposit on a pre-noted bank account.
An additional value of “Empty” is also supported for Salem (Bin 000001) merchants only. This value will
instruct the downstream host to use whatever default value it has stored.
A merchant may be enabled for a default value on the Orbital Gateway. If this element is left NULL, that
default will be used. If no default is stored, the auth method will revert to Telephone.
Merchants can invoke Early Warning with specific combinations of MessageType and ECPActionCode. Invalid
combinations will result in an error, in the form of a proc status message.
Account Status Verification is supported with the below combinations:
Force and Validate and As noted in Table 7, a Force Capture prepares settlement for
Capture (FC) Deposit (W4) transactions and defers validation until the time of settlement. If this
validation is successful, a W4 will invoke an EWS Account Status
Verification before the deposit is completed.
Refund (R) Validate and As noted in Table 7, a Refund request does not perform Authorization
Refund (W6) and the validation defers until the time of settlement. If this validation is
successful, a W6 will invoke an EWS Account Status Verification
before refund is completed.
Pre-Note (FC) Validate and Pre- As noted in Table 7, a Pre-Note request does not perform
Note (W8) Authorization and the validation defers until the time of
settlement. If the validation is successful, a W8 will invoke an
EWS Account Status Verification.
EWS Pre-Note (W8) support Force Capture only.
Force and Validate and As noted in Table 7, a Force Capture prepares settlement for
Capture (FC) Deposit (W5) transactions and defers validation until the time of settlement. If this
validation is successful, a W5 will invoke an EWS Account Status
Verification before the deposit is completed.
Early Warning Services (EWS) specific fields must be submitted when
this action code is used.
Refund (R) Validate and As noted in Table 7, a Refund request does not perform Authorization
Refund (W7) and the validation defers until the time of settlement. If this validation is
successful, a W7 will invoke an EWS Account Status Verification
before refund is completed.
Early Warning Services (EWS) specific fields must be submitted when
this action code is used.
Pre-Note Validate and Pre- As noted in Table 7, a Pre-Note request does not perform
Note (W9) Authorization and the validation defers until the time of
settlement. If the validation is successful, a W9 will invoke an
EWS Account Status Verification.
EWS Pre-Note (W9) support Force Capture only.
Early Warning Services (EWS) specific fields must be
submitted when this action code is used.
EWS requires additional information about the checking account holder to perform an AOA. These EWS
elements have some inter-dependencies, which are only enforced when the ECP Action Code invokes
AOA. In the event AOA is requested and required EWS elements are not submitted, the transaction fails
with a proc status error.
9.19.7 Others
Virtual Terminal:
All of EWS functionality supported through this interface is additionally available through the Orbital
Gateway Virtual Terminal.
Profiles:
Additional checking account holder information sent through New Order Request to perform AOA will not
be stored in Orbital and cannot be utilized to create a profile.
9.19.7.1 Electronic Check Same Day Processing and Electronic Check Smart Re-deposit
Same Day ACH processing is an optional service that expedites the delivery of an ACH deposit (debit or credit)
transaction to the issuing bank for an additional fee. When available, both debit and credit/refund transactions can
be processed using the Same Day service. Same Day ACH is an accelerated payment that, when processed
successfully, can be received by the issuing bank the same day it is originated to Merchant Services by the client.
Clients can opt into this service by including a new identifier as part of the transaction to distinguish an ECP Same
Day transaction from a traditional next day transaction. This is available to merchants processing standard,
extended or advanced verification electronic check transactions.
Orbital supports the ECPSameDayInd element, which allows transaction by transaction designation of same day
or next day processing within the New Order Request message. Please refer New Order Request for allowed
values and business rules of this element.
9.20 UK Maestro/Solo
Chase Paymentech Solutions offers processing of Great Britain’s UK Maestro®/Solo™ debit cards for Salem
merchants (BIN 000001) through the Orbital Gateway. UK Maestro/Solo functionality must be enabled at the
merchant level in order to process this method of payment. Please contact your Chase Paymentech Solutions
Account Representative if you wish to accept UK Maestro/Solo.
NOTE As of June 2012, the International Maestro method of payment absorbed UK Maestro / Solo.
Merchants who wish to accept these cards going forward should code to process International
Maestro transactions.
Legacy users of the Web Services API are not required to re-certify for International Maestro. As of
the above date, any details specific to the UK Maestro / Solo data elements are no longer
documented.
Fully managed Account Updater for Profiles is available to Salem (Bin 000001) merchants using
customer profiles. The functionality is specifically designed to update merchant or chain level profiles
housed on the gateway utilizing the Salem Account Updater process. Visa and MasterCard approval is
required for participation. Please contact your account representative for additional details.
Once enabled, update requests are submitted to Visa and MasterCard according to a merchant selected
schedule. Visa and MasterCard typically respond to requests within three days, inclusive of the
submission day. Visa and MasterCard responses may contain information regarding new card account
numbers, expiration dates, account closures, etc. Based upon the information returned, the Gateway
automatically updates customer profiles. A scheduled report is available that lists profiles that were
updated as a part of the process.
The Account Updater transaction type facilitates an additional account updater request for a specific
profile, outside of the selected schedule. The request is included in the next Account Updater submission
unless sent with a future scheduled date (Use the <ScheduledDate>to do so). A successful Account
Updater transaction returns a message stating the profile is scheduled for Account Updater. Subsequent
information provided by Visa or MasterCard is used for a profile update. This information is not returned
via an XML response.
Notes:
If the card account number contained within a profile is invalid or not eligible for the Transaction
Division’s Account Updater setup on the host, the Account Updater request triggers a host
reject.
If the card account number is invalid or the card account is closed, an associated profile is
automatically suspended, preventing unsuccessful future auth or capture attempts. As with
any suspended profile, the status can easily be changed to active as new information becomes
available
An Account Updater change of account number update to a profile is suppressed if the merchant initiates
a change to the account number after the request is initiated and prior to the update.
The Orbital Gateway supports partial authorizations on New Order requests only. Partial
authorizations are supported for both Salem (BIN 000001) and Tampa (BIN 000002) merchants.
All merchants must communicate support for partial approvals in the request message to receive
partial authorization response messages.
The <PartialAuthInd> element in the New Order message indicates support for partial
authorizations. For Tampa merchants, populating the element with a Y indicates a request for a
partial authorization if the full amount cannot be authorized. Salem merchants can rely on host
settings by sending populating the element with an S, or override the host settings by sending a Y
or an N. Partial Authorizations are not supported by New Order messages using specifications
prior to PTI50, or with a NULL <PartialAuthInd> value.
NOTES Salem clients who have host system settings for Amex cards and do not
indicate support for partial approvals may receive a partial approval response
from Amex. The Orbital Gateway will respond to this by overriding the partial
approval with a decline, returning a respcode value of ‘M2’
The Orbital Gateway supports the Safetech™ Fraud Tools service. This advanced fraud scoring
technology is offered to Salem (Bin 000001) merchants, enabling the detection of fraud patterns that are
more difficult to identify through traditional fraud management tools.
Merchants create a custom fraud analysis strategy for their business using the Safetech Agent Web
Console. The Safetech service applies this strategy to provide the following benefits:
Minimize lost sales and the associated costs of combating fraud
Control levels of fraud exposure with customizable tools
Maximize order conversion, increasing your revenue
The Safetech service is fully integrated with Orbital Gateway processing. Whether including additional
information in an authorization request, or sending a stand-alone request, the basic process remains the
same:
A consumer navigates to the payment page to complete a purchase or bill payment.
The Safetech Fraud Tools seamlessly capture location and device data from the consumer.
The merchant sends an authorization request or standalone Fraud Analysis request, including
any additional or optional elements available, to the Orbital Gateway.
The Safetech service returns fraud score information in the response message to the request.
o A dynamic suite of detectors are utilized to perform real-time checks on over 200
variables, to produce a ‘score’ from 1 to 99 – a higher fraud score indicates a higher risk.
Based on the response, the merchant determines whether to complete or reject the transaction.
Please contact your Account Representative for more information on the program, including how
to obtain a Safetech Merchant ID (used in addition to the merchant ID number) and the
assignment of a risk analyst.
The risk analyst:
Provides ongoing monitoring of rule strategy effectiveness, including modification of rules as
needed
Assists with creation of fraud strategy and establishment of respective custom fraud rules
9.24.1 Fraud Analysis Requests
Fraud scoring information may be requested from the Safetech service through either an authorization
(most newOrder or flexCache messages) or a standalone Fraud Analysis request (a
SafetechFraudAnalysis message).
All data elements submitted in the transaction are included in the fraud scoring process performed by the
Safetech service, so the overall value of the fraud score result is directly related to the transaction data
included in the request.
Fraud analysis requests indicate one of two available formats. The format is designated by the
fraudScoreIndicator element in the request and echoed in the response. The two fraud scoring formats
are defined below:
Fraud Score 1 (FS1)
This is the short form fraud analysis request. It limits the information supplied, as well as the
information returned in the response.
Fraud Score 2 (FS2)
This is the long form fraud analysis request. It extends both the number of data fields that may be
submitted, as well as the volume of data returned in the response.
The Safetech service also allows for additional shopping cart data and user defined fields to be passed
on a transaction by transaction basis. These data sets may be submitted through the
KTTVersionNumber, KTTDataLength, and KTTDataString elements in the request message.
9.24.2 Fraud Analysis Responses
Safetech Fraud Tools is a solution which enables a merchant to better determine the risk involved with a
transaction. The Fraud Score is a numerical representation of the relative risk of each transaction that is
screened. The information returned can be used to enhance any current risk program, or to develop a
customized approach to risk management.
The Orbital Gateway provides the response information provided by the Safetech service; however it is
the merchant’s decision to proceed or not to proceed with a transaction.
Key items to remember when handling transactions which include Fraud Analysis:
The authorization returned by the issuer and the Fraud Score response from the Safetech
service are two separate and distinct values.
The fraud score information does not impact the Merchant Selectable Response functionality
provided by the Orbital Gateway. A fraud score value cannot trigger the Gateway to override
an approval with a decline.
When a transaction receives a fraud score a merchant deems unacceptable, the merchant
should submit a corresponding Void or Reversal request to the Gateway to prevent the
transaction from going out in settlement.
9.24.3 Other
Neither Level 2 and Level 3 data, nor Soft Descriptors, are supported by the Safetech service.
Orbital Gateway supports the use of customer profiles to perform a Fraud Analysis request; however
profiles may not be created as part of a standalone request to the Safetech service.
The Safetech Service is also available through the Orbital Gateway Virtual Terminal. Please see the Virtual
Terminal user guide for more information.
resides in digital wallet applications and replaces the cardholder account number in transaction
processing.
American Express, ChaseNet, Visa, and MasterCard have made processing changes in support of the
"Payment Token Standard". These changes allow acquirer, merchant, and issuer CDPT implementations
that provide enhanced security for cardholder Primary Account Number (PAN). Changes have been
made to support accepting, recognizing, and processing CDPT based transactions.
NOTE: The Orbital Gateway currently supports CDPT for Mobile In-application and Ecommerce
transactions. It does not support CDPT for Near Field Communication/Contactless transactions.
9.26.1 How it Works
Merchants can obtain a token, as well as other data elements, via digital wallets, through an
authentication process. The data elements provided back to the merchant in the authentication
response are required for pursuant authorization requests.
CDPT values are supported in three types of authorization requests:
Initial authorizations or auth/capture requests
Any subsequent or split shipment authorizations associated with the initial authorization
Recurring payments
DPAN Indicator as S
Industry Type as Ecommerce (EC)
ECI Indicator is BIN specific for all recurring billing transactions; see note below.
This field can be left empty and is then derived by the gateway.
For each subsequent transaction that is submitted, the CDPT value should be the same
and continue to be sent in the Account Number field.
NOTE For Visa transactions only, the original cryptogram must be sent in the CAVV field. For all
other card brands, that field must be left empty or a ProcStatus error will be returned.
NOTE ChasePay wallet transactions require an ECI indicator of 7 for initial wallet transactions,
and an ECI indicator of 2 for all subsequent transactions.
As a recurring payment request
Recurring CDPT transactions that are submitted by the merchant must include the DPAN
Indicator as S, and Industry Type as Recurring (RC). The ECI Indicator will be set to 2 for all card
brands and platforms; see note below. This field can be left empty and it will be derived by the
gateway.
NOTE The cryptogram field (AEVV, AAV, CAVV) must not be populated for recurring payments.
If populated, a ProcStatus error is returned.
NOTE BIN 000002 merchants processing American Express transactions must pass a value of
20 in the ECI Indicator field. The Recurring Indicator must also be submitted with either a value of
recurring first (RF) or recurring subsequent (RS).
WARNING CDPT is not supported in the Orbital Gateway Profile Management solution at this
time. Profiles created using a CDPT token may result in declined transactions should an initial or
recurring authorization be attempted against that profile. Affiliated solutions such as Managed
Billing and Fully Managed Account Updater also do not support CDPT.
The following table outlines how to submit CDPT requests to the gateway based on the card type
and transaction type. For more information on the individual data elements, please see the 4.1
New Order Request Elements message definition table.
Table Data Elements for Sending CDPT Authorizations
<AEVV> Base 64
Encoded N/A N/A
Cryptogram
<DigitalTokenCryptogram Base 64
> Encoded N/A N/A
Cryptogram
MasterCard
<IndustryType> EC EC RC
<AuthenticationECIInd>* 5 5 BIN 000001 = 2
* Can be empty * Can be empty BIN 000002 = 5
* Can be empty
<AAV> Base 64
Encoded N/A N/A
Cryptogram
<RecurringInd> BIN 000002 only:
RF – Recurring
N/A N/A First
RS – Recurring
Subsequent
<DPANInd> Y S S
<DigitalTokenCryptogram Base 64 N/A N/A
> Encoded
Cryptogram
Visa and ChaseNet
<IndustryType> EC EC RC
<AuthenticationECIInd>* 5 5 BIN 000001 = 2
NOTE: NOTE: ChasePay BIN 000002 = 5
ChasePay Wallet Wallet transaction * Can be empty
transaction must must be 7
be 7
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 100
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Discover
<IndustryType> EC EC RC
<AuthenticationECIInd>* 5 5 BIN 000001 = 2
* Can be empty * Can be empty BIN 000002 = 5
NOTE: NOTE: ChasePay * Can be empty
ChasePay Wallet Wallet transaction
transaction must must be 7
be 7
NOTE <DigitalTokenCryptogram> is an optional field which can be used to populate any of the card
brand cryptograms.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 101
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
- XML
- SOAP
- XML Batch
- CSV Batch
o Orbital gateway must create new database fields to store the new elements submitted by
merchants.
o Orbital must pass the new FX elements to Stratus in Online message.
o Orbital must enhance response from Stratus to receive Access FX elements in the online
response and return it to merchant in the New Order Response for all interfaces (SOAP, XML,
XML Batch, CSV Batch).
o In the settlement file to Stratus, Orbital gateway must pass the Rate ID along with other FX
related elements in a new product record created as per stratus 120 byte deposit specifications.
o Orbital must upgrade request and response version for XML Interface.
o Orbital must upgrade the file version of XML and CSV batch response file.
o Orbital must upgrade the response message version for SOAP interface.
o Orbital must support FX elements in the refund processing.
Out of Scope
o Virtual terminal is considered out of scope as there is no requirement to support FX elements on
user interface. VT can be enhanced in the future if there is a business need.
o Tandem is out of scope.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 102
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 103
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Y = Yes, Required
N = No, Optional
C = Conditionally Required
The following is the list of complex types available for this transaction:
PriorAuthID
PC3Core/PC3LineItem
FraudAnalysis
SoftMerchantDescriptors (Only available to Aggregator merchant’s certified to process
Soft Merchant Descriptors on the Global Platform through the Orbital Gateway.)
NOTE: Due to the flexibility of this transaction, many of the fields are optional. Many individual
transactions types (for instance, constructing a credit card authorization only transaction) will
require several fields marked as optional. In most cases, the Chase Paymentech Gateway will
return descriptive error messages when required fields are missing. For additional help in
constructing your transactions, please refer to the supplied samples or call Chase Paymentech
Support for assistance.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 104
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
OrbitalConnectionUsername Orbital Connection Username set up C 32 A
on Orbital Gateway
Formats:
- Between 8-32 characters (a-z, A-Z, 0-9
- Minimum 1 numeric digit
- No leading, trailing, or embedded
spaces
- Not case sensitive
OrbitalConnectionPassword Orbital Connection Password used in C 32 A
conjunction with Orbital Username
Formats:
- Between 8-32 characters (a-z, A-Z, 0-9
- Minimum 1 numeric digit
- No leading, trailing, or embedded
spaces
- Password is case sensitive and must
match with what is stored on Orbital
Gateway exactly
IndustryType Defines the Industry type of the M 2 A
transaction:
MO – Mail Order transaction
RC – Recurring Payment
(not a valid choice for BIN
000002 Canadian merchants who
are processing standard recurring
payments; see RecurringInd
element for more details)
EC– eCommerce transaction
IV – IVR [PINLess Debit Only]
MessageType Defines the transaction New Order M 2 A
Transaction Type:
A – Authorization request
AC – Authorization and Mark for Capture
FC – Force-Capture request
R – Refund request
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 105
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
BIN Transaction Routing Definition: M 6 N
Assigned by Chase Paymentech
000001 – Salem
000002 – PNS
MerchantID Gateway merchant account number M 12 N
assigned by Chase Paymentech:
This account number will match that of
your host platform
BIN 000001 – 6 digit Salem Division
Number
BIN 000002 – 12 digit PNS Merchant ID
TerminalID Merchant Terminal ID assigned by M 3 N
Chase Paymentech:
All Salem Terminal IDs at present must
be ‘001’. PNS Terminal ID’s can be from
‘001’ – ‘999’. Most are ‘001’.
CardBrand Card Type/Brand for the Transaction C 2 A
Returns the Card Type/Brand as
processed on the host platform
For Refunds and Force transactions,
if no CardBrand, such as Visa or
MasterCard, was sent in the request
(when optional), the specific Card
Brand mnemonic is returned.
For PINless Debit transactions, the
Card Brand is DP (which is a generic
PINless mnemonic).
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 106
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
AccountNum Card Number identifying the customer. M 19 N
Should be NULL (meaning empty) under
any of the following conditions:
- Profile Use transactions.
- Refunds with a valid TxRefNum
element
- Electronic Check transactions
- European Direct Debit transactions
using a valid IBAN
For Bill Me Later transactions, the
account number field should be populated
with either the customer’s Bill Me Later
account number or a Bill Me Later Bank
Identification Number (BIN) followed by
ten zeros (dummy account number) –
such as 5049900000000000.
The consumer’s 16- byte Bill Me Later
account number will be returned on all
approved transactions.
Consumer Digital Payment Tokens
(CDPT) are sent in this element.
Exp Card Expiration Date: C 4 N
Format: MMYY
Mandatory for all card types except ECP,
European Direct Debit, Bill Me Later and
PINLess Debit; except as defined below:
- Can be null for Refund transactions,
provided that the TxRefNum field is
filled appropriately.
- Salem [BIN 000001] allows a blank to
be submitted when no known EXP
date exists. Please discuss this
feature with your certification analyst
before implementing. There are three
valid mechanisms for submitting a
‘Blank’ expiration date using Orbital to
the Salem Host. They are:
- Null fill this XML element -
<Exp/>
- Send four spaces - <Exp>
</Exp>
- Zero fill the XML Element -
<Exp>0000</Exp>
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 107
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
CurrencyCode Defines the transaction currency: M 3 N
The gateway using the standard ISO
defines currency codes. Keys:
- Bin 000002 only supports the US
Dollar [‘840’] and Canadian Dollar
[‘124’].
- See Appendix for complete list of
supported currencies.
CurrencyExponent Defines the transactions currency M 6 N
exponent:
See Appendix for values.
CardSecValInd Supported by Visa and Discover only: C 1 N
1 - Value is Present
2 - Value on card but illegible
9 - Cardholder states data not available
NOTE: If the transaction is not a Visa or
Discover transaction, null fill this attribute
or do not submit the attribute at all.
CardSecVal Card Verification Number O 4 N
- Visa CVV2 – 3 bytes
- MasterCard CVC2 – 3 bytes
- American Express CID – 4 bytes
- Discover CID – 3 bytes
NOTE: It is against regulations to store
this value.
BCRtNum Bank routing and transit number for C 9 N
the customer.
Conditionally required for Electronic
Check processing.
NOTE:
- All US Bank Routing Numbers are 9
digits
- All Canadian Bank Routing Numbers
are 8 Digits
CheckDDA Customer DDA account number C 17 A
Conditionally required for Electronic
Check processing.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 108
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
BankAccountType Deposit Account Type C 1 A
Conditionally required for Electronic
Check processing:
C Consumer Checking (US or
Canadian)
S Consumer Savings (US or
Canadian)
X Commercial Checking (US or
Canadian)
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 109
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
BankPmtDelv ECP Payment Delivery Method C 1 A
Conditionally required for
Electronic Check processing.
This field indicates the
preferred manner to deposit
the transaction:
B Best Possible Method (US Only)
Chase Paymentech utilizes the
method that best fits the
situation. If the RDFI is not an
ACH participant, a facsimile draft
is created. This should be the
default value for this field.
A ACH (US or Canadian)
Deposit the transaction by ACH
only. If the RDFI is not an ACH
participant, the transaction is
rejected.
F Facsimile Draft
This is a document created by
CPS per merchant request or if the
receiving bank is not a participant of
the ACH association. The
facsimile draft flows through
the Federal Reserve’s check
clearing process rather than the
ACH network
AVSzip Cardholder Billing Address Zip Code: C 10 A
- All AVS Requests must minimally
include the 5-digit Zip Code.
- If sending Zip Code + 4, please
separate with a ‘-‘
Required for Bill Me Later sale
transactions
AVSaddress1 Cardholder Billing Address line 1 C 30 A
Should not include %
Required for Bill Me Later sale
transactions
AVSaddress2 Cardholder Billing Address Line 2 O 30 A
Should not include %
Required for Bill Me Later sale
transactions
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 110
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
AVScity Cardholder Billing City C 20 A
Should not include %
For BIN 000001, must supply AVSzip,
AVSaddress1, and AVScity in order for
data to be transmitted to Host Processing
System
Required for Bill Me Later sale
transactions
AVSstate Cardholder Billing State C 2 A
Should not include any of the following
characters types:
% | ^ \ /
Required for Bill Me Later sale
transactions
AVSphoneNum Cardholder Billing Phone Number C 14 A
AAAEEENNNNXXXX, where
AAA = Area Code
EEE = Exchange
NNNN = Number
XXXX = Extension
Required for Bill Me Later sale
transactions
AVSname Cardholder Billing Name C 30 A
Required for Bill Me Later sale
transactions, all Electronic Check
Transactions, and all European Direct
Debit (EUDD) transactions.
AVScountryCode Cardholder Billing Address Country C 2 A
Code:
Required if processing a U.K. based
Address. Valid values:
US – United States
CA – Canada
GB – Great Britain
UK – United Kingdom
“ “ – Blank for all other countries
Required for Bill Me Later sale
transactions
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 111
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
AVSDestzip Bill Me Later Cardholder Destination C 10 A
Address Zip Code:
- All AVS Requests must minimally
include the 5-digit Zip Code.
- If sending Zip Code + 4, please
separate with a ‘-‘
Required for Bill Me Later sale
transactions. Also supported on non-BML
transactions which use the Safetech
service.
AVSDestaddress1 Bill Me Later Cardholder Destination C 30 A
Address line 1
Should not include %
Required for Bill Me Later sale
transactions. Also supported on non-BML
transactions which use the Safetech
service.
AVSDestaddress2 Bill Me Later Cardholder Destination O 28 A
Address Line 2
Should not include %
Optional for Bill Me Later Transactions.
Also supported on non-BML transactions
which use the Safetech service.
AVSDestcity Bill Me Later Cardholder Destination C 20 A
Billing City
Should not include %
Required for Bill Me Later sale
transactions. Also supported on non-BML
transactions which use the Safetech
service.
AVSDeststate Bill Me Later Cardholder Destination C 2 A
Billing State
Should not include any of the following
characters types:
% | ^ \ /-
Required for Bill Me Later sale
transactions. Also supported on non-BML
transactions which use the Safetech
service.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 112
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
AVSDestphoneNum Bill Me Later Cardholder Destination O 14 A
Phone Number
AAAEEENNNNXXXX, where
AAA = Area Code
EEE = Exchange
NNNN = Number
XXXX = Extension
Optional for Bill Me Later sale
transactions. Also supported on non-BML
transactions which use the Safetech
service.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 113
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
CustomerRefNum Sets the Customer Reference Number C 22 A
that will be used to utilize a Customer
Profile on all future Orders.
Mandatory if Customer Profile Action
Type = Read, Update, or Delete
Or
Create and the Customer Profile Number
generation option = S [Use
CustomerRefNum Element]
Keys:
- If CustomerProfileFromOrderInd = A,
the Customer Reference Number will
be defined by the Gateway and any
value passed in this element will be
ignored.
- Given that this value can be the same
as the Order Number, the valid
characters for this field follow the
same convention as the Order ID
element. Those valid characters are:
abcdefghijklmnopqrstuvwxyzABCDEF
GHIJKLMNOPQRSTUVWXYZ01234
56789-,$@& and a space character.
However, the space character cannot
be the leading character.
This value may not be changed through a
Profile Update action.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 114
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
CustomerProfileOrderOverrideInd Defines if any Order Data can be pre- C 2 A
populated from the Customer
Reference Number
[CustomerRefNum]:
Mandatory if Customer Profile Action
Type = Create
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 115
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
AuthenticationECIInd Defines transaction type: C 1 N
Conditionally required for Verified by Visa
and MasterCard SecureCode
transactions or Consumer Digital
Payment Tokens.
2 Designates a recurring
transaction conducted with a
Consumer Digital Payment
Token
5 Verified by Visa/MasterCard
SecureCode – Authenticated
Transaction or an Electronic
Commerce Consumer Digital
Payment Token
6 Verified by Visa/MasterCard
SecureCode – Attempted
Authentication
20 Designates an American Express
Consumer Digital Payment
Token
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 116
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
XID Transaction ID used in Verified by Visa O 40 A
Transactions (XID):
This number must be Base 64
Encoded.
Unique tracking number set by the
Merchant and sent to the Issuer
Authentication/Service in the
Authentication Request message
[Optional]
OrderID Merchant Defined Order Number: M 22 A
Field defined and supplied by the auth
originator, and echoed back in response.
The first 8 characters should be unique
for each transaction.
Valid Characters:
abcdefghijklmnopqrstuvwxyzABCDEFGHI
JKLMNOPQRSTUVWXYZ0123456789-
,$@ and a space character. However,
the space character cannot be the
leading character.
PINLess Debit transactions can only use
upper and lower case alpha [A-Z, a-z]
and numeric [0-9] characters and NO
special characters.
Amount Transaction Amount: M 12 N
Keys:
- Implied Decimal including those
currencies that are a zero exponent.
For example, both $100.00 (an
exponent of ‘2’) and 100 Yen (an
exponent of ‘0’) should be sent as
<Amount>10000</Amount>.
Comments Free form comments: O 64 A
Merchant can fill in this field and the info
will be stored with the transaction details.
For PNS customers, this field will
populate the Customer Defined Data
field, which is displayed in Resource
Online.
ShippingRef Shipping Tracking Reference Number. O 40 A
Merchant can fill in this field and the info
will be stored with the transaction details.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 117
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
TaxInd Level 2 Data Tax Type: C 1 N
Conditionally required for Purchasing
Card Level II Data
0 – Not provided
1 – Included
2 – Non-Taxable
See Level 2 & 3 Data Reference for
further details.
Tax Level 2 Tax Amount for the purchase: C 12 N
- Conditionally required for Purchasing
Card Level II Data
- Implied decimal including those
currencies that are a zero exponent.
See Level 2 & 3 Data Reference for
further details.
AMEXTranAdvAddn1 Amex Purchasing Card Data – C 40 A
Transaction Advice Addendum #1
The TAA Record is used to further
identify the purchase that is associated
with the charge to the cardholder. It is
also used in Purchasing / Procurement
card transactions to provide specific
details about the transaction to the
cardholder for tracking purposes. TAA’s
should be as concise as possible. A TAA
of “Merchandise” for example, would not
be acceptable.
Salem Only / Conditionally required for
Amex Purchasing Card Data
See Level 2 & 3 Data Reference for
further details.
AMEXTranAdvAddn2 Amex Purchasing Card Data – C 40 A
Transaction Advice Addendum #2
Salem Only / Conditionally required for
Amex Purchasing Card Data
See Level 2 & 3 Data Reference for
further details.
AMEXTranAdvAddn3 Amex Purchasing Card Data – C 40 A
Transaction Advice Addendum #3
Salem Only / Conditionally required for
Amex Purchasing Card Data
See Level 2 & 3 Data Reference for
further details.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 118
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
AMEXTranAdvAddn4 Amex Purchasing Card Data – C 40 A
Transaction Advice Addendum #4
Salem Only / Conditionally required for
Amex Purchasing Card Data
See Level 2 & 3 Data Reference for
further details.
AAV Accountholder Authentication Value C 32 A
for MasterCard Secure Code:
Conditionally required for
MasterCard SecureCode
transactions.
This number must be Base 64
Encoded.
Unique transaction token generated
by the issuer and presented to the
merchant each time a cardholder
conducts an electronic transaction
using MasterCard SecureCode. AAV
incorporates elements specific to the
transaction and effectively binds the
cardholder to a transaction at a
merchant for a given sales amount.
For Consumer Digital Payment
Tokens, this is the unique
transaction cryptogram generated by
the digital wallet provider. It should
be submitted as it was received.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 119
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
SDMerchantName Soft Descriptor Merchant Name C 25 A
Conditionally required for Soft Descriptors
The Merchant Name field should be what
is most recognizable to the cardholder
[Company name or trade name]. The
actual length of this field is conditionally
tied to Host and the Size of the
<SDProductDescription> field used.
Salem:
- CREDIT – Three options, which
conditionally affects the
SDProductDescription [see below]:
o Max 3 bytes
o Max 7 bytes
o Max 12 bytes
- ECP:
o Max 15 bytes
PNS:
- Max 25 bytes.
SDProductDescription Soft Descriptor Product Description C 18 A
Conditionally required for Soft
Descriptors.
Provides an accurate product description
Salem:
- CREDIT:
o If SDMerchantName = 3
bytes – then Max = 18 bytes
o If SDMerchantName = 7
bytes – then Max = 14 bytes
o If SDMerchantName = 12
bytes – then Max = 9 bytes
- ECP:
o 10 bytes Max
PNS:
- This field will not show on Cardholder
statements for PNS Merchants.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 120
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
SDMerchantCity Soft Descriptor Merchant City C 13 A
Tag conditionally required for Soft
Descriptors.
Merchant City for Retail. Field required
but should be null filled if any Soft
Descriptor data is submitted.
SDMerchantPhone Soft Descriptor Merchant Phone C 12 A
Tag conditionally required for Soft
Descriptors
Only one of the location Soft Descriptor
records should be sent [meaning Phone,
URL, or Email].
This field will not show on Cardholder
statements for PNS Merchants.
Valid Formats:
- NNN-NNN-NNNN
- NNN-AAAAAAA
NOTE: For MasterCard MOTO
(Transaction Type 1) and Recurring
(Transaction Type 2), if the City/Phone
field at the division level is not a
Customer Service Phone Number, then a
Customer Service Phone Number must
be populated in the Merchant
city/Customer Phone Number field or the
transaction will reject with Response
Reason Code BP (Missing Customer
Service Phone).
SDMerchantURL Soft Descriptor Merchant URL C 13 A
Tag conditionally required for Soft
Descriptors [can be null filled]
Only one of the location Soft Descriptor
records should include data [meaning
Phone, URL, or Email].
This field will not show on Cardholder
statements for PNS Merchants.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 121
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
SDMerchantEmail Soft Descriptor Merchant Email C 13 A
Tag conditionally required for Soft
Descriptors [can be null filled]
Only one of the location Soft Descriptor
records should include data [meaning
Phone, URL, or Email].
This field will not show on Cardholder
statements for PNS Merchants.
RecurringInd Recurring indicator C 2 A
This tag is conditionally required for
merchants that are:
Located in Canada
And processing on BIN 000002
And processing recurring
transactions
This field should not be sent when the
IndustryType field is recurring. In Canada,
the objective is to define the initial
transaction collection method.
Valid values:
RF First Recurring Transaction
RS Subsequent Recurring
Transactions
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 122
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
EUDDCountryCode European Direct Debit Country Code C 2 A
Customer’s Country Code. The following
is the list of valid country codes.
AT - Austria
BE - Belgium
CY - Cyprus
DE - Germany
ES - Spain
FI - Finland
FR - France
GB - United Kingdom
GR - Greece
IE - Ireland
IT - Italy
LU - Luxemborg
MC - Monaco
MT - Malta
NL - Netherlands
PT - Portugal
SI - Slovenia
SK - Slovak Republic
Conditionally required for European
Direct Debit.
EUDDBankSortCode European Direct Debit Bank Sort Code C 10 A
Customer’s Bank Sort code.
Used when EUDDIBAN is not present.
Not used for Belgium or The Netherlands
EUDDRibCode European Direct Debit RIB C 2 A
Bank Account checksum.
Used when EUDDIBAN is not present.
Required in France, Italy, Portugal, Spain.
BMLCustomerIP Customer’s IP Address O 45 A
Optional for Bill Me Later sale
transactions
BMLCustomerEmail Customer Email Address O 50 A
Optional for Bill Me Later sale
transactions
BMLShippingCost Total Shipping Cost of Consumers C 8 N
Order
Mandatory for Bill Me Later sale
transactions
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 123
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
BMLTNCVersion Terms and Conditions Number C 5 N
The Terms and Conditions Number to
which the consumer agreed.
Mandatory for Bill Me Later sale
transactions
BMLCustomerRegistrationDate Customer Registration Date C 8 N
The date a customer registered with the
merchant.
Mandatory for Bill Me Later sale
transactions
BMLCustomerTypeFlag Customer Type Flag O 2 A
New or Existing Customer to the
Merchant [not Bill Me Later]
Valid Values:
N – New
E – Existing
Optional for Bill Me Later sale
transactions
BMLItemCategory Item Category C 4 N
Product Description Code assigned by
I4Commerce
Mandatory for Bill Me Later sale
transactions
BMLPreapprovalInvitationNum Pre-Approval Invitation Number O 16 A
Indicates whether the consumer has been
pre-approved for Bill Me Later or not.
Pre-approval from credit bureau
should include the 16-digit pre-
approval number. This will allow the
pre-approval to be matched with the
first consumer order.
Internal pre-approval should include
the leftmost digit as a 1.
No pre-approval should include all
zeros or be blank filled.
Optional for Bill Me Later sale
transactions
BMLMerchantPromotionalCode Merchant Promotional Code O 4 A
Optional for Bill Me Later sale
transactions
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 124
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
BMLCustomerBirthDate Customer Date of Birth C 8 N
YYYYMMDD Format
Mandatory for Bill Me Later sale
transactions
BMLCustomerSSN Customer Social Security Number C 9 N
Either the full 9 digit or last 4 digits of the
customer’s Social Security Number.
Mandatory for Bill Me Later sale
transactions
BMLCustomerAnnualIncome Gross Household Annual Income O 10 N
Implied Decimal. For example,
$100,000.00 should be sent as:
<BMLCustomerAnnualIncome>10000000
</BMLCustomerAnnualIncome>
Optional for Bill Me Later sale
transactions
BMLCustomerResidenceStatus Customer Residence Status O 1 A
Valid Values:
O – Own
R – Rent
X – Other
Optional for Bill Me Later sale
transactions
BMLCustomerCheckingAccount Customer Checking Account Indicator O 1 A
Valid Values:
Y – Yes, customer has a checking
account
N – No, customer does not have a
checking account
Optional for Bill Me Later sale
transactions
BMLCustomerSavingsAccount Customer Savings Account Indicator O 1 A
Valid Values:
Y – Yes, customer has a savings account
N – No, customer does not have a
savings account
Optional for Bill Me Later sale
transactions
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 125
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
BMLProductDeliveryType Delivery Type Indicator C 3 A
Valid Values:
CNC – Cash and Carry
DIG – Digital Goods
PHY – Physical Delivery Required
SVC – Service
TBD – To Be Determined
Optional for Bill Me Later sale
transactions
BillerReferenceNumber Biller Reference Number [PINLess C 25 A
Debit Only]
Reference Number the Biller (merchant)
uses on their system to identify this
customer.
Conditionally required for PINLess Debit
PinlessDebitMerchantUrl Merchant URL (PINless Debit E- C 40 A
commerce Only)
The merchant’s Internet address
where goods were sold
This tag is required for PINless Debit
E-commerce only and not to PINless
Debit BillPay transactions.
Example: www.abccompany.com
PinlessDebitTxnType PINless Debit Transaction Type C 2 A
When CardBrand = DP, the value
in this tag will be used to decide if
the merchant wants to process a
“PINless Debit BillPay” or a “PINless
Debit E-commerce” transaction
Allowed values :
BP ->For PINless Debit BillPay
EC->For PINless Debit E-commerce
It is a mandatory tag for PINless
Debit E-commerce and an optional
tag for PINless Debit BillPay.
However, it is recommended that
merchants should send “BP” in it for
processing BillPay transactions.
Note: Empty/Null value in this tag will be
processed as PINless Debit BillPay
transaction only when CardBrand = DP
and a valid BillerReferenceNumber is sent
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 126
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
MBType Managed Billing Type C 1 A
Indicates the type of Managed Billing the
merchant is participating in. The value
submitted must be in agreement with the
type of Managed Billing the merchant is
configured for at Chase Paymentech.
Valid Values:
R – Recurring
D – Deferred
This field serves to notify the Orbital
system that the transaction is a Managed
Billing transaction. If this field is not sent
in conjunction with a Managed Billing
transaction, any other Managed Billing
fields will be ignored.
MBOrderIdGenerationMethod Managed Billing Order ID generation C 2 A
method
This value is used to set the method that
Orbital will use to generate the Order ID
for any Managed Billing transactions.
This field does NOT influence the Order
ID for stand-alone transactions initiated
by the merchant, VT transactions, etc.
Valid values:
IO – Use Customer Reference Number
(Profile ID); this value is made up of the
capital letters ‘I’ and ‘O’, no numerals.
DI – Dynamically generate; this value is
made up of the capital letters ‘D’ and ‘I’,
no numerals.
MBRecurringStartDate Managed Billing Recurring Start Date C 8 N
Defines the future date that Orbital will
begin a recurring billing cycle to the
associated Profile.
To allow the Managed Billing engine to
properly calculate and schedule all
billings, this date must be at least one day
after the request date (a recurring billing
cycle can never begin on the date that the
request message is sent to the Orbital
system).
Format is MMDDYYYY
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 127
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
MBRecurringEndDate Managed Billing Recurring End Date C 8 N
Defines the future date that Orbital will
end a recurring billing cycle to the
associated Profile.
Format is MMDDYYYY
This is the first of three possible recurring
end triggers. Only one end trigger can be
submitted per request message.
MBRecurringNoEndDateFlag Managed Billing ‘No End Date’ C 1 A
Indicator
Valid values:
Y – this value will schedule recurring
transactions for an infinite amount of time.
If “Y”, this value will override
MBRecurringEndDate (above), even if it
is populated with an end date.
N (or blank) – Orbital will use
MBRecurringEndDate(above) to define
the recurring end date
This is the second of three possible
recurring end triggers. Only one end
trigger can be submitted per request
message.
MBRecurringMaxBillings Managed Billing Max Number of C 6 N
Billings
This value will define the maximum
number of billings that will be allowed for
a recurring billing cycle.
Valid values: 1 – 999999
This is the third of three possible
recurring end triggers. Only one end
trigger can be submitted per request
message.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 128
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
MBRecurringFrequency Managed Billing Recurring Frequency C Var A
Pattern
This pattern is a subset of a standard
CRON expression, comprised of 3 fields
separated by white space.
Field Allowed Values
Allowed Special Chars
1)Day-of-month 1-31
, - * ? / L W
2)Month 1-12 or JAN-DEC
, - * /
3)Day-of-week 1-7 or SUN-SAT
, - * ? / L #
For a full discussion of these three fields,
the usage of the special characters, and
multiple example values, see the Profiles
and Managed Billing section above (prior
to the message layouts).
MBDeferredBillDate Managed Billing Deferred billing date C 8 N
Defines the future date that Orbital will
trigger a one-time billing to the associated
Profile.
This date must be at least one day after
the request date (a deferred billing can
never take place on the date that the
request message is sent to the Orbital
system).
Format is MMDDYYYY
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 129
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
TxRefNum Gateway transaction reference O 40 A
number:
A unique value is assigned by the
Gateway for each transaction.
The only time this field will be used in a
New Order is to complete a Return
(Refund, Credit) transaction on the card
used in the original transaction from
which the TxRefNum was issued.
If this field is submitted with a Return, the
card number and expiration date are no
longer required. If no amount is sent, the
original amount will be refunded. If an
amount is sent, it must be equal to or less
than the original amount.
If this field is submitted with any other
type of New Order transaction other than
a Return, it will be ignored.
PCOrderNum PO number or Order number from C 17 A
customer:
Required for Purchasing Card Level 2
Data
See Level 2 & 3 Data Reference for
further details.
PCDestZip Shipping Destination Zip code for the C 10 A
purchase:
- Required for Purchasing Card Level 2
and Level 3 Data
- For Zip Code + 4 please separate
with ‘-‘.
Required for best Interchange rate and
cannot be all zeros or nines.
See Level 2 & 3 Data Reference for
further details.
PCDestName Amex Purchasing Card Data – C 30 A
Cardholder Ship To: Name
Salem Only / Required for Amex
Purchasing Card Data
See Level 2 & 3 Data Reference for
further details.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 130
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
PCDestAddress1 Amex Purchasing Card Data - C 30 A
Cardholder Ship To: Address line 1
Salem Only / Required for Amex
Purchasing Card Data
See Level 2 & 3 Data Reference for
further details.
PCDestAddress2 Amex Purchasing Card Data - C 30 A
Cardholder Ship To: Address line 2
Salem Only / Required for Amex
Purchasing Card Data
See Level 2 & 3 Data Reference for
further details.
PCDestCity Amex Purchasing Card Data – C 20 A
Cardholder Ship TO: City
Salem Only / Required for Amex
Purchasing Card Data
See Level 2 & 3 Data Reference for
further details.
PCDestState Amex Purchasing Card Data – C 2 A
Cardholder Ship TO: State
Salem Only / Required for Amex
Purchasing Card Data
See Level 2 & 3 Data Reference for
further details.
PartialAuthInd Partial Auth Support Indicator O 1 A
This element must be populated to
indicate the web application can
support a partial authorization.
Valid values:
Y Specify the issuer should return a
partial auth if needed.
N Specify the issuer should not return
a partial auth.
S Salem (BIN 000001) only:
Indicates a partial auth can be
supported without attempting to
override host settings.
Supported for Visa, MasterCard, Amex,
and Discover only.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 131
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
AccountUpdaterEligibility Account Updater Eligibility Flag O 1 A
This element is used to designate if a
customer profile created as part of a
New Order should be eligible for
Account Updater.
This field only applies to Salem
(Bin 000001) merchants using
the “Designated Profiles”
Account Updater setup option.
Valid values:
Y Account Updater requests for this
profile may be processed.
N Account Updater requests for this
profile will not be processed.
UseStoredAAVInd Use Stored AAV Indicator C 1 A
This element is conditionally required
on recurring payments for
International Maestro.
Valid values:
Y Submit the Static AAV stored by
Gateway with this transaction.
This should not be submitted if the
AAV element is populated.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 132
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
ECPActionCode ECP Action Code C 2 A
This element is conditionally required
to extend the MessageType for
additional ECP processing methods.
Valid values:
LO Validate Only
ND Validate and Prenote (Debit)*
NC Validate and Verify (Credit)
W1 EWS: Validate / ASV
W3 EWS: Validate / ASV and AOA
W4 EWS: Validate / ASV/ Deposit
W5 EWS: Validate / ASV and AOA /
Deposit
W6 EWS: Validate / ASV / Refund
W7 EWS: Validate / ASV and AOA /
Refund
W8 EWS: Validate / ASV / Pre-Note
W9 EWS: Validate / ASV and AOA /
Pre-Note
Supported for electronic check
processing.
*Supported for GBP European Direct
Debit (EUDD) processing
See Extended ECP Processing
Requirements for more information.
See Early Warning Systems (EWS)
Processing for more information on
EWS specific action codes.
ECPCheckSerialNumber ECP Check Serial Number C Var N
This value corresponds to the check
number on a physical check supplied
by the consumer.
This value is 9 digits for BIN 000001
merchants and 6 digits for BIN 000002.
Must be NULL unless CardBrand = EC
and ECPAuthMethod = A or P.
ECPTerminalCity ECP Terminal City C 4 A
This value corresponds to the city of
the point of sale the check is
processed at.
Must be NULL unless CardBrand = EC
and ECPAuthMethod = P.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 133
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
ECPTerminalState ECP Terminal State C 2 A
This value corresponds to the city of
the point of sale the check is
processed at.
Must be NULL unless CardBrand = EC
and ECPAuthMethod = P.
ECPImageReferenceNumber ECP Check Image Reference Number C 32 A/N
Image reference number associated
with a check.
Must be NULL unless CardBrand = EC
and ECPAuthMethod = P.
CustomerAni Customer Automatic Number O 10 N
Identification
The ANI specified phone number that
the customer used to place the order.
AVSPhoneType Customer Telephone Type Indicator O 1 A
Valid values:
D Day
H Home
N Night
W Work
This value is defaulted to H if any
phone number is present and this
element is either not present or null
filled.
CustomerEmail Customer Email Address O 50 A
The customer’s contact email address.
EmailAddressSubtype Customer Email Address Subtype O 1 A
Used to indicate the type of email
address in the CustomerEmail element.
Valid values:
B Bill To/Buyer Email Address
G Giftee Email Address
This value is defaulted to B if an email
address is present and this element is
not present or null filled.
CustomerIpAddress Customer IP Address O 45 A/N
The single source IP address used by
the customer to request a payment.
Supports IPv4 or IPv6 formats.
Punctuation marks are allowed.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 134
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
CustomerBrowserName Customer Browser Type O 60 A
Used to indicate the type of web
browser used by the customer to
initiate the request.
Example: MOZILLA/4.0
(COMPATIBLE; MSIE 5.0; WINDOWS
95)
ShippingMethod Method of Shipping To A Customer O 1 A
Valid values:
C Lowest Cost
D Carrier Designated by
Customer
E Electronic Delivery*
G Ground*
I International*
M Military*
N Next Day or Overnight*
O Other
P Store Pickup
S Same Day*
T Two Day Service*
W Three Day Service
For American Express, use only
values marked with an asterisk.
CardIndicators Enhanced Authorization: Card Type O 1 A
Indicators
This element is optionally available to
BIN 000001 merchants, to request
additional response information.
This value is ignored on unsupported
transactions. See the Card Type
Indicator section for more information.
Valid values:
Y Card Indicators should be
returned,
if available.
N Card Indicators should not be
returned
EUDDBankBranchCode EUDD Bank Branch Code C 10 A
Conditionally required for European
Direct Debit transactions.
Used when EUDDIBAN is not present.
Required for the following countries:
Cyprus, Greece, Italy, Portugal, and
Spain.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 135
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
EUDDIBAN Customer’s International Bank C 34 A
Account Number (IBAN)
Conditionally required for European
Direct Debit transactions.
If populated, the Bank Identifier Code
(BIC) is required.
EUDDBIC Customer’s Bank Identifier Code (BIC) C 11 A
Conditionally required for European
Direct Debit transactions.
If populated, the International Bank
Account Number (IBAN) is required.
This field is populated with an 8 or 11
character value.
EUDDMandateSignatureDate EUDD Mandate Signature Date C 8 N
The date the customer signed the
mandate.
This field is strongly recommended
for EUDD transactions, and Mandatory
for GBP Prenote requests.
EUDDMandateID EUDD Mandate ID C 35 A
The customer’s mandate identification
number.
This field is strongly recommended for
EUDD transactions, and Mandatory for
GBP prenote requests.
EUDDMandateType EUDD Type of Mandate C 1 N
Valid values:
1 First*
2 Recurrence*
3 Last*
4 One-off*
5 New
6 Cancel
7 Change from manual to
electronic
““ Blank (valid only if all mandate
info is blank)*
For EUR (Euro) currency merchants,
only values with an Asterisk are
supported.
This field is strongly recommended for
EUDD transactions, and Mandatory for
GBP Prenote requests.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 136
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
PaymentInd Payment Indicator O 1 A
Valid values:
D Debt Repayment
Used to indicate when a transaction is
made as a repayment of existing debt.
Currently supported for VISA
transactions under MCC codes 6012
and 6051. Please ask your Account
Executive for more information.
TxnSurchargeAmt Transaction Surcharge Amount O 8 N
The portion of the transaction amount,
up to 4%, which is a surcharge
amount.
Supported for Visa, Mastercard,
Discover, Diners, and ChaseNet
transactions only.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 137
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
AEVV American Express Verification Value O 56 A
For Consumer Digital Payment Tokens,
this is the unique transaction cryptogram
generated by the digital wallet provider.
The cryptogram can be provided as either
a 56-byte Base 64 encoded value or a
40-byte binary value. In either case the
Orbital Gateway can only process the 56-
byte Base 64 encoded value. If the
cryptogram provided is Base 64 encoded,
submit it as it was received. If the
cryptogram is a binary value, it must be
Base 64 encoded prior to submitting the
authorization request to the Orbital
Gateway.
DWWalletID Digital Wallet ID (WID) C 3 AN
Identifies if a transaction has been
tagged as a MasterPass wallet
transaction. Provided by MasterCard
during the wallet process. No special
characters or all zeros allowed.
See Error! Reference source not
found for more details.
DWSLI Security Level Indicator C 1 N
Identifies if a MasterPass transaction
utilizes MasterCardSecureCode
‘2’ = For MasterPass transactions with
non-Risk based authentication types
OR a MasterCard transaction (not
initiated via the MasterPass wallet on
the merchant website) from a
MasterPass enabled merchant (WID
not supplied).
‘4’ = Non-SecureCode MasterPass
transaction with Merchant Risk Based
Decision
‘5’ = Non-SecureCode MasterPass
transaction with Issuer Risk Based
Decision
‘6’ = Non-SecureCode MasterPass
transaction with Merchant’s own Risk
Based Decisioning
Existing values of blank, ‘0’, and ‘1’
shall remain valid and process BAU.
Note: Presence of a ‘0’ or ‘1’ indicate a
Non-MasterPass transaction. If sent
along with a WID, it will be rejected by
the Host.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 138
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
DWIncentiveInd MasterPass Incentive Indicator C 1 A
Identifies if a merchant is MasterPass
enabled but not using MasterPass
wallet.
Note: For UK merchants only
Current valid values:
Y or N
DigitalWalletType Identifies if a Digital Wallet was used C 10 AN
by the consumer in the process of
handling the payment.
Current valid values: MasterPass
See Error! Reference source not found
for more details.
PRBirthDate Date of Birth of Primary Recipient O 8 N
This recipient data element should be sent for
person-to-person transactions when
MCC=6012 for VISA to avoid additional fees.
This element is ignored for all other MOPs and
MCCs.
YYYYMMDD format
PRMaskedAccountNumber Masked Account Number of Primary O 10 AN
Recipient
Partially masked account number of recipient
account.
Card-to-Card Payments
First 6 and the last 4 digits of the recipient
account number, no blanks.
Card-to-Non-Card Payments
The 10-digit recipient account number. For
example, credit card account to EUDD
account.
This recipient data element should be sent for
person-to-person transactions when
MCC=6012 for VISA to avoid additional fees.
This element is ignored for all other MOPs and
MCCs.
PRPartialPostalCode Partial Postal Code of Primary Recipient O 6 AN
First 6 characters of the primary recipient’s
postal code.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 139
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
PRLastName Last Name of Primary Recipient O 6 AN
First 6 characters of the last name of the
primary recipient.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 140
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
EWSLastName Early Warning Systems Last Name C 40 A
The last name of the checking account owner.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 141
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
EWSAddressLine2 Early Warning Systems Address, Line 2 C 40 A
The second line of the checking account
owner’s address.
This field must be blank when
ECPActionCode = W3, W5, W7 or W9 and
EWSFirstName, EWSLastName, and
EWSBusinessName are all sent, or the
transaction rejects with a RespCode of 30
(Invalid Value in Message).
Used only for EWS Electronic Check
transactions with Account Owner
Authentication. See 3.2.5.4 Early Warning
Systems for more information.
EWSCity Early Warning Systems City C 25 A
The city of the checking account owner’s
address.
This field must be blank when
ECPActionCode = W3, W5, W7 or W9 and
EWSFirstName, EWSLastName, and
EWSBusinessName are all sent, or the
transaction rejects with a RespCode of 30
(Invalid Value in Message).
Used only for EWS Electronic Check
transactions with Account Owner
Authentication. See 3.2.5.4 Early Warning
Systems for more information.
EWSState Early Warning Systems State C 2 A
The state of the checking account owner’s
address.
This field must be blank when
ecpActionCode = W3, W5, W7 or W9 and
EWSFirstName, EWSLastName, and
EWSBusinessName are all sent, or the
transaction rejects with a RespCode of 30
(Invalid Value in Message).
Used only for EWS Electronic Check
transactions with Account Owner
Authentication. See 3.2.5.4 Early Warning
Systems for more information.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 142
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
EWSZip Early Warning Systems Zip Code C 10 A
The zip code of the checking account
owner’s address.
Valid zip code formats:
NNNNN
NNNNNNNNN
NNNNN-NNNN
This field must be blank when
ECPActionCode = W3, W5, W7 or W9 and
EWSFirstName, EWSLastName, and
EWSBusinessName are all sent, or the
transaction rejects with a RespCode of 30
(Invalid Value in Message).
Used only for EWS Electronic Check
transactions with Account Owner
Authentication. See 3.2.5.4 Early Warning
Systems for more information.
EWSPhoneType Early Warning Systems Phone Type C 1 A
The phone type of the checking account
owner’s phone number.
Must be provided when EWS phone
number is present.
Valid values:
H – Home
W – Work
" " – Blanks
Home phone (H) is the default value.
This field must be blank when
ECPActionCode = W3, W5, W7 or W9 and
EWSFirstName, EWSLastName, and
EWSBusinessName are all sent, or the
transaction rejects with a RespCode of 30
(Invalid Value in Message).
Used only for EWS Electronic Check
transactions with Account Owner
Authentication. See 3.2.5.4 Early Warning
Systems for more information.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 143
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
EWSPhoneNumber Early Warning Systems Phone Number C 10 A
The phone number of the checking
account owner.
Must be provided when EWS phone type is
present.
This field must be blank when
ECPActionCode = W3, W5, W7 or W9 and
EWSFirstName, EWSLastName, and
EWSBusinessName are all sent, or the
transaction rejects with a RespCode of 30
(Invalid Value in Message).
Used only for EWS Electronic Check
transactions with Account Owner
Authentication. See 3.2.5.4 Early Warning
Systems for more information.
EWSCheckSerialNumber Early Warning Systems Check Serial C 15 N
Number
The serial number of the checking account
owner’s check.
This field is required when ECPActionCode
= W1 or W3 and ECPAuthMethod = A or P.
Used only for EWS Electronic Check
transactions with Account Owner
Authentication. See 3.2.5.4 Early Warning
Systems for more information.
EWSSSNTIN Early Warning Systems SSNTIN C 4 A
Last four digits of the checking account
owner’s Social Security number or of the
business Tax Identification Number.
This field must be blank when
ECPActionCode = W3, W5, W7 or W9 and
EWSFirstName, EWSLastName, and
EWSBusinessName are all sent, or the
transaction rejects with a RespCode of 30
(Invalid Value in Message).
Used only for EWS Electronic Check
transactions with Account Owner
Authentication. See 3.2.5.4 Early Warning
Systems for more information.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 144
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
EWSDOB Early Warning Systems DOB C 8 N
Date of Birth of the checking account
owner.
This field must be blank when
ECPActionCode = W3, W5, W7 or W9 and
EWSFirstName, EWSLastName, and
EWSBusinessName are all sent, or the
transaction rejects with a RespCode of 30
(Invalid Value in Message).
Used only for EWS Electronic Check
transactions with Account Owner
Authentication. See 3.2.5.4 Early Warning
Systems for more information.
EWSIDType Early Warning Systems ID Type C 1 A
Type of identification associated with the
account owner identification number
Must be provided when EWS ID Number is
present.
Valid values:
0 – Driver’s License USA
1 – Military USA
2 – Passport
3 – Resident Alien ID
4 – State identification
5 – Student identification
6 – Driver’s License foreign
7 – Driver’s License Canada
8 – Driver’s License Mexico
9 – Other primary ID foreign
A – Matricula Consular card
B – South America Cedula No.
" " – Blank
This field must be blank when
ECPActionCode = W3, W5, W7 or W9 and
EWSFirstName, EWSLastName, and
EWSBusinessName are all sent, or the
transaction rejects with a RespCode of 30
(Invalid Value in Message).
Used only for EWS Electronic Check
transactions with Account Owner
Authentication. See 3.2.5.4 Early Warning
Systems for more information.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 145
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
EWSIDNumber Early Warning Systems ID Number C 28 A
Identification number of the checking account
owner’s presented ID.
Must be provided when EWS ID Type is
present.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 146
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
ECPSameDayInd ECP Same Day Indicator O 1 A
This field is applicable only to merchants
processing standard, extended, or
advanced verification Electronic check
transactions (CardBrand = EC).
Valid Values:
Y – Same Day ACH requested
N – Next Day ACH requested
Blank – No change to the ACH
processing
If an invalid value is sent, proc status
19788 will be returned.
If an invalid length is sent, proc status
521 will be returned..
If this field is equal to ‘Y’ and
ECPActionCode does not equal NC, W6,
W7, W8, W9 (only Credit and Pre-Note
actions) then the transaction is
processed as Next Day ACH.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 147
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
ECPReDepositInd ECP Re Deposit Indicator O 2 A
This field is applicable only to merchants
processing standard, extended, or
advanced verification Electronic check
transactions (CardBrand = EC).
Valid values:
Weekdays
MO - Monday
TU - Tuesday
WE - Wednesday
TH - Thursday
FR - Friday
Note: Redeposit occurs on the next
matching day after the settlement of the
transactions. For example, choosing
Thursday and settling Tuesday will
trigger re-deposit two days later.
Choosing Tuesday and settling on
Tuesday will cause re-deposit on
Tuesday of the next week.
01-99
Note: If 01-99 is sent, this represents
the number of days to allow a re-deposit
attempt from the deposit return date.
2X
Note: If 2X is sent as the valid value
then this is a bundled option. The re-
deposit attempt occurs on the 15th
and/or the close of the month,
whichever date is closer.
Blank
Note: If a blank is sent then merchant’s
default setup is used.
If an invalid length is sent, proc status
521 will be returned.
If an invalid value is sent, proc status 19787
will be returned.
If value of ECPReDepositFreq is 1 or 2 then
ECPReDepositInd must be sent or proc status
19786 will be returned.
If value of ECPReDepositFreq is 0 or NULL
then ECPReDepositInd is optional and if it is
sent, the value will be ignored.
If the value for ECPReDepositFreq field
is sent and ECPActionCode = LO, W1, or
W3 then the value in this field is
ignored.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 148
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
ECPReDepositFreq ECP Re Deposit Frequency O 2 A
This field is applicable only to merchants
processing standard, extended, or
advanced verification Electronic check
transactions (CardBrand = EC).
Valid values:
1 - Attempt re-deposit once.
2 - Attempt re-deposit twice.
0 - Opt out of re-deposit, do not attempt
to re-deposit.
Blank - Do not change the existing re-
deposit options.
If an invalid length is sent, proc status
521 will be returned.
If an invalid value is sent, proc status 19785
will be returned.
If the value for ECPReDepositFreq field
is sent and ECPActionCode = LO, W1, or
W3 then the value in this field is
ignored.
DigitalTokenCryptogram Digital Token Cryptogram O 120 AN
The gateway will parse the data
provided in this field and place it into
the proper format.
For Discover CDPT transactions –
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 149
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
FXRateHandlingIndicator Rate Handling Indicator C 1 A
Indicator to allow the merchant to define
if there is an issue with the Rate ID,
process with either reject or use default
rate ID for Deposit processing.
Valid values:
D = Default Rate ID is used if the Rate
ID cannot be determined.
R = Reject the transaction if the Rate
ID cannot be determined.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 150
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
MITStoredCredentialInd Stored Credential Flag O 1 A
Indicates that the cardholder’s
credentials are on-file with the
merchant. Valid values are:
Y – The cardholder’s credentials are on-
file with the merchant
N – The cardholder’s credentials are not
on-file with the merchant
“ “ – Blank
MITSubmittedTransactionID Submitted CIT/MIT Transaction ID C 15 A
in the Request
The submitted Transaction ID returned
to the merchant from a previous
authorization request in a series of
transaction.
Transaction ID is not sent for CIT
transactions, but it is a required value
for MIT transactions
(This tag is not required for
merchants/clients that use Orbital’s
Profile Management service. This is only
required for merchants/clients who store
and manage their customer payment
credentials outside of Orbital)
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 151
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
10.1.1 PriorAuthID
This transaction can be used to construct a prior auth id to a NewOrder transaction.
COM
Dim PriorAuth As TransactionElement
Set PriorAuth = Request.getComplexRoot("PriorAuthID")
.NET
TransactionElement priorauth =
transaction.GetComplexRoot(Paymentech.RequestType.PRIOR_AUTH_ID);
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
PriorAuthID Defines the Transaction Type as a Prior O 6 A
Authorization
When this value is present, the request is
considered a Force Authorization.
No online authorization will be generated to
the Host systems.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 152
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
.NET
TransactionElement pc3core =
transaction.GetComplexRoot(Paymentech.RequestType.PC3_CORE);
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
PC3FreightAmt Level 3 freight amount for shipment O 12 N
Total freight or shipping and handling charges.
Implied decimal.
See Level 2 & 3 Data Reference for further
details.
PC3DutyAmt Level 3 Duty Amount for Shipment O 12 N
Total charges for any import and/or export
duties included in this transaction. Implied
decimal.
See Level 2 & 3 Data Reference for further
details.
PC3DestCountryCd Level 3 Destination Country Code C 3 A
The ISO-assigned code of the country to
which the goods are shipped.
Required for all Level 3 transactions.
If no value is submitted, defaults to the
United States (USA).
See Table ISO country codes in Appendix.
See Level 2 & 3 Data Reference for further
details.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 153
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 154
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 155
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
10.1.3 PC3LineItems
This transaction can be used to construct a PC3 line item to PC3 core header to a NewOrder
transaction.
COM
Dim PC3LineItem As TransactionElement
Set PC3LineItem = PC3Core.getRecursiveElement("PC3LineItems")
.NET
TransactionElement pc3lineitem =
pc3core.GetRecursiveElement(Paymentech.RequestType.PC3_LINE_ITEMS);
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
PC3LineItemCount Level 3 Number of Line Items C 2 N
The number of Level 3 Line Item Detail items
included with this transaction. The maximum
number of line items is 98. At least 1 line item
must be included to submit Purchasing Card 3
data.
Required for Level 3 Data.
PC3LineItemArray Level 3 Detail Header C N/A N/A
Required parent tag for Purchasing Card 3
Line Item Detail components.
PC3LineItem Parent XML Tag for Individual Purchase C N/A N/A
Card Level 3 Line Item Details
This XML Tag is the parent for each Line item
detail included in this transaction. It should be
repeated for each item.
PC3DtlIndex Level 3 Line Item Index C 2 N
The sequential number [1 – 98] of the Line
Item Details included with this transaction.
Required for Level 3 Data.
See Level 2 & 3 Data Reference for further
details.
PC3DtlDesc Level 3 Line Item Detail Element – C 35 A
Description
Text description of the item purchased.
Cannot be all zeros
Required for Level 3 Card Data.
See Level 2 & 3 Data Reference for further
details.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 156
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 157
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 158
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 159
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 160
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
10.1.1 FraudAnalysis
This transaction can be used to construct a fraud analysis to a NewOrder transaction.
COM
Dim FraudAnalysis As TransactionElement
Set FraudAnalysis = FraudAnalysis.getRecursiveElement("FraudAnalysis")
.NET
TransactionElement FraudAnalysis =
FraudAnalysis.GetRecursiveElement(Paymentech.RequestType.Fraud_Analysis);
Field
FIeld Name Description Req. Max. Type
M/C/O Char A/N
FraudScoreIndicator Fraud Analysis Type Indicator C 1 N
Used to request the type of fraud analysis
performed on the transaction. The value of this
field directly determines the scope of elements
returned in the response message.
Valid values:
1 Short Form Request
2 Long Form Request
RulesTrigger Fraud Analysis Rules Return Trigger O 1 A/N
Determines whether the Agent Web Console
(AWC) rules are returned.
Valid values:
Y Triggered rules are returned
N Triggered rules are not returned
SafetechMerchantID Safetech Merchant ID O 6 A/N
A value assigned by Chase Paymentech when
a merchant is enabled for the Safetech
service.
This is not the same value as Transaction
Division number found in the MerchantID
element.
If no value is present, a default value will be
used if available. If no default is stored, the
request will generate an error.
KaptchaSessionID Kaptcha Session ID O 32 A
A merchant generated session ID for this fraud
scoring request.
The Safetech system recommends this value
be unique for 30 days, or the Fraud Score
results may not be accurate.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 161
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 162
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 163
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
10.1.2 SoftMerchantDescriptors
This transaction can be used to construct a Soft Merchant Descriptor NewOrder transaction.
COM
Dim SoftMerchantDescriptors As TransactionElement
Set FraudAnalysis =
SoftMerchantDescriptors.getRecursiveElement("SoftMerchantDescriptors ")
.NET
TransactionElement SoftMerchantDescriptors =
SoftMerchantDescriptors.GetRecursiveElement(Paymentech.RequestType.
Soft_Merchant_Descriptors);
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
SMDDBA Soft Merchant Information for Merchant O 38 A/N
“Doing Business As” name
Format:
Aggregator Name*Account Name
Required for American Express
SMDMerchantID Soft Merchant Information for Merchant O 20 A/N
Location ID
Required for American Express
SMDContactInfo Soft Merchant Information for Merchant O 40 A/N
Contact Information
If this element begins with a number, it is
considered a phone number otherwise, it is a
URL or an email address.
Valid phone formats:
NNN-NNN-NNNN
NNN-AAAAAAA
NNN-NNNNNNN
Valid URL formats:
Must contain “.”
Valid Email formats:
Must contain a “@”
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 164
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 165
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 166
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
ProcStatus Process Status: M 6 A
The first element that should be checked to
determine the result of a request. It is the only
element that is returned in all response
scenarios. It identifies whether transactions
have successfully passed all of the Gateway
edit checks.
0 – Success
All other values constitute an error condition.
See appendix for definition of those error
values.
ApprovalStatus Approval Status: C 1 N
Conditional on Process Status returning a ‘0’
or successful response. If so, approval status
identifies the result of the authorization
request to the host system.
0 – Decline
1 – Approved
2 – Message/System Error
RespCode Response Code: C 2 A
Normalized authorization response code
issued by the host system [Salem / PNS],
which identifies an approval (‘00’) or the
reason for a decline or error.
See appendix for values.
AVSRespCode Address verification request response: M 2 A
- See appendix for values
- Conditional on AVS request being sent.
CVV2RespCode Card verification value request response: M 1 A
- See appendix for values
- Conditional on card verification request
being sent
AuthCode Issuer approval Code: C 6 A
Unique transactional level code issued by the
bank or service establishment for approvals.
PINLess Debit transactions could return
blanks or N/A
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 167
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
RecurringAdviceCd Recurring Payment Advice Code M 2 N
[MasterCard Only]
01=New account information available.
Obtain new account information
02=Try again later. Recycle transaction in 72
hours.
03=Do not try to obtain another form of
payment.
CAVVRespCode Response code to VbV Requests M 1 A
StatusMsg Text message associated with ProcStatus C Var A
value.
RespMsg Messages associated with RespCode. C 80 A
HostRespCode Actual host response code: C 3 A
Exact response sent by host authorization
system [non-normalized by the gateway]. For
those systems that have already coded to the
Salem / PNS authorization response values,
they are available via this tag.
HostAVSRespCode Actual host address verification response C 2 A
code:
Exact address verification response sent by
host authorization system [non-normalized by
the gateway]. For those systems that have
already coded to the Salem / PNS
authorization response values, they are
available via this tag.
HostCVV2RespCode Actual host card verification response C 1 A
code:
Exact card verification response sent by host
authorization system [non-normalized by the
gateway]. For those systems that have
already coded to the Salem / PNS
authorization response values, they are
available still via this tag.
CustomerRefNum The Customer Reference Number M 22 A
If Customer Profile Action Type = Create and
If CustomerProfileFromOrderInd = S, this field
will echo the Customer Reference Number
sent in the Profile Request.
CustomerName Customer Billing Name M 30 A
Value from the Request Returned.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 168
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
ProfileProcStatus Result Status of Profile Management: M 6 A
Communicates the success or failure of a
Profile Management request.
0 – Success
>0 – An error condition, see Appendix A for
definition of the specific Profile Management
error values.
CustomerProfileMessage Verbose Text Description associated with M Var A
ProfileProcStatus
BillerReferenceNumber Biller Reference Number [PINLess Debit C 25 A
Only]
Echoed for Request
RespTime Time the transaction was processed by M 6 N
gateway:
Format – ‘hh24miss’
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 169
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
IsoCountryCode ISO Country Code C 2 A
Corresponds with the
CountryFraudFilterStatus element, indicating
the country where the consumer’s card was
issued.
This will always be NULL for Tampa (BIN
000002) merchants.
Please contact your Account Executive for
questions on fraud filtering.
FraudScoreProcStatus Process Status of Fraud Score request M Var N
Identifies whether transactions have
successfully passed all of the Gateway
edit checks related specifically to Fraud
Analysis messages:
0 Success
All other values constitute an error condition.
See Appendix A for definition of these error
values.
FraudScoreProcMsg Verbose Text Description associated with C Var A
FraudScoreProcStatus
FraudAnalysisResponse Parent Element of Fraud Analysis Response M N/A N/A
Data
FraudScoreIndicator Echoes FraudScoreIndicator from the request M 1 N
message.
FraudStatusCode Fraud Status Code C 4 A
The response code returned by the Safetech
service to indicating the status of the fraud
analysis.
RiskInquiryTransactionId Risk Inquiry Transaction ID C 32 A
A unique ID used to identify the fraud
assessment.
AutoDecisionResponse Auto Decision Response O 1 A
The auto decision response code returned by
the Safetech service.
The following is a list of valid values.
A Approved
D Decline
E Manager Review
R Review
This list may expand in the future.
RiskScore Risk Score C 2 N
This element may be returned as null if the
Safetech service was not successful in
generating a fraud score.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 170
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
KaptchaMatchFlag Kaptcha Match Flag O 1 A
Indicates if a request to the Safetech service
has a corresponding Kaptcha record.
WorstCountry Worst Country C 2 A
The two character ISO 3166 country code
associated with this customer in the last 14
days.
This element is only returned with a Fraud
Score Indicator of 2.
CustomerRegion Customer Region C 2 A
The estimated region of the customer.
This field is case sensitive. The Safetech
service will use lower case letters to represent
a state or province, while uppercase letters
indicate a county.
This element is only returned with a Fraud
Score Indicator of 2.
PaymentBrand Payment Brand O 4 A
The payment method (brand) identified by the
Safetech service during Fraud Analysis.
This element is only returned with a Fraud
Score Indicator of 2.
FourteenDayVelocity Fourteen Day Velocity O 2 A/N
The total number of prior sales by this
customer within the last 14 days.
This element is only returned with a Fraud
Score Indicator of 2.
SixHourVelocity Six Hour Velocity O 2 A/N
The total number of prior sales by this
customer in any six hour window over the last
14 days.
This element is only returned with a Fraud
Score Indicator of 2.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 171
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
CustomerNetwork Customer Network Type indicator O 1 A
A single character designation of the type of
network used by the customer to initiate the
transaction.
Some possible values can include:
A Anonymous
L Library
H High School
N Normal
P Prison
S Satellite
This element is only returned with a Fraud
Score Indicator of 2.
NumberOfDevices Number of Devices with Transaction O 3 N
The number of devices associated with the
transaction, as recorded by the Safetech
service.
This element is only returned with a Fraud
Score Indicator of 2.
NumberOfCards Number of Cards with Transaction O 3 N
The number of cards associated with the
transaction, as recorded by the Safetech
service.
This element is only returned with a Fraud
Score Indicator of 2.
NumberOfEmails Number of Emails with Transaction O 3 N
The number of emails associated with the
transaction, as recorded by the Safetech
service.
This element is only returned with a Fraud
Score Indicator of 2.
DeviceLayers Device Layer Description O 54 A
A period-delimited description of the Network,
Flash, JavaScript, HTTP, and Browser layers
of the device used by the customer to initiate
the transaction, as determined by the
Safetech service.
This element is only returned with a Fraud
Score Indicator of 2.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 172
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
DeviceFingerprint Device Fingerprint O 32 A
A hash of system identifiers determined by the
Safetech service to be constants for the
device used by the customer.
This element is only returned with a Fraud
Score Indicator of 2.
CustomerTimeZone Customer Time Zone O 4 N
The time zone where the customer resides, as
an offset from GMT.
This element is only returned with a Fraud
Score Indicator of 2.
CustomerLocalDateTime Customer Local Date & Time O 16 N
The local timestamp of the customer’s device.
Format: YYYY-MM-DD HH:MM
This element is only returned with a Fraud
Score Indicator of 2.
DeviceRegion Device Region O 2 A
Indicates the region or state where the
customer’s device resides.
The Safetech service will use lower case
letters to represent a state or province, while
uppercase letters indicate a county.
This element is only returned with a Fraud
Score Indicator of 2.
DeviceCountry Device Country O 2 A
The ISO 3166 Country code which indicates
the country where the customer’s device
resides.
This element is only returned with a Fraud
Score Indicator of 2.
ProxyStatus Proxy Status Indicator O 1 A
Indicates if the device used by the customer is
using a proxy network.
This element is only returned with a Fraud
Score Indicator of 2.
JavascriptStatus JavaScript Status Indicator O 1 A
Indicates if the device used by the customer
allows use of JavaScript.
This element is only returned with a Fraud
Score Indicator of 2.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 173
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
FlashStatus Flash Status Indicator O 1 A
Indicates if the device used by the customer
allows Flash.
This element is only returned with a Fraud
Score Indicator of 2.
CookiesStatus Cookies Status Indicator O 1 A
Indicates if the device used by the customer
allows use of cookies.
This element is only returned with a Fraud
Score Indicator of 2.
BrowserCountry Browser Country O 2 A
The ISO 3166 Country code which indicates
the country where the customer’s browser
resides.
This element is only returned with a Fraud
Score Indicator of 2.
BrowserLanguage Browser Language O 2 A
The ISO 639-1 standard code which indicates
the language of the customer’s browser.
This element is only returned with a Fraud
Score Indicator of 2.
MobileDeviceIndicator Mobile Device Indicator O 1 A
Indicates if the device used by the customer is
a mobile device.
This element is only returned with a Fraud
Score Indicator of 2.
MobileDeviceType Mobile Device Type O 32 A
A description of the type of mobile device
used by the customer.
This element is only returned with a Fraud
Score Indicator of 2.
MobileWirelessIndicator Mobile Wireless Indicator O 1 A
Indicates if the device used by the customer
has wireless capabilities.
This element is only returned with a Fraud
Score Indicator of 2.
VoiceDevice Voice Device Indicator O 1 A
Indicates if the device used by the customer is
voice controlled.
This element is only returned with a Fraud
Score Indicator of 2.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 174
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
PCRemoteIndicator PC Remote Indicator O 1 A
Indicates if the device used by the customer is
a remotely controlled computer.
This element is only returned with a Fraud
Score Indicator of 2.
RulesDataLength Rules Trigger Reply Data Length O 4 N
Indicates the length of the data contained in
the RulesData element.
Values in this element are no less than 0005
and no greater than 0999.
Returned only if the RulesTrigger element is
set to ‘Y’ on the request message.
RulesData Rules Trigger Reply Data O Var A/N
A comma-delimited list of the rules triggered in
the Safetech service by the transaction
request.
For more information please Appendix.
CTIAffluentCard Card Indicator: Affluent Category O 1 A
Affluent cards have very high pre-set
spending limits, if any.
Returned only for BIN 000001 merchants on
applicable transactions.
CTICommercialCard Card Indicator: Commercial Card O 1 A
See Level 2 and Level 3 Data for more
information.
Returned only for BIN 000001 merchants on
applicable transactions.
CTIDurbinExemption Card Indicator: Durbin O 1 A
Returned only for BIN 000001 merchants on
applicable transactions.
CTIHealthcareCard Card Indicator: Healthcare Card O 1 A
Returned only for BIN 000001 merchants on
applicable transactions.
CTILevel3Eligible Card Indicator: Level 3 Data Eligibility O 1 A
See Level 2 and Level 3 Data for more
information.
Returned only for BIN 000001 merchants on
applicable transactions.
CTIPayrollCard Card Indicator: Payroll Card O 1 A
Returned only for BIN 000001 merchants on
applicable transactions.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 175
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
CTIPrepaidCard Card Indicator: Prepaid Card O 1 A
Returned only for BIN 000001 merchants on
applicable transactions.
CTIPINlessDebitCard Card Indicator: PINless Debit Eligibility O 1 A
See PINless Debit for more information.
Returned only for BIN 000001 merchants on
applicable transactions.
CTISignatureDebitCard Card Indicator: Signature Debit Eligibility O 1 A
Signature Debit refers to processing a debit
card as a credit card.
Returned only for BIN 000001 merchants on
applicable transactions.
CTIIssuingCountry Card Indicator: Issuing Country O 3 A
Used to distinguish a domestic or international
customer.
Format: 3 alphanumeric character ISO country
code.
Returned only for BIN 000001 merchants on
applicable transactions.
EUDDCountryCode EUDD Country Code O 2 A
Echoes the value in the request.
EUDDBankSortCode EUDD Bank Sort Code O 10 AN
Echoes the value in the request.
EUDDRibCode EUDD RIB O 2 AN
Echoes the value in the request.
EUDDBankBranchCode EUDD Bank Branch Code O 10 AN
Echoes the value in the request.
EUDDIBAN EUDD International Bank Account Number O 34 AN
(IBAN)
If not present in the request, this may be
returned by the issuer.
EUDDBIC EUDD Bank Identification Code O 11 AN
If not present in the request, this may be
returned by the issuer.
EUDDMandateSignature EUDD Mandate Signature Date O 8 N
Date Echoes the value in the request.
EUDDMandateID EUDD Mandate ID O 35 AN
Echoes the value in the request.
EUDDMandateType EUDD Mandate Type O 1 N
Echoes the value in the request.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 176
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
TokenAssuranceLevel Token Assurance Level O 2 AN
Conveys confidence level of the Consumer
Digital Payment Token
DPANAccountStatus Account Status O 1 AN
Indicates the status of the account
Valid Values:
R = Regulated
N = Non-Regulated
Space = Not Applicable
EWSAccountStatusCode EWS Account Status Code C 3 N
Conditional on EWS Electronic Check
transactions.
Bank account status code returned by the Early
Warning System when an Account Status
Verification action is taken.
See Table 28 in Appendix A.9.1 for descriptions
of Account Status Codes.
EWSAOAConditionCode EWS AOA Condition Code C 3 N
Conditional on EWS Electronic Check
transactions with Account Owner Authentication.
Value returned to indicate the availability of
Account Owner Authentication data.
See Table 29 in Appendix A.9.2 for descriptions
of Account Owner Authentication (AOA)
Condition codes.
EWSNameMatch EWS Name Match Code C 1 A
Conditional on EWS Electronic Check
transactions with Account Owner Authentication,
when the corresponding data is in the New Order
request.
Valid values:
Y- Closely or exactly matches
C - Conditionally (Partially) matches
N - No match
U - No identifying data is available
" " – Blank
Notes: Indicates the results of a match on all
three name fields on the ECP Advanced
Verification for an Account Owner Authentication.
It is returned when EWSAOAConditionCode is
000 (Normal return – no system errors).
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 177
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
EWSFirstNameMatch EWS First Name Match Code C 1 A
Conditional on EWS Electronic Check
transactions with Account Owner Authentication,
when the corresponding data is in the New Order
request.
Valid values:
Y - Closely or exactly matches
N - No match
U - No identifying data is available
" " - Blank
Notes: Indicates the results of a match on the
First Name field on the ECP Advanced
Verification for an Account Owner Authentication.
It is returned when EWSAOAConditionCode is
000 (Normal return – no system errors).
EWSMiddleNameMatch EWS Middle Name or Initial Match Code C 1 A
Conditional on EWS Electronic Check
transactions with Account Owner Authentication,
when the corresponding data is in the New Order
request.
Valid values:
Y - Closely or exactly matches
N - No match
U - No identifying data is available
" " - Blank
Notes: Indicates the results of a match on Middle
Name or Initial field on the ECP Advanced
Verification for an Account Owner Authentication.
It is returned when EWSAOAConditionCode is
000 (Normal return – no system errors).
EWSLastNameMatch EWS Last Name Match Code C 1 A
Conditional on EWS Electronic Check
transactions with Account Owner Authentication,
when the corresponding data is in the New Order
request.
Valid values:
Y - Closely or exactly matches
N - No match
U - No identifying data is available
" " - Blank
Notes: Indicates the results of a match on the
Last Name field on the ECP Advanced
Verification for an Account Owner Authentication.
It is returned when EWSAOAConditionCode is
000 (Normal return – no system errors).
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 178
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
EWSBusinessNameMatch EWS Business Name or Initial Match Code C 1 A
Conditional on EWS Electronic Check
transactions with Account Owner Authentication,
when the corresponding data is in the New Order
request.
Valid values:
Y- Closely or exactly matches
C - Conditionally (Partially) matches
N - No match
U - No identifying data is available
" " - Blank
Notes: Indicates the results of a match on the
Business Name field on the ECP Advanced
Verification for an Account Owner Authentication.
It is returned when EWSAOAConditionCode is
000 (Normal return – no system errors).
EWSAddressMatch EWS Address 1 and Address 2 Match Code C 1 A
Conditional on EWS Electronic Check
transactions with Account Owner Authentication,
when the corresponding data is in the New Order
request.
Valid values:
Y- Closely or exactly matches
C - Conditionally (Partially) matches
N - No match
U - No identifying data is available
" " - Blank
Notes: Indicates the results of a match on the
combined Address 1 and Address 2 fields on the
ECP Advanced Verification for an Account
Owner Authentication. It is returned when
EWSAOAConditionCode is 000 (Normal return –
no system errors).
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 179
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
EWSCityMatch EWS City Name or Initial Match Code C 1 A
Conditional on EWS Electronic Check
transactions with Account Owner Authentication,
when the corresponding data is in the New Order
request.
Valid values:
Y- Closely or exactly matches
C - Conditionally (Partially) matches
N - No match
U - No identifying data is available
" " - Blank
Notes: Indicates the results of a match on City
field on the ECP Advanced Verification for an
Account Owner Authentication. It is returned
when EWSAOAConditionCode is 000 (Normal
return – no system errors).
EWSStateMatch EWS State Match Code C 1 A
Conditional on EWS Electronic Check
transactions with Account Owner Authentication,
when the corresponding data is in the New Order
request.
Valid values:
Y- Closely or exactly matches
N - No match
U - No identifying data is available
" " - Blank
Notes: Indicates the results of a match on the
State field on the ECP Advanced Verification for
an Account Owner Authentication. It is returned
when EWSAOAConditionCode is 000 (Normal
return – no system errors).
EWSZipMatch EWS Zip Code Match Code C 1 A
Conditional on EWS Electronic Check
transactions with Account Owner Authentication,
when the corresponding data is in the New Order
request.
Valid values:
Y- Closely or exactly matches
C - Conditionally (Partially) matches
N - No match
U - No identifying data is available
" " - Blank
Notes: Indicates the results of a match on the Zip
field on the ECP Advanced Verification for an
Account Owner Authentication. It is returned
when EWSAOAConditionCode is 000 (Normal
return – no system errors).
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 180
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
EWSPhoneMatch EWS Phone Match Code C 1 A
Conditional on EWS Electronic Check
transactions with Account Owner Authentication,
when the corresponding data is in the New Order
request.
Valid values:
Y- Closely or exactly matches
C - Conditionally (Partially) matches
N - No match
U - No identifying data is available
" " - Blank
Notes: Indicates the results of a match on the
Phone field on the ECP Advanced Verification for
an Account Owner Authentication. It is returned
when EWSAOAConditionCode is 000 (Normal
return – no system errors).
EWSSSNTINMatch EWS SSN or TIN Match Code C 1 A
Conditional on EWS Electronic Check
transactions with Account Owner Authentication,
when the corresponding data is in the New Order
request.
Valid values:
Y- Closely or exactly matches
N - No match
U - No identifying data is available
" " - Blank
Notes: Indicates the results of a match of the last
four digits on SSN or TIN field on the ECP
Advanced Verification) for an Account Owner
Authentication. It is returned when
EWSAOAConditionCode is 000 (Normal return –
no system errors).
EWSDOBMatch EWS Date of Birth Match Code C 1 A
Conditional on EWS Electronic Check
transactions with Account Owner Authentication,
when the corresponding data is in the New Order
request.
Valid values:
Y- Closely or exactly matches
C - Conditionally (Partially) matches
N - No match
U - No identifying data is available
" " - Blank
Notes: Indicates the results of a match on the
DOB field on the ECP Advanced Verification for
an Account Owner Authentication. It is returned
when EWSAOAConditionCode is 000 (Normal
return – no system errors).
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 181
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
EWSIDTypeMatch EWS ID Type Match Code C 1 A
Conditional on EWS Electronic Check
transactions with Account Owner Authentication,
when the corresponding data is in the New Order
request.
Valid values:
Y- Closely or exactly matches
N - No match
U - No identifying data is available
" " - Blank
Notes: Indicates the results of a match on ID
Type field on the ECP Advanced Verification for
an Account Owner Authentication. It is returned
when EWSAOAConditionCode is 000 (Normal
return – no system errors).
EWSIDNumberMatch EWS Identification Number Match Code C 1 A
Conditional on EWS Electronic Check
transactions with Account Owner Authentication,
when the corresponding data is in the New Order
request.
Valid values:
Y- Closely or exactly matches
C - Conditionally (Partially) matches
N - No match
U - No identifying data is available
" " - Blank
Notes: Indicates the results of a match on the ID
Number field on the ECP Advanced Verification
for an Account Owner Authentication. It is
returned when EWSAOAConditionCode is 000
(Normal return – no system errors).
EWSIDStateMatch EWS State Identification Match Code C 1 A
Conditional on EWS Electronic Check
transactions with Account Owner Authentication,
when the corresponding data is in the New Order
request.
Valid values:
Y- Closely or exactly matches
N - No match
U - No identifying data is available
" " - Blank
Notes: Indicates the results of a match on ID
State field on the ECP Advanced Verification for
an Account Owner Authentication. It is returned
when EWSAOAConditionCode is 000 (Normal
return – no system errors).
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 182
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
FXOptoutIndicator Opt-Out Indicator M 1 A
Identifies if the Merchant is Opting out of Custom
IB rate Processing.
Valid Values:
"Y" - Merchant is opting out of the processing for
custom IB rates
"N" - Merchant is opting in for the processing of
custom IB rates (default)
FXRateHandlingIndicator Rate Handling Indicator C 1 A
Indicator to allow the merchant to define if there
is an issue with the Rate ID, process with either
reject or use default rate ID for Deposit
processing.
Valid values:
D = Default Rate ID is used if the Rate ID
cannot be determined.
R = Reject the transaction if the Rate ID cannot
be determined.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 183
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
FXRateStatus Rate Status M 3 A
Indicates the status of the rate information
exchanged with CSo.
Valid values:
Valid values:
000 = Valid Rate ID
001 = Invalid Rate ID
002 = Missing Rate ID
003 = Expired Rate ID
004 = Invalid ACTION code, not
supported Missing Product Record Request
005 = Invalid ACTION code to Rate file ACTION
006 = Invalid Currency used No Default Rate ID,
last valid Rate ID used
007 = Opt out selected - no custom rates applied
008 = Invalid MOP, not supported
009 = Opt out indicator invalid
010 = Rate Handling indicator invalid
011 = Rate ID and Rate mismatch
012 = Other
MITReceivedTransactionID Received Transaction ID C 15 A
The received Transaction ID returned to the
merchant.
This field will always have a value for CIT/MIT
transactions.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 184
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
The table below identifies how Mark for Captures function when the Amount Captured is less
than the initial Authorization – i.e. a Split transaction.
SPLIT SHIPMENT EXAMPLE FLOW:
TRANSACTION AMOUNT
2a. Original $100 Trans. MFC for $20 2c. New "Unmarked" order systemically created for remainder of original order amount: $80
3. Merchant sends MFC for $30 3c. New "Unmarked" order systemically created for remainder of split: $50
3a. Unmarked $80 transaction now MFC for $50
4. Merch. sends
4b. New "Unmarked" order systemically created for remainder of split: $40
MFC for $10
4a. Unmkd $50
now MFC for $10
TRANSACTION KEY:
- Authorization Request
- Marked Transaction
- Unmarked Transaction
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 185
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Required Max Char Type
OrbitalConnectionUsrname Orbital Connection Username set up C 32 A
on Orbital Gateway
Formats:
- Between 8-32 characters (a-z, A-Z, 0-
9
- Minimum 1 numeric digit
- No leading, trailing, or embedded
spaces
- Not case sensitive
OrbitalConnectionPassword Orbital Connection Password used C 32 A
in conjunction with Orbital
Username
Formats:
- Between 8-32 characters (a-z, A-Z, 0-
9
- Minimum 1 numeric digit
- No leading, trailing, or embedded
spaces
- Password is case sensitive and must
match with what is stored on Orbital
Gateway exactly
OrderID Merchant Defined Order Number: Y 22 A
Must use the same OrderID as the
original request
Amount Transaction Amount: N 12 N
Keys:
- Amount being captured. It can be
less than or equal to the original
authorization. Anything less than
will create a split transaction.
- Implied decimal including those
currencies that are a zero
exponent. For example, both
$100.00 (an exponent of ‘2’) and
100 Yen (an exponent of ‘0’) should
be sent as
<Amount>10000</Amount>.
See table for min/max amount for each
currency type.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 186
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 187
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 188
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 189
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 190
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 191
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
.NET
TransactionElement pc3core =
transaction.GetComplexRoot(Paymentech.RequestType.PC3_CORE);
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
PC3FreightAmt Level 3 freight amount for shipment O 12 N
Total freight or shipping and handling charges.
Implied decimal.
See Level 2 & 3 Data Reference for further
details.
PC3DutyAmt Level 3 Duty Amount for Shipment O 12 N
Total charges for any import and/or export
duties included in this transaction. Implied
decimal.
See Level 2 & 3 Data Reference for further
details.
PC3DestCountryCd Level 3 Destination Country Code C 3 A
The ISO-assigned code of the country to which
the goods are shipped. Conditionally required
for all Purchasing Card 3 transactions. If no
value is submitted, it will be default to the
United States [USA].
Required for Level 3 Transactions.
See Appendixfor Country Codes
See Level 2 & 3 Data Reference for further
details.
PC3ShipFromZip Level 3 Ship from Zip C 10 A
The zip/postal code of the location from which
the goods are shipped.
Required for best Interchange rate
Cannot be all zeros or nines.
See Level 2 & 3 Data Reference for further
details.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 192
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 193
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 194
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
10.3.2 PC3LineItems
This transaction can be used to construct a PC3 line item to PC3 core header to a Mark For
Capture transaction.
COM Dim PC3LineItem As TransactionElement
Set PC3LineItem = PC3Core.getRecursiveElement("PC3LineItems")
.NET
TransactionElement pc3lineitem =
pc3core.GetRecursiveElement(Paymentech.RequestType.PC3_LINE_ITEMS);
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
PC3LineItemCount Level 3 Number of Line Items C 2 N
The number of Purchasing Card 3 Line Item
Detail items included with this transaction.
The maximum number of line items is 98. At
least 1 line item must be included to submit
Purchasing Card 3 data.
Required for Level 3 Data.
PC3LineItemArray Purchase Card Level 3 Detail Header C N/A N/A
Required parent tag for Level 3 Line Item
Detail components.
PC3LineItem Parent XML Tag for Level 3 Line Item C N/A N/A
Details
This XML Tag is the parent for each Line item
detail included in this transaction. It should be
repeated for each item.
PC3DtlIndex Level 3 Line Item Index C 2 N
The sequential number [1 – 98] of the Line
Item Details included with this transaction.
Required for Level 3 Data.
See Level 2 & 3 Data Reference for further
details.
PC3DtlDesc Level 3 Line Item Detail Element – C 35 A
Description
Text description of the item purchased.
Cannot be all zeros
Required for Level 3 Data.
See Level 2 & 3 Data Reference for further
details.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 195
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 196
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 197
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 198
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 199
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char. A/N
MerchantID Gateway merchant account number assigned by M 12 N
Chase Paymentech Solutions:
Echoes the account number passed in the request
TerminalID Merchant Terminal ID assigned by Chase M 3 N
Paymentech Solutions:
Echoes the Terminal ID passed in the request
OrderID Merchant Defined Order Number: M 22 A
Echoes the Order Number passed in the request
TxRefNum Gateway transaction reference number: M 40 A
Echoes the Transaction Reference Number passed
in the request
TxRefIdx Gateway transaction index: C 4 A
Used to identify the unique components of
transactions adjusted more than one time.
Required on for void transactions, not for Mark for
Captures.
Amount Transaction Amount: M 12 N
Echoes the Amount passed in the request
ProcStatus Process Status: M 6 A
The first element that should be checked to
determine the result of a request. It is the only
element that is returned in all response scenarios. It
identifies whether transactions have successfully
passed all of the Gateway edit checks.
0 – Success
All other values constitute an error condition. See
appendix for definition of those error values.
StatusMsg Text message associated with ProcStatus value. C Var A
RespTime Time the transaction was processed by M 6 N
gateway:
Format – ‘hh24miss’
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 200
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 201
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
COM
Request.Type = "Reverse"
.NET
Transaction transaction = new Transaction(RequestType.REVERSE_TRANSACTION);
Field
Field Name Description Req. Max. Type
M/C/O Char. A/N
OrbitalConnectionUsername Orbital Connection Username set C 32 A
up on Orbital Gateway
Formats:
- Between 8-32 characters (a-z, A-Z,
0-9
- Minimum 1 numeric digit
- No leading, trailing, or embedded
spaces
- Not case sensitive
OrbitalConnectionPassword Orbital Connection Password used C 32 A
in conjunction with Orbital
Username
Formats:
- Between 8-32 characters (a-z, A-Z,
0-9
- Minimum 1 numeric digit
- No leading, trailing, or embedded
spaces
- Password is case sensitive and must
match with what is stored on Orbital
Gateway exactly
TxRefNum Gateway transaction reference C 40 A
number:
A unique value for each transaction,
which is required to adjust any
transaction in the gateway [such as
Mark for Capture or void].
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 202
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 203
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char. A/N
Response Required XML Parent Tag M N/A N/A
ReversalResp XML tag that defines the transaction as a New Order M N/A N/A
response
MerchantID Gateway merchant account number assigned by M 12 N
Chase Paymentech Solutions:
Echoes the account number passed in the request
TerminalID Merchant Terminal ID assigned by Chase M 3 N
Paymentech Solutions:
Echoes the Terminal ID passed in the request
OrderID Merchant Defined Order Number: M 22 A
Echoes the Order Number passed in the request
TxRefNum Gateway transaction reference number: M 40 A
Echoes the Transaction Reference Number passed in the
request
TxRefIdx Gateway transaction index: C 4 A
Used to identify the unique components of transactions
adjusted more than one time. Required on for void
transactions, not for Mark for Captures.
OutstandingAmt Remaining Non-voided amount for partial Voids M 12 N
ProcStatus Process Status: M 6 A
The first element that should be checked to determine the
result of a request. It is the only element that is returned
in all response scenarios. It identifies whether
transactions have successfully passed all of the Gateway
edit checks.
0 – Success
All other values constitute an error condition. See
appendix for definition of those error values.
StatusMsg Text message associated with ProcStatus value. C Var A
RespTime Time the transaction was processed by gateway: M 6 N
Format – ‘hh24miss’
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 204
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 205
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char. A/N
Response Required XML Parent Tag M N/A N/A
EndOfDayResp XML tag that defines the transaction as a New Order M N/A N/A
response
MerchantID Gateway merchant account number assigned by M 12 N
Chase Paymentech Solutions:
Echoes the account number passed in the request
TerminalID Merchant Terminal ID assigned by Chase M 3 N
Paymentech Solutions:
Echoes the Terminal ID passed in the request
BatchSeqNum Batch Sequence Number M 32 A
Sequence value that References a Settlement Batch
ProcStatus Process Status: M 6 A
The first element that should be checked to determine
the result of a request. It is the only element that is
returned in all response scenarios. It identifies whether
transactions have successfully passed all of the
Gateway edit checks.
0 – Success
All other values constitute an error condition. See
appendix for definition of those error values.
StatusMsg Text message associated with ProcStatus value. C Var A
RespTime Time the transaction was processed by gateway: M 6 N
Format – ‘hh24miss’
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 206
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
Request Required Parent XML Tag M N/A N/A
SafetechFraudAnalysis XML Tag that Defines the M N/A N/A
Transaction as a Fraud Analysis
Request
OrbitalConnectionUsername Orbital Connection Username set up C 32 A
on Orbital Gateway
Provide Username associated with
this MID.
Required if merchant is not set up
for IP-based authentication.
Formats:
Between 8–32 characters (a-z, A-
Z, 0-9)
Minimum 1 number
No leading, trailing, or embedded
spaces
Not case-sensitive
OrbitalConnectionPassword Orbital Connection Password used C 32 A
in conjunction with Orbital
Username
Provide Password associated with
Connection Username.
Formats:
Between 8–32 characters (a-z, A-
Z, 0-9)
Minimum 1 number
No leading, trailing, or embedded
spaces
Password is case-sensitive and
must exactly match what is stored
on Orbital Gateway
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 207
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 208
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 209
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 210
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 211
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 212
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 213
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 214
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 215
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 216
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 217
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 218
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 219
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 220
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 221
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Example: MOZILLA/4.0
(COMPATIBLE; MSIE 5.0; WINDOWS
95
ShippingMethod Method of Shipping To A Customer O 1 A
Valid values:
C Lowest Cost
D Carrier Designated by
Customer
E Electronic Delivery*
G Ground*
I International*
M Military*
N Next Day or Overnight*
O Other
P Store Pickup
S Same Day*
T Two Day Service*
W Three Day Service
For American Express, use only values
marked with an asterisk.
EUDDBankBranchCode EUDD Bank Branch Code C 10 A
Conditionally required for European
Direct Debit transactions.
Used when EUDDIBAN is not present.
Required for the following countries:
Cyprus, Greece, Italy, Portugal, and
Spain.
EUDDIBAN Customer’s International Bank C 34 A
Account Number (IBAN)
Conditionally required for European
Direct Debit transactions.
If populated, the Bank Identifier Code
(BIC) is required.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 222
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 223
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 224
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
CustomerID Customer ID O 32 A
A merchant generated ID for a specific
customer.
This element should only be sent when
the FraudScoreIndicator element is set
to 2.
CustomerIDCreationTime Customer ID Creation Time O 10 N
The time the value used in the
CustomerID element was created by
the merchant.
Format: Unix Epoc
This element should only be sent when
the FraudScoreIndicator element is set
to 2.
KTTVersionNumber User Defined and Shopping Cart C 1 N
Format Indicator
This element must contain a value of
“1” as of the release of this
specification if the KTTDataLength and
KTTDataString elements are
populated.
KTTDataLength User Defined or Shopping Cart C 4 N
Format Data Length
Indicates the length of the value of the
KTTDataString element. This must be a
4 digit number no less than 0001 and
no greater than 0999.
KTTDataString User Defined or Shopping Cart C Var A/N
Format Data String
This field can be populated with user-
defined Agent Web Console rules,
Shopping Cart Data, or both.
Please see Special notes on KTT
elementsfor additional information.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 225
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char. A/N
Response Required XML Parent Tag M N/A N/A
SafetechFraudAnalysisResp XML Tag that Defines the M N/A N/A
Transaction as a Fraud Analysis
Response
IndustryType Industry Type of the Transaction M 2 A
This tag returns null results.
MerchantID Gateway Merchant Account M 12 N
Number assigned by Chase
Paymentech
Echoes the Merchant ID passed in
the request.
TerminalID Merchant Terminal ID assigned M 3 N
by Chase Paymentech
Echoes the Terminal ID passed in
the request.
CardBrand Card Type/Brand for the M 2 A
Transaction
Returns the Card Type/Brand as
processed on the host platform
For Refunds and Force
transactions, if no CardBrand,
such as Visa or MasterCard,
was sent in the request (when
optional), the specific Card
Brand mnemonic is returned.
For PINless Debit transactions,
the Card Brand is DP (which is
a generic PINless mnemonic).
AccountNum Account Number M 19 N
Echoes the Account Number
passed in the request
OrderID Merchant-Defined Order Number M 22 A
Echoes the Order Number passed
in the request.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 226
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char. A/N
RespTime Time the Transaction was M 6 N
Processed by Gateway
Format: hh24mmss
ProcStatus Process Status M 6 A
The first element that should
be checked to determine the
result of a request.
The only element that is
returned in all response
scenarios.
Identifies whether transactions
have successfully passed all of
the Gateway edit checks:
0 Success
All other values constitute an
error condition. See Appendix
for definition of these error
values.
ApprovalStatus Approval Status C 1 N
Conditional on Process Status
returning a 0 (or successful)
response. If so, the Approval Status
identifies the result of the
authorization request to the host
system:
0 Declined
1 Approved
2 Message/System Error
RespCode Response Code C 2 A
Normalized authorization response
code issued by the host system
(Salem/PNS), which identifies an
approval (00) or the reason for a
decline or error.
See Appendix for values.
StatusMsg Text Message Associated with C Var A
RespCode Value
RespMsg Message Associated with C 80 A
HostRespCode
May not be populated for
transactions not requiring an
authorization such as Force or
Refunds
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 227
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char. A/N
HostRespCode Actual Host Response Code C 3 A
Exact response sent by host
authorization system (non-
normalized by the Gateway).
For those systems that have
already coded to the
Salem/PNS authorization
response values, they are
available via this tag.
CustomerRefNum Customer Reference Number C 22 A
This field will echo the Customer
Reference Number sent in the
Request, if applicable.
CustomerName Customer Billing Name C 30 A
Echoes value from the request.
ProfileProcStatus Result Status of Profile C 6 A
Management
Communicates the success or
failure of a Profile Management
request:
0 Success
>0 An error condition, see
Appendix for values
CustomerProfileMessage Verbose Text Description C Var A
associated with ProfileProcStatus
FraudScoreProcStatus Process Status of Fraud Score M Var N
request
Identifies whether transactions
have successfully passed all of
the Gateway edit checks
related specifically to Fraud
Analysis messages:
0 Success
All other values constitute an error
condition.
See Appendix for definition of these
error values.
FraudScoreProcMsg Verbose Text Description C Var A
associated with
FraudScoreProcStatus
FraudAnalysisResponse Parent Element of Fraud Analysis M N/A N/A
Response Data
FraudScoreIndicator Echoes FraudScoreIndicator from M 1 N
the request message.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 228
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char. A/N
FraudStatusCode Fraud Status Code C 4 A
The response code returned by the
Safetech service to indicating the
status of the fraud analysis.
RiskInquiryTransactionId Risk Inquiry Transaction ID C 32 A
A unique ID used to identify the
fraud assessment.
AutoDecisionResponse Auto Decision Response O 1 A
The auto decision response code
returned by the Safetech service.
The following is a list of valid
values.
A Approved
D Decline
E Manager Review
R Review
This list may expand in the future.
RiskScore Risk Score C 2 N
This element may be returned as
null if the Safetech service was not
successful in generating a fraud
score.
KaptchaMatchFlag Kaptcha Match Flag O 1 A
Indicates if a request to the
Safetech service has a
corresponding Kaptcha record.
WorstCountry Worst Country C 2 A
The two character ISO 3166 country
code associated with this customer
in the last 14 days.
This element is only returned with a
Fraud Score Indicator of 2.
CustomerRegion Customer Region C 2 A
The estimated region of the
customer.
This field is case sensitive. The
Safetech service will use lower case
letters to represent a state or
province, while uppercase letters
indicate a county.
This element is only returned with a
Fraud Score Indicator of 2.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 229
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char. A/N
PaymentBrand Payment Brand O 4 A
The payment method (brand)
identified by the Safetech service
during Fraud Analysis.
This element is only returned with a
Fraud Score Indicator of 2.
FourteenDayVelocity Fourteen Day Velocity O 2 A/N
The total number of prior sales by
this customer within the last 14
days.
This element is only returned with a
Fraud Score Indicator of 2.
SixHourVelocity Six Hour Velocity O 2 A/N
The total number of prior sales by
this customer in any six hour
window over the last 14 days.
This element is only returned with a
Fraud Score Indicator of 2.
CustomerNetwork Customer Network Type indicator O 1 A
A single character designation of
the type of network used by the
customer to initiate the transaction.
Some possible values can include:
A Anonymous
L Library
H High School
N Normal
P Prison
S Satellite
This element is only returned with a
Fraud Score Indicator of 2.
NumberOfDevices Number of Devices with O 3 N
Transaction
The number of devices associated
with the transaction, as recorded by
the Safetech service.
This element is only returned with a
Fraud Score Indicator of 2.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 230
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char. A/N
NumberOfCards Number of Cards with O 3 N
Transaction
The number of cards associated
with the transaction, as recorded by
the Safetech service.
This element can only be returned
when the FraudScoreIndicator
element is returned with a value of
2.
NumberOfEmails Number of Emails with O 3 N
Transaction
The number of emails associated
with the transaction, as recorded by
the Safetech service.
This element is only returned with a
Fraud Score Indicator of 2.
DeviceLayers Device Layer Description O 54 A
A period-delimited description of the
Network, Flash, JavaScript, HTTP,
and Browser layers of the device
used by the customer to initiate the
transaction, as determined by the
Safetech service.
This element is only returned with a
Fraud Score Indicator of 2.
DeviceFingerprint Device Fingerprint O 32 A
A hash of system identifiers
determined by the Safetech service
to be constants for the device used
by the customer.
This element is only returned with a
Fraud Score Indicator of 2.
CustomerTimeZone Customer Time Zone O 4 N
The time zone where the customer
resides, as an offset from GMT.
This element is only returned with a
Fraud Score Indicator of 2.
CustomerLocalDateTime Customer Local Date & Time O 16 N
The local timestamp of the
customer’s device.
Format: YYYY-MM-DD HH:MM
This element is only returned with a
Fraud Score Indicator of 2.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 231
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char. A/N
DeviceRegion Device Region O 2 A
Indicates the region or state where
the customer’s device resides.
This field is case sensitive. The
Safetech service will use lower case
letters to represent a state or
province, while uppercase letters
indicate a county.
This element is only returned with a
Fraud Score Indicator of 2.
DeviceCountry Device Country O 2 A
The ISO 3166 Country code which
indicates the country where the
customer’s device resides.
This element is only returned with a
Fraud Score Indicator of 2.
ProxyStatus Proxy Status Indicator O 1 A
Indicates if the device used by the
customer is using a proxy network.
This element is only returned with a
Fraud Score Indicator of 2.
JavascriptStatus JavaScript Status Indicator O 1 A
Indicates if the device used by the
customer allows use of JavaScript.
This element is only returned with a
Fraud Score Indicator of 2.
FlashStatus Flash Status Indicator O 1 A
Indicates if the device used by the
customer allows Flash.
This element is only returned with a
Fraud Score Indicator of 2.
CookiesStatus Cookies Status Indicator O 1 A
Indicates if the device used by the
customer allows use of cookies.
This element is only returned with a
Fraud Score Indicator of 2.
BrowserCountry Browser Country O 2 A
The ISO 3166 Country code which
indicates the country where the
customer’s browser resides.
This element is only returned with a
Fraud Score Indicator of 2.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 232
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char. A/N
BrowserLanguage Browser Language O 2 A
The ISO 639-1 standard code which
indicates the language of the
customer’s browser.
This element is only returned with a
Fraud Score Indicator of 2.
MobileDeviceIndicator Mobile Device Indicator O 1 A
Indicates if the device used by the
customer is a mobile device.
This element is only returned with a
Fraud Score Indicator of 2.
MobileDeviceType Mobile Device Type O 32 A
A description of the type of mobile
device used by the customer.
This element is only returned with a
Fraud Score Indicator of 2.
MobileWirelessIndicator Mobile Wireless Indicator O 1 A
Indicates if the device used by the
customer has wireless capabilities.
This element is only returned with a
Fraud Score Indicator of 2.
VoiceDevice Voice Device Indicator O 1 A
Indicates if the device used by the
customer is voice controlled.
This element is only returned with a
Fraud Score Indicator of 2.
PCRemoteIndicator PC Remote Indicator O 1 A
Indicates if the device used by the
customer is a remotely controlled
computer.
This element is only returned with a
Fraud Score Indicator of 2.
RulesDataLength Rules Trigger Reply Data Length O 4 N
Indicates the length of the data
contained in the RulesData
element.
Values in this element are no less
than 0005 and no greater than
0999.
Returned only if the RulesTrigger
element is set to ‘Y’ on the request
message.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 233
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char. A/N
RulesData Rules Trigger Reply Data O Var A/N
A comma-delimited list of the rules
triggered in the Safetech service by
the transaction request.
For more information on the data
contained in this element, please
see Special Notes on Rules Trigger
response data
EUDDCountryCode EUDD RIB O 2 A/N
Echoes the value in the request.
EUDDBankSortCode EUDD Bank Branch Code O 10 A/N
Echoes the value in the request.
EUDDRibCode EUDD International Bank O 34 A/N
Account Number (IBAN)
If not present in the request, this
may be returned by the issuer.
EUDDBankBranchCode EUDD Bank Identification Code O 11 A/N
If not present in the request, this
may be returned by the issuer.
EUDDIBAN EUDD RIB O 2 A/N
Echoes the value in the request.
EUDDBIC EUDD Bank Branch Code O 10 A/N
Echoes the value in the request.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 234
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
The following is the list of complex types available for this transaction:
PriorAuthID
FraudAnalysis
Field
Field Name Description Req. Max. Type
M/C/O Char. A/N
OrbitalConnectionUsername Orbital Connection Username set C 32 A
up on Orbital Gateway
Formats:
- Between 8-32 characters (a-z, A-
Z, 0-9
- Minimum 1 numeric digit
- No leading, trailing, or embedded
spaces
- Not case sensitive
OrbitalConnectionPassword Orbital Connection Password C 32 A
used in conjunction with Orbital
Username
Formats:
- Between 8-32 characters (a-z, A-
Z, 0-9
- Minimum 1 numeric digit
- No leading, trailing, or embedded
spaces
- Password is case sensitive and
must match with what is stored on
Orbital Gateway exactly
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 235
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 236
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 237
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 238
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 239
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 240
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 241
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 242
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Example: MOZILLA/4.0
(COMPATIBLE; MSIE 5.0;
WINDOWS 95
ShippingMethod Method of Shipping To A O 1 A
Customer
Valid values:
C Lowest Cost
D Carrier Designated by
Customer
E Electronic Delivery*
G Ground*
I International*
M Military*
N Next Day or Overnight*
O Other
P Store Pickup
S Same Day*
T Two Day Service*
W Three Day Service
For American Express, use only
values marked with an asterisk.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 243
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
10.11.1 PriorAuthID
This transaction can be used to construct a prior auth id to a GiftCard transaction.
COM
Dim PC3Core As TransactionElement
Set PC3Core = Request.getComplexRoot("PC3Core")
.NET
TransactionElement priorauth =
transaction.GetComplexRoot(Paymentech.RequestType.PRIOR_AUTH_ID);
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
PriorAuthID Defines the Transaction Type as a Prior O 6 A
Authorization
When this value is present, the request is
considered a Force Authorization.
No online authorization will be generated to
the Host systems.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 244
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
COM
DimFraudAnalysis As TransactionElement
Set FraudAnalysis = Request.getComplexRoot("FraudAnalysis")
.NET
TransactionElement fraudanalysis =
transaction.GetComplexRoot(Paymentech.RequestType.FRAUD_ANALYSIS);
Field
Field Name Description Req. Max. Type
M/C/O Char A/N
FraudScoreIndicator Fraud Analysis Type Indicator C 1 N
Used to request the type of fraud analysis
performed on the transaction. The value of this
field directly determines the scope of elements
returned in the response message.
Valid values:
1 Short Form Request
2 Long Form Request
RulesTrigger Fraud Analysis Rules Return Trigger O 1 A/N
Determines whether the Agent Web Console
(AWC) rules are returned.
Valid values:
Y Triggered rules are returned
N Triggered rules are not returned
SafetechMerchantID Safetech Merchant ID O 6 A/N
A value assigned by Chase Paymentech when
a merchant is enabled for the Safetech
service.
This is not the same value as Transaction
Division number found in the MerchantID
element.
If no value is present, a default value will be
used if available. If no default is stored, the
request will generate an error.
KaptchaSessionID Kaptcha Session ID O 32 A
A merchant generated session ID for this fraud
scoring request.
The Safetech system recommends this value
be unique for 30 days, or the Fraud Score
results may not be accurate.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 245
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 246
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 247
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char. A/N
Request Required XML Parent Tag M N/A N/A
Gift CardResp XML tag that defines the transaction as a M N/A N/A
New Order request
MerchantID Gateway merchant account number M 12 N
assigned by Chase Paymentech:
This account number will match that of your
host platform
BIN 000001 – 6 digit Salem Division Number
BIN 000002 – 12 digit PNS Merchant ID
TerminalID Merchant Terminal ID assigned by Chase M 3 N
Paymentech:
All Salem Terminal IDs at present must be
‘001’. PNS Terminal ID’s can be from ‘001’ –
‘999’. Most are ‘001’.
OrderID Merchant Defined Order Number: M 22 A
Field defined and supplied by the auth
originator, and echoed back in response.
AccountNum Card Number identifying the customer. C 19 N
Should be null for electronic check processing
StartAccountNum Defines the first Card Number in a Block C 19 N
Activation Sequence
BatchFailedAcctNum Card Number in a Block Activation C 19 N
Sequence that caused a Block Activation
Failure
Conditionally returned on a Block Activation
failure
FlexRequestedAmount Transaction amount submitted in the C 12 N
request:
Implied Decimal.
Conditionally returned
FlexRedeemedAmt Actual amount Redeemed on a C 12 N
Redemption Completion where the
flexPartialRedemptionInd = Yes:
Implied Decimal.
Conditionally returned Regardless of whether
the amount redeemed is equal to or less than
the requested amount, it will be identified in
this tag.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 248
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 249
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 250
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 251
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 252
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 253
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 254
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 255
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Req. Max. Type
Description M/C/O Char A/N
OrbitalConnectionUsername Orbital Connection Username set up on C 32 A
Orbital Gateway
Formats:
- Between 8-32 characters (a-z, A-Z, 0-9
- Minimum 1 numeric digit
- No leading, trailing, or embedded spaces
- Not case sensitive
OrbitalConnectionPassword Orbital Connection Password used in C 32 A
conjunction with Orbital Username
Formats:
- Between 8-32 characters (a-z, A-Z, 0-9
- Minimum 1 numeric digit
- No leading, trailing, or embedded spaces
- Password is case sensitive and must
match with what is stored on Orbital
Gateway exactly
CustomerBin Transaction Routing Definition: M 6 N
Assigned by Chase Paymentech
000001 – Salem
000002 – PNS
This value may not be changed through a
Profile Update action.
This is the equivalent to the <BIN>
element used on transactional requests
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 256
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 257
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 258
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 259
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 260
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 261
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 262
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 263
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 264
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 265
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 266
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 267
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 268
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 269
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 270
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 271
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 272
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Req. Max. Type
Description M/C/O Char A/N
CustomerBin Transaction Routing Definition: M 6 N
Value from the Request Returned
CustomerMerchantID Gateway merchant account number from M 15 N
Request
CustomerName Customer Billing Name M 30 A
CustomerRefNum Customer Reference Number M 22 A
CustomerProfileAction Defines the Customer Profile action M 6 A
requested
ProfileProcStatus Result Status of Profile Management M 6 A
Communicates the success or failure of a
Profile Management request:
0 Success
>0 An error condition, see in Appendix
A for values.
CustomerProfileMessage Verbose Text Description associated with M Var A
ProfileProcStatus
CustomerAddress1 Cardholder Billing Address line 1 M 30 A
CustomerAddress2 Cardholder Billing Address line 2 M 30 A
CustomerCity Cardholder Billing City M 20 A
CustomerState Cardholder Billing State M 2 A
CustomerZIP Cardholder Billing Address Zip Code: M 10 A
CustomerEmail Cardholder Email M 50 A
CustomerPhone Cardholder Telephone Number: M 14 A
Format = AAAEEENNNNXXXX, where
AAA – Area Code
EEE – Exchange
NNNN – Number
XXXX – EXTENSION
CustomerCountryCode Cardholder Address Country Code C 2 A
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 273
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 274
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 275
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 276
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 277
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
COM
Request.Type = " Inquiry"
.NET
Transaction transaction = new Transaction(RequestType.INQUIRY);
Field
Field Name Description Req. Max. Type
M/C/O Char. A/N
OrbitalConnectionUsername Orbital Connection Username set up C 32 A
on Orbital Gateway
Formats:
- Between 8-32 characters (a-z, A-Z, 0-9
- Minimum 1 numeric digit
- No leading, trailing, or embedded
spaces
- Not case sensitive
OrbitalConnectionPassword Orbital Connection Password used in C 32 A
conjunction with Orbital Username
Formats:
- Between 8-32 characters (a-z, A-Z, 0-9
- Minimum 1 numeric digit
- No leading, trailing, or embedded
spaces
- Password is case sensitive and must
match with what is stored on Orbital
Gateway exactly
BIN Transaction Routing Definition M 6 N
Assigned by Chase Paymentech
000001 - Salem
000002 - Tampa
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 278
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 279
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char. A/N
IndustryType Defines the Industry type of the M 2 A
transaction
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 280
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char. A/N
ProcStatus Process Status M 6 A
0 – Success
0 - Decline
1 - Approved
2 - Message/System Error
RespCode Response Code M 2 A
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 281
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char. A/N
RecurringAdviceCd Recurring Payment Advice Code M 2 N
[MasterCard Only]
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 282
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char. A/N
ProfileProcStatus Result Status of Profile Management M 6 A
0 - Success
Greater than 0 - An error condition, see
Appendix A for definition of the specific
Profile Management error values
CustomerProfileMessage Verbose Text Description associated with M Var A
ProfileProcStatus
BillerReferenceNumber Biller Reference Number [PINLess Debit C 25 A
Only]
Format – ‘hh24miss’
PartialAuthOccured Indicates if a Partial Approval was C 1 A
returned
This tag will be NULL unless a Partial
Authorization has been returned.
RequestedAmount Requested Transaction Amount C Var N
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 283
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char. A/N
IsoCountryCode ISO Country Code C 2 A
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 284
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char. A/N
AutoDecisionResponse Auto Decision Response O 1 A
The auto decision response code returned
by the Safetech service.
The following is a list of valid values.
A Approved
D Decline
E Manager Review
R Review
This list may expand in the future.
RiskScore Risk Score C 2 N
This element may be returned as null if the
Safetech service was not successful in
generating a fraud score.
KaptchaMatchFlag Kaptcha Match Flag O 1 A
Indicates if a request to the Safetech
service has a corresponding Kaptcha
record.
WorstCountry Worst Country C 2 A
The two character ISO 3166 country code
associated with this customer in the last 14
days.
This element is only returned with a Fraud
Score Indicator of 2.
CustomerRegion Customer Region C 2 A
The estimated region of the customer.
This field is case sensitive. The Safetech
service will use lower case letters to
represent a state or province, while
uppercase letters indicate a county.
This element is only returned with a Fraud
Score Indicator of 2.
PaymentBrand Payment Brand O 4 A
The payment method (brand) identified by
the Safetech service during Fraud
Analysis.
This element is only returned with a Fraud
Score Indicator of 2.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 285
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char. A/N
FourteenDayVelocity Fourteen Day Velocity O 2 A/N
The total number of prior sales by this
customer within the last 14 days.
This element is only returned with a Fraud
Score Indicator of 2.
SixHourVelocity Six Hour Velocity O 2 A/N
The total number of prior sales by this
customer in any six hour window over the
last 14 days.
This element is only returned with a Fraud
Score Indicator of 2.
CustomerNetwork Customer Network Type indicator O 1 A
A single character designation of the type
of network used by the customer to initiate
the transaction.
Some possible values can include:
A Anonymous
L Library
H High School
N Normal
P Prison
S Satellite
This element is only returned with a Fraud
Score Indicator of 2.
NumberOfDevices Number of Devices with Transaction O 3 N
The number of devices associated with the
transaction, as recorded by the Safetech
service.
This element is only returned with a Fraud
Score Indicator of 2.
NumberOfCards Number of Cards with Transaction O 3 N
The number of cards associated with the
transaction, as recorded by the Safetech
service.
This element is only returned with a Fraud
Score Indicator of 2.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 286
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char. A/N
NumberOfEmails Number of Emails with Transaction O 3 N
The number of emails associated with the
transaction, as recorded by the Safetech
service.
This element is only returned with a Fraud
Score Indicator of 2.
DeviceLayers Device Layer Description O 54 A
A period-delimited description of the
Network, Flash, JavaScript, HTTP, and
Browser layers of the device used by the
customer to initiate the transaction, as
determined by the Safetech service.
This element is only returned with a Fraud
Score Indicator of 2.
DeviceFingerprint Device Fingerprint O 32 A
A hash of system identifiers determined by
the Safetech service to be constants for
the device used by the customer.
This element is only returned with a Fraud
Score Indicator of 2.
CustomerTimeZone Customer Time Zone O 4 N
The time zone where the customer
resides, as an offset from GMT.
This element is only returned with a Fraud
Score Indicator of 2.
CustomerLocalDateTime Customer Local Date & Time O 16 N
The local timestamp of the customer’s
device.
Format: YYYY-MM-DD HH:MM
This element is only returned with a Fraud
Score Indicator of 2.
DeviceRegion Device Region O 2 A
Indicates the region or state where the
customer’s device resides.
The Safetech service will use lower case
letters to represent a state or province,
while uppercase letters indicate a county.
This element is only returned with a Fraud
Score Indicator of 2.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 287
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char. A/N
DeviceCountry Device Country O 2 A
The ISO 3166 Country code which
indicates the country where the customer’s
device resides.
This element is only returned with a Fraud
Score Indicator of 2.
ProxyStatus Proxy Status Indicator O 1 A
Indicates if the device used by the
customer is using a proxy network.
This element is only returned with a Fraud
Score Indicator of 2.
JavascriptStatus JavaScript Status Indicator O 1 A
Indicates if the device used by the
customer allows use of JavaScript.
This element is only returned with a Fraud
Score Indicator of 2.
FlashStatus Flash Status Indicator O 1 A
Indicates if the device used by the
customer allows Flash.
This element is only returned with a Fraud
Score Indicator of 2.
CookiesStatus Cookies Status Indicator O 1 A
Indicates if the device used by the
customer allows use of cookies.
This element is only returned with a Fraud
Score Indicator of 2.
BrowserCountry Browser Country O 2 A
The ISO 3166 Country code which
indicates the country where the customer’s
browser resides.
This element is only returned with a Fraud
Score Indicator of 2.
BrowserLanguage Browser Language O 2 A
The ISO 639-1 standard code which
indicates the language of the customer’s
browser.
This element is only returned with a Fraud
Score Indicator of 2.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 288
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char. A/N
MobileDeviceIndicator Mobile Device Indicator O 1 A
Indicates if the device used by the
customer is a mobile device.
This element is only returned with a Fraud
Score Indicator of 2.
MobileDeviceType Mobile Device Type O 32 A
A description of the type of mobile device
used by the customer.
This element is only returned with a Fraud
Score Indicator of 2.
MobileWirelessIndicator Mobile Wireless Indicator O 1 A
Indicates if the device used by the
customer has wireless capabilities.
This element is only returned with a Fraud
Score Indicator of 2.
VoiceDevice Voice Device Indicator O 1 A
Indicates if the device used by the
customer is voice controlled.
This element is only returned with a Fraud
Score Indicator of 2.
PCRemoteIndicator PC Remote Indicator O 1 A
Indicates if the device used by the
customer is a remotely controlled
computer.
This element is only returned with a Fraud
Score Indicator of 2.
RulesDataLength Rules Trigger Reply Data Length O 4 N
Indicates the length of the data contained
in the RulesData element.
Values in this element are no less than
0005 and no greater than 0999.
Returned only if the RulesTrigger element
is set to ‘Y’ on the request message.
RulesData Rules Trigger Reply Data O Var A/N
A comma-delimited list of the rules
triggered in the Safetech service by the
transaction request.
For more information please Appendix.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 289
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char. A/N
CTIAffluentCard Card Indicator: Affluent Category O 1 A
Affluent cards have very high pre-set
spending limits, if any.
Returned only for BIN 000001 merchants
on applicable transactions.
CTICommercialCard Card Indicator: Commercial Card O 1 A
See Level 2 and Level 3 Data for more
information.
Returned only for BIN 000001 merchants
on applicable transactions.
CTIDurbinExemption Card Indicator: Durbin O 1 A
Returned only for BIN 000001 merchants
on applicable transactions.
CTIHealthcareCard Card Indicator: Healthcare Card O 1 A
Returned only for BIN 000001 merchants
on applicable transactions.
CTILevel3Eligible Card Indicator: Level 3 Data Eligibility O 1 A
See Level 2 and Level 3 Data for more
information.
Returned only for BIN 000001 merchants
on applicable transactions.
CTIPayrollCard Card Indicator: Payroll Card O 1 A
Returned only for BIN 000001 merchants
on applicable transactions.
CTIPrepaidCard Card Indicator: Prepaid Card O 1 A
Returned only for BIN 000001 merchants
on applicable transactions.
CTIPINlessDebitCard Card Indicator: PINless Debit Eligibility O 1 A
See PINless Debit for more information.
Returned only for BIN 000001 merchants
on applicable transactions.
CTISignatureDebitCard Card Indicator: Signature Debit O 1 A
Eligibility
Signature Debit refers to processing a
debit card as a credit card.
Returned only for BIN 000001 merchants
on applicable transactions.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 290
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/O Char. A/N
CTIIssuingCountry Card Indicator: Issuing Country O 3 A
Used to distinguish a domestic or
international customer.
Format: 3 alphanumeric character ISO
country code.
Returned only for BIN 000001 merchants
on applicable transactions.
EUDDCountryCode EUDD Country Code O 2 A
Echoes the value in the request.
EUDDBankSortCode EUDD Bank Sort Code O 10 AN
Echoes the value in the request.
EUDDRibCode EUDD RIB O 2 AN
Echoes the value in the request.
EUDDBankBranchCode EUDD Bank Branch Code O 10 AN
Echoes the value in the request.
EUDDIBAN EUDD International Bank Account O 34 AN
Number (IBAN)
If not present in the request, this may be
returned by the issuer.
EUDDBIC EUDD Bank Identification Code O 11 AN
If not present in the request, this may be
returned by the issuer.
EUDDMandateSignatureDate EUDD Mandate Signature Date O 8 N
Echoes the value in the request.
EUDDMandateID EUDD Mandate ID O 35 AN
Echoes the value in the request.
EUDDMandateType EUDD Mandate Type O 1 N
Echoes the value in the request.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 291
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Field
Field Name Description Req. Max. Type
M/C/ Char. A/N
O
Response Required XML Parent Tag M N/A N/A
QuickResp XML tag that defines the transaction as a M N/A N/A
New Order response
MerchantID Gateway merchant account number M 12 N
assigned by Chase Paymentech Solutions:
Echoes the account number passed in the
request
TerminalID Merchant Terminal ID assigned by Chase M 3 N
Paymentech Solutions:
Echoes the Terminal ID passed in the request
OrderID Merchant Defined Order Number: C 22 A
Echoes the Order Number passed in the
request
AccountNum Card Number identifying the customer. C 19 N
Echoes the Account Number passed in the
request
StartAccountNum Defines the first Card Number in a Block C 19 N
Activation Sequence
TxRefNum Gateway transaction reference number: C 40 A
Conditionally returned dependant on the error
TxRefIdx Gateway transaction index: C 4 A
ProcStatus Process Status: M 6 A
The first element that should be checked to
determine the result of a request. It is the only
element that is returned in all response
scenarios. It identifies whether transactions
have successfully passed all of the Gateway
edit checks.
See appendix for definition of those error
values.
StatusMsg Text message associated with ProcStatus C Var A
value.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 292
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
0 - Success
Greater than 0 - An error condition, see
Appendix A for definition of the specific Profile
Management error values
CustomerProfileMessage Verbose Text Description associated with C Var A
ProfileProcStatus
CustomerAddress1 Cardholder Billing Address line 1 C 30 A
CustomerAddress2 Cardholder Billing Address line 2 C 30 A
CustomerCity Cardholder Billing City C 20 A
CustomerState Cardholder Billing State C 2 A
CustomerZIP Cardholder Billing Address ZIP Code C 10 A
CustomerEmail Cardholder Email C 50 A
CustomerPhone Cardholder Telephone Number C 14 A
Format: AAAEEENNNNXXXX, where:
AAA = Area Code
EEE = Exchange
NNNN = Number
XXXX = Extension
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 293
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 294
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 295
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Max Field
Field Name Description Required Char Type
OrbitalConnectionUsername Orbital Connection Username set up on Orbital C 32 A
Gateway
Provide Username associated with this MID.
Required if merchant is not set up for IP-based
authentication.
Formats:
Between 8–32 characters (a-z, A-Z, 0-9)
Minimum 1 number
No leading, trailing, or embedded spaces
Not case-sensitive
OrbitalConnectionPassword Orbital Connection Password used in C 32 A
conjunction with Orbital Username
Provide Password associated with Connection
Username.
Formats:
Between 8–32 characters (a-z, A-Z, 0-9)
Minimum 1 number
No leading, trailing, or embedded spaces
Password is case-sensitive and must exactly
match what is stored on Orbital Gateway
CustomerBin Transaction Routing Definition M 6 N
Assigned by Chase Paymentech.
000001 Salem
000002 PNS
This is the equivalent to the <BIN> element
used on transactional requests.
CustomerMerchantID Gateway merchant account number assigned by M 15 N
Chase Paymentech
This account number will match that of your
host platform:
- BIN 000001: 6-digit Salem Division Number
- BIN 000002: 12-digit PNS Merchant ID
This is the equivalent to the <MerchantID>
element used on transactional requests.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 296
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 297
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Max Field
Field Name Description Required Char Type
CustomerBin Transaction Routing Definition M 6 N
Echoes the BIN passed in the request.
CustomerMerchantID Gateway Merchant Account Number M 15 N
assigned by Chase Paymentech
Echoes the Merchant ID passed in the request.
CustomerRefNum Customer Reference Number M 22 A
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 298
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Wait Wait 2–3 days before resending or try to resolve with the customer.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 299
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 300
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 301
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 302
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 303
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 304
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
I1 Block Activation Failed – Card Range Not Set Up for MOD 10 Error Fix
I2 Block Activation Failed – E-mail or Fulfillment Flags were set to Y Error Fix
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 305
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 306
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
ND Account number appears on European Direct Debit negative file Decline Cust.
P3 No Information Found Decline Cust.
PP No Match for Debit Authorization based on Trace, Account, and Error Fix
Division Number
PQ Unable to Validate Debit Auth Record Based on Amount, Action Error Fix
Code, and MOP
PR Refund Not Allowed – Refund Requested on a Star only BIN or Error Fix
BIN not Found
R1 Blocked Card Number Prefix Decline Cust.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 307
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
G No match at all
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 308
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
UK Unknown
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 309
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
3 PWS_DB_ERROR Resend
Database error
6 Payware NET timed out waiting for a response from the gateway. Resend
Address: [%s], port: [%s], timeout (s):[%s]
21 Fix
The SET protocol does not allow a partial reversal of a Sale transaction
24 Resend
Failed to start capture
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 310
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
31 Error: You have already sent a %s message, You cannot send another. Fix
34 The difference between the authorized amount [%s] and the requested capture Fix
amount [%s] is greater than [%s] percent
38 A batch with ID [%s] that was expected to be open is not open Fix
40 The backend module reported an error [%s]. Please see the backend modules Resend
event log for more details.
41 Error. The SET protocol only allows you to reverse the most recent authorization Fix
(index %s)
42 Error. Unable to add/edit range. Possibly this card range exists already Fix
43 The customer ID %s cannot be found, and a new customer cannot be created Fix
because no details have been supplied
44 The customer ID %s already exists, so you do not need to enter new details. Fix
45 If you enter customer details, you also need to enter a customer ID Fix
46 There was no acquirer BIN found for brand %s and merchant %s Fix
53 Bad data length. Actual: %s, Allowed: %s. Name: %s. Value: %s. Fix
54 Industry Type is Currently Not Supported for Merchant and BIN Fix
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 311
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
206 The data [%s] was not found in column [%s] of table [%s]. Fix
208 Failed to connect to database using this user name and password Resend
PWS_ERROR_FAILED_TO_CONNECT
209 Failed to connect to database as administrator using this user name Resend
and password
210 Failed to connect to database as administrator using this user name Resend
and password: %s
250 Missing one or more required elements for PAN Encryption Fix
302 Timeout error at ip address [%s] at port [%s]. Timeout [%s] Resend
314 An error occured updating a table while processing a capture reverse Resend
response
315 An error occured searching for an open batch for capture reverse Resend
316 Error. A capture was attempted but the capture percentages had not Fix
been set
317 Error. A capture reversal was attempted but there was nothing to Fix
reverse
318 Error. A capture was attempted but there was nothing to capture Fix
319 Error. An authorisation was attempted but there was nothing to Fix
authorise
320 Error. An authorisation reversal was attempted but there was nothing Fix
to reverse
321 Error. A credit was attempted but there was nothing to credit Fix
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 312
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
322 Error. A credit reversal was attempted but there was nothing to Fix
reverse
323 Batch open is not supported. Check the value of nBatchAdminFunction in Fix
the acquirer configuration utility
324 Batch close is not supported. Check the value of nBatchAdminFunction Fix
in the acquirer configuration utility
336 An auth or credit was not allowed because it would have exceeded the Fix
balance amount of the order.
341 The backend prevents a credit from being unmarked for capture Fix
342 The backend prevents an authorised transaction from being unmarked for Fix
capture
343 The backend prevented the operation because there is an end-of-day Resend
operation in progress for this merchant. Please try again later
344 The backend does not allow credits on this type of card Fix
346 Processing a CtlUserRequestReq message did not allow a request because Fix
the request it referenced was of the wrong type.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 313
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
347 Processing a CtlUserRequestReq message did not allow a request because Fix
another request already exists which references the same referenced
request.
351 This industry type does not allow a capture greater than the value of the auth Fix
352 This industry type does not allow a capture less than the value of the auth Fix
353 This industry type does not allow a split shipment Fix
354 Re-Auth failed. This error is returned when a re-auth is attempted behind-the- Call
scenes by the Gateway (usually in the case of a split transaction) and fails at the
host.
511 The Payware NET configuration utility cannot change its own listening port. If this Fix
port is changed, all integration components, including the configuration utility
itself,n\\will also need to be changed to send to this new port. Please consult the
user manual as to how to change this value
512 The Payware NET configuration utility cannot change this value. This value must Fix
remain as 1 for the configuration utility to continue working
513 Your login to the configuration utility has expired after %s minutes of inactivity. Fix
Please login again.
516 The Merchant ID/Acquiring BIN ID is invalid or missing. Message rejected Fix
518 This merchant is not active until … [This error is returned when a Merchant Account Call Customer
has been setup, but with an Activation date in the future of the present date]. Service
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 314
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
521 Error. The Orbital Gateway has received a badly formatted message Fix
522 This user (%s) is not allowed to process a message of this type (%s) Fix
600 There was an error reading data from SPAY table Fix
601 There was an error adding a new keyset for this card Fix
603 The merchant does not have an entry in the merchbrand table for merchant [%s], Fix
brand [%s] and acquirer[%s]. Please use Certificate Manager to correct this.
604 The merchant does not have a gateway certificate for merchant [%s], brand [%s], Fix
and acquirer[%s]. Please use Certificate Manager to correct this.
605 The merchant does not have an entry in the keyset table for merchant [%s], brand Fix
[%s] and acquirer[%s]. Please use Certificate Manager to correct this.
606 The merchant does not have a certificate for merchant [%s], brand [%s], and Fix
acquirer[%s]. Please use Certificate Manager to correct this.
607 For some reason the merchant is missing a certificate of type [%s] with thumbprint Fix
[%s]. You may need to request the certificate again.
700 Could not find a routing code for the %s request. Further transactions in the same Fix
operation will be %s. Merchant: %s Currency: %s PAN begins: %s
701 Cannot update merchant setting Call
702 Cannot update system setting Call
703 Cannot update currency Call
704 Cannot delete currency Call
705 Cannot get currency Call
706 Cannot update merchant Call
707 Cannot delete merchant Call
708 Cannot get merchant Call
709 Cannot update merchant currency Call
710 Cannot delete merchant currency Call
711 Cannot get merchant currency Call
712 Cannot update card range Call
713 Cannot delete card range. It may be in use. Call
714 Cannot get card range Call
715 Cannot update merchant map Call
716 Cannot delete merchant map Call
717 Cannot get merchant map Call
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 315
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 316
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 317
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
788 Another card brand name is mapped to the same host card brand name Fix
789 The approval code (%s) is invalid. It must be either empty, or contain only numbers, and have a Fix
length <= 6
790 Cannot update INDUSTRY_TYPE Call
791 Cannot delete INDUSTRY_TYPE Call
792 Cannot get INDUSTRY_TYPE Call
793 Cannot update TERMINAL Call
794 Cannot delete TERMINAL Call
795 Cannot get TERMINAL Call
796 Cannot update STORE Call
797 Cannot delete STORE Call
798 Cannot get STORE Call
799 The First character of the username and password must be non-numeric Fix
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 318
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 319
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
855 Line item validation error. Commodity code must be not greater than 4 characters Fix
long
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 320
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
860 Line item validation error. Vat rate missing or invalid. Must be between 0 and 99. Fix
861 Line item total [%s] not equal to quantity * cost - discount [%s] Fix
871 Error in Number of Line Items. Num Line Items specified [%s], Num line items received [%s] Fix
872 For this card number you also need to send the card brand Fix
873 Error validating auto original/return date [%s], ensure xml format is mmddyy Fix
874 Error validating auto original/return time [%s] Fix
875 Error validating lodge arrive/depart date [%s], ensure xml format is mmddyy Fix
876 Error, lodge depart date before arrive date, arrive/depart date [%s]/[%s] Fix
877 Error, auto return date before original date, orig/return date [%s]/[%s] Fix
881 The LIDM you supplied # does not match with any existing transaction (Cannot void Fix
or Mark a Transaction because the TxRefNum does match a transaction)
884 Error validating amount. Must be numeric, greater than 0, and no greater than Fix
99999999
885 Error Validating Amount. Must be Numeric, Equal to Zero or Greater Fix
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 321
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
887 Reversal: Invalid Reversal Indicator [%s]. Must be one of the following values: Fix
[YN]
892 Error validating surcharge amount. Must be numerical and greater than 0 Fix
900 Credit card number must be empty if account number or bank sort code are Fix
provided
901 Bank sort code must be provided if account number is provided Fix
902 Account number must be provided if bank sort code is provided Fix
903 Account number and bank sort code must be provided if credit card number is Fix
empty
904 The account number must be between 3 and 10 characters in length, and also Fix
match the length specified in the card range table
905 The bank sort code must be exactly 8 digits in length Fix
906 The first digit of the bank sort code must be 1-9, and the other digits must be 0-9 Fix
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 322
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 323
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 324
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
9000 Partial Authorization: Invalid PA Indicator. Max length is [%s] and must be one of the following: Fix
[%s]
9001 SET Error: Message not supported Fix
9002 SET Error: Decoding failure Fix
9003 SET Error: Invalid certificate Fix
9004 SET Error: Expired certificate Fix
9005 SET Error: Revoked certificate Fix
9006 SET Error: Missing certificate Fix
9007 SET Error: Signature failure Fix
9008 SET Error: Bad message header Fix
9009 SET Error: Wrapper message mismatch Fix
9010 SET Error: Version too old Fix
9011 SET Error: Version too new Fix
9012 SET Error: Unrecognized extension Fix
9013 SET Error: Message too big Fix
9014 SET Error: Signature required Fix
9015 SET Error: Message too old Fix
9016 SET Error: Message too new Fix
9017 SET Error: Thumbs mismatch Fix
9018 SET Error: Unknown rrpid Fix
9019 SET Error: Unknown xid Fix
9020 SET Error: Unknown lid Fix
9021 SET Error: Challenge mismatch Fix
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 325
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
9720 Soft Desc: Merchant not activated for soft descriptors Fix
9721 Soft Desc: Merchant Name is required if soft descriptor data is sent Fix
9722 Soft Desc: Merchant Name exceeds max length of [%s] for %s transactions Fix
9725 Soft Desc: Product Description cannot be present if Merchant Name is > %s Fix
9726 Soft Desc: Product Description length cannot exceed [%s] if Merchant Name length Fix
is between %s and %s
9727 Soft Desc: Too many Merchant descriptors. Never send more than one of the Fix
following: City, phone, url OR email
9728 Soft Desc: [%s] is not allowed for ECP or ED transactions Fix
9729 Soft Desc: Invalid format for Merchant Phone. Must be nnn-nnn-aaaa or nnn- Fix
aaaaaaaa
9735 Flex Cache: Invalid Block Activate Count. Valid passed was [%s]. Max value allowed [%s]. Fix
9739 Invalid Approval Code. Alphanumeric data only. Special characters not allowed. Fix
9742 PCard 3: Commodity Code [%s] not numeric in index [%s] Fix
9743 PCard 3: PCard 3 data was sent in original txn and is required in adjustments Fix
9744 PCard 3: If Alt Tax is sent Alt Tax Ind is required Fix
9746 PCard 3: Line item count must be between 1 and 98 inclusive Fix
9748 PCard 3: Cannot send Pcard 3 data without sending Pcard 2 field Fix
9750 PCard 3: Minimal Pcard 3 line item data missing or invalid on index Fix
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 326
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
9751 PCard 3: Line Item Count does not match the number of line items sent Fix
9752 PCard 3: Invalid debit indicator for Bin 000002 in index. Must be 'D' or 'C' Fix
9753 PCard 3: Invalid Gross/Net for Bin 000002 in index. Must be 'Y' or 'N' Fix
9754 PCard 3: Amount hash error, negative total on line item data index Fix
9755 PCard 3: Amount hash error on line item data index. Total = [%s] Hash = [%s] Fix
9760 PCard 3: Invalid Discount Indicator [%s] in index [%s]. Must be Y or N or Empty. Fix
9761 PCard 3: Index Number is out of order or invalid. Expected [%s] Sent [%s] Fix
9762 PCard 3: Discount Amount [%s] not numeric in index [%s] Fix
9766 BML: The Bill Me Later Card Type [BL] is Not Allowed with [%s] Transactions. Fix
9768 BML: Invalid [Values. Must be one of the following values: XXX or empty Fix
9769 BML: Mandatory Field [%s] is missing for [%s] Customer Type. Fix
9780 Pinless Debit: Retry Trace must be used for Pinless Debit transaction and this Retry Trace must Fix
be used for PINLess Debit transaction and this interface version: [%s]
9781 Pinless Debit: A versioned interface is required to use Pinless Debit functionalities. Fix
9782 Pinless Debit: Biller Reference Number is required for all PINLess Debit Bill Pay transactions. Fix
9783 Pinless Debit: Expiration Date is required for Pinless Debit Profiles. Fix
9784 Pinless Debit: Profile is not Pinless Debit or is an invalid status to convert to credit card. Fix
9785 PINLess Debit: Invalid Pinless Debit Transaction type [%s]. Valid values are: (Empty or BP for Fix
Bill Pay) or (EC for ECommerce)
9786 PINLess Debit: Invalid Currency: [%s]. Currency Must Be USD [840] for PINLess Debit Fix
ECommerce transactions.
9787 PINLess Debit: PIN is not required for PINLess Debit ECommerce transactions. Fix
9788 PINLess Debit: AVS Address Line 1 and ZIP code are required for PINLess Debit ECommerce Fix
transactions.
9789 PINLess Debit: The PINLess Debit ECommerce is Only Allowed with [%s] Transactions. Fix
9793 PINless Debit: Invalid [%s] : [%s]. The field is missing, invalid, or has exceeded Fix
the max length of: [%s].
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 327
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
9794 PINless Debit: The PINLess Debit Bill Pay Transactions are not allowed with [%s] Fix
9795 PINless Debit: The PINLess Debit Bill Pay is Only Allowed with [%s] Transactions. Fix
9796 PINless Debit: The PINLess Debit ECommerce is Only Allowed with Industry Type of Fix
[%s].
9797 PINless Debit: Card Number Not Eligible for PINless Debit Processing Fix
9798 PINLess Debit: IV Industry Type Is For PINLess Debit Processing Only. Fix
9799 PINLess Debit: Inquiry Trace Number is required to perform an inquiry lookup. Fix
9800 Flex Cache: Invalid Transaction type for PNS Flexcache Fix
9801 Flex Cache: Cannot send auth auth flag of Y for PNS Flexcache Fix
9802 Flex Cache: Invalid Transaction type for SLM Flexcache Fix
9803 Flex Cache: Partial Redemptions are invalid for PNS Flexcache Fix
9805 Invalid currency code [%s] for retail transactions coming from this interface Fix
9806 Refund Transactions By TxRefNum Are Only Valid When The Original Transaction Was An Fix
AUTH Or AUTH CAPTURE.
9807 Refund by TxRefNum must be less than or equal to original transaction amount Fix
9811 Online reversals are not allowed for cardtype [x]. Fix
9812 Age of auth is [x] minutes, max age for online reversal of this method of payment Fix
is [x] minutes.
9890 Invalid value for Payment Indicator Fix
9990 Gateway Unavailable: Gateway Resources Unavailable: [ROUTE1] Resend
9991 Gateway Unavailable: Gateway Resources Unavailable: [ROUTE2] Resend
9992 Authorizer Unavailable: Host Resource Marked Down: [ROUTE1] Resend
9993 Authorizer Unavailable: Host Resource Marked Down: [ROUTE2] Resend
9999 Unknown error type [%d]. Resend
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 328
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
11001 Locked Down: Unable to Perform a Partial Void on Industry Type: [RE]. Fix
19717 Invalid Recurring Indicator []. Supported values are [RF] or [RS] Fix
19719 [%s] has Invalid value[%s], allowed values are [%s] Fix
19720 Either mcSecureCodeAAV or useStoredAAVInd [but not both] must be present Fix
19722 Industry type must be one of [%s] for Card Brand [%s] Fix
19723 Managed Billing type must be [%s] for Account Type [%s] Fix
19724 Static AAV must be on file for merchantID [%s] when Managed Billing type is [%s] and Account Fix
Type is [%s]
19725 Invalid EUDD Country Code: [%s] for Currency: [%s], Valid values are: [%s] Fix
19726 Invalid Transaction Type: Transaction Type must be [%s] for ECP Action Code: [%s] Fix
19729 Invalid ECP Auth Method for ECP Action Code Fix
19731 Invalid ECP Auth Method for ECP Delivery Method Fix
19734 Check Serial Number cannot be greater than [%s] bytes for BIN [%s] Fix
19735 Invalid ECP Delivery Method for ECP Back Acct Type Fix
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 329
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
19745 Fraud Analysis: Unable to perform Fraud Analysis. The associated transaction failed Call
19755 Error validating card/account number for signature debit eligibility Fix
19756 Error bad card signature debit indicator [%s] for [%s] Fix
19758 Invalid DPAN Indicator Value. Valid values are [%s]. Fix
19760 Cryptogram Not Expected When DPAN Indicator Value is [%s]. Fix
19762 AEVV Expected Only When DPAN Indicator Value is [%s]. Fix
19763 CAVV Expected When DPAN Indicator Value is [%s] And Industry Type is [%s]. Fix
19764 DPAN Indicator [%s] Not Expected When Industry Type is [%s]. Fix
19766 Recurring Indicator Expected When Industry Type is [%s] And DPAN Indicator Fix
Value is [%s].
19767 P2P Encryption Invalid, Both Encryption Method and Encryption ID should be Null or Fix
Not Null.
19768 Invalid Purchasing Card Level 2 Data - Canadian Merchants only [%s]. Fix
19771 PURCHCRD: Invalid Data Type, Field[%s], value[%s], Expected [%s]. Fix
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 330
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
19775 EWS: Invalid Amount cannot be $[%s], for Transaction Type [%s], and Action Code [%s]. Fix
19777 EWS: Check Serial Number is expected when ecpAuthMethod is [%s] Fix
19778 EWS: Check Serial Number is not expected when ecpAuthMethod is [%s] Fix
19779 EWS: ID type and number is optional or both must be present Fix
19780 EWS: Phone ID type and number is optional or both must be present Fix
19781 EWS: [%s] is a Invalid Phone Id type Fix
19782 EWS: [%s] is a Invalid Id type Fix
19783 EWS: Invalid birth date format. Must be in yyyymmdd Fix
19784 EWS: Invalid Action Code [%s], For Transaction Type [%s]. Fix
19786 ECP: Redemption Redeposit Frequency and Redemption Redeposit Indicator Both Fix
Must Be Present.
9549 Profile: Cannot %s profile for Cust Ref Num: [%s] and MID: [%s]. Profile is not active. Fix
9550 Profile: Invalid Cust Ref Num from Order Indicator. Fix
9551 Profile: Invalid Cust Ref Num. The field is missing, invalid, or it has exceeded the Fix
max length of [%s].
9552 Profile: System Failure. Unable To Perform Customer Profile Request at This Time. Call
9553 Profile: Invalid Action Indicator: [%s]. Must be one of the following values: [%s]. Fix
9555 Profile: Invalid BIN: [%s]. The field is missing, invalid, or it has exceeded the max Fix
length of: [%s].
9556 Profile: Invalid Merchant ID: [%s]. The field is missing, invalid, or it has exceeded Fix
the max length of: [%s].
9557 Profile: Invalid Name: [%s]. The field is missing, invalid, or it has exceeded the Fix
max length of: [%s].
9558 Profile: Invalid Address: [%s]. The field is missing, invalid, or it has exceeded the Fix
max length of: [%s].
9559 Profile: Invalid Address 2: [%s]. The field is missing, invalid, or it has exceeded the Fix
max length of: [%s].
9560 Profile: Invalid City: [%s]. The field is missing, invalid, or it has exceeded the max Fix
length of: [%s].
9561 Profile: Invalid State: [%s]. The field is missing, invalid, or it has exceeded the max Fix
length of: [%s].
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 331
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
9562 Profile: Invalid ZIP: [%s]. The field is missing, invalid, or it has exceeded the max Fix
length of: [%s].
9563 Profile: Invalid Email: [%s]. The field is missing, invalid, or it has exceeded the max length of: Fix
[%s].
9564 Profile: Invalid Phone: [%s]. The field is missing, invalid, or it has exceeded the max length of: Fix
[%s].
9565 Profile: Invalid Order Description: [%s]. The field is missing, invalid, or it has exceeded the max Fix
length of: [%s].
9566 Profile: Invalid Amount: [%s]. The field is missing, invalid, or it has exceeded the max length of: Fix
[%s].
9567 Profile: Invalid Account Type Indicator: [%s]. Must be one of the following values: [%s] Fix
9568 Profile: Invalid Account Number: [%s]. The field is missing, invalid, or it has exceeded the max Fix
length of: [%s].
9569 Profile: Invalid Account Expire Date: [%s]. The field is missing, not formatted properly, or it has Fix
exceeded the max length of: [%s].
9570 Profile: Invalid ECP Account DDA: [%s]. The field is missing or it has exceeded the max length Fix
of: [%s].
9571 Profile: Invalid ECP Account Type Indicator: [%s]. Must be one of the following values: [%s] Fix
9572 Profile: Invalid ECP Account Route: [%s]. The field is missing, invalid, or it has exceeded the Fix
max length of: [%s].
9573 Profile: Invalid ECP Bank Payment Delivery Method: [%s]. Must be one of the following values: Fix
[%s]
9574 Profile: Invalid Switch Solo Start Date: [%s]. The field is missing, invalid, or it has exceeded the Fix
max length of: [%s].
9575 Profile: Invalid Switch Solo Issue Number: [%s]. The field is missing, invalid, or it has exceeded Fix
the max length of: [%s].
9576 Profile: Unable to Perform Profile Transaction. The Associated Transaction Failed. Call
9577 Profile: Invalid Order Override Indicator: [%s]. Must be one of the following values: Fix
[%s].
9578 Profile: Merchant-Bin [%s]:[%s] is not allowed to perform profile transactions. Call
9580 Profile: Cannot %s profile for Cust Ref Num: [%s] and MID: [%s]. A database error has Call
occurred.
9581 Profile: Cannot %s profile. Profile does not exist for Cust Ref Num: [%s] and MID: [%s]. Fix
9582 Profile: Cannot %s profile. Profile already exists for Cust Ref Num: [%s] and MID: [%s]. %s Fix
9583 Profile: Missing Switch Solo Account Information. Either a start date or issue number must be Fix
valid.
9586 Profile: Profile request was detected but has an action type of [I] (Ignore). Call
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 332
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
9587 Profile: Auto Generation of Cust Ref Num Error: Indicator: [%s] : Cust Ref Num Call
[%s] invalid when derived from [%s]. The field is missing, invalid, or has exceeded
max length of [%s]
9588 Profile: Unable to Determine "On-the-fly" Profile Action: Cust Ref From Profile Ind: [%s] and Fix
Cust Ref Num is [%s]. One of the values must be valid.
9591 Profile: Profile Merging Mismatch Error: Stored Profile Account Type of: [%s] Does not Match Fix
Incoming Account Type of
9593 Profile: Invalid Country Code [%s]. Supported values are [CA], [GB], [UK], or [US] Fix
9594 Profile status is currently [%s]. Only refunds are available while the profile is in this status. Fix
9595 Account Updater: Invalid: [%s]. The field is missing, invalid, or it has exceeded the Fix
max length of [%s]. Format [%s].
9596 Account Updater: Schedule Date – The Future Schedule Date Is In The Past Fix
9598 Invalid Profile Fetch: Either Cust Ref Num or CC Account Num [but not both] must Fix
be present.
9599 Method of Payment [%s] is not supported for custom profile ID generation Call
9600 Invalid value for Account Updater Eligibility [%s]. Must be Y or N Fix
9602 Profile: Invalid Profile Fetch: Either CC Account Num or EUDD IBAN [but not both] must be Fix
present.
9604 Profile: Account Updater request not allowed for CDPT profiles. Fix
9605 Profile: Managed Billing request not allowed for CDPT profiles. Fix
19723 Managed Billing type must be [%s] for Account Type [%s] Fix
19724 Static AAV must be on file for merchantID [%s] when Managed Billing type is [%s] Fix
and Account Type is [%s]
Retry Errors
9711 Too many waiting for transaction to complete Wait & Resend
9713 Invalid MIME header - Merchant ID in MIME does not match XML message Fix
9714 Invalid retry trace number received. Trace number must be between 1 and Fix
9999999999999999
9715 The retry request did not match the original request for this trace number Fix
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 333
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
9850 Managed Billing features are not supported for Bill Me Later or Pinless Debit transaction Fix
types
9851 Merchant account is not configured to use Managed Billing features Call
9852 Profile level for merchant account is set to ‘chain-level.’ In order to use Managed Billing, Call
the profile level must be set to ‘merchant-level’
9855 Managed Billing: Dollar Value for a Micro Payment can not be less then $1 - [%s]. Fix
9856 Managed Billing: Micro Payment Transaction Dollar Amount for Tandem Must Be Numeric And Has Fix
Max Value Of [99999999] - [%s].
9857 Managed Billing: Micro Payment Transaction Dollar Amount for Salem Must Be Numeric And Has Fix
Max Value Of [999999999999] - [%s].
9858 Managed Billing: Max Micro Payment Billing Days is [1 - 30] - [%s]. Fix
9859 Managed Billing: Max Micro Payment Transactions Before Acquiring Funds is [1 - 99] - [%s]. Fix
9860 Managed Billing: MIcro Payment Profiles Require At Least One Trigger Method [Max Dollar Amount, Fix
Max Billing Days, Max Transactions].
9861 Deferred Billing Date must be a valid date (at least 1 day in the future – and at most Fix
365 days in the future)
9862 Recurring Start Date must be a valid date at least 1 day in the future Fix
9863 Only one Recurring End Date Trigger can be selected Fix
9864 Invalid Recurring No End Date flag. Must be ‘Y’ or ‘N’. Fix
9866 Recurring End Date must be a valid date at least 1 day greater than Recurring Start Fix
Date
9869 Industry Type of ‘IN’ can only be used when merchant is configured for a Managed Fix
Billing type of Recurring
9870 Order ID Generation Method must be Dynamic [DI] For Micro Payments. Fix
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 334
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
9871 Missing Default Managed Billing values. All values must be set in transaction payload Fix
9872 The Industry Type [IN] Is Only Valid For Managed Billing Transactions. Fix
9877 Send in future payment cancel requests "after" updating profile. Fix
9880 Start Date and End Date range is too small for selected recurring frequency (there are Fix
no possible future billings)
9882 User does not have proper privileges to set-up a Managed Billing profile Call
9883 Industry type of Recurring is not allowed to be set-up as Deferred Managed Billing type Fix
9884 Error occurred while searching for transaction related to retry trace ID Call
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 335
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
9552 System Failure. Unable To Perform Customer Profile Request at This Time. Error Call
9576 Unable to Perform Profile Transaction. The Associated Transaction Failed. Error Call
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 336
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
9550 Invalid Customer Reference Number From Order Indicator Error Fix
9552 System Failure. Unable To Perform Customer Profile Request at This Time. Error Call
9576 Unable to Perform Profile Transaction. The Associated Transaction Failed. Error Call
9578 Merchant-Bin combination is not allowed to perform profile transactions. Error Call
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 337
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
9580 Cannot process profile for Cust Ref Num and MID combination. A database Error Call
error has occurred
9581 Cannot process profile. Profile does not exist for Cust Ref Num and MID. Error Fix
9582 Cannot process profile. Profile already exists for Cust Ref Num and MID. Error Fix
9583 Missing Switch Solo Account Information. Either start date or issue number Error Fix
is required.
9588 Unable to Determine Profile Action from Auth Request Error Fix
9589 Cannot Create Profile: A Customer Profile Name is Required Error Fix
9595 Schedule Date – The Future Schedule Date Is Invalid Error Fix
9596 Schedule Date – The Future Schedule Date Is In The Past Error Fix
19725 Invalid EUDD Country Code: [] for Currency: [], Valid values are: [] Error Fix
19793 MIT: Invalid MIT message type [MIT Code passed in Request][ Only CSTO, Error Fix
CGEN, CREC, CINS, MUSE, MREC, MINS are allowed while using NON MIT
Profile] (for VISA)
Invalid MIT message type [MIT Code passed in Request][Only CGEN, CREC
and MREC are allowed while using NON MIT Profile]. (for Discover)
19810 MIT: Transaction id is mandatory in order to create MIT Profile Error Fix
19814 MIT Profile contains invalid MIT Message Type [MIT CODE STORED IN PROFILE]. Error Fix
Only [CSTO, CGEN, CREC and CINS] are allowed (for VISA)
MIT Profile contains invalid MIT Message Type [MIT CODE STORED IN PROFILE].
Only [CGEN, CREC] are allowed (for Discover)
19814 New MIT Profile cannot be added while using an existing MIT Profile [Profile ID Sent Error Fix
in the request].
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 338
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Code Description
M CVV Match
P Not processed
I Invalid
Y Invalid
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 339
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 340
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 341
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 342
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
LBR LIBERIA
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 343
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 344
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 345
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 346
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 347
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 348
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Tax Indicator M M Visa does not allow level 2 transactions to be tax exempt
Tax Amount M M This may not be zero to qualify as level 2. Acceptable thresholds
vary by card type.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 349
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Duty Amount M M N/A Highlights the amount of the purchase which is for duty.
Ship From ZIP M M N/A Allows for 5 digit, 9 digit, or Canadian zip
Destination Country C C N/A This defaults to USA if not submitted. See Table 24 ISO
Code country codes for further reference
Discount Amount M N/A N/A Visa only: A listing of any discount given to the order as a
whole, as opposed to a discount on a particular line item.
VAT Tax Amount O N/A N/A Value Add Tax or other Tax Amount included in total sale
VAT Tax Rate O N/A N/A Value Add Tax or other Tax Rate included in total sale
Alternate Tax N/A O N/A Equivalent to VAT Tax Amount for MasterCard
Amount
Alternate Tax Rate N/A O N/A Equivalent to VAT Tax Rate for MasterCard
Line Item Data M M M A transaction must include 1-98 line items to qualify. Each
data element below is submitted once per line item for all line
items.
Detail Index M M M The line item number.
“This is line item __ of [Total # of Line items”
Detail Description M M M An alphanumeric description of the Line Item.
26 characters for Visa, 35 for MasterCard
Description defined by the merchant. Cannot be all
spaces or zeros in order to qualify for the interchange
adjustment.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 350
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Detail Tax Rate M M M Lists the tax rate applied to this transaction.
5 digits, with 3 implied decimal places
- Example: Submit 14287, which means 14.287%
The hundredths place is truncated off for Visa
12345 is truncated to mean 12.34%
Detail Line Total M M M Generally this is Price * Quantity.
Detail Discount O O N/A The discount applied, if any, to this specific line item.
Detail Commodity M N/A M Accepted values of this field are defined by Visa.
Code
Detail Unit Cost M C M 4 implied decimals
Mastercard: Required for the UK if transaction exceeds
a minimum threshold
NOTE: Discover Card Unit Cost is 2 decimal implied
Detail Gross Net M M N/A Indicates if Tax is included in this line item. Must be Y or N.
Detail Discount N/A M N/A Indicates if a discount was applied. Defaults to N if Discount
Indicator Amount is empty.
Detail Debit O O N/A This field is only used by PNS only.
Indicator
Detail Discount Rate N/A N/a M Discover only. 4 implied decimals.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 351
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Duty Amount M M Highlights the amount of the purchase which is for duty.
Destination Country C C This defaults to USA if not submitted. See ISO Country Codes for
Code further reference
Discount Amount M N/A Visa only: A listing of any discount given to the order as a whole,
as opposed to a discount on a particular line item.
VAT Tax Amount O N/A Value Add Tax or other Tax Amount included in total sale
VAT Tax Rate O N/A Value Add Tax or other Tax Rate included in total sale
Line Item Data M M A transaction must include 1-98 line items to qualify. Each
applicable data element below is submitted once per line item for
all line items.
Detail Index M M The line item number.
“This is line item __ of [Total # of Line items”
Detail Description M M An alphanumeric description of the Line Item.
35 characters for both Visa and MasterCard
All letters must be in CAPS
Detail Product Code M M These values are defined by the Card Issuer.
Detail Discount O O The discount applied, if any, to this specific line item.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 352
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 353
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
The short form request is listed below as FS1. The long form request is listed as FS2.
Legend: M – Mandatory
C - Conditional (See accompanying notes)
O – Opitional
N/A – Not Applicable: Tag will be null filled or left out of the message
Table Safetech Request Element Information
Data Type FS1 FS2 Notes
FraudAnalysis M M Parent element of Fraud Analysis elements. Must be present
to submit a request to the Safetech Service
FraudScoreIndicator M M Used to indicate if the request falls under the short (FS1) or
long (FS2) forms
RulesTrigger O O Used to prompt the Safetech service to return all of the rules
enabled in the Safetech Web Console which the transaction
triggered
SafetechMerchantID M M A static value issued to a merchant as part of the setup
process. Can be defaulted through the Virtual Terminal
KaptchaSessionID O O A unique session ID for the Safetech service.
WebsiteShortName O O This can be defaulted as part of the setup process.
CustomerID N/A O This value is merchant-generated and does not have to imply
a tokenized customer profile.
CustomerIDCreationTime N/A O A unix timestamp for the previous element.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 354
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Legend: M – Mandatory
C- Conditional (See accompanying notes)
O – Opitional
N/A – Not Applicable: Tag will be null filled or left out of the message
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 355
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
NumberOfDevices N/A O This element and the two following elements are additional
customer information collected by the Safetech service as
part of scoring the transaction
NumberOfCards N/A O
NumberOfEmails N/A O
CustomerTimeZone N/A O This element and the following element are used to identify
the local time of the customer.
CustomerLocalDateTime N/A O
DeviceRegion N/A O This element and the twelve following elements are all
technology information about the customer, as identified by
the Safetech fraud tools.
DeviceCountry N/A O
ProxyStatus N/A O
JavascriptStatus N/A O
FlashStatus N/A O
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 356
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
BrowserCountry N/A O
BrowserLanguage N/A O
MobileDeviceIndicator N/A O
MobileDeviceType N/A O
MobileWirelessIndicator N/A O
VoiceDevice N/A O
PCRemoteIndicator N/A O
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 357
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 358
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 359
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
004 Invalid ACTION code not supported. Missing Product Record Request
012 Other
For Country codes used in Level 3 data, please refer to Error! Reference source not found. Codes.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 360
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 361
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 362
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
For Country codes used in Level 3 Data, please refer to Level 3 Data - Codes.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 363
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
020 Enhanced OD
021 Enhanced OD
022 Enhanced OD
080 Credit Card Check
081 Participant Line of Credit Check
082 Participant Home Equity Check
084 Participant Broker Check
096 No Known Information
098 Non-DDA
099 Present
102 Savings Closed for Cause
103 Savings Closed for Cause/ Purged
106 Savings Stop Payment ¾ Individual
107 Savings Stop Payment ¾ Range
110 Savings Post No Debits
112 Savings Closed
113 Savings Closed/Purged
114 Savings Pending Closed
199 Savings Present
430-499 High Probability of Return
699 Open Valid
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 364
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Code Description
blank CAVV Not Present or CAVV not verified, issuer has not selected CAVV verification option
0 CAVV could not be verified or CAVV data was not provided when expected
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 365
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
403 Forbidden: SSL A Clear Text (or unencrypted) request was made to the Orbital Gateway. All
Connection Required transactions must be SSL Encrypted to interface to Orbital.
408 Request Timed Out The Response could not be processed within the maximum time allowed.
412 IP Security Failure A non-registered IP Address attempted to connect to the Orbital Gateway. The
HTTP connection was refused as a result.
500 Internal Server Error The server encountered an unexpected condition, which prevented it from fulfilling
the request.
502 Connection Error The server, while acting as a gateway or proxy, received an invalid response from
the upstream server it accessed in attempting to fulfill the request.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 366
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 367
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 368
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 369
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 370
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 371
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Bill Me Later 16
Carte Blanche 14
Diners Club 14
Discover (Novus) 16
JCB 16
MasterCard 16
Visa/Delta 13 or 16
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 372
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 373
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
http://www.activexperts.com/support/activmonitor/online/ii6metabase/
12.1.9 Will the SDK Operate on Windows 95 or 98
The SDK has not been certified on Windows 95 or 98.
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 374
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 375
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 376
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
30-Sept-2010 6.5.0 Updated to add support for Partial Auth’s Scott Ring
15-August-2011 6.6.0 Updated to include PTI51-53. Jennifer Prasaud
Added support for:
Account Updater Eligibility flag,
International Maestro,
EUDD Customer Profiles
ECP for Bin 000002
Extended ECP Action Codes and New
ECP Auth Methods
03-November-2011 6.7.0 Added support for Safetech Fraud Lori Dawidowicz
10-July-2012 6.8.0 Removed support for UK Domestic Lori Dawidowicz
Maestro
10-July-2012 6.8.0 Added support for Purchasing Cards to Lori Dawidowicz
reflect Commercial Card Support.
Reference Level 2 and Level 3 data
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 377
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
SUNSET:
- Support for Windows XP, Vista,
and MS Server 2003 is limited as
these technologies are no longer a
part of the validation processes
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 378
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
UPDATED:
- Characters allowed note in the
AVSaddress1, AVSaddress2,
AVScity, AVSDestaddress1,
AVSDestaddress2 and
AVSDestcity elements for the New
Order and Safetech Fraud
Analysis Request Transaction
Types.
- Security Level Indicator code note
for identifying MasterPass
transactions using the DWSLI
element of New Order Request
Transaction Type
01.19.2016 7.4.3 IMPORTANT PACKAGING AND Dave P
INSTALLATION NOTE:
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 379
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 380
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
UPDATED:
- DigitalTokenCryptogram field
name
- NewOrder element sequence to
match XML DTD PTI68
07.17.2017 7.4.6 IMPORTANT PACKAGING AND Dave P
INSTALLATION NOTE:
- Orbital SDK Version 7.4.6 is
comprised of two components,
SDK Version 7.4.0 and “Template
Library Update” Version 7.4.6.
Both must be installed to take
advantage of processing features.
The XML DTD supported for this
release is PTI71
Note: “Template Library Update”
Version 7.4.6 includes all of the
processing features introduced in
“Template Library Update” Version
7.4.1, 7.4.2, 7.4.3, 7.4.4, and 7.4.5
ADDED:
- NewOrder elements to support
Electronic Check Same Day
Processing and Electronic Check
Smart Re-deposit
UPDATED:
- Electronic Check Same Day
Processing and Electronic Check
Smart Re-deposit
10.16.2016 7.4.5 IMPORTANT PACKAGING AND Dave P
INSTALLATION NOTE:
- Orbital SDK Version 7.4.5 is
comprised of two components,
SDK Version 7.4.0 and “Template
Library Update” Version 7.4.5.
Both must be installed to take
advantage of processing features.
The XML DTD supported for this
release is PTI70
Note: “Template Library Update”
Version 7.4.5 includes all of the
processing features introduced in
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 381
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 382
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
UPDATED:
None
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 383
Chase Orbital Gateway Version: 7.4.8
COM and .NET SDK Developer’s Guide Date: 05.20.2018
Chase Orbital Gateway COM and .NET SDK Developer’s Guide 384