Connecting to PaymentTrust's Secure Transaction Network - WorldPay

Connecting to PaymentTrust’s 

Secure Transaction Network 

Developer’s Guide 

Issued by: IT Department 

Issue date: December 2007 

Document Version – 08.24.25

Table Of Contents 

1 Who should read this document............................................................................................... 8 

2 Terminology ................................................................................................................................ 8 

3 Introduction................................................................................................................................. 9 

4 STLink overview ....................................................................................................................... 10 

5 Network Requirements ............................................................................................................ 12 

6 Transaction Specifications...................................................................................................... 13 

6.1 Transaction Types .........................................................................................................................13 

6.2 Request Type Specifications and Responses ................................................................................15 

RiskGuardian Request (RG)...........................................................................................................16 

STLink will return the following Response for a RiskGuardian Request (RG).............................21 

RiskGuardian Request (RG) with RequestType = R for Reprocessing .........................................23 

STLink will return the following Response for a RiskGuardian Request (RG) with 

RequestType = R ...........................................................................................................................24 

DataShare: ......................................................................................................................................26 

STLink will return the following Response for a DataSharing Request (DS) ...............................37 

DataShare PayBack with Electronic Credit Request (DS)(P) ........................................................38 

STLink will return the following items for a DataShare PayBack with Electronic 

Credit Request (DS)(P)...................................................................................................................47 

PaymentTrust Requests.......................................................................................................................48 

PaymentTrust Authorization Request (PT)(A)...............................................................................48 

STLink will return the following items for a PaymentTrust Authorization Request 

(PT)(A) ...........................................................................................................................................56 

PaymentTrust Forced Authorization Request (PT)(A)...................................................................58 

STLink will return the following items for a PaymentTrust Forced Authorization 

Request (PT)(A) .............................................................................................................................66 

PaymentTrust Deposit (Settlement) Request (PT)(D)....................................................................67 

STLink will return the following items for a PaymentTrust Deposit (Settlement) 

Request (PT)(D) .............................................................................................................................69 

PaymentTrust Refund Request (PT)(R) .........................................................................................70 

STLink will return the following items for a PaymentTrust Refund Request (PT)(R)..................71 

PaymentTrust Forced Refund Request (PT)(R) .............................................................................73 

STLink will return the following items for a PaymentTrust Forced Refund Request 

(PT)(R) ...........................................................................................................................................75 

PaymentTrust Finalize Request (PT)(F).........................................................................................76 

STLink will return the following items for a PaymentTrust Finalize Request 

(PT)(F)............................................................................................................................................77 

PaymentTrust Simultaneous Authorization and Settlement (Sale) Request (PT)(S) .....................78 

2

3 

STLink will return the following items for a PaymentTrust Simultaneous ...................................84 

PaymentTrust Simultaneous Forced Authorization and Settlement (Sale) Request 

(PT)(S)............................................................................................................................................85 

STLink will return the following items for a PaymentTrust Simultaneous ...................................93 

PaymentTrust Cancellation Request (PT)(C).................................................................................94 

STLink will return the following items for a PaymentTrust Cancellation Request 

(PT)(C) ...........................................................................................................................................95 

PaymentTrust PayBack to Credit Card Request (PT)(P) ...............................................................96 

STLink will return the following items for a PaymentTrust PayBack to Credit Card 

Request (PT)(P)............................................................................................................................100 

PaymentTrust PayBack with Cheque Request (PT)(P)................................................................101 

STLink will return the following items for a PaymentTrust PayBack with Cheque 

Request (PT)(P)............................................................................................................................103 

PaymentTrust PayBack with Electronic Credit Request (PT)(P).................................................104 

STLink will return the following items for a PaymentTrust PayBack with 

Electronic Credit Request (PT)(P)................................................................................................107 

PaymentTrust Bank Transfer ID (BTS) Request (PT)(B)............................................................108 

STLink will return the following items for a PaymentTrust Bank Transfer ID 

Request (PT)(B)............................................................................................................................109 

PaymentTrust Deposit (Settlement) Request (PT)(D) for PURCHASING CARDS 

(VISA, AMEX, MASTER CARD)..............................................................................................110 

STLink will return the following items for a PaymentTrust Deposit (Settlement) 

Request (PT)(D) for PURCHASING CARDS.............................................................................116 

PaymentTrust Simultaneous Authorization and Settlement (Sale) Request (PT)(S) 

for PURCHASING CARDS (VISA, AMEX, MASTER CARD) ...............................................117 

STLink will return the following items for a PaymentTrust Simultaneous 

Authorization and Settlement (Sale) Request (PT)(S) for PURCHASING CARDS...................123 

PaymentTrust Refund Request (PT)(R) for PURCHASING CARDS (VISA, 

AMEX, MASTER CARD)...........................................................................................................125 

STLink will return the following items for a PaymentTrust Refund Request (PT)(R) 

for PURCHASING CARDS.........................................................................................................132 

3D Secure Requests...........................................................................................................................133 

3D Secure Verify Enrollment Request (3D)(V)...........................................................................133 

STLink will return the following items for a 3D Secure Verify Enrollment Request 

(3D)(V).........................................................................................................................................134 

3D Secure Authenticate Request (3D)(A)....................................................................................135 

STLink will return the following items for a 3D Secure Authenticate Request 

(3D)(A).........................................................................................................................................137 

Foreign Exchange Requests ..............................................................................................................139 

Foreign Exchange Rate Request (FX)(X) ....................................................................................139 

STLink will return the following items for a Foreign Exchange Rate Request 

(FX)(X).........................................................................................................................................141 

Foreign Exchange Placement Request (FX)(D)...........................................................................142 

STLink will return the following items for a Foreign Exchange Placement Request 

(FX)(D).........................................................................................................................................143 

Foreign Exchange Refund Request (FX)(R) ................................................................................144

4 

STLink will return the following items for a Foreign Exchange Refund Request 

(FX)(R).........................................................................................................................................145 

Foreign Exchange Cancellation Request (FX)(C)........................................................................146 

STLink will return the following items for a Foreign Exchange Cancel Request 

(FX)(C).........................................................................................................................................147 

BIN System Request .........................................................................................................................148 

BIN System Request (BN) (Also known as Issuer Identification Number).................................148 

STLink will return the following items for a BIN Request (BN).................................................149 

IP Geo Positioning Request ..............................................................................................................150 

IP Geo Positioning Request (GP).................................................................................................150 

STLink will return the following items for an IP Geo Positioning Request (GP) .......................150 

Identify Me System Request .............................................................................................................152 

Identify Me System Request (IM)................................................................................................152 

STLink will return the following items for an Identify Me Request (IM) ...................................162 

Supplementary Requests ...................................................................................................................167 

Supplementary RG(Q) Request....................................................................................................167 

STLink will return the following Response for a Risk Guardian Query Request (Q) .................168 

Supplementary DS(Q) Request ....................................................................................................170 

STLink will return the following Response for a Data Share Query Request (Q).......................171 

Supplementary (Q) Request for PaymentTrust (PT) communication failures. ............................172 

STLink will return the following items for a Query Request (Q) on PaymentTrust 

(PT) network communication failures..........................................................................................173 

Supplementary (Q) Request for Batch Submissions ....................................................................175 

STLink will return the following items for a Query Request (Q) on a PaymentTrust 

(PT) batch .....................................................................................................................................176 

Supplementary FX(Q) Request for pending transactions.............................................................178 

STLink will return the following items for a Query Request (Q) on Foreign 

Exchange ......................................................................................................................................179 

Supplementary BN(Q) Request....................................................................................................180 

STLink will return the following Response for a BIN Query Request (Q)..................................180 

Supplementary GP(Q) Request ....................................................................................................182 

STLink will return the following Response for an IP Geo Positioning (GP) Query 

Request (Q)...................................................................................................................................182 

Supplementary IM(Q) Request.....................................................................................................184 

STLink will return the following Response for an Identify Me (IM) Query Request 

(Q).................................................................................................................................................184 

6.3 XML Definitions.........................................................................................................................189 

RiskGuardian Request (RG).........................................................................................................189 

RiskGuardian Request (RG) with RequestType = R for Reprocessing .......................................191 

DataShare: ....................................................................................................................................192 

Data Sharing PayBack with Electronic Credit Request (DS)(P)..................................................195 

PaymentTrust Authorization Request (PT)(A).............................................................................198 

PaymentTrust Forced Authorization Request (PT)(A).................................................................199 

PaymentTrust Deposit (Settlement) Request (PT)(D)..................................................................201 

PaymentTrust Refund Request (PT)(R) .......................................................................................202 

PaymentTrust Forced Refund Request (PT)(R) ...........................................................................202 

PaymentTrust Simultaneous Authorization and Settlement (Sale) Request (PT)(S) ...................203

5 

PaymentTrust Simultaneous Forced Authorization and Settlement (Sale) Request 

(PT)(S)..........................................................................................................................................204 

PaymentTrust Cancellation Request (PT)(C)...............................................................................205 

PaymentTrust PayBack with Credit Card Request (PT)(P) .........................................................206 

PaymentTrust PayBack with Cheque Request (PT)(P)................................................................207 

PaymentTrust PayBack with Electronic Credit Request (PT)(P).................................................208 

PaymentTrust Bank Transfer ID Request (PT)(B).......................................................................209 

PaymentTrust Deposit (Settlement) Request (PT)(D) for PURCHASING CARDS 

(VISA, AMEX, MASTER CARD)..............................................................................................210 

PaymentTrust Simultaneous Authorization and Settlement (Sale) request (PT)(S) 

for PURCHASING CARDS (VISA, AMEX, MASTER CARD) ...............................................212 

PaymentTrust Refund Request (PT)(R) for PURCHASING CARDS (VISA, 


Data Sharing Batch Request (DS) ................................................................................................216 

PaymentTrust Forced Authorization Batch Request (PT)(A) ......................................................219 

PaymentTrust Deposit (Settlement) Batch Request (PT)(D) .......................................................221 

PaymentTrust Refund Batch Request (PT)(R).............................................................................222 

PaymentTrust Forced Refund Batch Request (PT)(R).................................................................223 

PaymentTrust Simultaneous Authorization and Settlement (Sale) Batch Request 

(PT)(S)..........................................................................................................................................224 

PaymentTrust Simultaneous Forced Authorization and Settlement (Sale) Batch 

Request (PT)(S)............................................................................................................................226 

PaymentTrust Cancellation Batch Request (PT)(C).....................................................................228 

PaymentTrust PayBack with Credit Card Batch Request (PT)(P) ...............................................229 

PaymentTrust PayBack with Cheque Batch Request (PT)(P)......................................................230 

PaymentTrust PayBack with Electronic Credit Batch Request (PT)(P) ......................................231 

PaymentTrust Bank Transfer ID Batch Request (PT)(B).............................................................232 

PaymentTrust Deposit (Settlement) Batch Request (PT)(D) for PURCHASING 

CARDS (VISA, AMEX, MASTER CARD)................................................................................233 

PaymentTrust Simultaneous Authorization and Settlement (Sale) Batch Request 

(PT)(S) for PURCHASING CARDS (VISA, AMEX, MASTER CARD) ..................................235 

PaymentTrust Refund Batch Request (PT)(R) for PURCHASING CARDS (VISA, 


3D Secure Verify Enrollment Request (3D)(V)...........................................................................239 

3D Secure Authenticate Request (3D)(A)....................................................................................239 

Foreign Exchange Rate Request (FX)(X) ....................................................................................240 

Foreign Exchange Placement Request (FX)(D)...........................................................................240 

Foreign Exchange Refund Request (FX)(R) ................................................................................241 

Foreign Exchange Cancellation Request (FX)(C)........................................................................241 

BIN System Request (BN) (Also known as Issuer Identification Number).................................242 

IP Geo Positioning Request (GP).................................................................................................242 

Identify Me Request (IM).............................................................................................................243 

RiskGuardian (RG) Supplementary (Q) Request.........................................................................245 

DataShare (DS) Supplementary (Q) Request...............................................................................246 

PaymentTrust (PT) Supplementary (Q) Request for communication failures. ............................247 

PaymentTrust (PT) Supplementary (Q) Request for Batch Submissions ....................................248 

Foreign Exchange Supplementary (Q) Request ...........................................................................249

BIN (BN) Supplementary (Q) Request ........................................................................................250 

IP Geo Positioning (GP) Supplementary (Q) Request .................................................................250 

Identify Me (IM) Supplementary (Q) Request.............................................................................250 

DataShare: Historical Data Loading.............................................................................................251 

HDL Header .................................................................................................................................251 

HDL Record Event.......................................................................................................................251 

7 DEVELOPMENT ...................................................................................................................... 263 

8 Appendices ............................................................................................................................. 278 

6

© 2000-2006 PaymentTrust Ltd. All rights reserved. 

PaymentTrust Developer’s Guide 

Version 08.24.25 


Document Control: 

Author: IT Department 

This document is protected by the copyright laws and treaties and may not be reproduced, stored in 

a retrieval system or transmitted in any form or by any means (photocopying, recording, or 

otherwise) without permission from PaymentTrust Ltd., Royal Bank of Scotland. 

RiskGuardian TM , PaymentTrust TM, and the PaymentTrust Ltd. logo are 

trademarks or service marks of Royal Bank of Scotland. All other marks 

listed in this document may be trademarks of their respective owners and 

are mentioned for identification purposes only. 

PaymentTrust Canada 

9900 Cavendish Blvd, Suite 206 

Canada H4M 2V2 

Phone +1 514.336.4949 

Fax +1 514.336.0239 

7

1 Who should read this document 

This document is designed for Developers/Integrators and System Administrators who are in 

charge of implementing a link into the Secure Transaction Network. 

8 

It also represents an information guide for Project Managers and IT Management personnel 

who want more detailed information on the functionality of Secure Transaction System. 

2 Terminology 

The following is a glossary of terms and abbreviations used in this document: 

Term or Abbreviation Definition 

STLink: Secure Transaction Link 

STN: Secure Transaction Network 

SSL: Secure Sockets Layer 

API: Application Program Interface 

ASP: Active Server Pages 

CGI: Common Gateway Interface 

VPN: Virtual Private Network 

RG -RM: RiskGuardian - Risk Management 

PT -PP: PaymentTrust - Payment Processing 

Includes PaymentTrust (PT), RiskGuardian (RG), Bins 

Transaction Services: (BN), Bank Transfer Service (BT) and others. 

Merchant : PaymentTrust Ltd. Client

3 Introduction 

The Secure Transaction Network (STN) is a collection of robust, multithreaded and real-time 

transaction systems (See Figure 1 below). STN is composed of the Secure Transaction Link 

(STLink) system and back-end Transaction Services. STLink receives transaction 

information from merchants, processes the information through one of the many transaction 

services, and sends the response back to the merchant’s requesting system. All Internet 

communication mentioned in this document is executed via an Internet 128 bit Secure 

Sockets Layer (SSL) connection, or an Internet Virtual Private Network (VPN) connection 

using the Triple DES standard. 

9 

VIA Internet 

HTTPS/XML 

SSL 128 bit 

FireWall 

HTTP/XML 

VPN Hardware 

Triple DES 

Secure Transaction Link System 

Serialization and Dispatch 

PaymentTrust RiskGuardian 

HTTP/HTTPS/XML 

Direct Link 

(On Demand) 

BIN request and 

other services

4 STLink overview 

Secure Transaction Link (STLink) is a high performance communication solution. 

10 

STLink is a service of on-demand secure communication links between the Secure 

Transaction Network (STN) and a PaymentTrust Ltd. Client (Merchant). STLink conforms to 

encryption and protocol standards as described below (See Figure 2 for network 

implementation). 

Transactions sent between a PaymentTrust Ltd. Merchant and the STN travel securely via a 

128-bit SSL Internet connection. The STLink system also allows for a hardware encryption 

method/solution using VPN technology & IPSEC standards. 

The Merchant’s own application will reside on his system and will be accessible via major 

web servers, Transaction platforms, and back-end systems. Merchants will be using 

PaymentTrust Ltd.’s technical specs as guidance to develop their own applications. 

PaymentTrust Ltd. provides Merchants example code in ASP/VB, C++, Java, HTML and 

XML. Merchants may choose to use their own samples and applications to send transaction 

information but must conform to the string requirements set in this document. 

Transaction Services 

STLink System 

Secure Transaction Network 

VPN 

SSL 

HTTP(s) 

Post/Get/XML 

VPN 

Merchants 

Merchants 

Merchants 

The STN is comprised of three layers. Descriptions of these layers can be found below in Figure 

3.

11 

Authentication 

Communication 

STlink within STN 

Security 

Network TCP/IP (Internet) 

Access 

SSL / VPN 

(Cryptography) 

* Platform Independent 

Fig. 3 Secure Transaction Services Network - Communication Protocol Layers 

NETWORK LAYER: This layer is handled exclusively by the designated Internet Service 

Provider. 

SECURITY LAYER: 

a) The Security Layer will be handled either by 128-bit SSL certificate or a secure 

tunnel Triple DES VPN conforming to the IPSEC standard. PaymentTrust Ltd. will 

provide at an additional cost the VPN hardware equipment if required. 

b) The Security Layer also includes the Merchant access layer into the Secure 

Transaction Network (STN). This involves the use of a Merchant ID, a Username 

and Password, which are sent as a string to STLink. 

STLINK APPLICATION: 

The Application Layer manipulates data using HTTP(S) GET/POST request or an XML 

request and communicates via standard ports 443 for SSL or port 80 for VPN. The system 

can intelligently process a request whether GET/POST or XML. The request (an input string) 

is routed with the STN to the appropriate service for processing – PT, RG, and others. The 

system returns the response to the requesting URL. Should the delivery fail, the system will 

capture the error, inform the merchant and store the information for later reporting. Captured 

errors are further analyzed. When the delivery is successful, the merchant receives a 

response and stamps each transaction with an appropriate message code. Please note that 

for larger strings sizes the GET method should not be used. 

The input string/message sent by the Merchant is stored in a serialized database with a 

unique serial number. PaymentTrust Ltd. maintains a log of any transaction requested by the 

Merchant and responds with a real-time message which will encapsulate information 

regarding: 

Integrity of the message sent by the Merchant – if a message is received truncated/ 

incomplete or in a tampered condition, the STLink application will capture the error and 

will respond with the appropriate error message to the merchant’s system;

12 

Authentication of sending and receiving agents (attributes that assure a given request is 

received from a specific trading partner) – messages between Merchant and 

PaymentTrust Ltd. must contain attributes that identify and recognize a specific 

Merchant; 

The Type of Transaction requested along with processing statistics. I.e. An RG 

transaction that took 2 seconds to process from IP NNN.NNN.NNN.NNN using SSL etc. 

It must be noted that the STLink system is Payload independent – data 

within the communication link is independent and can accommodate any 

type of Transaction, for example, an RG transaction with the same ease 

as a PT transaction. This eases the transition when new services become 

available. 

The STLink system is based on HTTP/1.1 as a transport protocol as well as XML 1.0. It uses 

generic protocols for communication between user agents and proxies/gateways and other 

Internet systems. Communication between a PaymentTrust Ltd. Merchant and a STN will be 

achieved through request messages and response messages. The STLink system 

implements and exploits the advantages provided by HTTP(S) and XML. 

5 Network Requirements 

The following is required prior to testing of the STN and STLink system by Merchants. 

Internet access or dedicated link into the Secure Transaction Network 

The originating external IPs if SSL is used, or the internal IP addresses of the computers 

that will participate in the VPN, as well as the external IP it will use. 

Name and phone number of the designated technician or administrator responsible for 

the integration process. 

Notification when the testing process is complete. 

Our Network Operations Team will at that point take over of the process. The Merchant will 

receive the following items from PaymentTrust Ltd.: 

VPN hardware if this is the solution chosen. 

SSL URL if SSL is chosen (High Encryption Pack).

6 Transaction Specifications 

6.1 Transaction Types 

For the purpose of this document we will focus on 3 transaction types through STLink and 

STN: PT for PaymentTrust and RG for RiskGuardian and BN for BIN System also known 

as Issuer Identification System. 

13 

RiskGuardian TM (RG): 

RiskGuardian is a secure risk management solution that allows merchants to securely 

manage the risk associated with doing business on the Internet. RiskGuardian provides a 

set of static risk factors, determined by PaymentTrust Ltd., and a set of customizable risk 

factors, which the merchant can alter to manage their risk on an individual basis.

14 

RG Features: 

Provides risk management and assessment for online transactions 

Total overhead is less than three seconds 

Merchant controlled parameters and values 

Online reporting and administration tools 

Export and Import capabilities for mass updates 

Focused on identity theft through Internet aware as well as traditional parameters 

Over 60 parameters and 300 algorithms and cross checks performed 

Data Sharing (DS) 

Marketing information to come… 

PaymentTrust TM (PT): 

PaymentTrust provides cost-effective, reliable and secure transaction processing solutions 

for online businesses. PaymentTrust enables Internet businesses to authorize, process and 

manage Credit Card, Debit Card, Electronic Cheque and Purchasing Card transactions in 

real-time, as well as Bank Transfers and Credit Card Payback. 

PaymentTrust offers merchants easy to use tools to effectively manage their online 

payment activities. Merchants can benefit from global business opportunities through the 

ability to process and deposit payments in multiple currencies. 

Once the customer clicks on the "buy" button, the merchant's storefront establishes a 

connection to the PaymentTrust system via STLink. PaymentTrust then establishes contact 

with the credit card processor and a credit card authorization is completed in real-time. The 

transaction is logged in the database for recovery. 

PT Transaction Types 

Authorization 

Cancel 

Settlement 

Sale 

Refund 

Finalize 

Payback 

Bank Transfer 

Query 

Foreign Exchange (FX): 

FXMicroPay allows you to trade foreign exchange in over 600 currency pairings via batch 

or real-time API access to the interbank market. The service assumes the risk of currency 

exposure market risk and can tailor rates to customer's specific requirements. Scalable to 

3,000 transactions per second and available 24/7, FXMicroPay offers wholesale execution 

efficiencies on even the smallest transactions. 

BIN System (BN): 

PaymentTrust Ltd.’s Bank Identification Number System provides, secure transaction 

processing in order for merchants to identify a card Issuer worldwide. The system accepts 

a Card number and responds to the merchant with the Card Type, Issuing Country Code 

and Issuing Bank. 

IP Geo Positioning System (GP): 

PaymentTrust Ltd.’s Internet Geo Positioning System provides, secure transaction 

processing in order for merchants to identify a consumer’s Geographic location by usage of 

their IP address. The system accepts an IP address or a DNS entry and responds to the 

merchant with the Country Code, Region, City and other details on that request.

15 

Supplementary (Q) Request: 

PaymentTrust Ltd. allows merchant’s to conduct queries in order to update their systems 

from batch transaction details they have submitted earlier. Once a batch is submitted for 

processing a merchant may wish to find the status of each transaction within a batch. At 

any later stage and at least 30 minutes after a batch has been submitted a merchant can 

issue a Q Transaction Type with a Batch ID and receive back an XML file which will detail 

each transaction and the result. The result of each transaction within the Q response 

would follow the same rules as if it were a single transaction. Please see the XML schemas 

in section 6.3 for more information. In the Case of Bank Transfers a BatchID is not needed 

but rather a request type. 

6.2 Request Type Specifications and Responses 

Each of the transaction types described in Section 6.1 has fields that must be sent for a 

proper response to be sent back to the merchant. There are mandatory as well as optional 

fields depending on Transaction Type. This section describes each of these fields and 

provides sample values for each. 

Every transaction request has an associated transaction response sent back to the 

merchant in real-time with the exception of the Batch processing part of the system. 

In Batch mode the system only sends back a BatchId that the file has been accepted and 

that it will be processed in accordance with the schedule. Batch submissions can only be 

sent via XML and will only work with PaymentTrust, D, R and P Request Types as well as 

with forced A and S and R and the BIN System requests. 

All transaction types are independent of each other and can be used separately.

RiskGuardian Request (RG) 

RiskGuardian is a secure Risk Management Solution that allows Merchants to securely manage and 

assess risk presented with financial card transactions. RiskGuardian provides a set of static risk factors 

based on PaymentTrust Ltd. control and a set of modifiable risk factors regulated by merchants in real 

time; allowing merchants to tailor the risk assessment to their industry specific needs. RiskGuardian’s 

latest feature allows for the inclusion of the AgeVerify and DataSharing Flag to be sent along side a 

normal RG string. By default a merchant is disabled for the Age Verification and Data Sharing thus the 

flag is always set to 0. However if the flag is set to one then a new set of verifications will take place 

that will result in an analysis of certain fields along with some new additional fields. 

Field Name Data Type Data Size Description 

M=Mandatory Fields 

O=Optional Fields 

StringIn= N/A N/A 

Must be at beginning of all strings. Capitals must 

be used as shown. 

Note: Not required for XML batch requests. 

M 

VersionUsed Alphanumeric 4 

Version Used specific to Transaction Type 

Example “4” for RG 

Permanent Merchant ID assigned by 

M 

MerchantId Numeric N/A PaymentTrust Ltd. 

Example “100000” 

M 

UserName Alphanumeric 15 

UserName assigned by PaymentTrust Ltd. 

Example “Mariah” 

M 

UserPassword Alphanumeric 15 

UserPassword assigned by PaymentTrust Ltd. 

Example “rr87uy” 

M 

TransactionType Alphanumeric 2 Transaction Type, “RG” for RiskGuardian M 

IsTest Numeric 1 

''1' for "Test", '0' for "Live", 

Note: Defaults to 0 if left blank 

Indicates the maximum time the merchant allows 

O 

TimeOut Numeric N/A for the transaction, in milliseconds 


For use to differentiate between Merchants or 

M 

StoreID Alphanumeric 10 

Stores. Permanent Store ID assigned by 

PaymentTrust Ltd. or Merchant if left blank 


Account type. 

CC - Visa & MasterCard debit & credit cards, 

Carte Bancaire, Carte Bleue 

DS - Switch/Solo debit cards 

CQ - Cheques 

O 

MOP Alpha 2 

EC - Electronic cheques or credit 

DC - Debit Card PIN enabled cards 

PC - Purchasing cards 

NT - Net Teller 

P2 – Pay 2 

Example: “CC” 

M 

16


TRXSource Numeric N/A 

Track2Data Alphanumeric 100 

TypeOfSale Alphanumeric 1 

OrderNumber Alphanumeric 35 

AcctName Alphanumeric 30 

AcctNumber Numeric N/A 

AcctNumber2 Numeric N/A 

ExpDate Numeric N/A 

CurrencyId Numeric N/A 

17 

Indicates the method used to receive the 

CreditCard information. 

1 - Swiped with a Card Present 

2 - Keyed by merchant with a Card present 

3 - Mail Order Telephone Order MOTO (Card Not 

Present) 

4 - Web orders (Card not present) 

5 – Web orders (Card not present, e-mail not 

present) 

9 – Integrated Circuit Card 

Note: Defaults to the Merchant default value during setup. 

Note: Mandatory for ICC transactions. 

Indicates swipe information from the Track2data 

of the Card when the TRXSource is 1 (Swiped 

with a Card Present) 

Example: 

“;4459510002561039=09100000000000000000?” 

Note: This becomes a mandatory field when 

TRXSource =1 or TRXSource = 9 for a down 

graded ICC transaction. 

‘H’ Hard goods, = Requires Shipping Details 

‘D’ Digital goods, = Does not Require Shipping 

Details 

‘S’ Service, = Does not Require Shipping Details 

Specific Order number submitted by the Merchant 

for tracking purposes. 

Example “10098987” 

Note: If no order number is submitted the system 

will generate one for the merchant at the time of 

the transaction. 

Account holder name on card or account 

Example “John Smith” 

Credit card number, Debit Card number, 

Purchase Card number, Bank account number, or 

any other applicable Bank Identifier. 

Example “4459510002561039” 

Secondary Credit card number, Debit Card 

number, Purchase Card number, Bank account 

number, or any other applicable Bank Identifier. 

Example “4459510002561039” 

Note: Primary usage is for prepaid cards. 

Expiry date for credit card in MMYYYY format 


Note: Mandatory for CC, PC and DS MOP types. 

ISO standard numeric ids 

Example 840 = USD, 124 = CAD, 826 = GBP 

Note: Please see Appendix B for complete list of 

values. 



O 

O 

O 

O 

M 

M 

O 

O 

M




Amount Numeric N/A 

Transaction amount. Up to 4 decimals maximum. 

Decimal varies based on CurrencyId. 

Example 840 = “56.78”, 392 = “99”, 048 = 

“125.333” 

Number of full months that the customer has been 

M 

IsMember Numeric N/A 

a member with the Merchant. 


Note: Set to 0 for new customer. 

1 sets the flag to verify the age, 0 or if flag is not 

O 

AgeVerify Numeric N/A sent will not test for Age verification. 


The Date Of Birth as entered by the consumer in 

a DDMMYYYY format. 

Example “23091963” 

O 

DOB Numeric N/A Note: Please make sure that single digit months 

are padded with zero in the beginning. i.e 9 

becomes 09. Also note that this field is important 

only when the AgeVerify flag is set to 1 

In Countries where ID is required as an additional 

doc to verify the age then the type of the ID that is 

being sent must be provided. 

PP – PassPort 

O 

IDType Alpha 2 

DL – Drivers License 

CC – Citizenship Card ID 

MD – Medical ID 

SI – Social Insurance Number 

OT – Other 

Note: Mandatory depending on country. 

In Countries where ID is required as an additional 

doc to verify the age then based on the type 

O 

IDNumber Alphanumeric 100 specified in the IDType field a number is provided. 

Example “XJK23091963” or “jhsdgf743hgwf” 

Note: Mandatory depending on country 

1 sets the flag to share risk data, 0 or if flag is not 

O 

DataSharing Numeric N/A sent will not send the transaction for data sharing. 


O 

Title Alphanumeric 20 

Billing contact Title 

Example “Sir” 

O 

Company Alphanumeric 60 

Billing contact company 

Example “PaymentTrust Ltd.” 

O 

FirstName Alphanumeric 60 

Billing contact First Name 

Example “John” 

M 

MiddleName Alphanumeric 60 Billing contact Middle Name O 

LastName Alphanumeric 60 

Billing contact Last Name 

Example “Smith” 

M 

Suffix Alphanumeric 20 

Billing contact suffix 

Example “3rd” 

O 

Address1 Alphanumeric 60 

Billing contact Address line 1 

Example “2130 Gold” 

M 



Example “Suite101” 

O 

Address3 Alphanumeric 60 Billing contact Address line 3 O 

City Alphanumeric 60 

Billing contact City 

Example “New York” 

M 

18




StateCode Alphanumeric 60 

Billing contact state code, two-character long ISO 

code required for North America. Remaining 

Region and Provinces around the world may use 

free form field 

Example “NY” 

Note: Please See Appendix E for complete list of 

values 

O 

ZipCode Alphanumeric 30 

Billing contact ZIP / Postal Code 


Billing contact ISO Country Code 

O 

CountryCode Alpha 2 

Example “US” 

Note: Please See Appendix D for complete list of 

values 

Billing contact Phone Number, only digits, no 

M 

PhoneNumber Alphanumeric 30 parentheses 

Example “6188565656” 

M 

PhoneExtension Alphanumeric 10 

Billing contact Phone Extension 


Billing contact Email address 

Note: This field is optional for MOTO 

O 

Email Alphanumeric 50 Transactions where TRXSource = 3. 

Example “johns@aol.com” 

Note: Mandatory when TRXSource is set to 4. 

Ship to contact Title 

O 

ShipToTitle Alphanumeric 20 Only if TypeOfSale = H. 


O 

ShipToCompany Alphanumeric 

60 

Ship to contact company 

Only if TypeOfSale = H. 


Ship to contact First Name 

O 

ShipToFirstName Alphanumeric 

60 Only if TypeOfSale = H. 



TypeOfSale is “H” 

O 

ShipToMiddleName Alphanumeric 

60 Ship to contact Middle Name 


O 

ShipToLastName Alphanumeric 60 

ShipToSuffix Alphanumeric 20 

ShipToAddress1 Alphanumeric 60 



19 

Ship to contact Last Name 





Ship to contact suffix 

Only if TypeOfSale = H 


Ship to contact Address line 1 










O 

O 

O 

O 

O


ShipToCity Alphanumeric 60 

ShipToStateCode Alphanumeric 

20 

30 

ShipToZipCode Alphanumeric 30 

ShipToCountryCode Alpha 2 

ShipToPhoneNumb 

er 

ShipToPhoneExten 

sion 

Alphanumeric 

30 

Alphanumeric 10 

REMOTE_ADDR Alphanumeric 100 

HTTP_USER_AGE 

NT 

HTTP_ACCEPT_L 

ANGUAGE 

HTTP_ACCEPT_C 

HARSET 




HTTP_REFERER Alphanumeric 200 

Ship to contact City 





Ship to contact state code, two-character long ISO 

code required for North America. Remaining 

Region and Provinces may use free form field 




values 

Note 2: This becomes a mandatory field when 


Ship to contact ZIP / Postal Code 





Ship to contact ISO Country Code, list will be 

provided by PaymentTrust Ltd. 




values 

Note 2: This becomes a mandatory field when 


Ship to contact Phone Number, only digits, no 

parentheses 


Example “6188565656” 



Ship to contact Phone Extension 


Customer’s IP address or DNS Address. 

Example “207.253.196.193” or 

“Dialup339.paymenttrust.com” 

Note: This becomes an optional field when TRXSource 

= 3 for MOTO TRX. 

Customer’s HTTP header 

‘HTTP_USER_AGENT’ 

HTTP user header information. 

i.e. en, fr-CA 


i.e. ISO-8859-1, *, utf-8 




O 

O 

O 

O 

O 

O 

M 

O 

O 

O 

O




ProductType Alphanumeric 50 

Product type, category, code or any other 

descriptive code from a merchant’s product list 

that can be associated with a specific risk. This 

field is merchant specific. 

Example “CD004H78” 

Return a list of 5 RG parameters indicating the 

reason(s) of automatic success or failure of a 

O 

IsExtended Numeric 1 transaction with an RG score of 0 or 100. Set to '1' 

for "Yes", '0' for "No" 

Note: Defaults to 0 if left blank. 

Return a list of all the RG analysis parameter 

codes, their scores and responses. Set to '1' for 

O 

IsAnalysis Numeric 1 

"Yes", '0' for "No". 


Note: Only for XML requests. See Section 6.3 

(XML Definitions) 

O 

Sample Input String: 

StringIn=VersionUsed^4~MerchantId^100000~UserName^Mariah~UserPassword^rr87uy~TransactionType^ 

RG~IsTest^1~TimeOut^60000~MOP^CC~TypeOfSale^D~AcctName^John 

Smith~AcctNumber^4459510002561039~ExpDate^092010~CurrencyId^840~Amount^56.78~FirstName^Joh 

n~LastName^Smith~Address1^2130 Gold~City^New 

York~CountryCodeÛS~PhoneNumber^6188565656~REMOTE_ADDR^205.188.146.23 

STLink will return the following Response for a RiskGuardian 

Request (RG) 


MerchantId Numeric N/A 

Permanent Merchant ID assigned by PaymentTrust Ltd. 


TransactionType Alpha 2 Transaction Type, “RG” for RiskGuardian 

Order number submitted by the Merchant or a number 


generated by PaymentTrust Ltd. if order number was not 

specified. 

Example “10098987” 

StrId Numeric N/A 

Reference Number from STLink also known as STRING 

ID 

MessageCode Numeric N/A 

Note: Please See Appendix A for complete list of 

Response Messages 

Reference Number from RG system also known as the 

GTTID or RGID Numeric N/A 

RGID 

Note: If the version is less than 4.0, GTTID is returned. If 

not RGID is returned. 

tScore Numeric N/A Score of the transaction requested 

tRisk Numeric N/A Set Threshold between 1-100 at the time of the transaction 

21


AgeVerifyMessage 

Code 

22 

Numeric N/A 

1 digit code returned when Age check is requested. 

Possible values: 

0 = DOB Matched 

1 = Partial Match Month/Year only 

2 = Partial Match Year only 

3 = Partial Match age group above 18 

4 = Partial Match Age is valid 

5 = Nothing Matched 

6 = Could not verify 

AgeVerifyMessage Alphanumeric 50 

Returned when Age check is requested. 

Descriptive message of AgeVerifyMessageCode 

Example: “Partial Match age group above 18” 

DSID Numeric N/A Id assigned by Data Sharing service 

DSMessageCode Numeric N/A Message Code assigned by Data Sharing service 

DSMessage Alphanumeric 50 Message assigned by Data Sharing service 

“List Of Extended 

Parameters” 

Example “FNA” 

“List Of RG 

Analysis 

Parameters” 


XML N/A 

pCode Alphanumeric 3 

pScore Numeric 3 

pResponse Alphanumeric 100 

Sample Response: 

A list of RG parameters indicating the reason(s) of 

automatic success or failure of a transaction with RG 

scores of 0 or 100. Returned only if IsExtended flag was 

set to ‘1’ 

Note: The parameter name is 3 characters in length. 

Note: Up to a maximum of 5 parameters are returned. 

Return a list of all the RG analysis parameter codes, their 

scores and responses. Set to '1' for "Yes", '0' for "No". 

Returned only if IsAnalysis flag was set to ‘1’ 

Example: 

• pCode: CCA 

• pScore: 93 

• pResponse: gb/gb 

Note: Returned only as XML. See Section 6.3 (XML 

Definitions) 

Parameter code abbreviation. 


Definitions) 

Score calculated for the parameter ranging from 0 – 100. 


Definitions) 

Values used to calculate parameter score. 


Definitions) 

MerchantId^100000~TransactionType^RG~OrderNumber^10098987~StrId^121155~MessageCode^100~RGI 

D^490095~tScore^100.0000~tRisk^52 

Extended Sample Response: 

MerchantId^100000~TransactionType^RG~OrderNumber^10098987~StrId^121155~MessageCode^100~RGI 

D^490095~tScore^100.0000~tRisk^52~FNAÂlbert~CCAÎQ 

Analysis Sample Response: See Section 6.3 (XML Definitions)

RiskGuardian Request (RG) with RequestType = R for Reprocessing 

There are cases such as MOTO environments where a post Risk Analysis check-up is required just 

before the product is shipped or the funds are deposited for settlement. In these case RiskGuardian offers 

a unique way to re-process the TRX simply by submitting the GTTID/RGID received from the original RG 

request along with some basic values. RiskGuardian will then re-process the TRX and compare it to many 

other TRXs that may have come in between the time of order and the time of shipment. 





Must be at beginning of all strings. Capitals must 

be used as shown. 


M 



Example “4” for RG 


M 



M 




M 

UserPassword Alphanumeric 15 

UserPassword assigned by PaymentTrust Ltd. 


M 

TransactionType Alphanumeric 2 Transaction Type, “RG” for RiskGuardian M 




Indicates the maximum time the merchant allows 

O 

TimeOut Numeric N/A for the transaction, in milliseconds 


M 

RequestType Alphanumeric 1 ‘R’ for Reprocessing 

Specific Order number submitted by the Merchant 

for tracking purposes. 

M 


Example “10098987” 




Reference Number from RG system also known 

O 


as the RGID 

Note: If the version is less than 4.0, GTTID is 

required. If not RGID is required. 

Return a list of 5 RG parameters indicating the 

reason(s) of automatic success or failure of a 

M 

IsExtended Numeric 1 transaction with an RG score of 0 or 100. Set to '1' 

for "Yes", '0' for "No" 


Return a list of all the RG analysis parameter 

codes, their scores and responses. Set to '1' for 

O 


"Yes", '0' for "No". 


Note: Only for XML requests. See Section 6.3 

(XML Definitions) 

O 


23


RG~IsTest^1~TimeOut^60000~RequestType^R~GttId^490095 

STLink will return the following Response for a RiskGuardian 

Request (RG) with RequestType = R 









specified. 

Example “10098987” 



ID 






RGID 









Code 

Numeric N/A 







Returned when Age check is requested. 

AgeVerifyMessage Alphanumeric 50 Descriptive message of AgeVerifyMessageCode 


DSID Numeric N/A Id assigned by Data Sharing service 

DSMessageCode Numeric N/A Message Code assigned by Data Sharing service 




Parameters” 











“List Of RG 

Example: 

Analysis 

XML N/A • pCode: CCA 

Parameters” 




Definitions) 

24



pCode Alphanumeric 3 Note: Returned only as XML. See Section 6.3 (XML 

Definitions) 


pScore Numeric 3 Note: Returned only as XML. See Section 6.3 (XML 

Definitions) 


pResponse Alphanumeric 100 Note: Returned only as XML. See Section 6.3 (XML 

Definitions) 


MerchantId^100000~TransactionType^RG~OrderNumber^10098987~StrId^121155~MessageCode^100~RGID^4900 

95~tScore^100.0000~tRisk^52 


MerchantId^100000~TransactionType^RG~OrderNumber^10098987~StrId^121155~MessageCode^100~RGID^4900 

95~tScore^100.0000~tRisk^52~AgeVerifyMessageCode^4~FNAÂlbert~CCAÎQ~ 

Analysis Sample Response: See Section 6.3 (XML Definitions) 

25

DataShare: 

Authorisation Request (DS)(A) 

Deposit (Settlement) Request (DS)(D) 

Sale Request (DS)(S) 

Refund Request (DS)(R) 

Finalise Request (DS)(F) 

Cancellation Request (DS)(C) 

Requests A, S, D, S, R, F, C, and P are defined in our PaymentTrust system sending the equivalent 

request type to the DataShare system will either score that transaction, or store a record of the 

transaction to be used later in the score calculation but will not process the payment. 

Note: Please reference the latest Ethoca integration documents for additional information regarding 

optional fields. 





Must be at beginning of all strings. Capitals 

must be used as shown. 


Version Used specific to Transaction Type. 

M 

VersionUsed 

Alphanume 

ric 

4 

Note: Must evaluate to numeric value for 

DS. 

Example “1” for DS 


M 



M 

UserName 

Alphanume 

ric 

15 



M 

UserPassword 

Alphanume 

ric 

15 

UserPassword assigned by PaymentTrust 

Ltd. 


M 

TransactionType 

Alphanume 

ric 

2 Transaction Type, “DS” for DataShare M 




Indicates the maximum time the merchant 

O 

TimeOut Numeric N/A allows for the transaction, in milliseconds 

Recommendation “60000” 

‘A’ Authorisation. 

‘D’ Deposit (Settlement). 

‘R’ Refund 

M 

RequestType 

Alphanume 

ric 

1 

‘S’ Sale 

‘C’ Cancellation 

‘F’ Finalise 

Note: Defaults to ‘A’ 

Note: BACS payback transactions 

should be sent as Refunds 

For use to differentiate between Stores. 

O 

StoreID 

Alphanume 

ric 

10 

Permanent Store ID assigned by 



O 

26


Account type. 



MOP Alpha 2 

CC - Visa & MasterCard debit & credit 

cards, Carte Bancaire, Carte Bleue 


CQ - Cheques 





M 



InfractionMessageCode 

OrderNumber 

AcctName 

27 

Alphanume 

ric 

Alphanume 

ric 

Alphanume 

ric 

N/A 

35 

60 



IssueNumber Numeric N/A 






3 - Mail Order Telephone Order MOTO 

(Card Not Present) 


5 – Web orders (Card not present, e-mail 

not present) 


Note: Defaults to the Merchant default value 

during set-up. 



Note: Please See Appendix E for complete 

list of Results 

Bank code returned for the transaction 

Specific Order number submitted by the 

Merchant for tracking purposes. 

Example “10098987” 





Example “John Smith 3 rd ” 

Note: Mandatory for Carte Bancaire and 

Carte Bleue cards. 


Purchase Card number, Bank account 

number, or any other applicable Bank 

Identifier. 

Example “4459510002561039” 

Note: This field is not required when 

TRXSource is 1 

Expiry date for credit card in MMYYYY 

format 


Note: Mandatory for CC, PC and DS MOP 

types. 

Submit for Switch/Solo cards if available. 


O 

O 

O 

O 

M 

M 

O 

O




StartDate Numeric N/A 




Example 840 = USD, 124 = CAD, 826 = 

O 

CurrencyId Numeric N/A GBP 


values. 

ID of transaction to be updated. 

M 

DSID Numeric N/A Note: Mandatory for any transaction that is 

to be updated. 


O 

RGID Numeric N/A 

Note: Mandatory for any transaction that is 

to be updated. Can be used in place of 

DSID. 

Transaction amount. Up to 4 decimals 

maximum. Decimal varies based on 

O 

Amount Numeric N/A CurrencyId. 

Example 840 = “56.78”, 392 = “99”, 048 = 

“125.333” 

Infraction amount. Up to 4 decimals 


M 

InfractionAmount Numeric N/A CurrencyId. 

Example 840 = “56.78”, 392 = “99”, 048 = 

“125.333” 

Date and Time the transaction 

(YYYYMMDDHHMMSS). 

O 

TRXDateTime 

AlphaNum 

eric 

20 

Example “20050223164000” 

Note: Time is in military format, and must 

use time zone GMT. 

Date and Time the transaction was 

recorded as an infraction 


Example “20050223164000” 

O 

InfractionDateTime 

Title 

Company 

FirstName 

MiddleName 

LastName 

Suffix 

Address1 

28 

AlphaNum 

eric 

Alphanume 

ric 

Alphanume 

ric 

Alphanume 

ric 

Alphanume 

ric 

Alphanume 

ric 

Alphanume 

ric 

Alphanume 

ric 

20 

20 

60 

60 



Note: If IsChargeBack = 1, or 

MessageCode = 2960 this field becomes 

mandatory 







60 Billing contact Middle Name O 

60 

20 

60 




Example “ 3 rd ” 



O 

O 

O 

M 

M 

O 

M




Address2 

Alphanume 

ric 

60 



O 

Address3 

Alphanume 

ric 

60 Billing contact Address line 3 O 

Unit 

Alphanume 

ric 

15 Billing unit number / apartment number O 

BuildingNumber 

Alphanume 

ric 

10 Billing house, or building number O 

StreetName 

Alphanume 

ric 

30 Billing street name O 

StreetType 

Alphanume 

ric 

15 

Billing street type 

Example: avenue, street, road 

Billing street direction 

N = North 

NE = NorthEast 

E = East 

O 

StreetDirection Alpha 2 SE = SouthEast 

S = South 

SW = SouthWest 

W = West 

NW = NorthWest 

O 

City 

Alphanume 

ric 

60 



M 

StateCode 

ZipCode 

29 

Alphanume 

ric 

Alphanume 

ric 


PhoneNumber 

PhoneExtension 

MobilePhoneNumber 

Alphanume 

ric 

Alphanume 

ric 

Alphanume 

ric 

MobilePhoneCountryCode Alpha 2 

Pager 

Alphanume 

ric 

60 

30 

30 

10 

30 

30 

The billing information state based on the 

two-character long ISO codes. This is a 

mandatory field for North America only. The 

remaining world regions /Provinces may use 

this as an Optional field. 


Note: Please See Appendix C for complete list of 

values 






values 

Billing contact Phone Number, only digits, 

no parentheses 

Example “6188565656” 



Billing contact Mobile Phone Number, only 

digits, no parentheses 

Example “6188565656” 

Billing contact Mobile Phone Number ISO 

Country Code 


values 

Billing contact Pager Number, only digits, 


Example “6188565656 

O 

O 

M 

M 

O 

O 

O 

O




PagerCountryCode Alpha 2 

Billing contact Pager Number ISO Country 

Code 


values 



O 

Email 

Alphanume 

ric 

50 

Transactions where TRXSource = 3. 


Note: Mandatory when TRXSource is set to 

4. Must contain personal e-mail 

The Date Of Birth as entered by the 

consumer in a DDMMYYYY format. 

O 

DOB Numeric N/A 

Example “23091963” 

Note: Please make sure that single digit 

months are padded with zero in the 

beginning. i.e 9 becomes 09. 

In Countries where ID is required as an 

additional doc to verify the age then the 

type of the ID that is being sent must be 

provided. 


O 

IDType1 Alpha 2 DL – Drivers License 




OT – Other 



additional doc to verify the age then based 

O 

IDNumber1 

Alphanume 

ric 

100 

on the type specified in the IDType field a 

number is provided. 

Example “XJK23091963” or 

“jhsdgf743hgwf” 





provided. 


O 





OT – Other 




O 

IDNumber2 

Alphanume 

ric 

100 






O 

30





provided. 








OT – Other 



O 

IDNumber3 

Alphanume 

ric 

100 










provided. 


O 





OT – Other 




O 

IDNumber4 

Alphanume 

ric 

100 









provided. 


O 





OT – Other 




O 

IDNumber5 

Alphanume 

ric 

100 






O 

31


ShipToTitle 

Alphanume 

ric 

20 



ShipToCompany 

Alphanume 

ric 

60 



ShipToFirstName 

Alphanume 

ric 

60 



ShipToMiddleName 

ShipToLastName 

ShipToSuffix 

ShipToAddress1 



ShipToUnit 

ShipToBuildingNumber 

ShipToStreetName 

ShipToStreetType 

32 

Alphanume 

ric 

Alphanume 

ric 

Alphanume 

ric 

Alphanume 

ric 

Alphanume 

ric 

Alphanume 

ric 

Alphanume 

ric 

Alphanume 

ric 

Alphanume 

ric 

Alphanume 

ric 

ShipToStreetDirection Alpha 2 

ShipToCity 

ShipToStateCode 

ShipToZipCode 

Alphanume 

ric 

Alphanume 

ric 

Alphanume 

ric 




60 Ship to contact Middle Name O 

60 

20 

60 

60 









60 Ship to contact Address line 3 O 

15 Ship to unit number / apartment number O 

10 Ship to house, or building number O 

30 Ship to street name O 

15 

60 

30 

30 

Ship to street type 


Ship to street direction 

N = North 


E = East 

SE = SouthEast 

S = South 


W = West 




Ship to contact state code, two-character 

long ISO code required for North America. 

Remaining Region and Provinces may use 

free form field or leave it blank. 



values 



Ship to contact ISO Country Code, list will 

be provided by PaymentTrust Ltd. 



values 

O 

O 

O 

O 

O 

O 

O 

O 

O 

O 

O 

O 

O




ShipToPhoneNumber 

Alphanume 

ric 

30 

Ship to contact Phone Number, only digits, 


Example “6188565656” 

O 

ShipToPhoneExtension 

Alphanume 

ric 

10 



O 

BusinessAddress1 

Alphanume 

ric 

60 

Business contact Address line 1 


O 



BusinessUnit 

BusinessBuildingNumbe 

r 

BusinessStreetName 

BusinessStreetType 

33 

Alphanume 

ric 

Alphanume 

ric 

Alphanume 

ric 

Alphanume 

ric 

Alphanume 

ric 

Alphanume 

ric 

BusinessStreetDirection Alpha 2 

BusinessCity 

BusinessStateCode 

BusinessZipCode 

Alphanume 

ric 

Alphanume 

ric 

Alphanume 

ric 

BusinessCountryCode Alpha 2 

BusinessPhoneNumber Alphanume 

ric 

BusinessPhoneExtension Alphanume 

ric 

BusinessFaxNumber 

Alphanume 

ric 

60 



60 Business contact Address line 3 O 

15 Businessunit number / apartment number O 

10 Business house, or building number O 

30 Business street name O 

15 

60 

30 

30 

30 

10 

30 

Business street type 


Business street direction 

N = North 


E = East 


S = South 


W = West 


Business contact City 


Business contact state code, two-character 






values 

Business contact ZIP / Postal Code 


Business contact ISO Country Code, list will 




values 

Business contact Phone Number, only 


Example “6188565656” 

Business contact Phone Extension 


Business contact Fax Number, only digits, 


Example “6188565656” 

O 

O 

O 

O 

O 

O 

O 

O 

O 

O




BusinessEmail 

Alphanume 

ric 

50 Business contact Email address O 

HomeAddress1 

Alphanume 

ric 

60 

Home contact Address line 1 


O 

HomeAddress2 

HomeAddress3 

HomeUnit 

HomeBuildingNumber 

HomeStreetName 

HomeStreetType 

34 

Alphanume 

ric 

Alphanume 

ric 

Alphanume 

ric 

Alphanume 

ric 

Alphanume 

ric 

Alphanume 

ric 

HomeStreetDirection Alpha 2 

HomeCity 

HomeStateCode 

HomeZipCode 

Alphanume 

ric 

Alphanume 

ric 

Alphanume 

ric 

HomeCountryCode Alpha 2 

PhoneNumber1 

Alphanume 

ric 

PhoneNumber1CountryCode Alpha 2 

PhoneNumber1Extension 

PhoneNumber2 

Alphanume 

ric 

Alphanume 

ric 

60 



60 Home contact Address line 3 O 

15 Home unit number / apartment number O 

10 Home house, or building number O 

30 Home street name O 

15 

60 

30 

30 

30 

10 

30 

Home street tyoe 


Home street direction 

N = North 


E = East 


S = South 


W = West 


Home contact City 


Home contact state code, two-character 






values 

Home contact ZIP / Postal Code 


Home contact ISO Country Code, list will be 




values 

Supplementary Phone Number, only digits, 


Example “6188565656” 

Supplementary Mobile Phone Number ISO 

Country Code 


values 

Supplementary Phone Number Extension 




Example “6188565656” 

O 

O 

O 

O 

O 

O 

O 

O 

O 

O 

O




PhoneNumber2CountryCode Alpha 2 


Country Code 


values 

O 

PhoneNumber2Extension 

Alphanume 

ric 

10 



O 

Email1 

Alphanume 

ric 

50 

Additional contact Email address 


O 

Email2 

Alphanume 

ric 

50 



O 

Email3 

Alphanume 

ric 

50 



“0” for “No scoring”, 

“1” for “Score transaction only, and do not 

add to data for future scores”, 

O 

ProcessType Numeric 1 “2” for “Score transaction, and add to data 

for future scores” 

“3” for “Record an account creation, or 

update to an existing account” 

“0” for Approve 

“1” for Approve, and review 

“2” for Decline, and review 

M 

ProcessAction Numeric 1 “3” for Decline 

“4” for Referral 

The process to be applied to the 

transaction. 


O 

REMOTE_ADDR 

Alphanume 

ric 

100 

Example “207.253.196.193” or 


Note: This becomes an optional field when 

TRXSource = 3 for MOTO TRX. 

M 

HTTP_USER_AGENT Alphanume 

ric 

200 Customer’s HTTP header 


O 

HTTP_ACCEPT_LANGU 

AGE 

Alphanume 

ric 

50 HTTP user header information. 


O 

HTTP_ACCEPT_CHARS 

ET 

Alphanume 

ric 

100 HTTP user header information. 

i.e. ISO-8859-1, *, utf-8 

O 

HTTP_REFERER Alphanume 

ric 

ProductType 

35 

Alphanume 

ric 

200 

IsChargeBack Numeric 1 

50 


Product type, category, code or any other 

descriptive code from a merchant’s product 

list that can be associated with a specific 

risk. This field is merchant specific. 

Example “CD004H78” 

''1” for "Yes”, “0” for "No", 


O 

O 

O



Comments 


36 

Alphanume 

ric 



Return a list of all the RG analysis 

parameter codes, their scores and 

responses. Set to '1' for "Yes", '0' for "No". 


O 

Note: Only for XML requests. See Section 

6.3 (XML Definitions) 

Note: Analysis fields will be populated only 

if a score is requested. 

200 Comment field for the transactions. O 

StringIn=VersionUsed^3~MerchantId^100000~UserName^dsuser~UserPassword^********~TransactionType^DS~Tim 

eOut^10000~MOP^cc~TypeofSale^d~AcctName^Suzanne 

Gibson~AcctNumber^********3253~ExpDate^122008~Amount^161.1~CurrencyId^978~RequestType^~OrderNumber 

^0704131611~IsTest^1~DSID^~StoreId^1~MessageCode^2100~InfractionMessageCode^225~InfractionAmount^~T 

RXDateTime^20070223164000~InfractionDateTime^20070223164000~DOB^23091963~ProcessType^2~Title^Mrs.~ 

Company^Jacomo Inc.~FirstName^Suzanne~MiddleName^Lorraine~LastName^Gibson~Suffix^~Address1^145 Des 

Merisiers Street~Address2^~Address3^~City^Vaudreuil-Dorion~StateCode^Quebec~ZipCode^J7V 

9S9~CountryCode^CA~PhoneNumber^4505102197~PhoneExtension^~Email^ds@unknown.ca~

STLink will return the following Response for a DataSharing Request 

(DS) 


Permanent Merchant ID assigned by PaymentTrust 

MerchantId Numeric N/A International 


TransactionType Alpha 2 Transaction Type, “DS” for DataSharing 



generated by PaymentTrust International if order number 

was not specified. 

Example “10098987” 



ID 

DSID Numeric N/A Reference Number from DS system 


DSMessageCode Numeric N/A Note: Please See Appendix A for complete list of 


DSMessage Alphanumeric 50 

Message assigned by Data Sharing service 

Example: “Transaction Processed” 

DSScore Numeric N/A 

Score of the transaction requested. 

Example: 0, 100, 76, -1 



RequestType Alphanumeric 1 


‘S’ Sale 



ShareServiceTRXId1 Alphanumeric 30 

Id supplied by third party service used. 

Note: Id will be returned if applicable and available 




ShareServiceScore Numeric N/A 

Score supplied by third party service used. 

Note: Score will be returned as received from third party. 

Return a list of all the DS analysis parameter codes, their 



Example: 

“List Of DS 

• AssmtId 

Analysis 

XML N/A • AdviceCode 

Parameters” 

• OverrideCode 

• …….. 


37 


Definitions) for complete list 

MerchantId^100000~TransactionType^DS~OrderNumber^0704131611~StrId^100553~DSID^36~DSMessageCode^6 

100~DSMessage^Transaction 

processed~DSScore^0~RequestTypeÂ~ShareServiceTRXId1^6512C133490D44E691CB33015~ShareServiceTRXI 

d2^105CDA815D5B432BBDDE4FFCE~ShareServiceScore^0 


DataShare PayBack with Electronic Credit Request (DS)(P) 









M 



DS. 



M 



M 





M 

UserPassword Alphanumeric 15 Ltd. 


M 

TransactionType Alphanumeric 2 Transaction Type, “DS” for DataShare M 





O 



M 

RequestType Alphanumeric 1 ‘P’ PayBack request. 


M 





Account type. 




O 

MOP Alpha 2 

CQ - Cheques 





Example: “EC” 


M 

MessageCode Numeric N/A Note: Please See Appendix E for complete 

list of Results 

O 

InfractionMessageCode Alphanumeric N/A Bank code returned for the transaction 


O 


OrderNumber Alphanumeric 

35 Example “10098987” 






O 



values. 

M 

38





DSID Numeric N/A Note: Mandatory for any transaction that is O 

RGID Numeric N/A 


InfractionAmount Numeric N/A 

TRXDateTime 

InfractionDateTime 

39 

AlphaNumeri 

c 

AlphaNumeri 

c 

20 

20 

IBAN Alphanumeric 35 

PayeeBankNumber Numeric 

PayeeAccountNumber Numeric 

See 

Description 

See 

Description 

AccountCountryCode Alpha 2 

PaymentREF Alphanumeric 60 



to be updated. 


Note: Mandatory for any transaction that is 

to be updated. Can be used in place of 

DSID. 



CurrencyId. 

Example 840 = “56.78”, 392 = “99”, 048 = 

“125.333” 



CurrencyId. 

Example 840 = “56.78”, 392 = “99”, 048 = 

“125.333” 



Example “20050223164000” 






Example “20050223164000” 






A representation of payee’s Bank Branch 

Code and Bank Account Number. 

Example: “fr1234567890” 

Note: Starts with 2-letter CountryCode. 

Payee’s bank number where funds are 

transferred. 

Payee’s account number where funds are 

transferred. 

Payee’s account number ISO Country 

Code. 



values 

The contents of this parameter appear in 

the memo field of the issued cheque or 

electronic credit. If omitted, defaults to 

empty string. 





O 

M 

O 

O 

O 

O 

M 

M 

M 

O 

O 

O



40 



Note: Size is calculated by adding 

FirstName and LastName including 

one space character. 



MiddleName Alphanumeric 60 Billing contact Middle Name 


O 

LastName Alphanumeric 25 Example “Smith” 

Note: See FirstName. 

M 




O 




M 




O 


Unit Alphanumeric 15 Billing unit number / apartment number O 

BuildingNumber Alphanumeric 10 Billing house, or building number O 

StreetName Alphanumeric 30 Billing street name O 

StreetType Alphanumeric 15 

Billing street type 


Billing street direction 

N = North 


E = East 

O 

StreetDirection Alpha 2 SE = SouthEast 

S = South 


W = West 


Billing contact City. 


O 

City Alphanumeric 60 Note: For CountryCode “NL” (Netherlands) 

If IBAN is not present; City is mandatory 

and size of 35. 




M 






values 

O 




Billing contact ISO Country Code. 

O 




values 


M 

PhoneNumber Alphanumeric 30 no parentheses 

Example “6188565656” 

M 




O 

M




MobilePhoneNumber Alphanumeric 30 

Billing contact Mobile Phone Number, only 


Example “6188565656” 

Billing contact Mobile Phone Number ISO 

O 

MobilePhoneCountryCode Alpha 2 

Country Code 


values 

Billing contact Pager Number, only digits, 

O 

Pager Alphanumeric 30 no parentheses 

Example “6188565656 

Billing contact Pager Number ISO Country 

O 

PagerCountryCode Alpha 2 

Code 


values 



O 

Email Alphanumeric 50 

Transactions where TRXSource = 3. 


Note: Mandatory when TRXSource is set to 

4. Must contain personal e-mail 



O 

DOB Numeric N/A 

Example “23091963” 







provided. 


O 





OT – Other 





O 

IDNumber1 Alphanumeric 100 number is provided. 







provided. 


O 





OT – Other 


O 

41





IDNumber2 Alphanumeric 100 






O 

IDType3 Alpha 2 





42 





provided. 






OT – Other 












provided. 






OT – Other 












provided. 






OT – Other 


O 

O 

O 

O 

O












O 

ShipToTitle Alphanumeric 20 



O 

ShipToCompany Alphanumeric 60 



O 

ShipToFirstName Alphanumeric 60 



O 

ShipToMiddleName Alphanumeric 60 Ship to contact Middle Name O 




O 




O 




O 




O 

ShipToAddress3 Alphanumeric 60 Ship to contact Address line 3 O 

ShipToUnit Alphanumeric 15 Ship to unit number / apartment number O 

ShipToBuildingNumber Alphanumeric 10 Ship to house, or building number O 

ShipToStreetName Alphanumeric 30 Ship to street name O 

ShipToStreetType Alphanumeric 15 

Ship to street type 

O 

ShipToStreetDirection Alpha 2 


ShipToStateCode Alphanumeric 30 



43 


Ship to street direction 

N = North 


E = East 


S = South 


W = West 










values 







values 

O 

O 

O 

O 

O




ShipToPhoneNumber Alphanumeric 30 



Example “6188565656” 

O 

ShipToPhoneExtension Alphanumeric 10 



O 

BusinessAddress1 Alphanumeric 60 



O 

BusinessAddress2 Alphanumeric 60 



O 

BusinessAddress3 Alphanumeric 60 Business contact Address line 3 O 

BusinessUnit Alphanumeric 15 Businessunit number / apartment number O 

BusinessBuildingNumber Alphanumeric 10 Business house, or building number O 

BusinessStreetName Alphanumeric 30 Business street name O 

BusinessStreetType Alphanumeric 15 

Business street type 


Business street direction 

N = North 


E = East 

O 

BusinessStreetDirection Alpha 2 SE = SouthEast 

S = South 


W = West 


O 

BusinessCity Alphanumeric 60 

Business contact City 


Business contact state code, two-character 



O 

BusinessStateCode Alphanumeric 30 free form field or leave it blank. 



values 

O 

BusinessZipCode Alphanumeric 30 

Business contact ZIP / Postal Code 


Business contact ISO Country Code, list will 


O 

BusinessCountryCode Alpha 2 Example “US” 


values 

Business contact Phone Number, only 

O 

BusinessPhoneNumber Alphanumeric 30 digits, no parentheses 

Example “6188565656” 

O 

BusinessPhoneExtensio 

n 


Business contact Phone Extension 


Business contact Fax Number, only digits, 

O 

BusinessFaxNumber Alphanumeric 30 no parentheses 

Example “6188565656” 

O 

BusinessEmail Alphanumeric 50 Business contact Email address O 

HomeAddress1 Alphanumeric 60 



O 

HomeAddress2 Alphanumeric 60 



O 

HomeAddress3 Alphanumeric 60 Home contact Address line 3 O 

44




HomeUnit Alphanumeric 15 Home unit number / apartment number O 

HomeBuildingNumbe 

r 

Alphanumeric 10 Home house, or building number O 

HomeStreetName Alphanumeric 30 Home street name O 

HomeStreetType Alphanumeric 15 

Home street tyoe 


Home street direction 

N = North 


E = East 

O 

HomeStreetDirection Alpha 2 SE = SouthEast 

S = South 


W = West 


O 

HomeCity Alphanumeric 60 

Home contact City 


Home contact state code, two-character 

O 

HomeStateCode Alphanumeric 30 






values 

O 

HomeZipCode Alphanumeric 30 

Home contact ZIP / Postal Code 


Home contact ISO Country Code, list will be 


O 

HomeCountryCode Alpha 2 Example “US” 


values 

Home contact Phone Number, only digits, 

O 

PhoneNumber1 Alphanumeric 30 no parentheses 

Example “6188565656” 


O 

PhoneNumber1CountryCo 

de Alpha 2 

Country Code 


values 

O 

PhoneNumber1Extension Alphanumeric 10 

Home contact Phone Extension 



O 

PhoneNumber2 Alphanumeric 30 no parentheses 

Example “6188565656” 


O 

PhoneNumber2CountryCo 

de Alpha 2 

Country Code 


values 

O 

PhoneNumber2Extension Alphanumeric 10 



O 

Email1 Alphanumeric 50 

Additional Email address 


O 




O 




O 

45


ProcessType Numeric 1 

ProcessAction Numeric 1 

REMOTE_ADDR Alphanumeric 100 

HTTP_USER_AGEN 

T 

HTTP_ACCEPT_LA 

NGUAGE 

HTTP_ACCEPT_CH 

ARSET 

46 




HTTP_REFERER Alphanumeric 200 




“2” for “Score transaction, and add to data for 

future scores” 



“0” for Approve 

“1” for Approve, and review 

“2” for Decline, and review 

“3” for Decline 

“4” for Referral 

The process to be applied to the 

transaction. 


Example “207.253.196.193” or 




Customer’s HTTP header 





i.e. ISO-8859-1, *, utf-8 




IsChargeBack Numeric 1 

''1” for "Yes”, “0” for "No", 





O 





Note: Analysis fields will be populated only 

if a score is requested. 

O 

Comments Alphanumeric 200 Comment field for the transactions. O 


StringIn=VersionUsed^3~MerchantId^100000~UserName^dsuser1~UserPassword^*********~TransactionType^DS~Ti 

meOut^10000~MOPêc~TypeofSale^d~AcctNameÂb~AcctNumber^********3253~ExpDate^122008~Amount^161.1~ 

CurrencyId^978~RequestType^p~OrderNumber^0704131611~IsTest^1~DSID^~StoreId^1~MessageCode^2100~Infr 

actionMessageCode^225~InfractionAmount^~TRXDateTime^20070223164000~InfractionDateTime^2007022316400 

0~DOB^23091963~ProcessType^2~Title^Mrs.~Company^Jacomo 

Inc.~FirstName^Suzanne~MiddleName^Lorraine~LastName^Gibson~Suffix^~Address1^145 Des Merisiers 

Street~Address2^~Address3^~City^Vaudreuil-Dorion~StateCode^Quebec~ZipCode^J7V 

9S9~CountryCode^CA~PhoneNumber^4505102197~PhoneExtension^~Email^ds@unknown.ca~PayeeBankNumber 

^123456789~PayeeAccountNumber^1234567~ 

M 

O 

O 

O 

O 

O 

O

STLink will return the following items for a DataShare PayBack with 

Electronic Credit Request (DS)(P) 





TransactionType Alpha 2 Transaction Type, “DS” for DataShare 




specified. 

Example “10098987” 

StrId Numeric N/A Reference Number from STLink 

Reference Number from DataShare system generated with 

Auth response 

DSID Numeric N/A Example “10003606” 

Note: If the version is less than 2.0, PTTID is returned. If not 

PTID is returned. 


DSMessageCode Numeric N/A Note: Please See Appendix A for complete list of Response 

Messages 




Example: 0, 100, 76, -1 

RequestType Alpha 1 ‘P’ PayBack request. 

ShareServiceTRXI 

d1 




ShareServiceTRXI 

d2 










Example: 

“List Of DS 

• AssmtId 

Analysis 


Parameters” 


• …….. 


47 



MerchantId^100000~TransactionType^DS~OrderNumber^0704131611~StrId^100552~DSID^35~DSMessageCode^6100~D 

SMessage^Transaction 

processed~DSScore^0~RequestType^p~ShareServiceTRXId1Ê8CB2DDD976145BBA36262305~ShareServiceTRXId2^47 

23EBA47457421F813C0C867~ShareServiceScore^0 


PaymentTrust Requests 

PaymentTrust Authorization Request (PT)(A) 

PaymentTrust is capable of receiving multiple request types within the PT Transaction Type. Each 

request type instructs the system to perform a different financial transaction. It is important to note that all 

requests types must follow a logical sequence so prior to a Deposit request one must have an 

Authorization request. There are cases where the PT TRX is an independent TRX not requiring any other 

Request type such in the case of a payback TRX or Bank Transfer. Following the submission of a 

request, the system will return an appropriate response code that will flag the transaction as being either 

successful, unsuccessful (with reason) or pending (awaiting third party confirmation). Each numeric 

response code is accompanied by a text definition. 

An Authorization (A) request will reduce the cardholder’s open to buy (credit limit). It places a hold on 

the funds for the merchant with the cardholder’s bank for a limited period of time (defined by the credit 

card associations) before it expires. An authorization does not move any funds to the merchant’s bank 

account. A deposit request type is required to initiate fund collection and is described below. 









M 



PT. 

Example “2” for PT 


M 



M 





M 



M 

TransactionType Alphanumeric 2 Transaction Type, “PT” for PaymentTrust M 





O 



M 

RequestType Alphanumeric 1 ‘A’ Authorization 


M 





O 

48


Account type. 



MOP Alpha 2 




CQ - Cheques 





P2 - Pay 2 

M 




49 

35 












not present) 





Indicates swipe information from the 

Track2data of the Card when the 

TRXSource is 1 (Swiped with a Card 

Present) 

Example: 

“;4459510002561039=09100000000000000000 

?” 


TRXSource =1 or TRXSource = 9 for a 

down graded ICC transaction. 



Example “10098987” 











Identifier. 

Example “4459510002561039” 



O 

O 

O 

O 

M



format 



ExpDate Numeric N/A Example “092010” 

O 



types. 



O 



O 


FXID Numeric N/A 

50 




GBP 


values. 

ID of precalculated Foreign Exchange rate. 

Note: Mandatory for FX transactions 




CurrencyId. 

Example 840 = “56.78”, 392 = “99”, 048 = 

“125.333” 

M 




O 




O 




O 





O 



O 






Note: Required for AVS 


















values 




M 

O 

O 

O 

O 

O 

O






CountryCode Alpha 2 Note: Required for AVS 

O 


51 

values 

PhoneNumber Alphanumeric 30 



Example “6188565656” 

O 




O 




O 




O 




O 




O 





O 




O 




O 




O 




O 




ShipToPhoneNumber Alphanumeric 30 









values 







values 



Example “6188565656” 



O 

O 

O 

O 

O


Security code implemented by card 

schemes. CVV2 for Visa, CVC for 



CVN Numeric N/A 

MasterCard and CID for AMEX are all 

supported. 3 to 4 digit code found on back 

of credit card. 

O 

SVID Numeric N/A 

ECI Numeric 2 

SecureId Alphanumeric 20 

CAV Alphanumeric 50 

CHEnrolled Alpha 1 

TXStatus Alpha 1 

ICCAppVersionNumber Alphanumeric 4 

ICCTerminalCapabilit 

ies 

52 


ICCTerminalCountryCode Alpha 2 

Note: Initiates AVS and security verification. 

Reference Number from 3D Secure system 

generated with Verify Enrollment response. 

Example “10003606” 

Note: If submitted PaymentTrust will 

reference the 3D Secure system to 

determine liability shift. 

Electronic Commerce Indicator as returned 

from the 3D Secure MPI response. 

Note: For 3D Secure enabled transactions 

submit when available. 

The specific transaction identifier that was 

submitted to the MPI during 3D Secure 

authentication. 



Cardholder Authentication Value as 

returned from the 3D Secure MPI response. 



Enrollment status used to determine liability 

shift as returned from the 3D Secure MPI 

response. 



Authentication status used to determine 

liability shift as returned from the 3D Secure 

MPI response. 



Terminal Application Versions Number 

Example “FF1C” 

Note: Mandatory when TRXSource = 9. 

Note: Not required for down graded ICC 

transactions. 

EMV tag 9F 33. 

Example “1C2A6D” 

Note: Mandatory when TRXSource is 9. 


transactions. 

Terminal ISO Country Code 


O 

O 

O 

O 

O 

O 

O 

O 

O


Terminal Verification Result. 



ICCTerminalResult Alphanumeric 10 

A hexadecimal value that indicates the code 

values recording the results of the tests the 

terminal carried out during the EMV 

process. 

Example “1C2E9A6D1F” 



O 

ICCTerminalDatetime Alphanumeric 20 

ICCAppId Alphanumeric 32 

ICCAppUsageControl Alphanumeric 4 

ICCAppProfile Alphanumeric 4 

ICCCryptogramInformation Alphanumeric 2 

ICCCryptogramType Numeric 2 

53 

transactions. 

Date and Time the rate expires 


Example “20050223164000” 

Note: Time is in military format. 



transactions. 

Application Identifier. 

A hexadecimal identifying within the IC, the 

card application provider and the business 

function. 

Example 

“FF1C2DEE3B9A6D1FD1FC2DF1EE3B9A 

6F” 

Application Usage Control. 

A hexadecimal value that indicates the IC 

equivalent of the service code found on 

track 2 of the magnetic stripe. 


Application Interchange Profile. 

A hexadecimal value that specifies the 

application functions that are supported by 

the application in the IC. 




transactions. 

Cryptogram Information Data. 

Indicates the type of cryptogram. 

40 (TC) – Transaction Certificate. 

80 (ARQC) – Authorization Request 

Cryptogram. 




transactions. 

Note: All other values are treated as an 

ARQC request. 

Cryptogram Transaction Type. 

Specifies the types of transactions the IC 

shall perform. 




transactions. 

O 

O 

O 

O 

O 

O




ICCCryptogram Alphanumeric 16 

Cryptogram data as a hexadecimal value. 

Must either be the TC or ARQC pending 

what ICCCryptogramInformation is 

submitted. 

Example “FF1C2DEE3B9A6D1F” 



transactions. 

Application Transaction Counter. 

A hexadecimal value that indicates the 

device for monitoring card usage. 

O 

ICCAppTrxCounter Alphanumeric 4 Example “FF1C” 



transactions. 

Issuer Action Code. 

A hexadecimal value that indicates a series 

of values optionally encoded in an IC that 

O 

ICCIssuerActionCode Alphanumeric 30 

indicates the card issuers preferred actions 

for this transaction. 

Example 

“1C2DEE3B9A6D1FD1FC2DF1EE3B9A2A 

” 

Issuer Application Data. 

A hexadecimal value that indicates 

additional, undefined, data sent by the card 

issuer to enable authentication of the card. 

Example 

O 

ICCIssuerAppData Alphanumeric 64 “FF1C2DEE3B9A6D1FD1FC2DF1EE3B9A 

6F3BFC2DEE3B9A6D1FD1FC2DF1EEA6 

D1” 



transactions. 

The PAN sequence number as provided by 

the IC. 

O 

ICCPANSequenceNu 

mber 

Numeric 2 


Note: Provide if available. 


transactions. 

Transaction Status Information. 

EMV tag 9B. 

O 

ICCTrxStatus Alphanumeric 4 




transactions. 

O 

54


Card Verification Method Type. 

1 - Customer Present, Signature 

2 - Customer Present, PIN 



ICCVerificationType Numeric 1 

3 - Customer Present, Alternate CVM 

4 - Customer Present, UPT, No CVM 

5 - Customer Present, UPT, PIN 

6 - Customer Present, UPT, Alternate 

CVM 

7 - Customer Not Present 

O 

ICCVerificationResult Alphanumeric 6 

ICCUnpredictableNumber Alphanumeric 8 

NarrativeStatement1 Alphanumeric 50 



55 

8 - No Verification 

Card Verification Method Results. 


results of the cardholder verification method 

performed in this transaction. 




transactions. 

Unpredictable Number. 

A hexadecimal value to provide variability 

and uniqueness to the generation of the 

application cryptogram. 

Example “1C2A6D1F” 



transactions. 

Short description appearing on shopper’s 

credit card statement. (Line 1) 

Example “Online clothing store.” 

Note: Size varies depending on financial 

institution. 



Example “Jean pants.” 


institution. 

StringIn=VersionUsed^1~MerchantId^100000~UserName^Mariah~UserPassword^Mariah~TransactionType^ 

PT~IsTest^1~TimeOut^60000~RequestTypeÂ~MOP^CC~AcctNumber^4459510002561039~ExpDate^0920 

10~CurrencyId^840~Amount^56.78 

O 

O 

O 

O

STLink will return the following items for a PaymentTrust 

Authorization Request (PT)(A) 




Example 100000 

TransactionType Alpha 2 Transaction Type, “PT” for PaymentTrust 




specified. 

Example “10098987” 


Reference Number from PaymentTrust system generated 

with Auth response 

PTTID or PTID Numeric N/A Example “10003606” 



Account type. 

CC - Visa & MasterCard debit & credit cards, Carte 

Bancaire, Carte Bleue 


CQ - Cheques 

MOP Alpha 2 





P2 – Pay 2 



CurrencyId Numeric N/A Example 840 = USD, 124 = CAD, 826 = GBP 

Note: Please see Appendix B for complete list of values. 

Transaction amount. Up to 4 decimals maximum. Decimal 

Amount Numeric N/A varies based on CurrencyId. 

Example 840 = “56.78”, 392 = “99”, 048 = “125.333” 

Approved sale and authorization transactions receive a 

AuthCode Alphanumeric 30 

numeric or alphanumeric authorization code referencing the 

transaction for processing purposes. 

Example “P24586DE” 

RequestType Alpha 1 'A' Authorization 

Authorization Response Cryptogram. 

ICCCryptogramRespo 

nse Alphanumeric 32 

A cryptogram generated as hexadecimal value by the card 

issuer in response to an ARQC; used by the card to 

authenticate the card issuer. 

Example “FF1C2DEE3B9A6D1F FF1C2DEE3B9A6D1F” 

Issuer Script Data. 

A hexadecimal value that indicates encrypted commands 

returned by the card issuer to add/amend/delete data in the 

ICCIssuerScript Alphanumeric 256 IC. 

Example 

“FF1C2DEE3B9A6D1FFF1C2DEE3B9A6D1FFF1C2DEE3 

B9A6D1FFF1C2DEE3B9A6D1F” 

Authorising Entity for the transaction 

AuthEntity Alphanumeric N/A 

Possible values: Acquirer, Card acceptor 

56




Note: Please See Appendix C for complete list of Results 

Message Alphanumeric 60 

Note: Please See Appendix C for complete list of Response 

Messages 

Returned when the response is a referral. 

ReferrerCode Numeric 20 Note: When placing a call to the bank this code must be 

presented to the bank representative. 

1 digit code returned when CVN check is requested. 


CVNMessageCo 

de 

Numeric N/A 

0 = Security/Address Matched 

1 = Data not Verified by Bank 

2 = No Data Matched 

3 = Address Match only 

4 =Security Match only 

CVNMessage Alphanumeric 100 Descriptive message of CVNMessageCode 

Reference Number from Foreign Exchange system. 


Example “10003606” 

Note: Only returned when transaction is associated with FX 

transaction. 

The current foreign exchange rate. Decimal length varies. 

FXRate Numeric N/A 

Example “0.84566” 


transaction. 


FXMessageCode Numeric N/A 


transaction. 



FXMessage Alphanumeric 60 

transaction. 


Messages 


MerchantId^100000~TransactionType^PT~OrderNumber^6202021815~StrId^1692784~PTTID^43153506 

~MOP^CC~CurrencyId^840~Amount^56.78~AuthCode^BB71CD~RequestTypeÂ~MessageCode^2100~ 

Message^Transaction Approved 

57

PaymentTrust Forced Authorization Request (PT)(A) 









M 



PT. 



M 



M 





M 



M 


IsTest 

Numeric 

1 




O 



M 

RequestType Alphanumeric 1 ‘A’ Authorization 


M 





Account type. 




CQ - Cheques 

O 

MOP Alpha 2 





P2 – Pay 2 




M 


58 







not present) 





O





Present) 




Example: 

“;4459510002561039=09100000000000000000 

?” 



O 


59 

35 














Example “10098987” 

Note: For Carte Bancaire and Carte Bleue cards 

OrderNumber must reference a previously 

submitted authorization/sale that returned a 

referral response. 











Identifier. 

Example “4459510002561039” 




format 



types. 







GBP 


values. 





CurrencyId. 

Example 840 = “56.78”, 392 = “99”, 048 = 

“125.333” 





O 

O 

M 

O 

O 

O 

M 

O 

M 

O 

O







O 





O 





O 

Address1 Alphanumeric 60 Example “2130 Gold” 


O 




O 

Address3 Alphanumeric 60 Billing contact Address line 3 


O 

City Alphanumeric 60 Example “New York” 


O 





StateCode Alphanumeric 60 this as an Optional field. 




values 


O 

ZipCode Alphanumeric 30 Example “90210” 



O 




values 


O 


Example “6188565656” 

O 




O 




O 




O 




O 




O 





O 




O 




O 




O 

60








O 








values 

O 






O 

ShipToCountryCode Alpha 2 Example “US” 


values 


O 

ShipToPhoneNumber Alphanumeric 30 no parentheses 

Example “6188565656” 

O 




Approved sale and authorization 

transactions receive a numeric or 

alphanumeric authorization code 

referencing the transaction for processing 

O 


purposes. Generated by financial institution 

and given to merchant by phone or other 

method. 


Note: Optional when TRXSource = 9 and 

ICCCryptogramType = 40. 



M 


Example “10003606” 





O 

ECI Numeric 2 






O 

SecureId Alphanumeric 20 authentication. 




O 





O 

61







response. 





O 

TXStatus Alpha 1 MPI response. 





O 

ICCAppVersionNumber Alphanumeric 4 Note: Mandatory when TRXSource = 9. 


transactions. 


O 


ies 





transactions. 

O 








O 

ICCTerminalResult Alphanumeric 10 process. 




transactions. 

O 

ICCTerminalDatetime AlphaNumeri 



c 

20 

Example “20050223164000” 




transactions. 




O 

ICCAppId Alphanumeric 32 function. 

Example 


6F” 



O 

ICCAppUsageControl Alphanumeric 4 equivalent of the service code found on 



O 

62












O 




ICCAppTrxCounter Alphanumeric 4 


63 

transactions. 









transactions. 


ARQC request. 







transactions. 




submitted. 




transactions. 







transactions. 






Example 


” 

O 

O 

O 

O 

O






ICCIssuerAppData Alphanumeric 64 



Example 



D1” 



O 


mber 

64 

Numeric 2 






transactions. 


the IC. 




transactions. 


EMV tag 9B. 




transactions. 








CVM 










transactions. 








transactions. 





institution. 

O 

O 

O 

O 

O 

O









institution. 

O 



PT~IsTest^1~TimeOut^60000~RequestTypeÂ~MOP^CC~AcctNumber^4459510002561039~ExpDate^0920 

10~CurrencyId^840~Amount^56.78~AuthCode^P24586DE 

65

STLink will return the following items for a PaymentTrust Forced 

Authorization Request (PT)(A) 









specified. 

Example “10098987” 







Account type. 




CQ - Cheques 

MOP Alpha 2 





P2 – Pay 2 







Example 840 = “56.78”, 392 = “99”, 048 = “125.333” 

RequestType Alpha 1 'A' Authorization 






Messages 



Example “10003606” 


transaction. 



Example “0.84566” 


transaction. 




transaction. 




transaction. 


Messages 

66



~MOP^CC~CurrencyId^840~Amount^56.78~RequestTypeÂ~MessageCode^2100~Message^Transactio 

n Approved 

PaymentTrust Deposit (Settlement) Request (PT)(D) 

A Deposit request marks a previously authorized transaction for funds collection during the next deposit 

cycle with the financial institution. Merchants who do not ship goods immediately should only perform this 

transaction request at the order fulfillment stage (shipment). 

Important Note: A merchant can only submit one deposit request per authorization and this must be for a 

value lesser or equal to the authorized amount. 

Please also note that this Request Type can also be submitted via Batch. For more on Batch submissions 

please refer to the XML definitions in section 6.3 of this document. 


Must be at beginning of all strings. 




Capitals must be used as shown. 

Note: Not required for XML batch 

requests. 

M 


Version Used specific to Transaction 

Type. Note: Must evaluate to numeric 

value for PT. 



M 



UserName assigned by PaymentTrust 

M 

UserName Alphanumeric 15 Ltd. 


UserPassword assigned by 

M 

UserPassword Alphanumeric 15 PaymentTrust Ltd. 


M 

TransactionType Alphanumeric 2 

Transaction Type, “PT” for 

PaymentTrust 

M 




Indicates the maximum time the 

O 

TimeOut Numeric N/A 

merchant allows for the transaction, in 

milliseconds 


M 

RequestType Alphanumeric 1 ‘D’ Deposit (Settlement). 



M 

OrderNumber Alphanumeric 35 Example “10098987” 

Note: If no order number is submitted the 

system will generate one for the merchant at 

the time of the transaction. 

O 

67






Example 840 = USD, 124 = CAD, 826 

= GBP 

Note: Please see Appendix B for complete 

M 


PTTID or PTID Numeric N/A 




NarrativeStateme 

nt1 


nt2 


68 



list of values. 



CurrencyId. 

Example 840 = “56.78”, 392 = “99”, 

048 = “125.333” 

Reference Number from PaymentTrust 

system generated with Auth response 

Example “10003606” 

Note: If the version is less than 2.0, PTTID 

is required. If not PTID is required. 

Cryptogram data as a hexadecimal 

value. 



Note: Not required for down graded 

ICC transactions. 

Note: Not required if submitted during 

Authorisation request. 



code values recording the results of the 

tests the terminal carried out during the 

EMV process. 






EMV tag 9B. 





Short description appearing on 

shopper’s credit card statement. (Line 

1) 


Note: Size varies depending on 

financial institution. 


shopper’s credit card statement. (Line 

2) 




StringIn=VersionUsed^1~MerchantId^100000~UserName^Mariah~UserPassword^Mariah~TransactionTy 

pe^PT~IsTest^1~TimeOut^60000~RequestType^D~CurrencyId^840~Amount^56.78~PTTID^43153507 

M 

M 

O 

O 

O 

O 

O

STLink will return the following items for a PaymentTrust Deposit 

(Settlement) Request (PT)(D) 









specified. 

Example “10098987” 







Account type. 




CQ - Cheques 

MOP Alpha 2 





P2 – Pay 2 







Example 840 = “56.78”, 392 = “99”, 048 = “125.333” 

RequestType Alpha 1 ‘D’ Deposit (Settlement) 



Note: Please see Appendix C for complete list of Results 


Note: Please see Appendix C for complete list of Response 

Messages 



Example “10003606” 


transaction. 



Example “0. 84566” 


transaction. 




transaction. 




transaction. 


Messages 

69


MerchantId^100000~TransactionType^PT~OrderNumber^9381795632~StrId^1692786~PTTID^43153508~M 

OP^CC~CurrencyId^840~Amount^56.78~RequestType^D~MessageCode^2050~Message^Request pending 

PaymentTrust Refund Request (PT)(R) 

A Refund request returns a specified amount to the cardholder’s account. The following refund is 

submitted where a previous deposit transaction has been processed by the system. 

Important Note: Merchants setup for 2-stage refund can only send this type of refund. Merchants 

processing PC cards cannot use the 2-stage refund. 

Important Note: This Request Type can also be submitted via Batch. For more on Batch submissions 









M 

VersionUsed Alphanumeric 

4 


Note: Must evaluate to numeric value for PT. 



M 



M 





M 



M 


IsTest Numeric N/A 



I Indicates the maximum time the merchant 

O 



M 

RequestType Alphanumeric 1 ‘R’ Refund on a Deposit (Settlement). 



M 


70 



3 - Mail Order Telephone Order MOTO (Card 

Not Present) 



present) 


Note: Defaults to the Merchant default value during 

set-up. 


O






Track2data of the Card when the TRXSource 

is 1 (Swiped with a Card Present) 

Example: 

“;4459510002561039=09100000000000000000?” 



O 






nt1 


nt2 


71 






Example “10098987” 







values. 



CurrencyId. 

Example 840 = “56.78”, 392 = “99”, 048 = 

“125.333” 


system generated with 

Example “10003606” 

Note: If the version is less than 2.0, PTTID is 

required. If not PTID is required. 





institution. 





institution. 


pe^PT~IsTest^1~TimeOut^60000~RequestType^R~CurrencyId^840~Amount^56.78~PTTID^43153507 

STLink will return the following items for a PaymentTrust Refund 

Request (PT)(R) 






O 

M 

M 

M 

O 

O





specified. 

Example “10098987” 


PTTID Numeric N/A 

Reference Number from PT system 

Example “10003606” 

Account type. 




CQ - Cheques 

MOP Alpha 2 





P2 – Pay 2 







Example 840 = “56.78”, 392 = “99”, 048 = “125.333” 

RequestType Alpha 1 ‘R’ Refund on a Deposit (Settlement). 






Messages 



Example “10003606” 


transaction. 



Example “0.84566” 


transaction. 




transaction. 




transaction. 


Messages 



~MOP^CC~CurrencyId^840~Amount^56.78~RequestType^R~MessageCode^2050~Message^Request 

pending 

72

PaymentTrust Forced Refund Request (PT)(R) 








M 

VersionUsed Alphanumeric 

4 


Note: Must evaluate to numeric value for PT. 



M 



M 





M 



M 






O 



M 

RequestType Alphanumeric 1 ‘R’ Refund on a Deposit (Settlement). 


M 





Account type. 




CQ - Cheques 

O 

MOP Alpha 2 





P2 – Pay 2 




M 


73 



3 - Mail Order Telephone Order MOTO (Card 

Not Present) 



present) 


Note: Defaults to the Merchant default value during 

set-up. 


O






Track2data of the Card when the TRXSource 

is 1 (Swiped with a Card Present) 

Example: 

“;4459510002561039=09100000000000000000?” 



O 











nt1 


nt2 

74 






Example “10098987” 











Identifier. 

Example “4459510002561039” 



Expiry date for credit card in MMYYYY format 



types. 








values. 





CurrencyId. 

Example 840 = “56.78”, 392 = “99”, 048 = 

“125.333” 





institution. 





institution. 

O 

O 

M 

O 

O 

O 

M 

O 

M 

O 

O



pe^PT~IsTest^1~TimeOut^60000~RequestType^R~MOP^CC~AcctNumber^4459510002561039~ExpDat 

e^092010~CurrencyId^840~Amount^56.78 

STLink will return the following items for a PaymentTrust Forced 

Refund Request (PT)(R) 









specified. 

Example “10098987” 







Account type. 




CQ - Cheques 

MOP Alpha 2 





P2 – Pay 2 







Example 840 = “56.78”, 392 = “99”, 048 = “125.333” 

RequestType Alpha 1 ‘R’ Refund on a Deposit (Settlement). 






Messages 



Example “10003606” 


transaction. 



Example “0.84566” 


transaction. 

75





transaction. 




transaction. 


Messages 



~MOP^CC~CurrencyId^840~Amount^56.78~RequestType^R~MessageCode^2050~Message^Request 

pending 

PaymentTrust Finalize Request (PT)(F) 

Used to finalize a two-step refund. 








requests. 

M 


Version Used specific to Transaction 

Type. Note: Must evaluate to numeric 

value for PT. 



M 



UserName assigned by PaymentTrust 

M 

UserName Alphanumeric 15 Ltd. 



M 



M 



PaymentTrust 

M 




Indicates the maximum time the 

O 


merchant allows for the transaction, in 

milliseconds 


M 

RequestType Alphanumeric 1 ‘F’ Finalize. 



M 





O 

76







M 

Note: If the version is less than 2.0, PTTID 

is required. If not PTID is required. 



pe^PT~IsTest^1~TimeOut^60000~RequestType^F~PTTID^43153542 

STLink will return the following items for a PaymentTrust Finalize 

Request (PT)(F) 









specified. 

Example “10098987” 







Account type. 




CQ - Cheques 

MOP Alpha 2 





P2 – Pay 2 







Example 840 = “56.78”, 392 = “99”, 048 = “125.333” 

RequestType Alpha 1 ‘F’ Finalize 






Messages 

77




Example “10003606” 


transaction. 



Example “0.84566” 


transaction. 




transaction. 




transaction. 


Messages 



OP^CC~CurrencyId^840~Amount^56.78~RequestType^F~MessageCode^2100~Message^Transaction 

Approved 

PaymentTrust Simultaneous Authorization and Settlement (Sale) 

Request (PT)(S) 

A Simultaneous Authorization and Deposit (Sale) charges the specified amount against the cardholder’s 

account and marks the transaction for funds collection during the next deposit cycle with the financial 

institution. This single request initiates both an authorization and a deposit request in the PT system. It 

should only be used in situations where merchants fulfill their orders immediately. The deposit portion of 

the ‘S’ request will only proceed once a successful authorization has been obtained. 

Important Note: Once a merchant submits a ‘D’ or an ‘S’ request, funds will be transferred provided an 

authorization code is obtained and still valid. 









M 



PT. 



M 



M 





M 



M 


78




IsTest 

Numeric 

1 



O 



allows for the transaction, in milliseconds 


M 


‘S’ Sale or Simultaneous Authorization and 

Deposit. 


M 





Account type. 




CQ - Cheques 

O 

MOP Alpha 2 





P2 – Pay 2 




M 




79 







not present) 








Present) 

Example: 

“;4459510002561039=09100000000000000000 

?” 






Example “10098987” 




O 

O 

O




AcctPIN Alphanumeric 10 

DirectAcceptNumber Numeric N/A 






80 








Identifier. 

Example “4459510002561039” 



If the AcctNumber requires a PIN this field is 

used for Submission. In the Case of Pay2 

and Neteller these are the pass codes or 

pass ids of the Consumer. 

Example “Xd393” 

Note: This field is mandatory when MOP is 

P2 or NT. 

Last 4 digits of customer’s account number. 

Used for Neteller Direct Accept 

transactions. 


format 



types. 







GBP 


values. 








CurrencyId. 

Example 840 = “56.78”, 392 = “99”, 048 = 

“125.333” 

M 




O 




O 




O 




O 





O 

M 

O 

O 

O 

O 

O 

M 

O 

O







O 




O 



O 



O 









values 


O 




O 




values 


O 


Example “6188565656” 

O 




O 




O 




O 




O 




O 





O 




O 




O 




O 





O 

81











values 

O 






O 



values 


O 


Example “6188565656” 

O 




Security code implemented by card 

schemes. CVV2 for Visa, CVC for 

O 

CVN Numeric N/A 

MasterCard and CID for AMEX are all 

supported. 3 to 4 digit code found on back 

of credit card. 

Note: Initiates AVS and security verification. 



O 


Example “10003606” 





O 

ECI Numeric 2 






O 





O 







O 

CHEnrolled Alpha 1 response. 





O 

TXStatus Alpha 1 MPI response. 



O 

82









institution. 



O 

NarrativeStatement2 Alphanumeric 50 Example “Jean pants.” 


institution. 

O 

83



pe^PT~IsTest^1~TimeOut^60000~RequestType^S~MOP^CC~AcctNumber^4459510002561039~ExpDat 

e^092010~CurrencyId^840~Amount^56.78 


Simultaneous 

Authorization and Settlement (Sale) Request (PT)(S) 









specified. 

Example “10098987” 







Account type. 




CQ - Cheques 

MOP Alpha 2 





P2 – Pay 2 







Example 840 = “56.78”, 392 = “99”, 048 = “125.333” 






RequestType Alpha 1 ‘S’ Sale or Simultaneous Authorization and Deposit. 






Messages 

Returned when the response is a referral. 

ReferrerCode Numeric 20 Note: When placing a call to the bank this code must be 

presented to the bank representative. 

84


CVNMessageCo 

de 

85 

Numeric N/A 







4 =Security Match only 

CVNMessage Alphanumeric 100 Descriptive message of CVNMessageCode 







Example “10003606” 


transaction. 


Example “0.84566” 


transaction. 



transaction. 



transaction. 


Messages 


~MOP^CC~CurrencyId^840~Amount^56.78~AuthCode^B78F61~RequestType^S~MessageCode^2100~ 

Message^Transaction Approved 

PaymentTrust Simultaneous Forced Authorization and Settlement 

(Sale) Request (PT)(S) 









M 



PT. 



M 



M 





M 



M 

TransactionType Alphanumeric 2 Transaction Type, “PT” for PaymentTrust M




IsTest 

Numeric 

1 



O 



allows for the transaction, in milliseconds 


M 


‘S’ Sale or Simultaneous Authorization and 

Deposit. 


M 





Account type. 




CQ - Cheques 

O 

MOP Alpha 2 





P2 – Pay 2 




M 



86 







not present) 








Present) 

Example: 

“;4459510002561039=09100000000000000000 

?” 




O 

O




Example “10098987” 




35 

Note: For Carte Bancaire and Carte Bleue cards 

OrderNumber must reference a previously 

submitted authorization/sale that returned a 

referral response. 



O 








87 









Identifier. 

Example “4459510002561039” 




format 



types. 







GBP 


values. 






CurrencyId. 

Example 840 = “56.78”, 392 = “99”, 048 = 

“125.333” 

M 




O 




O 




O 




O 





O 

M 

O 

O 

O 

M 

O 

O







O 




O 



O 



O 









values 


O 




O 




values 


O 


Example “6188565656” 

O 




O 




O 




O 




O 




O 





O 




O 




O 




O 





O 

88











values 

O 






O 



values 


O 


Example “6188565656” 

O 




Approved sale and authorization 

transactions receive a numeric or 

alphanumeric authorization code 

referencing the transaction for processing 

O 


purposes. Generated by financial institution 

and given to merchant by phone or other 

method. 


Note: Not required when TRXSource = 9 

and ICCCryptogramType = 40. 



M 


Example “10003606” 





O 

ECI Numeric 2 






O 





O 







O 

CHEnrolled Alpha 1 response. 



O 

89







MPI response. 


O 

ICCAppVersionNumber Alphanumeric 4 


ies 

90 




ICCTerminalDatetime AlphaNumeri 

c 

20 

ICCAppId Alphanumeric 32 

ICCAppUsageControl Alphanumeric 4 







transactions. 





transactions. 







process. 




transactions. 



Example “20050223164000” 




transactions. 




function. 

Example 


6F” 



equivalent of the service code found on 










transactions. 

O 

O 

O 

O 

O 

O 

O 

O





ICCAppTrxCounter Alphanumeric 4 


ICCIssuerAppData Alphanumeric 64 

91 









transactions. 


ARQC request. 







transactions. 




submitted. 




transactions. 







transactions. 






Example 


” 





Example 



D1” 



transactions. 



O 

O 

O 

O 

O 

O





mber 

Numeric 2 


the IC. 




transactions. 


EMV tag 9B. 

O 





transactions. 





O 





CVM 






O 






transactions. 




O 






transactions. 



O 

NarrativeStatement1 Alphanumeric 50 Example “Online clothing store.” 


institution. 



O 

NarrativeStatement2 Alphanumeric 50 Example “Jean pants.” 


institution. 

O 

92



pe^PT~IsTest^1~TimeOut^60000~RequestType^S~MOP^CC~AcctNumber^4459510002561039~ExpDat 

e^092010~CurrencyId^840~Amount^56.78~AuthCode^P24586DE 


Simultaneous 

Forced Authorization and Settlement (Sale) Request (PT)(S) 









specified. 

Example “10098987” 





Note: If the version is less than 2.0, PTTID is returned. If 

not PTID is returned. 

Account type. 




CQ - Cheques 

MOP Alpha 2 





P2 – Pay 2 







Example 840 = “56.78”, 392 = “99”, 048 = “125.333” 







Messages 



Example “10003606” 

Note: Only returned when transaction is associated with 

FX transaction. 

93




Example “0.84566” 












Messages 



~MOP^CC~CurrencyId^840~Amount^56.78~RequestType^S~MessageCode^2100~Message^Transactio 

n Approved 

PaymentTrust Cancellation Request (PT)(C) 

A Cancellation request prevents a previously authorized transaction from being deposited. A merchant 

can cancel all or part of an authorized amount within the PT system. 









M 

VersionUsed Alphanumeric 4 Note: Must evaluate to numeric value for PT. 



M 



M 





M 



M 






O 



M 


‘C’ Cancellation (Reversal) of part or whole of 

an Authorization. 

M 

94







Example “10098987” 


O 




95 




Example “10003606” 

Note: If the version is less than 2.0, PTTID is 

required. If not PTID is required. 


pe^PT~IsTest^1~TimeOut^60000~RequestType^C~PTTID^43153548 


Cancellation Request (PT)(C) 









specified. 

Example “10098987” 







Account type. 




CQ - Cheques 

MOP Alpha 2 





P2 – Pay 2 







Example 840 = “56.78”, 392 = “99”, 048 = “125.333” 

M







Note : Only returned when cancelling an ICC authorisation 

that went online. 

RequestType Alpha 1 ‘C’ Void (Reversal) of the whole amount for an Authorization. 






Messages 



Example “10003606” 


transaction. 



Example “0.84566” 


transaction. 




transaction. 




transaction. 


Messages 



OP^CC~CurrencyId^840~Amount^56.78~RequestType^C~MessageCode^2170~Message^Transaction 

cancelled successfully 

PaymentTrust PayBack to Credit Card Request (PT)(P) 

A PayBack request will initiate a payment from the merchant’s account against the cardholders credit 

card account. This is similar to an Electronic Funds Transfer and varies from country to country. 

Please also note that this Request Type can also be submitted via Batch. For more on Batch submissions 










M 



PT. 


M 

96







M 





M 



M 


IsTest 

Numeric 

1 




O 



‘P’ PayBack request. 

M 

RequestType Alphanumeric 1 Note: This is dependant from country to 

country. I.e. UK will use the BACS system. 


M 





Account type. 




CQ - Cheques 

O 

MOP Alpha 2 





P2 – Pay 2 




M 


97 







not present) 





O





Present) 




Example: 

“;4459510002561039=09100000000000000000 

?” 



O 


98 

35 








Example “10098987” 











Identifier. 

Example “4459510002561039” 




format 



types. 



GBP 


values. 




CurrencyId. 

Example 840 = “56.78”, 392 = “99”, 048 = 

“125.333” 

M 




O 




O 




O 




O 





O 

O 

M 

O 

M 

O







O 




O 



O 



O 









values 


O 




O 




values 


O 


Example “6188565656” 

O 




O 




O 



PT~IsTest^1~TimeOut^60000~RequestType^P~MOP^CC~AcctNumber^4459510002561039~ExpDate^0920 

10~CurrencyId^840~Amount^56.78 

99

STLink will return the following items for a PaymentTrust PayBack to 

Credit Card Request (PT)(P) 









specified. 

Example “10098987” 







Account type. 




CQ - Cheques 

MOP Alpha 2 





P2 – Pay 2 







Example 840 = “56.78”, 392 = “99”, 048 = “125.333” 

‘P’ PayBack request. 

RequestType Alpha 1 Note: This is dependant from country to country. I.e. UK will 

use the BACS system. 






Messages 



OP^CC~CurrencyId^840~Amount^56.78~RequestType^P~MessageCode^2050~Message^Request Pending 

100

PaymentTrust PayBack with Cheque Request (PT)(P) 









M 



PT. 



M 



M 





M 



M 


IsTest 

Numeric 

1 




O 



M 



M 





Account type. 




CQ - Cheques 

O 

MOP Alpha 2 





P2 – Pay 2 

Example: “CQ” 


M 



35 Example “10098987” 






O 



values. 

M 

101







M 


Example 840 = “56.78”, 392 = “99”, 048 = 

“125.333” 



M 



M 







PaymentReference Alphanumeric 60 

ShippingMethod Alphanumeric 20 




102 
















Note: 25 characters long, when MOP is CQ. 



values 








values 




empty string. 

Note: For EC TRXs only the first 10 

characters will be used based on the 

requirements of the international banking 

system 

The type of service to be used when 

delivering the physical cheques. 

Example “Mail” 

Note: If not submitted the default value in 

the merchant setup is used. 



Example “6188565656” 





M 

O 

M 

M 

O 

M 

O 

O 

O 

O 

O



pe^PT~IsTest^1~TimeOut^60000~RequestType^P~MOP^CQ~CurrencyId^840~Amount^56.78~FirstNam 

e^John~LastName^Smith~Address1^2130 Gold~City^New 

York~StateCode^NY~ZipCode^90210~CountryCodeÛS 

STLink will return the following items for a PaymentTrust PayBack 

with Cheque Request (PT)(P) 









specified. 

Example “10098987” 







Account type. 




CQ - Cheques 

MOP Alpha 2 





P2 – Pay 2 

Example: “CQ” 






Example 840 = “56.78”, 392 = “99”, 048 = “125.333” 







Messages 



~MOP^CQ~CurrencyId^840~Amount^56.78~RequestType^P~MessageCode^2050~Message^Request 

Pending 

103

PaymentTrust PayBack with Electronic Credit Request (PT)(P) 









M 



PT. 



M 



M 





M 



M 






O 



M 



M 





Account type. 




CQ - Cheques 

O 

MOP Alpha 2 





P2 – Pay 2 



M 



35 Example “10098987” 






O 



values. 

M 

104







M 

Example 840 = “56.78”, 392 = “99”, 048 = 

FirstName Alphanumeric 

LastName Alphanumeric 

PayeeBankNumber Numeric 

105 

See 

Description 

See 

Description 

See 

Description 

IBAN Alphanumeric 35 

“125.333” 



Note: Size is calculated by adding 

FirstName and LastName including one 

space character. CountryCode maximum 

length: 

AU – 26 

CA – 22 

DE – 26 

GB – 17 

HK – 26 

NL – 34 

SG – 26 

US – 21 



Note: See FirstName. 


transferred. 

Note: Number of digits allowed per 

CountryCode: 

AU – 6 

CA – 6 

DE – 8 

GB – 6 

HK – 7 

NL – N/A 

SG – 7 

US – 9 

Note: If IBAN is not present; 

PayeeBankNumber is not required for 

CountryCode “NL” (Netherlands) 

Note: Data Type changes to alphanumeric 

and Data Size changes to 12 when 

CurrencyId is 978 (EUR). 


Code and Bank Account Number. 

Example: “fr1234567890” 


Note: Mandatory when CurrencyId is 978 

(EUR). 

M 

M 

M 

O




PayeeAccountNumbe 

r 

Numeric 

See 

Description 


transferred. 

Note: Number of digits allowed per 

CountryCode: 

AU – 9 

CA – 8 

DE – 10 

GB – 8 

HK – 9 

NL – 10 

SG – 9 

US – 17 

Note: Optional when CurrencyId is 978 

(EUR). 




M 

PaymentREF Alphanumeric 60 

empty string. 

Note: For EC TRXs only the first 10 

characters will be used based on the 

requirements of the international banking 

system 



O 

City Alphanumeric 60 Note: For CountryCode “NL” (Netherlands) 

If IBAN is not present; City is mandatory 

and size of 35. 


O 




values 


O 


Example “6188565656” 

O 




O 




O 



pe^PT~IsTest^1~TimeOut^60000~RequestType^P~MOPÊC~CurrencyId^840~Amount^56.78~FirstNam 

e^John~LastName^Smith~PayeeBankNumber^123456789~PayeeAccountNumber^1234567890 

106

STLink will return the following items for a PaymentTrust PayBack 

with Electronic Credit Request (PT)(P) 









specified. 

Example “10098987” 







Account type. 




CQ - Cheques 

MOP Alpha 2 





P2 – Pay 2 







Example 840 = “56.78”, 392 = “99”, 048 = “125.333” 







Messages 



~MOPÊC~CurrencyId^840~Amount^56.78~RequestType^P~MessageCode^2050~Message^Request 

Pending 

107

PaymentTrust Bank Transfer ID (BTS) Request (PT)(B) 









M 



PT. 



M 



M 





M 



M 


IsTest 

Numeric 

1 




O 



M 

RequestType Alphanumeric 1 ‘B’ Bank Transfer request. 


M 



35 Example “10098987” 






O 



values. 

Standard 2 letter Country Code 

Example UK = United Kingdom US = 

O 

CountryCode Alpha 2 United States, CA = Canada 

Note: Please see Appendix D for complete 

list of values. 

O 



pe^PT~IsTest^1~TimeOut^60000~RequestType^B 

108

STLink will return the following items for a PaymentTrust Bank 

Transfer ID Request (PT)(B) 









specified. 

Example “10098987” 


BTID Alphanumeric 12 Unique ID generated by PaymentTrust. 

RequestType Alphanumeric 1 ‘B’ Bank Transfer request. 

AccountNo Alphanumeric 50 

Merchant’s bank account number for specified currency. 

Note: Only returned if CurrencyId was submitted. 

BankAddress Alphanumeric 200 

Address of merchant’s bank. 



Example 840 - USD, 124 – CAD, 

CurrencyId Numeric N/A 826 – GBP 

Note: Please See Appendix B for complete list of values 





Note: A MessageCode will be returned only if an error 

occurred while processing the BTID request. 



Messages 

Note: A Message will be returned only if an error occurred 

while processing the BTID request. 


MerchantId^100000~TransactionType^PT~OrderNumber^4034618738~StrId^1692839~BTID^105684139 

7 

109

PaymentTrust Deposit (Settlement) Request (PT)(D) for PURCHASING 

CARDS (VISA, AMEX, MASTER CARD) 

As noted before a Deposit request marks a previously authorized transaction for funds collection during 

the next deposit cycle with the financial institution. Under the Deposit request for Purchasing Cards 

Merchants are also required to include certain Tax and line item information on a per Transaction basis. 

All these Transactions along with the line details can be placed in a single XML request. 

Important Note: A merchant can only submit one deposit request per authorization and this must be for a 

value lesser or equal to the authorized amount. 

Please also note that this Request Type when used with Purchasing Cards can only be submitted via 

Batch. In the same batch Refund (R) requests may also be placed. For more on Batch submissions 


VI = Visa, AX = Amex, MC = Master Card, O = Optional Fields, M = Mandatory Fields 



VI AX MC 




requests. 

Version Used specific to 

M M M 

VersionUsed Alphanumeric 4 Transaction Type 


Permanent Merchant ID assigned 

M M M 

MerchantId Numeric N/A by PaymentTrust Ltd. 


UserName assigned by 

M M M 

UserName Alphanumeric 15 PaymentTrust Ltd. 



M M M 



M M M 



PaymentTrust 

M M M 




O O O 


‘D’ Deposit (Settlement). Specific 

for PT Only 

Indicates the method used to 

receive the CreditCard information. 

M M M 


110 


2 - Keyed by merchant with a Card 

present 

3 - Mail Order Telephone Order 

MOTO (Card Not Present) 

4 - Web orders (Card not 

present) 

5 – Web orders (Card not present, 

e-mail not present) 


Note: Defaults to the Merchant default 

value during set-up. 


O O O




TRXSource is 1 (Swiped with a 

Card Present) 

Example: 

VI AX MC 

Track2Data Alphanumeric 100 “;4459510002561039=0910000000000 

0000000?” 

Note: This becomes a mandatory 

field when TRXSource =1 or 

TRXSource = 9 for a down graded 

ICC transaction. 

Specific Order number submitted by 

the Merchant for tracking purposes. 

Example “10098987” 

O O O 

OrderNumber Alphanumeric 35 Note: If no order number is 

submitted the system will generate 

one for the merchant at the time of 


Specific Order Reference number 

O O O 

OrderReference Alphanumeric 20 

submitted by the Merchant for 

tracking purposes. 

Example “E1009887BTHJ” 

The order Date in the format 

O O O 

OrderDate Numeric 8 DDMMYYYY. 

Example “27032001” 


Example 840 = USD, 124 = CAD, 

M M M 

CurrencyId Numeric N/A 826 = GBP 

Note: Please see Appendix B for 

complete list of values. 

Transaction amount. Up to 4 

decimals maximum. Decimal varies 

M M M 

Amount Numeric N/A based on CurrencyId. 

Example 840 = “56.78”, 392 = 

“99”, 048 = “125.333” 

Reference Number from 

PaymentTrust system generated 


M M M 


Note: If the version is less than 2.0, 

PTTID is required. If not PTID is 

required. 

Invoice number submitted by the 

M M M 

InvoiceNumber Alphanumeric 12 Merchant for tracking purposes. 

Example “3465456” 

The customer’s number within the 

O O O 

CustomerNumber Alphanumeric 12 merchant’s system. 

Example “46094586” 

This field is used to store additional 

O O O 

CustomerReference1 Alphanumeric 20 customer reference numbers. 

Example “3465456” 


N/A O N/A 


Example “3465456” 

O O O 

111



VI AX MC 


Example “3465456” 

O O O 

MerchantVATNumber Alphanumeric 20 

This is the Merchant’s VAT number. 

Example “XTY99BN3465456” 

This is the Customer’s VAT 

number. 

M M M 

CustomerVATNumber Alphanumeric 20 Example “XTY99BN3465456” 

Note: Mandatory only for crossborder 

transactions. 

The total discount amount of all line 

items. Up to 4 decimals maximum. 

Decimal varies based on 

O O O 

TotalDiscountAmount Numeric N/A CurrencyId. 

Example 840 - $USD “56.78”, 392 

- $JPY “99”, 048 - $BHD 

“125.333” 

VAT Rate for freight/shipping 

O O O 

ShippingVATRate Numeric N/A amount. Up to 2 decimals. 

Example “3.40” 

Total amount for shipping line 



O O N/A 

TotalShippingAmount Numeric N/A CurrencyId. 

Example 840 - $USD “56.78”, 392 

- $JPY “99”, 048 - $BHD 

“125.333” 

The total tax amount of all line 



O O O 

TotalTAXAmount Numeric N/A CurrencyId. 

Example 840 - $USD “56.78”, 392 

- $JPY “99”, 048 - $BHD 

“125.333” 

M O M 




O O O 




O O O 




O O O 

MiddleName Alphanumeric 60 Billing contact Middle Name O O O 




O O O 





O O O 



O O O 




O O O 



O O O 



O O O 

112


The billing information state based 

on the two-character long ISO 

codes. This is a mandatory field for 

North America only. The remaining 

VI AX MC 


world regions /Provinces may use 




Note: Please See Appendix E for 

complete list of values 


O O O 




O O O 



Note: Please See Appendix D for 


Billing contact Phone Number, only 

O O O 

PhoneNumber Alphanumeric 30 digits, no parentheses 

Example “6188565656” 

O O O 




O O O 




O O O 




O O O 




O O O 




O O O 

ShipToMiddleName Alphanumeric 60 Ship to contact Middle Name O O O 




O O O 




O O O 




O O O 




O O O 

ShipToAddress3 Alphanumeric 60 Ship to contact Address line 3 O O O 




Ship to contact state code, twocharacter 

long ISO code required 

for North America. Remaining 

O O O 


Region and Provinces may use free 

form field or leave it blank. 




O O O 




O O O 

113

Field Name Data Type Data Size Description VI AX MC 

ShipToCountryCod 

e 


er 

ShipToPhoneExtensi 

on 

114 

Alpha 2 



ShipFromAddress1 Alphanumeric 60 



ShipFromCity Alphanumeric 60 

ShipFromStateCode Alphanumeric 30 

ShipFromZipCode Alphanumeric 30 

ShipFromCountryCode Alpha 2 

ShipFromPhoneNumber Numeric 30 

CommodityCode Alphanumeric 10 

ProductCode Alphanumeric 30 

ProductDescription Alphanumeric 50 

UnitOfMeasure Alphanumeric 12 

UnitCost Numeric N/A 

Ship to contact ISO Country Code, 

list will be provided by 

PaymentTrust Ltd. 




Ship to contact Phone Number, only 


Example “6188565656” 



Ship from contact Address line 1. 


Ship from contact Address line 2 



Example “ BLK 56” 

Ship from contact City 


Ship from contact state code, twocharacter 



Regions and Provinces may use 





Ship from contact ZIP / Postal Code 


Ship from contact ISO Country 

Code. 




Ship from contact Phone Number, 

only digits, no parentheses or 

dashes. 

Example “6188565656” 

The commodity code that the 

product is associated with. 


Note: Please See Appendix F for 


The code of the product. 

Example “ZZZ90210” 

The Description of the product. 

Example “ACME Super Glue” 

The unit of measure used to price 

this specific product. 

Example “Kgs” 

Amount of individual unit. Up to 4 


based on CurrencyId. 

Example 840 - $USD “56.78”, 392 

- $JPY “99”, 048 - $BHD 

“125.333” 

O O O 

O O O 

O O O 

O M O 

O O O 

O O O 

O M O 

O O O 

O M O 

O M O 

O O O 

M O M 

O O N/A 

M M M 

M M M 

M M M


The Quantity sold. Up to 4 decimals 

VI AX MC 

Quantity Numeric N/A maximum. 


The TAX rate charged. Must be 

recognized/valid value for target 

M M M 

VATRate Numeric N/A financial institution. Up to 2 

decimals maximum. 


Discount amount of individual line 

item. Up to 4 decimals maximum. 

M O M 

LineItemDiscountA 

mount 

Numeric N/A 


CurrencyId. 

Example 840 - $USD “56.78”, 392 

- $JPY “99”, 048 - $BHD 

“125.333” 

Amount of line item. Up to 4 


O O O 

LineItemNetAmoun 

t 

Numeric N/A 


Example 840 - $USD “56.78”, 392 

- $JPY “99”, 048 - $BHD 

“125.333” 

Tax amount of line item. Up to 4 


M M M 

LineItemTAXAmount Numeric N/A 


Example 840 - $USD “56.78”, 392 

- $JPY “99”, 048 - $BHD 

“125.333” 

Cryptogram data as a hexadecimal 

value. 


Note: Mandatory when TRXSource 

M M M 

ICCCryptogram Alphanumeric 16 = 9. 



Note: Not required if submitted 

during Authorisation request. 


shopper’s credit card statement. 

O O O 

NarrativeStatement 

1 


(Line 1) 






O O O 


2 


(Line 2) 




O O O 

115

STLink will return the following items for a PaymentTrust Deposit 

(Settlement) Request (PT)(D) for PURCHASING CARDS 









specified. 

Example “10098987” 












Example 840 = “56.78”, 392 = “99”, 048 = “125.333” 

Account type. 




CQ - Cheques 

MOP Alpha 2 





P2 – Pay 2 

Example: “PC” 

RequestType Alpha 1 ‘D’ Deposit (Settlement) 






Messages 

116


Request (PT)(S) for PURCHASING CARDS (VISA, AMEX, MASTER 

CARD) 




VI AX MC 




requests. 


M M M 




M M M 




M M M 




M M M 



M M M 



PaymentTrust 

M M M 




O O O 


‘S’ Sale or Simultaneous 

Authorization and Deposit. 

For use to differentiate between 

Stores. Permanent Store ID 

M M M 

StoreID Alphanumeric 10 assigned by PaymentTrust Ltd. or 

Merchant if left blank 


Account type. 

CC - Visa & MasterCard debit & 

credit cards, Carte Bancaire, 

Carte Bleue 


CQ - Cheques 

O O O 

MOP Alpha 2 

EC - Electronic cheques or 

credit 

DC - Debit Card PIN enabled 

cards 



P2 – Pay 2 


M M M 

117




VI AX MC 









118 



present 




present) 










Card Present) 

Example: 

“;4459510002561039=0910000000000 

0000000?” 


field when TRXSource = 1 



Example “10098987” 

Note: If no order number is submitted 

the system will generate one for the 

merchant at the time of the transaction. 

Account holder name on card or 

account 


Credit card number, Debit Card 

number, Purchase Card number, 

Bank account number, or any other 

applicable Bank Identifier. 

Example “4459510002561039” 

Note: This field is not required 

when TRXSource is 1 

Expiry date for credit card in 

MMYYYY format 


Note: Mandatory for CC, PC and 

DS MOP types. 



826 = GBP 






Example 840 = “56.78”, 392 = 

“99”, 048 = “125.333” 

O O O 

O M O 

O M O 

O O O 

M O M 

O O O 

M M M 

M M M



VI AX MC 


Example “3465456” 


N/A O N/A 


Example “3465456” 


O O O 


Example “3465456” 

O O O 





number. 

M M M 



transactions. 




O O O 


Example 840 - $USD “56.78”, 392 

- $JPY “99”, 048 - $BHD 

“125.333” 


O O O 






O O N/A 


Example 840 - $USD “56.78”, 392 

- $JPY “99”, 048 - $BHD 

“125.333” 




O O O 


Example 840 - $USD “56.78”, 392 

- $JPY “99”, 048 - $BHD 

“125.333” 

M O M 




O O O 




O O O 




O O O 





O O O 





O O O 



O O O 




O O O 

119




O O O 







O O O 

StateCode Alphanumeric 60 world regions /Provinces may use 







O O O 




O O O 






O O O 


Example “6188565656” 

O O O 




O O O 




O O O 




O O O 




O O O 




O O O 





O O O 




O O O 




O O O 




O O O 








O O O 







O O O 

120







O O O 


e 

Alpha 2 

PaymentTrust Ltd. 




O O O 


er 




EXAMPLE “6188565656” 

O O O 


on 




O O O 




O M O 




O O O 




O O O 







O M O 







O O O 





Code. 

O M O 

ShipFromCountryCode Alpha 2 Example “US” 




O M O 



dashes. 

Example “6188565656” 



O O O 

CommodityCode Alphanumeric 10 Example “6400” 



M O M 




O O O 





M M M 

UnitOfMeasure Alphanumeric 12 this specific product. 


M M M 

121




VI AX MC 



Example 840 - $USD “56.78”, 392 

- $JPY “99”, 048 - $BHD 

“125.333” 


M M M 





M M M 






M O M 


mount 

Numeric N/A 


CurrencyId. 

Example 840 - $USD “56.78”, 392 

- $JPY “99”, 048 - $BHD 

“125.333” 



O O O 


t 

Numeric N/A 


Example 840 - $USD “56.78”, 392 

- $JPY “99”, 048 - $BHD 

“125.333” 



M M M 



Example 840 - $USD “56.78”, 392 

- $JPY “99”, 048 - $BHD 

“125.333” 

Reference Number from 3D Secure 

system generated with Verify 

Enrollment response. 

M M M 

SVID Numeric N/A Example “10003606” 

Note: If submitted PaymentTrust 

will reference the 3D Secure system 

to determine liability shift. 

Electronic Commerce Indicator as 

returned from the 3D Secure MPI 

O N/A O 

ECI Numeric 2 response. 

Note: For 3D Secure enabled 

transactions submit when available. 

The specific transaction identifier 

that was submitted to the MPI 

O N/A O 

SecureId Alphanumeric 20 during 3D Secure authentication. 




returned from the 3D Secure MPI 

O N/A O 

CAV Alphanumeric 50 response. 



O N/A O 

122


Enrollment status used to determine 

liability shift as returned from the 3D 

VI AX MC 

CHEnrolled Alpha 1 Secure MPI response. 



Authentication status used to 

determine liability shift as returned 

O N/A O 

TXStatus Alpha 1 from the 3D Secure MPI response. 





O N/A O 


1 


(Line 1) 






O O O 


2 


(Line 2) 




O O O 


Simultaneous Authorization and Settlement (Sale) Request (PT)(S) for 

PURCHASING CARDS 









specified. 

Example “10098987” 







Account type. 




CQ - Cheques 

MOP Alpha 2 





P2 – Pay 2 


123







Example 840 = “56.78”, 392 = “99”, 048 = “125.333” 







Messages 

124

PaymentTrust Refund Request (PT)(R) for PURCHASING CARDS 

(VISA, AMEX, MASTER CARD) 

As noted before a Refund request marks a previously authorized and settled transaction for return of 

funds to the purchaser’s account. The amount refunded can be the whole order amount or a less than the 

total. 

Important Note: A merchant cannot issue a refund in excess of the total amount deposited for an order 

and must include the line items details as with a deposit (Settlement). 

Under the Refund request for Purchasing Cards Merchants are also required to include certain Tax and 

line item information on a per Transaction basis. All these Transactions along with the line details can be 

placed in a single XML request. 

Please note that this Request Type when used with Purchasing Cards can only be submitted via Batch. In 

the same batch, Refund (R) requests may also be placed along side Deposit request. As long as 

Deposits of the same day are not refunded in the same batch file. For more on Batch submissions please 

refer to the XML definitions in section 6.3 of this document. 




VI AX MC 




requests. 


M M M 




M M M 




M M M 




M M M 



M M M 



PaymentTrust 

M M M 




O O O 

RequestType Alphanumeric 1 ‘R’ Refund. M M M 

125




VI AX MC 




OrderReference Alphanumeric 20 

OrderDate Numeric 8 



126 



present 




present) 










Card Present) 

Example: 

“;4459510002561039=0910000000000 

0000000?” 


field when TRXSource =1 or 

TRXSource = 9 for a down graded 

ICC transaction. 



Example “10098987” 

Note: If no order number is 

submitted the system will generate 

one for the merchant at the time of 


Specific Order Reference number 

submitted by the Merchant for 

tracking purposes. 

Example “E1009887BTHJ” 

The order Date in the format 

DDMMYYYY. 

Example “27032001” 



826 = GBP 






Example 840 = “56.78”, 392 = 

“99”, 048 = “125.333” 

O O O 

O O O 

O O O 

O O O 

M M M 

M M M 

M M M


Reference Number from 

PaymentTrust system generated 

VI AX MC 



Note: If the version is less than 2.0, 

PTTID is required. If not PTID is 

required. 


M M M 

InvoiceNumber Alphanumeric 12 Merchant for tracking purposes. 

Example “3465456” 


O O O 

OriginalInvoiceNumber Alphanumeric 15 Merchant during deposit. 

Example “3465456” 

The customer’s number within the 

M M M 

CustomerNumber Alphanumeric 12 merchant’s system. 

Example “46094586” 


O O O 


Example “3465456” 


N/A O N/A 


Example “3465456” 


O O O 


Example “3465456” 

O O O 





number. 

M M O 



transactions. 




O O O 


Example 840 - $USD “56.78”, 392 

- $JPY “99”, 048 - $BHD 

“125.333” 


O O O 






O O N/A 


Example 840 - $USD “56.78”, 392 

- $JPY “99”, 048 - $BHD 

“125.333” 




O O O 


Example 840 - $USD “56.78”, 392 

- $JPY “99”, 048 - $BHD 

“125.333” 

M O M 

127





O O O 




O O O 




O O O 





O O O 





O O N/A 



O O O 




O O O 



O O O 







O O O 


world regions /Provinces may use 







O O O 




O O O 






O O O 


Example “6188565656” 

O O O 




O O O 




O O O 




O O O 




O O O 




O O O 





O O O 




O O O 

128





O O O 




O O O 








O O O 







O O O 






O O O 


e 

Alpha 2 

PaymentTrust Ltd.; 




O O O 


er 




EXAMPLE “6188565656” 

O O O 


on 




O O O 




O M O 




O O O 




O O O 







O M O 







O O O 





Code. 

O M O 

ShipFromCountryCode Alpha 2 Example “US” 




O M O 



dashes. 

Example “6188565656” 

O O O 

129




VI AX MC 

CommodityCode Alphanumeric 10 Example “6400” 



M O O 




O O O 





M M M 

UnitOfMeasure Alphanumeric 12 this specific product. 




M M M 



Example 840 - $USD “56.78”, 392 

- $JPY “99”, 048 - $BHD 

“125.333” 


M M M 





M M M 






M O M 


mount 

Numeric N/A 


CurrencyId. 

Example 840 - $USD “56.78”, 392 

- $JPY “99”, 048 - $BHD 

“125.333” 



O O O 


t 

Numeric N/A 


Example 840 - $USD “56.78”, 392 

- $JPY “99”, 048 - $BHD 

“125.333” 



M M M 



Example 840 - $USD “56.78”, 392 

- $JPY “99”, 048 - $BHD 

“125.333” 



M M M 


1 


(Line 1) 




O O O 

130



2 

131 




(Line 2) 




O O O

STLink will return the following items for a PaymentTrust Refund 

Request (PT)(R) for PURCHASING CARDS 









specified. 

Example “10098987” 












Example 840 = “56.78”, 392 = “99”, 048 = “125.333” 

Account type. 




CQ - Cheques 

MOP Alpha 2 





P2 – Pay 2 


RequestType Alpha 1 ‘R’ Refund. 






Messages 

132

3D Secure Requests 

3D Secure Verify Enrollment Request (3D)(V) 









M 



3D Secure. 

Example “1” for 3D 


M 



M 





M 



M 

TransactionType Alphanumeric 2 Transaction Type, “3D” for 3D Secure. M 


''1” for "Test", “0” for "Live", 



O 

TimeOut Numeric N/A allows for the transaction, in milliseconds. 


For use to differentiate between Merchants 

M 


or Stores. Permanent Store ID assigned by 



O 

RequestType Alphanumeric 1 ‘V’ Verify Enrollment 


M 



35 Example “10098987” 




O 


Credit card number. 

Example “4459510002561039” 


M 

ExpDate Numeric N/A format. 




M 

GBP 

CurrencyId Numeric N/A Note: Merchant default value is used as setup 

within the PaymentTrust Ltd. MPI. 


values. 



O 


Example 840 = “56.78”, 392 = “99”, 048 = 

“125.333” 

M 

133




SecureId Alphanumeric 20 

A statistically unique transaction identifier. Later 

required for payment requests: Auth, Forced 

Auth, Sale and Forced Sale. 

Example “1AWH234KI56LI789LYGR” 

Note: Data size must be exactly 20. 

Note: Known as the 3D Secure XID. 

Note: If no SecureId is submitted the system will 

generate one for the merchant at the time of the 

transaction. 

O 

PurchaseDesc Alphanumeric 125 

A brief description of items purchased. 

Example “A pair of pants” 

O 


StringIn=VersionUsed^1~MerchantId^100000~UserName^Mariah~UserPassword^rr87uy~TransactionType^3 

D~IsTest^1~TimeOut^60000~RequestType^V~AcctNumber^4779160330716625~ExpDate^092010~Amount^ 

56.78 

STLink will return the following items for a 3D Secure Verify 

Enrollment Request (3D)(V) 



Permanent Merchant ID assigned by PaymentTrust Ltd.. 


TransactionType Alpha 2 Transaction Type, “3D” for 3D Secure. 




specified. 

Example “10098987” 

StrId Numeric N/A Reference Number from STLink. 

Reference Number from 3D Secure system generated with 

SVID Numeric N/A Verify Enrollment response. 

Example “10003606” 

RequestType Alpha 1 'V' Verify Enrollment. 

SecureId submitted by the Merchant or a number generated 

SecureId Alphanumeric 20 by PaymentTrust Ltd. if SecureId was not specified. 

Example “1AWH234KI56LI789LYGR” 

Enrollment status used to determine liability shift. 


PaReq Alphanumeric 800 

134 

Y = Authentication Available. Cardholder Enrolled. URL of 

Issuer ACS is included in response. 

N = Cardholder Not Participating. Cardholder Not Enrolled. 

U = Unable to Authenticate. 

Base64 encoded message from the PaymentTrust Ltd. MPI. 

Must be sent to the cardholder’s issuer Access Control 

Server.


Fully qualified URL of cardholder’ s issuer Access Control Server. 

Note: This is the location where cardholders must be 

ACSURL Alphanumeric 255 

redirected to authenticate themselves. 

Example 

“https://acs.someissuer.com/0/xqkxnFYraaGvmWXNebF 

DmjUAAAA0” 

Indicates whether cardholder is enrolled (4050) or not 


enrolled (4200) 



Example “Cardholder enrolled” 

Message Alphanumeric 60 Note: Please See Appendix C for complete list of Response 

Messages 


MerchantId^100000~TransactionType^3D~OrderNumber^10098987~StrId^121092~SVID^10064249~ 

RequestType^V~SecureId^1AWH234KI56LI789LYGR0~CHEnrolled^Y~PaReq^ 

eJxVUsuSmzAQ/BWKe9CDxxrXWFvOEic+mDgJriRHBVSYzUpgIdbYXx/Jhmyi03TP1PRMj+BxlC/eq9B906q 

VTwLse0KVbdWoeuUfis27hf/IoDhqIbJvohy0YLATfc9r4TXVyt/zr+JESIQJjugiTGhKUhqmOKQEP8QkjKM4jn0 

G+7WtYzApMSsUUEAztC11eeTKMODl6f02ZxGhYRQDmiBIobcZu5HJwyLFU/pOg+JSsEL0xpsbAbpxULaD 

MvrCcJgAmgEM+oUdjemWCJ3P56Du+EUKZfqgbCUC5NKA3mbaDy7qbbuxqdiu2F7z7EDzax3vsg+X3fULyZ 

/L6HOxXgFyFVBxIxjFOMGUJB6Jl+FiiUNANx64dHOwFAcY2w3vCDonsp5TLvMvA9Z6bS8zbzIjEGPXKjs7s3 

b+jaESfcmeWtkNRmivbtuqD6y8YwG9rfP0yRleGuvhePo9qs1PzfnHV/n9Ry5+bTL5fFjb54a8Fzm1xrmZ4uQm 

5wAg1wZNF0bT77DRf7/mD/8CyVE=~ACSURL^ 

https://acs.someissuer.com/0/xqkxnFYraaGvmWXNebFDmjUAAAA0~MessageCode^4050~Message~Cardh 

older enrolled 

3D Secure Authenticate Request (3D)(A) 









M 



3D Secure. 

Example “1” for 3D 


M 



M 





M 



M 

TransactionType Alphanumeric 2 Transaction Type, “3D” for 3D Secure. M 


''1” for "Test", “0” for "Live", 



O 

TimeOut Numeric N/A allows for the transaction, in milliseconds. 


M 

135





For use to differentiate between Merchants 

or Stores. Permanent Store ID assigned by 



O 

RequestType Alphanumeric 1 ‘A’ Authenticate 


M 



35 Example “10098987” 




A digitally signed message received from 

the cardholder’s issuer Access Control 

O 

PaRes Alphanumeric 5000 Server. Must be sent to the PaymentTrust 

Ltd. MPI to verify whether the cardholder 

authentication was successful or not. 


M 

SVID Numeric N/A generated with Verify Enrollment response. 

Example “10003606” 

O 


StringIn=VersionUsed^1~MerchantId^100000~UserName^Mariah~UserPassword^rr87uy~TransactionType^3 

D~IsTest^1~TimeOut^60000~RequestTypeÂ~PaRes^ 

eJytV9m2osgS/RVW9aNdxSCo1OK4VjIIqIkyKr4hIIMMKijg199Ezzll160e7sCLmWHEzsiInZuE 

s+JLGIpm6F8v4ZSDYVV5UYglwduXtWeEZ5KkCXLC0tRkTDLMmGZoesxORmNizFJDimG/TLk1MMLq 

EeGNg2Llyp1X31ZKsNvETWZGqQ3QQyDHW3ipkrKYkt+IbxSHf0zRohc/9op6ynn+mVe1KU1SQ5rh 

8Pcpl4cXVZw+jKPxhCXe/36aOfxH/Prajyq0kTYJptBS75poU9o9YqAodfCuk1rq0ysLvHF478EF 

Xh1OKYIYERQ5xkjmOzn+Tkw4/GHnTj0cyMsrwmYJguDwVwuHSnYJC7+bEsMRh3/OuLA9lUWIPNAm 

P8cc/iO5k1dMiZdnOCSRa2/lrO2Uq5P8p6RG3+khhz/sXFV79bWauhz+PuJ873abohrzPB2R0swB 

jye19eeg3+zDhQv9ZEqgwvW/jyiQReUlqeO8T/WPBg7vU8EfzZ1yZhIVaLFLiLV5VlRvX+K6Pn3H 

8aZpvjXDb+UlwlHCBE6wOHIIqiT67cszKgzU4lBOOcEryiLxvSy5ezVqOwzruAywzwV/BWkZPSqJ 

G5LwFcF+9Um6+NpbiCHJIHz816Av6f6TVX5O/FJ5X6vYI/sFfgKackZ4CPs2h5htqG9ffvsbyotJ 

FFb1f5PFRwavCB94jpddw+nQ0U8zv+DvwXK9Cl2DJXzpsrXz8aZ6+4h7enL4Z9rve/royuf+no6H 

604Iuy7HGZJhD4tRtti4CyBAUV7tpQYKQLiUA+aQ5CeYsA1U1lRnHtSyG1ikkQ/oUThAh2ywOjcb 

Nl3Od8Y9nix2VixV463hlTktBIzdqbbH7Kk43waN4Y6kiDov4rO3DtIq8kpnuz0l7LxOqfMcB+u5 

5tRjeRyvmdNAsp0VeegCcVHtPPvtpTnvu1yE3XNXW4ZgRa/2niPzuk9Dv9Y8dHoE7Y2kxkh/iG/k 

79jKflMtzAwvt8QPKzR/k9del6PjiibLN7MLirD7HTOtNy1sMLO81jG28bLeVXgDNof/DP9YTwgv 

dXJArEQSAlVVbFJBAFQXgUblQaSqcm2TZH82ZakRdXe+KHdqfPM1oEsSr4PmkEpLCI4yIG2Jj6Gg 

O3Yri2CD8ZHmIARLJJgs6HhrP3QIT+C37qbN/Lu0hoB4BrVQtofZcZ87DDTKRgau6Oj6Qmpnii3P 

mP3GuWKBAiNbMRhVaomdKNmQVx/BQguXpqNHNuV0QZ6luy1spRToz8WhJdiB7m6zerdhCP8OwllD 

NBhMkbqKNmq+zUBr7vVGLZVamB4bzYKkJhoeVNxWuIP5E8i1wHHmQCNqZtEjO1Vq2NVu60eYTbFk 

IEeRQ82qfnXxDrRnkG/xmcbsZCYLLcmEPHhmHMO5QfJxuCGzfWHcoaE30hN0iUlNPXcE3tpt55S3 

0fo6fQaCFs7RO2K4TMEVCnQLVfnQ11Awz7Kp7oeiLvFAR2eZljUgCjyW6As+0oXBQDpsS2PSZalW 

njaLHC8K6dzxxyie+2x7XQ2uztE9r63rVV2MFjOnVWR7wFvDgQnqNbVgoK7amIB47o/wzh81F/cw 

uyndhi0Oo2XSggqEO0pMoLA7iKRlNyUgZqu0kXy+zLKUNo/nVbFLPPZ4VZzTMV4m2KptlTmMtle1 

y7vDRhTi5KgMcHrZqCLQAV/SKn8UEQ/dpon2D24FamPylSXwlxLYZ5mYn80usoa6gMEsnymnQUuT 

MD3chThyV8fI/XNi/hUvsf+UmH/FS+wfE5NWde/uDGnn7uKXFgQ2fjsa+/sl5ZneXzEmEuanfAPF 

TQRHoI0TtgwUo1klk5tzzCzdNuZ2woqINoQ9nFNLAlGnMGb7Yn7by83tlW/LXOuwvQiGZQ9Gu+0u 

z6qdVd6WZOt/gmXtJ9hWegVr/V+A8RYfRRc+kma87iMSGgqU7EZvXHXRuDyv2woEC1mjYiJQwGjZ 

sRvT0XhDysz3TC2/cG86KhUWSM7Vz9lqL/xw2hIvteqY1C/0X0mRqOvCZV0rh7Vz0sxVusDmzvCG 

M9LWTRqxnUekYoqXNhkvotuBSHWRnFzvo5ye8Dq13uONvsVDeNz6erZSQVLji3GtiBNAN/JTOl+V 

8lfSKazuiLLh5kM6/6SnvTwcz/ExkdmGQMXSZ0DkB1CvGkF/EExGMjDnHUtyIe8+2cTDtZU7Q3Wm 

3YKtUaqzIN7Lzh3qk74QfZAiNTsr3BjX3fbYyilwn0QrLUx6ZVrH64FyjCzFOL4Kz9/pzkfPsYdi 

8fRWtJDZkjp0OSWRjBLarOxt1E+2vzyE2P/r7dAfQux/fzvw/oecYn/QU6ICUIoExK47Y65ZJzjD 

136

42prrAKtOVtKyyJuebEvR6MOzpDExnYxLLMonJyvHVFSPkYV+nFcH5drPldW871Wj7NOXYOsuM3K 

5YGdgwiVGsjp+g5YCKqH2omNLiEagTYF66cEIJ8DkgHeAkgiFRzyxNMx0jc8b5Z7PT8tF/w6AGq3 

ce2wGCup3Wk4FH/BN2QC/LVA3YwTcrC8N8K1q6x0OJ6Qk8vKWN93OCNqAjMK52EQlgZwzUnOOsxa 

oY/pfgOvi7tGOivBsQLZvN/W9mgvYOEd+OfHt8q/HRb8xxUH/7z2/LgQPT6KHl9y/T3+9QvvXz4l iiQ= 

STLink will return the following items for a 3D Secure Authenticate 

Request (3D)(A) 



Permanent Merchant ID assigned by PaymentTrust Ltd.. 


TransactionType Alpha 2 Transaction Type, “3D” for 3D Secure. 




specified. 

Example “10098987” 

StrId Numeric N/A Reference Number from STLink. 

Reference Number from 3D Secure system generated with 

SVID Numeric N/A Authentication response. 

Example “10003606” 

RequestType Alpha 1 'A' Authenticate. 

Authentication status used to determine liability shift. 


ECI Numeric 2 





137 

Y = Authentication Successful. 

N = Authentication Failed. 

U = Authentication Could Not Be Performed. 

A = Attempts Processing Performed. 

Note: If the status is N or not available do to error, the 

purchaser’s transaction must be declined and no payment 

should be processed. 

Electronic Commerce Indicator as returned from the 

PaymentTrust Ltd. MPI. Later required for payment 

requests: Auth, Forced Auth, Sale and Forced Sale. 


Cardholder Authentication Value as returned from the 

PaymentTrust Ltd. MPI. Later required for payment 

requests: Auth, Forced Auth, Sale and Forced Sale. 

Example “AAA9BVY0FVJAAAAAA12BAAAAAAA=” 

Indicates whether cardholder is authenticated (4100) or not 

authenticated (4220) 



Example “Cardholder authenticated” 


Messages

MerchantId^100000~TransactionType^3D~OrderNumber^10098987~StrId^121092~SVID^10064249~ 

RequestTypeÂ~TXStatus^Y~ECI^02~CAVÂAA9BVY0FVJAAAAAA12BAAAAAAA=~MessageCode^4100~ 

Message^Cardholder authenticated 

138

Foreign Exchange Requests 

Foreign Exchange Rate Request (FX)(X) 









M 



FX. 

Example “1” for FX 


M 



M 





M 



M 


Transaction Type, “FX” for Foreign 

Exchange 

M 

IsTest 

Numeric 

1 




O 



M 

RequestType Alphanumeric 1 ‘X’ Rate Request 


M 







O 





Credit card number or Debit Card number. 

Example “4459510002561039” 

O 

AcctNumber Numeric N/A Note: Either AcctNumber or 

ConvertedCurrencyId is mandatory to 

create an FX pair with the CurrencyId. 



O 



values. 

M 

139


CurrencyId to convert to. ISO standard 

numeric ids 



ConvertedCurrencyId Numeric N/A 


GBP 

Note: Either AcctNumber or 

ConvertedCurrencyId is mandatory to 

create an FX pair with the CurrencyId. 


O 


IsRefund Numeric 1 


140 

values. 



CurrencyId. 

Example 840 = “56.78”, 392 = “99”, 048 = 

“125.333” 

''1” for "Refund", “0” for "Non Refund", 


StringIn=VersionUsed^1~MerchantId^100000~UserName^Mariah~UserPassword^rr87uy~TransactionType^F 

X~IsTest^1~TimeOut^60000~RequestType^X~CurrencyId^840~ConvertedCurrencyId^124 

O 

O

STLink will return the following items for a Foreign Exchange Rate 

Request (FX)(X) 





TransactionType Alpha 2 Transaction Type, “FX” for Foreign Exchange. 




specified. 

Example “10098987” 


RequestType Alpha 1 'X' Rate Request 



Example “10003606” 




ConvertedCurren 

cyId 

Numeric N/A 

Converted CurrencyId. ISO standard numeric ids 





Example 840 = “56.78”, 392 = “99”, 048 = “125.333” 

ConvertedAmoun 

t 

Numeric N/A 

Converted amount. Up to 4 decimals maximum. Decimal 

varies based on CurrencyId. 

Example 840 = “56.78”, 392 = “99”, 048 = “125.333” 



Example “0.84566” 

ExpiryTime 

AlphaNumeri 

c 

20 

Date and Time the rate expires (YYYYMMDDHHMMSS). 

Example “20050223164000” 







Messages 


MerchantId^100000~TransactionType^FX~OrderNumber^10098987~StrId^130634~RequestType^X 

~FXID^10003606~CurrencyId^840~ConvertedCurrencyId^124~FXRate^0.84566~ExpiryTime^200502231 

64000~FXMessageCode^3100~FXMessage^Transaction approved 

141

Foreign Exchange Placement Request (FX)(D) 









M 



FX. 



M 



M 





M 



M 



Exchange 

M 

IsTest 

Numeric 

1 




O 



M 

RequestType Alphanumeric 1 ‘D’ Placement Request 

Reference Number from Foreign Exchange 

M 

FXID Numeric N/A system. 

Example “10003606” 



M 







O 


Example 840 = “56.78”, 392 = “99”, 048 = 

“125.333” 

M 


StringIn=VersionUsed^1~MerchantId^100000~UserName^Mariah~UserPassword^rr87uy~TransactionTy 

pe^FX~IsTest^1~TimeOut^60000~RequestType^D~FXID^10003606~Amount^56.78 

142

STLink will return the following items for a Foreign Exchange 

Placement Request (FX)(D) 









specified. 

Example “10098987” 


RequestType Alpha 1 'D' Placement Request 



Example “10003606” 




Transaction Amount. Up to 4 decimals maximum. Decimal 


Example 840 = “56.78”, 392 = “99”, 048 = “125.333” 



Example “0.84566” 

ExpiryTime 

AlphaNumeri 

c 

20 


Example “20050223164000” 







Messages 


MerchantId^100000~TransactionType^FX~OrderNumber^10098987~StrId^130634~RequestType^D~ 

FXID^10003606~CurrencyId^840~Amount^56.78~FXRate^0.84566~ExpiryTime^20050223164000~FXM 

essageCode^3050~FXMessage^Transaction pending 

143

Foreign Exchange Refund Request (FX)(R) 









M 



FX. 



M 



M 





M 



M 



Exchange 

M 

IsTest 

Numeric 

1 




O 



M 

RequestType Alphanumeric 1 ‘R’ Refund Request 


M 


Example “10003606” 



M 







O 


Example 840 = “56.78”, 392 = “99”, 048 = 

“125.333” 

M 



pe^FX~IsTest^1~TimeOut^60000~RequestType^R~FXID^10003606~Amount^56.78 

144

STLink will return the following items for a Foreign Exchange Refund 

Request (FX)(R) 









specified. 

Example “10098987” 


RequestType Alpha 1 'R' Placement Request 



Example “10003606” 






Example 840 = “56.78”, 392 = “99”, 048 = “125.333” 



Example “0.84566” 

ExpiryTime 

AlphaNumeri 

c 

20 


Example “20050223164000” 







Messages 


MerchantId^100000~TransactionType^FX~OrderNumber^10098987~StrId^130634~RequestType^R~FXI 

D^10003606~CurrencyId^840~Amount^56.78~FXRate^0.84566~ExpiryTime^20050223164000~FXMess 

ageCode^3050~FXMessage^Transaction pending 

145

Foreign Exchange Cancellation Request (FX)(C) 









M 



FX. 



M 



M 





M 



M 



Exchange 

M 

IsTest 

Numeric 

1 




O 



M 

RequestType Alphanumeric 1 ‘C’ Cancellation request 


M 


Example “10003606” 



M 





O 



pe^FX~IsTest^1~TimeOut^60000~RequestType^C~FXID^10003606 

146

STLink will return the following items for a Foreign Exchange Cancel 

Request (FX)(C) 









specified. 

Example “10098987” 


RequestType Alpha 1 'C' Cancellation request 



Example “10003606” 






Example 840 = “56.78”, 392 = “99”, 048 = “125.333” 



Example “0.84566” 






Messages 


MerchantId^100000~TransactionType^FX~OrderNumber^10098987~StrId^130634~RequestType^C~FXI 

D^10003606~CurrencyId^840~Amount^56.78~FXRate^0.84566~ExpiryTime^20050223164000~FXMess 

ageCode^3170~FXMessage^Transaction approved 

147

BIN System Request 

BIN System Request (BN) (Also known as Issuer Identification 

Number) 








M 



Example “3” for BN 


M 



M 





M 



M 


Transaction Type, “BN” for Bin Request 

System 

M 

IsTest 

Numeric 

1 




O 





M 







O 

AcctNumber Numeric N/A number, or any other applicable Bank 

Identifier. 

Example “4459510002561039” 

M 



pe^BN~IsTest^1~TimeOut^60000~AcctNumber^4459510002561039 

148

STLink will return the following items for a BIN Request (BN) 





TransactionType Alpha 2 Transaction Type, “BN” for Bin Request System 




specified. 

Example “10098987” 



Note: Please See Appendix A for complete list of Response 

Messages 

BTTID Numeric N/A 

Reference Number from BN system 

Example “10003606” 

Standard Card Types 

Example 

VI Visa Credit Card 

AX American Express 

BE Beneficial 

CB Carte Blanche 

DC Diners Club 

CreditCardType Alpha 2 

DI 

JC 

Discover 

JCB 

MC MasterCard 

SW Switch/Solo 

VI Visa credit 

VE Electron 

VD Visa debit 

MA Maestro 

MD Mastercard Debit 

XX Card type could not be determined 




Note: Please See Appendix D for complete list of values 

Issuing Bank or institution of the specific Card 

Issuer AlphaNumeric 100 Example “National Bank Of America” 

Note: This is not always available and is region specific. 


MerchantId^100000~TransactionType^BN~OrderNumber^10098987~StrId^1125261~MessageCode^100 

~BTTID^1003606~CreditCardType^VI~CountryCodeÛS~Issuer^National Bank Of America 

149

IP Geo Positioning Request 

IP Geo Positioning Request (GP) 








M 



Example “2” for GP 


M 



M 





M 



M 


Transaction Type, “BN” for Bin Request 

System 

M 





O 





M 


Example “10098987” 





O 

REMOTE_ADDR Alphanumeric 100 Example “207.253.196.193” or 


M 



pe^GP~IsTest^1~TimeOut^60000~REMOTE_ADDR^206.196.124.2 

STLink will return the following items for an IP Geo Positioning 

Request (GP) 





TransactionType Alpha 2 Transaction Type, “GP” for IP Geo Positioning. 




specified. 

Example “10098987” 


150




Messages 

GPID Numeric N/A 

Reference Number from GP system 

Example “10003606” 





CountryCode Alpha 2 Example “CA” 


Region within the Country Code returned. This may be a 

province or a State. 

Region Alphanumeric 100 Example “QC” or “Quebec” 

Note: This is not always available and is country 

specific. 

City within the Country Code returned 


Example “Montreal” 


specific. 

The IP address’s connection type. 

ConnectionType Alphanumeric 50 

Example “Dial-up” 

Note: Available as a premium service by 3 rd party 

subscription. 

The Remote Address’s angular distance on the earth's 

Longitude Alphanumeric 10 

surface, measured east or west from the prime meridian 

at Greenwich, England. 

Example “45.1253” 

The Remote Address’s angular distance north or south 

Latitude Alphanumeric 10 of the earth's equator, measured in degrees. 

Example “30.6532” 


MerchantId^100000~TransactionType^GP~OrderNumber^10098987~StrID^1125261~MessageCode^100 

~GPID^10003606~REMOTE_ADDR^206.196.124.2~CountryCodeÛS~Region^QC~City^Montreal~Long 

itude^45.1253~Latitude^30.6532 

151

Identify Me System Request 

Identify Me System Request (IM) 








M 



Example “3” for IM 


M 



M 





M 



M 


Transaction Type, “IM” for Identify Me 

Request System 

M 





O 





M 





1 sets the flag to verify the age, 0 or if flag is 

not sent will not test for Age verification. 

O 

AgeVerify Numeric 1 Note: Defaults to merchant set-up, if left 

blank, and merchant specific default value 

is not available. 

1 sets the flag to check the ID, 0 or if flag is 

not sent will not test for ID verification. 

O 

IDVerify Numeric 1 Note: Defaults to merchant set-up, if left 



1 sets the flag to check the individual, 0 or if 

flag is not sent will not test for 

O 

ProfileVerify Numeric 1 

individual/profile verification. 

Note: Defaults to merchant set-up, if left 



O 

152




Example “23091963” 




DOB Numeric 8 months are padded with zero in the 


M 

Note: The Date of Birth is required when 

AgeVerify is 1 and CountryCode is GB/UK 

IDType or IDType1 Alpha N/A 

IDNumber or 

IDNumber1 

153 


IDCode1 Alphanumeric 2 

or when IDType is DL or PP. 




provided. 

CE – Cedential de Elector 


ID – Identity Card No. 

IF – Identity Certificate No. 

PI – Personal Identification No. 


RF – Registro Federal de Contribuyentes 

RP – Residence Permit 

TD – Travel Document 


Note: IDType will only be accepted for 

legacy customers, all new implementations 

will receive IDType1. 








Note: IDNumber will only be accepted for 

legacy customers, all new implementations 

will receive IDNumber1. 

Note: For Passport and Driver’s License 

validation this field becomes mandatory. 

Where a secondary code is required in a 

piece of identification 

Note: For Passport validation if not 

submitted will default to P 

O 

O 

O


Country which issued the piece of 

identification 

IDIssuingCountry1 Alpha 3 

IDCountryOfOrigin1 Alpha 3 

IDNationality1 Alpha 3 

IDExpiryDate1 Numeric N/A 

IDIssueDate1 Numeric N/A 



154 

Note: Mandatory for if IDVerify= 1, and an 

IDNumber is supplied 

Note: On passports country of issuance is 

on the top of the passport there may not be 

a label stating “Issuing Country” 

Note: See Appendix ## for list of codes 

Country of Origin of the ID holder 


Nationality of the ID holder 

Note: For Passport validation this field 

becomes mandatory 


Expiry date of the ID as entered by the 


Example “23091963” 





validation this field becomes mandatory 

Issue date of the ID as entered by the 


Example “23091963” 









provided. 




















O 

O 

O 

O 

O 

O 

O









155 





















Example “23091963” 





validation this field becomes mandatory 



Example “23091963” 









provided. 













O 

O 

O 

O 

O 

O 

O











O 







156 






















Example “23091963” 








Example “23091963” 






O 

O 

O 

O 

O 

O





provided. 








157 






































Example “23091963” 








O 

O 

O 

O 

O 

O 

O









158 



Example “23091963” 









provided. 






































O 

O 

O 

O 

O 

O 

O





MiddleName Alphanumeric 60 


Gender Alpha 1 

AliasFirstName Alphanumeric 60 

AliasMiddleName Alphanumeric 60 

AliasLastName Alphanumeric 60 


159 



Example “23091963” 








Example “23091963” 






First Name of the individual to be verified 


Middle Name of the individual to be verified 

Example “Thomas” 

Last Name of the individual to be verified 


Gender of the individual to be verified. 

M – Male 

F – Female 

Note: Mandatory for UK age verification, 

non-UK profile verification submissions. 

Note: Mandatory when IDType = PP or DL. 

Note: As specified on passport only. If 

unavailable do not submit 

Alias First Name of the individual to be 

verified 


Note: This field becomes mandatory if 

AliasLastName is submitted 

Alias Middle Name of the individual to be 

verified 


Alias Last Name of the individual to be 

verified 


Note: This field becomes mandatory if 

AliasFirstName is submitted 

Suffix of the individual to be verified 




O 

O 

M 

O 

M 

M 

O 

O 

O 

O




Note: This line should only contain the 



Address1 Alphanumeric 60 street for UK age verification submissions. 

Note: This line becomes mandatory for 

profile verification submissions and should 

O 









160 

only contain the street name. 




locality for UK age verification submissions. 


locality for non-UK profile verification 

submissions. 


Note: This line becomes mandatory, and 

should only contain the building name, 

building number for UK age verification 

submissions. 

Note: This line becomes mandatory for 

profile verification submissions and should 

only contain the address door number. 


Note: This line should only contain the sub 

locality for UK age verification submissions. 



substreet for UK age verification 

submissions. 



Billing contact state code, two-character 


Remaining Region and Provinces around 

the world may use free form field 


Note: Mandatory for Irish counties. 


values 



Note: Optional for Ireland 




values 

O 

O 

O 

O 

O 

O 

M 

M







Example “6188565656” 

Note: The value should not include the 

international calling codes. (i.e. 44 for UK, 1 

for US, and Canada) 

Note: PhoneNumber becomes mandatory 

when ProfileVerify is 1 and CountryCode is 

listed in the ‘IdentifyMe Submission Best 

Results Criteria’ 

Machine Readable Zone (MRZ) line 1 of the 

passport. 

Example: 

O 

MRZLine1 Alphanumeric 50 “A

STLink will return the following items for an Identify Me Request (IM) 





TransactionType Alpha 2 Transaction Type, “IM” for Identify Me Request System 




specified. 

Example “10098987” 


IMID Numeric N/A 

Reference Number from IM system 

Example “10003606” 

162


Code returned when verification is requested. 

MessageCode Alphanumeric 16 

163 

Possible values position 1 DOB verification: 



2 = Partial Match 




6 = Could Not Verify 

7 = Matched with errors 

9 = Too many results refine search 

E = Error 

N = Not Applicable 

Note: For legacy merchant value 2 will return message 

Partial Match Year only 

Possible values position 2-6 ID Verification: 

0 = [IDType] Matched 






E = Error 


Possible values position 7 Electoral Roll verification: 

0 = Matched 






E = Error 


Possible values position 8 British Telecom verification: 

0 = Matched 






E = Error 

N = Not Applicable


Possible values position 9 Directors Data verification: 

0 = Matched 






E = Error 


164 

Possible values position 10 Sanctions: 

0 = Matched 






E = Error 


Possible values position 11 Deceased: 

0 = Matched 






E = Error 


Possible values position 12 Global-ID: 

0 = Matched 






E = Error 


Possible values position 13 PEP: 

0 = Matched 






E = Error 

N = Not Applicable


Possible values position 14 SDN: 

0 = Matched 






E = Error 


Message Alphanumeric N\A 

MRZLine1 Alphanumeric N\A 


165 

Possible values position 15 Terrorist: 

0 = Matched 






E = Error 


Possible values position 16 Financial: 

0 = Matched 






E = Error 


Note: Message code will contain a sequence of 

alphanumeric values each mapping to a given validation 

request as indicated above. One value will be returned 

for each of the 16 possible positions. MessageCode will 

therefore be of length 16. 

Note: The term is defined as a probable match, not an 

exact match. 

Descriptive message of MessageCode 

Example: “Partial Match age group above 18, Partial 

ID matched” 

Machine Readable Zone (MRZ) line 1 of the passport. 

Example: 

“A


MerchantId^100000~TransactionTypeÎM~OrderNumber^10098987~StrId^1125261~IMID^10003606~Me 

ssageCode^0~Message^DOB Matched 

Sample MessageCode Map 

*PEP = Politically Exposed Persons 

*SDN = Specially Designated Nationals 

*Directors = This includes Dun and Bradstreet Business Data 

166 

Financial 

Terrorist 

*SDN 

*PEP 

Global-ID 

Deceased 

Sanctions 

*Directors 

British Telecom 

Electoral Roll 

ID 5 

ID 4 

ID 3 

ID 2 

ID 1 

DOB 

Sample 1 0 2 5 6 9 N 2 

Sample 2 1 5 N N N N 0 0 5 5 0 0 0 5 5 0 

Sample 3 N N N N N N 2 N 5 6 1 0 5 5 5 0

Supplementary Requests 

Supplementary RG(Q) Request 

Data 


Field Name 

Type Data Size Description 






M 



Example “1” for Q 


M 



M 





M 



M 

TransactionType Alphanumeric 2 Transaction Type, “RG” for Risk Guardian. M 

RequestType Alpha 1 'Q' Query Request M 





O 





M 





Reference Number from RG system also 

O 


known as the RGID 

Note: If the version is less than 4.0, GTTID 

is returned. If not RGID is returned. 

Return a list of 5 RG parameters indicating 

the reason(s) of automatic success or 

M 

IsExtended Numeric 1 failure of a transaction with an RG score of 

0 or 100. Set to '1' for "Yes", '0' for "No" 




O 






O 



pe^RG~RequestType^Q~IsTest^1~TimeOut^60000~RGID~10003606 

167

STLink will return the following Response for a Risk Guardian Query 

Request (Q) 









specified. 

Example “10098987” 







RGID 









Code 

Numeric N/A 







AgeVerifyMessage Alphanumeric 50 

Descriptive message of AgeVerifyMessageCode 




Parameters” 











“List Of RG 

Example: 

Analysis 

XML N/A • pCode: CCA 

Parameters” 



pCode Alphanumeric 3 


Definitions) 



Definitions) 


pScore Numeric 3 Note: Returned only as XML. See Section 6.3 (XML 

Definitions) 


pResponse Alphanumeric 100 Note: Returned only as XML. See Section 6.3 (XML 

Definitions) 

168


MerchantId^100000~TransactionType^RG~OrderNumber^10098987~StrId^121155~MessageCode^100~ 

GttId^490095~tScore^100.0000~tRisk^52~AgeVerifyMessageCode^4~ÂgeVerifyMessage^Partial Match 

age group above 18 


MerchantId^100000~TransactionType^RG~OrderNumber^10098987~StrId^121155~MessageCode^100~ 

GTTID^490095~tScore^100.0000~tRisk^52~AgeVerifyMessageCode^4~ÂgeVerifyMessage^Partial 

Match age group above 18~FNAÂlbert~CCAÎQ~ 

Analysis Sample Response: See Section 6.3 (XML Definitions) 

169

Supplementary DS(Q) Request 

Data 


Field Name 







M 





M 



M 





M 



M 

TransactionType Alphanumeric 2 Transaction Type, “DS” for Data Share. M 






O 





M 


Example “10098987” 




Reference Number from DS system also 

known as the DSID. 

O 

DSID Numeric N/A Note: Either DSID, or the BatchId is 

required 

Note: BatchId takes priority over DSID. 

BatchId that was sent back when original 

batch submission was made. 

Example “938344376” 

M 

BatchId Numeric N/A 

Note: Either DSID, or the BatchId is 

required 

If BatchId is submitted the request and 

response strings can only be in XML. 

Note: BatchId takes priority over DSID. 



M 






O 



pe^DS~RequestType^Q~IsTest^1~TimeOut^60000~DSID^10003606 

170

STLink will return the following Response for a Data Share Query 

Request (Q) 





TransactionType Alpha 2 Transaction Type, “DS” for RiskGuardian 




specified. 

Example “10098987” 


DSID Numeric N/A Reference Number from DS system 


DSMessageCode Numeric N/A Note: Please See Appendix A for complete list of 





Example: 0, 100, 76, -1 





‘S’ Sale 















Example: 

“List Of DS 

• AssmtId 

Analysis 


Parameters” 


• …….. 


171 



MerchantId^100000~TransactionType^DS~OrderNumber^10098987~StrId^121155~DSID^490095~DSM 

essageCode^6100~DSMessage^Transaction Approved~DSScore^100.0000~ShareServiceTRXId1 

ÂA522343~ShareServiceTRXId2^BB522343~ShareServiceScore ^756~ 


Supplementary (Q) Request for PaymentTrust (PT) communication 

failures. 

In the event of a communication failure the Q request can be used to retrieve the status of last transaction 

sent with a specific OrderNumber if the StrId was not received. 

Data 


Field Name 







M 





M 



M 





M 



M 

TransactionType Alphanumeric 2 Transaction Type, “Q” for Query Request M 





O 





M 


Note: Will return the last transaction sent with 

the specified OrderNumber. 

M 

Sample Input String: See Section 6.3 (XML Definitions) 

172

STLink will return the following items for a Query Request (Q) on 

PaymentTrust (PT) network communication failures. 






TransactionCount Numeric N/A 

Indicates the number of transactions returned in the 

query request. 



OrderNumber Alphanumeric 35 specified. 

Example “10098987” 

Note: This is a Repeating field within the result file. 


Reference Number from PaymentTrust system 

generated with Auth response 




Account type. 




CQ - Cheques 

MOP Alpha 2 





P2 – Pay 2 






Amount Numeric N/A Decimal varies based on CurrencyId. 

Example 840 = “56.78”, 392 = “99”, 048 = “125.333” 

BTID Alphanumeric 12 

Unique ID generated by PaymentTrust. 

Note: Returned only on BTS transactions. 

BankRefID Alphanumeric 50 



Full name of person who made the bank transfer. 

CustomerName Alphanumeric 50 Example “John Smith” 


Standard 2 letter Country Code where bank transfer was 

made. 






Date bank transfer was processed by STN. In 

TransactionDate Numeric N/A 

YYYYMMDD format. 

Example “20050519” 


173


Time bank transfer was processed by STN. In 

HH:MM:ss:mmm format. 

TransactionTime Alphanumeric 10 Example “17:50:20:333” 



Date bank transfer was made. In YYYYMMDD format. 

CreditDate Numeric N/A Example “20050519” 


Specific for PT Only 

‘D’ Deposit (Settlement) 

RequestType Alpha 1 


‘P’ PayBack 

‘B’ Bank Transfer System 





Results 


Please See Appendix C for complete list of Response 

Message Alpha 60 Messages. 





CVNMessageCode Numeric N/A 




4 = Security Match only 

Note: Returned only if CVN is submitted. 

CVNMessage Alphanumeric 100 

Descriptive message of CVNMessageCode 


Sample Response: See Section 6.3 (XML Definitions) 

174

Supplementary (Q) Request for Batch Submissions 

Data 


Field Name 







M 





M 



M 





M 



M 

TransactionType Alphanumeric 2 Transaction Type, “Q” for Query Request M 





O 




M 



Note: Mandatory for BTS transactions only. 

BatchId that was sent back when original 

O 

BatchId Numeric N/A batch submission was made. 

Example “938344376” 

M 

Sample Input String: See Section 6.3 (XML Definitions) 

175

STLink will return the following items for a Query Request (Q) on a 

PaymentTrust (PT) batch 






BatchId that was sent back when original batch 

BatchId Numeric N/A submission was made. 

Example “938344376” 

TransactionCount Numeric N/A 

Indicates the number of transactions returned in the 

query request. 



OrderNumber Alphanumeric 35 specified. 

Example “10098987” 



Reference Number from PaymentTrust system 

generated with Auth response 




Account type. 




CQ - Cheques 

MOP Alpha 2 





P2 – Pay 2 






Amount Numeric N/A Decimal varies based on CurrencyId. 

Example 840 = “56.78”, 392 = “99”, 048 = “125.333” 

BTID Alphanumeric 12 

Unique ID generated by PaymentTrust. 


BankRefID Alphanumeric 50 



Full name of person who made the bank transfer. 

CustomerName Alphanumeric 50 Example “John Smith” 


Standard 2 letter Country Code where bank transfer was 

made. 






176


Date bank transfer was processed by STN. In 

TransactionDate Numeric N/A 

YYYYMMDD format. 

Example “20050519” 


Time bank transfer was processed by STN. In 

HH:MM:ss:mmm format. 

TransactionTime Alphanumeric 10 Example “17:50:20:333” 



Date bank transfer was made. In YYYYMMDD format. 

CreditDate Numeric N/A Example “20050519” 



‘D’ Deposit (Settlement) 

RequestType Alpha 1 


‘P’ PayBack 






Results 


Please See Appendix C for complete list of Response 

Message Alpha 60 Messages. 





CVNMessageCode Numeric N/A 




4 = Security Match only 


CVNMessage Alphanumeric 100 

Descriptive message of CVNMessageCode 


Sample Response: See Section 6.3 (XML Definitions) 

177

Supplementary FX(Q) Request for pending transactions 

Data 


Field Name 







M 





M 



M 





M 



M 



Exchange. 

M 






O 





M 






O 


Example “10003606” 

M 



pe^FX~RequestType^Q~IsTest^1~TimeOut^60000~FXID~10003606 

178

STLink will return the following items for a Query Request (Q) on 

Foreign Exchange 





TransactionType Alpha 2 Transaction Type, “FX” for Foreign Exchange. 




specified. 

Example “10098987” 


RequestType Alpha 1 'X' Rate Request 



Example “10003606” 




Converted CurrencyId. ISO standard numeric ids. Only 

ConvertedCurren 

cyId 

Numeric N/A 

returned for X requests. 





Example 840 = “56.78”, 392 = “99”, 048 = “125.333” 

ConvertedAmoun 

t 

Numeric N/A 

Converted amount. Up to 4 decimals maximum. Decimal 

varies based on CurrencyId. Only returned for X requests. 

Example 840 = “56.78”, 392 = “99”, 048 = “125.333” 

IsRefund Numeric 1 

''1” for "Refund", “0” for "Non Refund", Only returned for X 

requests 



Example “0.84566” 

ExpiryTime 

AlphaNumeri 

c 

20 


Example “20050223164000” 







Messages 


MerchantId^100000~TransactionType^FX~OrderNumber^10098987~StrId^130634~RequestType^X~FXI 

D^10003606~CurrencyId^840~ConvertedCurrencyId^124~Amount^56.78~ConvertedAmount^48.01~FXR 

ate^0.84566~ExpiryTime^20050223164000~FXMessageCode^3100~FXMessage^Transaction approved 

179

Supplementary BN(Q) Request 

Data 


Field Name 







M 





M 



M 





M 



M 

TransactionType Alphanumeric 2 Transaction Type, “BN” for BIN System. M 






O 





M 


Example “10098987” 




O 


Reference Number from BN system. 

Example “10003606” 

M 



pe^BN~RequestType^Q~IsTest^1~TimeOut^60000~BTTID~10003606 

STLink will return the following Response for a BIN Query Request 

(Q) 





TransactionType Alpha 2 Transaction Type, “BN” for Bin System 




specified. 

Example “10098987” 




Messages 

180



Reference Number from BN system 

Example “10003606” 

Standard Card Types 

Example 

VI Visa Credit Card 

AX American Express 

BE Beneficial 

CB Carte Blanche 

CreditCardType Alpha 2 

DC 

DI 

Diners Club 

Discover 

JC JCB 

MC MasterCard 

SW Switch/Solo 

VI Visa credit 

VE Electron 

VD Visa debit 

MA Maestro 





Issuing Bank or institution of the specific Card 

Issuer AlphaNumeric 100 Example “National Bank Of America” 

Note: This is not always available and is region specific. 


MerchantId^100000~TransactionType^BN~OrderNumber^10098987~StrId^1125261~ 

MessageCode^100~BTTID^10003606~CreditCardType^VI~CountryCodeÛS~Issuer^National Bank Of 

America 

181

Supplementary GP(Q) Request 

Data 


Field Name 







M 





M 



M 





M 



M 


Transaction Type, “GP” for Geo Positioning 

System. 

M 






O 





M 





O 


Reference Number from GP system 

Example “10003606” 

M 



pe^GP~RequestType^Q~IsTest^1~TimeOut^60000~GPID~10003606 

STLink will return the following Response for an IP Geo Positioning 

(GP) Query Request (Q) 





TransactionType Alpha 2 Transaction Type, “GP” for IP Geo Positioning System. 




specified. 

Example “10098987” 




Messages 

182



Reference Number from GP system. 

Example “10003606” 





CountryCode Alpha 2 Example “CA” 


Region within the Country Code returned. This may be a 

province or a State. 

Region Alphanumeric 100 Example “QC” or “Quebec” 


specific. 

City within the Country Code returned 


Example “Montreal” 


specific. 

The IP address’s connection type. 

ConnectionType Alphanumeric 50 Example “Dial-up” 

Note: This is not always available. 

The Remote Address’s angular distance on the earth's 

Longitude Alphanumeric 10 

surface, measured east or west from the prime meridian 

at Greenwich, England. 

Example “45.1253” 

The Remote Address’s angular distance north or south 

Latitude Alphanumeric 10 of the earth's equator, measured in degrees. 

Example “30.6532” 


MerchantId^100000~TransactionType^GP~OrderNumber^10098987~StrID^1125261~MessageCode^100 

~GPID^~10003606~REMOTE_ADDR^206.196.124.2~CountryCodeÛS~Region^QC~City^Montreal~Lon 

gitude^45.1253~Latitude^30.6532 

183

Supplementary IM(Q) Request 

Data 


Field Name 







M 





M 



M 





M 



M 


Transaction Type, “IM” for Identify Me 

System. 

M 






O 





M 





O 


Reference Number from IM system. 

Example “10003606” 

M 



peÎM~RequestType^Q~IsTest^1~TimeOut^60000~IMID~10003606 

STLink will return the following Response for an Identify Me (IM) 

Query Request (Q) 





TransactionType Alpha 2 Transaction Type, “IM” for IdentifyMe System 




specified. 

Example “10098987” 


184



Reference Number from IM system. 

Example “10003606” 

Code returned when verification is requested. 

MessageCode Alphanumeric 16 

185 

Possible values position 1 DOB verification: 










E = Error 


Note: For legacy merchant value 2 will return message 

Partial Match Year only 

Possible values position 2-6 ID Verification: 

0 = [IDType] Matched 






E = Error 


Possible values position 7 Electoral Roll verification: 

0 = Matched 






E = Error 


Possible values position 8 British Telecom verification: 

0 = Matched 






E = Error 

N = Not Applicable


Possible values position 9 Directors Data verification: 

0 = Matched 






E = Error 


186 

Possible values position 10 Sanctions: 

0 = Matched 






E = Error 


Possible values position 11 Deceased: 

0 = Matched 






E = Error 


Possible values position 12 Global-ID: 

0 = Matched 






E = Error 


Possible values position 13 PEP: 

0 = Matched 






E = Error 

N = Not Applicable


Possible values position 14 SDN: 

0 = Matched 






E = Error 


Message Alphanumeric N\A 



187 

Possible values position 15 Terrorist: 

0 = Matched 






E = Error 


Possible values position 16 Financial: 

0 = Matched 






E = Error 


Note: Message code will contain a sequence of 

alphanumeric values each mapping to a given validation 

request as indicated above. One value will be returned 

for each of the 16 possible positions. MessageCode will 

therefore be of length 16. 

Note: The term is defined as a probable match, not an 

exact match. 

Descriptive message of MessageCode 

Example: “Partial Match age group above 18, Partial 

ID matched” 

Machine Readable Zone (MRZ) line 1 of the passport. 

Example: 

“A


MerchantId^100000~TransactionTypeÎM~OrderNumber^10098987~StrId^1125261~IMID^10088717~Me 

ssageCode^0~Message^DOB Matched 

188

6.3 XML Definitions 

RiskGuardian Request (RG) 

Request Response 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

189 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 


 

 

 

 

 

 

 

 

 

 

 

 

 

190

RiskGuardian Request (RG) with RequestType = R for Reprocessing 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

191 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

DataShare: 

Authorisation Request (DS)(A) 

Deposit (Settlement) Request (DS)(D) 

Sale Request (DS)(S) 

Refund Request (DS)(R) 

Finalise Request (DS)(F) 

Cancellation Request (DS)(C) 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

192 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

193

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

194

Data Sharing PayBack with Electronic Credit Request (DS)(P) 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

195 

 

 

 

 

 

 

 

 

 

 

 

 

 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

196


 

 

 

 

 

 

 

 

 

 

197

PaymentTrust Authorization Request (PT)(A) 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

198 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

PaymentTrust Forced Authorization Request (PT)(A) 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

199 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

200

PaymentTrust Deposit (Settlement) Request (PT)(D) 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

201 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

PaymentTrust Refund Request (PT)(R) 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

202 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

PaymentTrust Forced Refund Request (PT)(R) 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 


Request (PT)(S) 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

203 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 


(Sale) Request (PT)(S) 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

204 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

PaymentTrust Cancellation Request (PT)(C) 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

205 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

PaymentTrust PayBack with Credit Card Request (PT)(P) 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

206 

 

 

 

 

 

 

 

 

 

 

 

 

 

PaymentTrust PayBack with Cheque Request (PT)(P) 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

207 

 

 

 

 

 

 

 

 

 

 

 

 

 

PaymentTrust PayBack with Electronic Credit Request (PT)(P) 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

208 

 

 

 

 

 

 

 

 

 

 

 

 

 

PaymentTrust Bank Transfer ID Request (PT)(B) 


 

 

 

 

 

 

 

 

 

 

 

 

 

209 

 

 

 

 

 

 

 

 

 

 

 

 

 

PaymentTrust Deposit (Settlement) Request (PT)(D) for PURCHASING 



 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

210 

 

 

 

 

 

 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

211


request (PT)(S) for PURCHASING CARDS (VISA, AMEX, MASTER 

CARD) 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

212 

 

 

 

 

 

 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

213

PaymentTrust Refund Request (PT)(R) for PURCHASING CARDS 

(VISA, AMEX, MASTER CARD) 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

214 

 

 

 

 

 

 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

215

Data Sharing Batch Request (DS) 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

< AccountCountryCode /> 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

216 

 

 

 

 

 

 

 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

217


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

218

PaymentTrust Forced Authorization Batch Request (PT)(A) 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

219 

 

 

 

 

 

 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

220

PaymentTrust Deposit (Settlement) Batch Request (PT)(D) 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

221 

 

 

 

 

 

 

PaymentTrust Refund Batch Request (PT)(R) 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

222 

 

 

 

 

 

 

PaymentTrust Forced Refund Batch Request (PT)(R) 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

223 

 

 

 

 

 

 


Batch Request (PT)(S) 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

224 

 

 

 

 

 

 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

225


(Sale) Batch Request (PT)(S) 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

226 

 

 

 

 

 

 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

227

PaymentTrust Cancellation Batch Request (PT)(C) 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

228 

 

 

 

 

 

 

PaymentTrust PayBack with Credit Card Batch Request (PT)(P) 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

229 

 

 

 

 

 

 

PaymentTrust PayBack with Cheque Batch Request (PT)(P) 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

230 

 

 

 

 

 

 

PaymentTrust PayBack with Electronic Credit Batch Request (PT)(P) 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

231 

 

 

 

 

 

 

PaymentTrust Bank Transfer ID Batch Request (PT)(B) 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

232 

 

 

 

 

 

 

PaymentTrust Deposit (Settlement) Batch Request (PT)(D) for 

PURCHASING CARDS (VISA, AMEX, MASTER CARD) 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

233 

 

 

 

 

 

 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

234


Batch Request (PT)(S) for PURCHASING CARDS (VISA, AMEX, 

MASTER CARD) 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

235 

 

 

 

 

 

 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

236

PaymentTrust Refund Batch Request (PT)(R) for PURCHASING 



 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

237 

 

 

 

 

 

 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

238

3D Secure Verify Enrollment Request (3D)(V) 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

3D Secure Authenticate Request (3D)(A) 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

239 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Foreign Exchange Rate Request (FX)(X) 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Foreign Exchange Placement Request (FX)(D) 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

240 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Foreign Exchange Refund Request (FX)(R) 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

241 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Foreign Exchange Cancellation Request (FX)(C) 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

BIN System Request (BN) (Also known as Issuer Identification 

Number) 


 

 

 

 

 

 

 

 

 

 

 

 

IP Geo Positioning Request (GP) 


 

 

 

 

 

 

 

 

 

 

 

 

242 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Identify Me Request (IM) 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

243 

 

 

 

 

 

 

 

 

 

 

 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

244

RiskGuardian (RG) Supplementary (Q) Request 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

245 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

DataShare (DS) Supplementary (Q) Request 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

246 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

PaymentTrust (PT) Supplementary (Q) Request for communication 

failures. 


 

 

 

 

 

 

 

 

 

 

 

247 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

PaymentTrust (PT) Supplementary (Q) Request for Batch 

Submissions 


 

 

 

 

 

 

 

 

 

 

 

 

248 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Foreign Exchange Supplementary (Q) Request 


 

 

 

 

 

 

 

 

 

 

 

 

249 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

BIN (BN) Supplementary (Q) Request 


 

 

 

 

 

 

 

 

 

 

 

 

 

250 

 

 

 

 

 

 

 

 

 

 

 

 

IP Geo Positioning (GP) Supplementary (Q) Request 


 

 

 

 

 

 

 

 

 

 

 

 

 

Identify Me (IM) Supplementary (Q) Request 


 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

DataShare: Historical Data Loading 

A comma delimited (CSV) file used to load a merchant’s historical data into the Data Sharing system. 

Note: There is a limit of 500,000 transactions per HDL file. 

HDL Header 

The header is the first line of the HDL file. 

Data 


Column Field Name Data Type Size Description 


1 VersionUsed Alphanumeric 4 



DS. 



M 

2 MerchantId Numeric N/A PaymentTrust Ltd. 


M 

3 UserName Alphanumeric 15 




M 

4 UserPassword Alphanumeric 15 Ltd. 


M 

5 TransactionType Alphanumeric 2 Transaction Type, “DS” for DataShare M 

6 IsTest Numeric 1 



O 

7 NumberOfRecords Numeric 1 

Number of record events included in the 

HDL file. 

M 

HDL Record Event 

The body of the HDL file consists of multiple record events. Each new line is a separate record event. 

All fields are delimited by a coma. 

Note: Please reference the latest Ethoca integration documents for additional information regarding 

optional fields. 

Colum 

Data 


n Field Name Data Type Size Description 


1 MerchantTRXId Alphanumeric 35 

The transaction ID is a merchant unique id 

for the request that they have submitted. It 

is used to check whether the request has 

already been processed successfully 

previously. 

Note: For existing merchants the RGID 

should be used. 

M 

251

Colum 

Data 




2 CustAcctID Alphanumeric 60 Client account ID. O 

3 CustId Alphanumeric 250 Client ID. O 

4 TRXProcessorID Alphanumeric 250 

The ID generated by the processor/financial 

institution of the transaction. 




O 

5 RequestType Alphanumeric 1 ‘S’ Sale 



Note: Defaults to ‘A’ 

For use to differentiate between merchants 

O 

6 StoreID Alphanumeric 10 

or stores. Permanent Store ID assigned by 

TrustMarque or merchant if left blank. 


Account type. 




O 

7 MOP Alpha 2 

CQ - Cheques 







Credit Card information. 

M 

8 TRXSource Numeric N/A 

9 MessageCode Numeric N/A 

252 







not present) 






Note: Please See Appendix E for complete 

list of results. 

10 InfractionMessageCode Alphanumeric 5 Bank code returned for the transaction O 

11 OrderNumber Alphanumeric 

12 AcctName Alphanumeric 60 

35 

Specific Order Number submitted by the 

merchant for tracking purposes. 

Example “10098987” 




Account holder name on card or account. 


O 

O 

O 

O

Colum 

Data 




13 AcctNumber Numeric N/A 

Credit Card number, Debit Card number, 

Purchase Card number, Bank Account 

number, or any other applicable bank 

identifier. 

Example “4459510002561039” 


TRXSource is 1. 


format 

O 

14 ExpDate Numeric N/A Example “092010” 


types. 

O 

15 IssueNumber Numeric N/A 



O 

16 StartDate Numeric N/A 




O 

17 PayeeBankNumber Numeric N/A 

transferred. 

Note: Mandatory for payback with electronic 

credit. 


O 

18 IBAN Alphanumeric 35 

Code and Bank Account number. 

Example: “fr1234567890” 



O 

19 PayeeAccountNumber Numeric N/A 

transferred. 

Note: Mandatory for payback with electronic 

credit. 


O 

20 PaymentREF Alphanumeric 60 



empty string. 

ISO standard numeric ids. 


O 

21 CurrencyId Numeric N/A GBP 


values. 

The type of account being used: 

M 

22 AcctSetUp Numeric N/A 

Example: 

0 = Not Joint 

1 = Joint 

Indicates type of transaction. 

Example: 

0 – Pre-arranged Payment, e-check 

O 

23 TRXType Numeric N/A 1 – Point of Purchase 

2 – Accounts Receivable Conversion 

3 – Telephone Initiated 

4 – Internet Initiated 

The type of bank account. 

Example: 

O 

24 TypeOfAcct Numeric N/A 0 = Checking 

1 = Savings 

2 = Other 

O 

25 PrimaryAcctName Alphanumeric 60 The primary account holder’s name. O 

26 SecondaryAcctName Alphanumeric 60 The secondary account holder’s name. O 

253

Colum 

Data 




27 AccountCountryCode Alpha 2 

Payee’s account number ISO Country 

Code. 



values 

Was the event successfully represented or not. 

O 

28 Representment Numeric 1 

Valid values for this are: 

Example : 0 = No 

1 = Yes 

1st party fraud occurs when a customer commits 

fraud on their own account. 3rd party fraud 

occurs when a 3rd party steals a financial 

instrument (e.g., credit card) and commits fraud 

O 

29 Fraud Type Numeric 1 on someone else's account. 

O 

30 Amount Numeric N/A 

31 InfractionAmount Numeric N/A 

32 TRXDateTime Alphanumeric 20 

33 InfractionDateTime Alphanumeric 20 

34 Company Alphanumeric 60 

35 Title Alphanumeric 20 

36 FirstName Alphanumeric 60 

254 

Example: 

0 = First Party Fraud 

1 = Third Party Fraud 



CurrencyId. 

Example 840 = “56.78”, 392 = “99”, 048 = 

“125.333” 



CurrencyId. 

Example 840 = “56.78”, 392 = “99”, 048 = 

“125.333” 



Example “20050223164000” 









Example “20050223164000” 






Billing contact company. 

Example “Trustmarque” 

Billing contact Title. 


Billing contact First Name. 


37 MiddleName Alphanumeric 60 Billing contact Middle Name. O 

38 LastName Alphanumeric 60 

Billing contact Last Name. 


M 

O 

M 

O 

O 

O 

M 

M

Colum 

Data 




39 AliasFirstName Alphanumeric 20 

Alias First Name of the individual to be 

verified. 


Alias Middle Name of the individual to be 

O 

40 AliasMiddleName Alphanumeric 20 verified. 


Alias Last Name of the individual to be 

O 

41 AliasLastName Alphanumeric 20 verified. 


O 

42 Suffix Alphanumeric 20 

Billing contact suffix. 


Billing contact Address line 1. 

O 

43 Address1 Alphanumeric 60 Example “2130 Gold” 


M 

44 Address2 Alphanumeric 60 

Billing contact Address line 2. 


O 

45 Address3 Alphanumeric 60 Billing contact Address line 3. O 

46 Unit Alphanumeric 15 Billing unit number / apartment number. O 

47 BuildingNumber Alphanumeric 10 Billing house, or building number. O 

48 StreetName Alphanumeric 30 Billing street name. O 

49 StreetType Alphanumeric 15 

Billing street type. 


Billing street direction. 

Example: 

N = North 


O 

50 StreetDirection Alpha 2 

E = East 


S = South 


W = West 



O 

51 City Alphanumeric 60 Example “New York” 

Note: Required for AVS. 




M 


52 StateCode Alphanumeric 60 this as an Optional field. 




values. 

Billing contact ZIP / Postal Code. 

O 

53 ZipCode Alphanumeric 30 Example “90210” 



O 


54 CountryCode Alpha 2 Note: Required for AVS. 


values. 


M 

55 PhoneNumber Alphanumeric 30 no parentheses. 

Example “6188565656” 

O 

255

Colum 

Data 




56 PhoneExtension Alphanumeric 10 

Billing contact Phone Extension. 


O 

57 Email Alphanumeric 50 

Billing contact Email address. 


O 

58 Email2 Alphanumeric 50 

Additional Email address 3. 


Additional Email address 2 type. 

“Business” 

“Other1” 

O 

59 EmailType2 Alphanumeric 8 “Other2” 

“Other3” 

Note: Field becomes mandatory if Phone2 is 

populated. 

O 

60 Email3 Alphanumeric 50 

Additional Email address 3. 


Additional Email address 3 type. 


“Other1” 

O 

61 EmailType3 Alphanumeric 8 “Other2” 

“Other3” 

Note: Field becomes mandatory if Phone3 is 

populated. 



O 

62 DOB Numeric N/A 

Example “23091963” 



beginning. I.e: 9 becomes 09. 




provided. 


O 

63 IDType1 Alpha 2 DL – Drivers License 




OT – Other 


O 

64 IDHolder1 Alphanumeric 60 Name of the ID holder. 




O 

65 IDNumber1 Alphanumeric 100 number is provided. 






O 

66 IDExpiryDate1 Numeric N/A 

Example “23091963” 




O 

256

Colum 

Data 




67 IDIssuingCountry1 Alpha 3 


identification. 




O 

68 IDIssuingStateCode1 Alpha 30 

State/Province which issued the piece of 




O 

69 IDIssueDate1 Numeric N/A 

Example “23091963” 







provided. 


O 





OT – Other 


O 

71 IDHolder2 Alphanumeric 60 Name of the ID holder 




O 







O 


Example “23091963” 






O 

74 IDIssuingCountry2 Alpha 3 Note: On passports country of issuance is 



O 






O 


Example “23091963” 




O 

257

Colum 

Data 




77 IDType3 Alpha 2 




provided. 






OT – Other 


O 

78 IDHolder3 Alphanumeric 60 Name of the ID holder. 




O 







O 

80 IDExpiryDate3 Numeric 8 

Example “23091963” 






O 




O 






O 


Example “23091963” 







provided. 


O 





OT – Other 


O 

85 IDHolder4 Alphanumeric 60 Name of the ID holder. O 

258

Colum 

Data 




86 IDNumber4 Alphanumeric 100 










O 


Example “23091963” 






O 



a label stating “Issuing Country”. 

O 


State/Province sued the piece of 




O 


Example “23091963” 







provided. 


O 





OT – Other 


O 

92 IDHolder5 Alphanumeric 60 Name of the ID holder 




O 







O 


Example “23091963” 




O 

259

Colum 

Data 




95 IDIssuingCountry5 Alpha 3 






O 


State/Province sued the piece of 




O 


Example “23091963” 




O 

98 SecondaryCompany Alphanumeric 60 

Additional contact company 


O 

99 SecondaryTitle Alphanumeric 20 

Additional contact Title. 


O 

100 SecondaryFirstName Alphanumeric 60 

Additional contact First Name. 


O 

101 SecondaryMiddleName Alphanumeric 60 Additional contact Middle Name. O 

102 SecondaryLastName Alphanumeric 60 

Additional contact Last Name. 


Additional contact suffix. 

O 

103 SecondaryoSuffix Alphanumeric 20 Only if TypeOfSale = H 


O 

104 SecondaryAddress1 Alphanumeric 60 

Additional contact Address line 1. 


O 

105 SecondaryAddress2 Alphanumeric 60 

Additional contact Address line 2. 


O 

106 SecondaryAddress3 Alphanumeric 60 Additional contact Address line 3. O 

107 SecondaryUnit Alphanumeric 15 

Additional contact unit number / apartment 

number. 

O 

108 SecondaryBuildingNum 

ber 


Additional contact house, or building 

number. 

O 

109 SecondaryStreetName Alphanumeric 30 Additional contact street name. O 

110 SecondaryStreetType Alphanumeric 15 

Additional contact street type. 

Example: “avenue”, “street”, “road” 

Additional contact street direction 

Example: 

N = North 


O 

111 SecondaryStreetDirection Alpha 2 

E = East 


S = South 


W = West 


O 

112 SecondaryCity Alphanumeric 60 

Additional contact City. 


O 

260

Colum 

Data 




113 SecondaryStateCode Alphanumeric 30 

Additional contact state code, two-character 






values. 

O 

114 SecondaryZipCode Alphanumeric 30 

Additional contact ZIP / Postal Code 


Additional contact ISO Country Code, list 

will be provided by PaymentTrust Ltd. 

O 

115 SecondaryCountryCode Alpha 2 Example “US” 


values. 

Additional contact type of address. 


O 

116 SecondaryAddressType Alphanumeric 50 

“Shipping” 

“Home” 

Note: Field becomes mandatory if secondary 

address information is populated 

O 

117 PhoneNumber1 Alphanumeric 30 

Additional Phone Number 1. 

Example “6188565656” 

O 

118 PhoneExtension1 Alphanumeric 10 

Additional Phone Number 1 Extension. 


Additional Phone Number 1 ISO Country 

O 

119 PhoneCountryCode1 Alphanumeric 2 

Code. 


values. 

Additional Phone Number 1 type. 


“BusinessFax” 

“Mobile” 

O 

120 PhoneType1 Alphanumeric 11 

“HomeFax” 

“Pager” 

“Other1” 

“Other2” 

Note: Field becomes mandatory if 

PhoneNumber1 is populated. 

O 



Example “6188565656” 

O 





O 


Code. 


values 




“Mobile” 

O 


“HomeFax” 

“Pager” 

“Other1” 

“Other2” 



O 

261

Colum 

Data 






Example “6188565656” 

O 





O 


Code. 


values 




“Mobile” 

O 


“HomeFax” 

“Pager” 

“Other1” 

“Other2” 






O 

129 ProcessType Numeric N/A “2” for “Score transaction, and add to data 

for future scores” 



M 

130 IsChargeBack Numeric N/A 

''1” for "Yes”, “0” for "No", 



Example “207.253.196.193” or 

O 

131 REMOTE_ADDR Alphanumeric 100 “Dialup339.trustmarque.com” 




Example “207.253.196.193” or 

M 

132 REMOTE_ADDR2 Alphanumeric 100 “Dialup339.trustmarque.com” 



O 

133 HTTP_USER_AGENT Alphanumeric 

200 Customer’s HTTP header 


O 

262

7 DEVELOPMENT 

Developing for STLink and STN 

This section outlines guidelines and sample code for communicating with STLink. Code 

fragments are shown for the more common programming environments. 

The supplied strings are only examples and do not represent real strings. Any URLs that are 

referenced are valid at the point of this document’s creation and may change at any time. 

Requests may be submitted in XML. XML responses will be returned. Submitted code will differ 

only in that submitted string requests will be in XML format suggested by PaymentTrust Ltd.. 

All transaction requests must be submitted to STLink and all batch requests to STLink Batch. 

Both STLink and STLink Batch accept the HTTP and HTTPS protocols, though it is 

recommended that the HTTPS protocol be used to safely transmit the requests via the Internet. 

All requests must be submitted using the HTTP POST method. The POST method works by 

supplying key/value pairs, where the key and value are split by the “=” symbol and key/value 

pairs by the “&” symbol. For instance: key1=some value&key2=some value... In the case of 

STLink, there is one key value pair. The key is StringIn and the value is any transaction type 

outlined in section 6.1. 

Example Q request (Non XML): 


Q~IsTest^1~TimeOut^60000~BatchId^938344376~ 

Example Q request (XML): 

StringIn=1100000Mariahrr87uyQ190000938344376 

Though STLink Batch accepts POST requests, it is important to note that the StringIn key is not 

required and must not be submitted to the STLink Batch for batch requests. If not the batch 

request will be rejected for reason of being a malformed XML document. 

The “=” and “&” symbols are standard characters used in the HTTP protocol to separate 

key/value pairs, there fore it is important that no “=” and “&” symbols be found in the transactions, 

although this can be overcome by escaping all characters after the StringIn key by using URL 

encoding. URL encoding allows the “=”, “&” and other HTTP characters to be included in the 

transaction. 

Example: 

StringIn= 

Because STLink Batch does use the StringIn key, the batch request must not be URL encoded. If 

not the batch request will be rejected for reason of being a malformed XML document. 

XML has its own encoding rules. For 0ne, the STLink and STLink Batch will support any XML 

document that has been encoded in an 8-bit ANSI character set, such as: ISO-8859-1. Second of 

all XML has its own share of “special” characters. If any of these characters are to be included 

within the data of a specified transaction tag, they to must be escaped. The table below lists 

those characters and their escape sequence. 

263

264 

Character Description Escape Sequence 

< Less than < 

> Greater than > 

& Ampersand & 

‘ Single quote ' 

“ Double quote " 

Example: 

 

 

The text in here contains a less than symbol. Here it is: < 

The text in here contains a double quote symbol. Here it is: " 

C++ code sample 

Communication with STLink can be performed via VC’s WinInet Internet classes – 

CInternetSession, CHttpConnection, and CHttpFile. 

The following code fragment illustrates sending of HTTPS and HTTP data to STLink. 

// Create the Internet objects 

CInternetSession session; 

CHttpConnection *pConnection = NULL; 

CHttpFile *pFile = NULL; 

CString URL = 

“https://www.paymenttrust.ca/stlinkssl/test/stlink.dll?StringIn=VersionUsed^3~MerchantId^100000 

~UserName^Mariah~UserPassword^rr87uy~TransactionType^RG~IsTest^1~TimeOut^60000~M 

OP^CC~AcctName^John 

Smith~AcctNumber^4459510002561039~ExpDate^092010~CurrencyId^840~Amount^56.78~Firs 

tName^John~LastName^Smith~Address1^2130 Gold~City^New 

York~CountryCodeÛS~PhoneNumber^6188565656~REMOTE_ADDR^205.188.146.23“; 

CString POSTstring = 

"https://www.paymenttrust.ca/stlinkssl/test/stlink.dll?StringIn=VersionUsed^3~MerchantId^100000 





York~CountryCodeÛS~PhoneNumber^6188565656~REMOTE_ADDR^205.188.146.23"; 

int status, x; 

UINT numbytes=0; 

char buffer[10000], *temp; 

CString outstring, server, object, inbox_buffer; 

DWORD service_type; 

INTERNET_PORT url_port; 

// get the URL and parse it 

AfxParseURL(URL, service_type, server, object, url_port); 

outstring = object; 

// GET Request 

try 

{ 

265

if (url_port == 443) 

{ 

// HTTPS request 

pConnection = session.GetHttpConnection(server, INTERNET_FLAG_SECURE | 

INTERNET_FLAG_IGNORE_CERT_CN_INVALID, 443); 

pFile = pConnection->OpenRequest(1, outstring, NULL, 1, NULL, NULL, 

} 

266 

INTERNET_FLAG_SECURE|INTERNET_FLAG_IGNORE_CERT_CN_INVALID); 

} 

else 

{ 

// HTTP request 

pConnection = session.GetHttpConnection(server, 0, 80); 

pFile = pConnection->OpenRequest(1, outstring, NULL, 1, NULL, NULL, 0); 

} 

pFile->SendRequest(); 

x=pFile->Read(buffer, 9999); 

buffer[x]='\0'; // ‘buffer’ contain received data 

catch (...) 

{ 

strcpy(buffer, "Exception Error"); // something went wrong 

} 

// POST Request 

try 

{ 

// search for the '?' and replace it with a null terminator 

// Note: this implies the URL will have a '?' in it 

strcpy(buffer, object); 

temp=strstr(buffer, "?"); 

*temp='\0'; 

if (url_port == 443)

{ 

// HTTPS 

pFile = pConnection->OpenRequest(0, buffer, NULL, 1, NULL, NULL, 

INTERNET_FLAG_SECURE | 

INTERNET_FLAG_IGNORE_CERT_CN_INVALID); 

} 

else 

{ 

// HTTP 

pFile = pConnection->OpenRequest(0, buffer, NULL, 1, NULL, NULL, 0); 

} 

} 

267 

strcpy(buffer, _T(LPCSTR(POSTstring))); 

pFile->SendRequest(NULL, 0, buffer, strlen(buffer)); 

x=pFile->Read(buffer, 9999); 

buffer[x]='\0'; // ‘buffer’ contain received data 

catch (...) 

{ 

strcpy(buffer, "Exception Error"); // something went wrong 

} 

// delete/free Internet objects after use 

if (pFile) delete pFile; 

if (pConnection) delete pConnection; 

The WinInet classes fire CInternetException exceptions when something goes wrong. The above 

code samples use catch–all exception handlers for simplicity.

VB code sample 

Communication with STLink can be performed via the Internet Transfer Control. 

The following code fragment illustrates sending of HTTPS GET/POST data to STLink. Both 

examples assume the Internet Transfer Control is called ‘Inet’. HTTP data is similar except 

references to HTTPS are directed to HTTP. 

Transmission via HTTPS GET 

Dim URL As String 

URL = " 

https://www.paymenttrust.ca/stlinkssl/test/stlink.dll?StringIn=VersionUsed^3~MerchantId^100000 





York~CountryCodeÛS~PhoneNumber^6188565656~REMOTE_ADDR^205.188.146.23" 

' this routine sends a string to STLink using a GET method and assigns the returned data to a text 

box 

Inbox.Text = Inet1.OpenURL(URL) + vbCrLf 

Transmission via HTTPS POST 

Dim POSTstring As String 

Dim URL As String 

POSTstring = " 

https://www.paymenttrust.ca/stlinkssl/test/stlink.dll?StringIn=VersionUsed^3~MerchantId^100000 





York~CountryCodeÛS~PhoneNumber^6188565656~REMOTE_ADDR^205.188.146.23" 

' This routine sends a string to STLink using a POST method 

' Note: POST requests do not have query strings appended to the URL 

URL = "https://www.paymenttrust.ca/stlinkssl/test/stlink.dll" 

Inet1.Execute URL, "POST", POSTstring 

268

Whereas the OpenUrl method returns immediately, the Internet Transfer Control will fire a 

StateChanged event on incoming data as follows: 

Private Sub Inet1_StateChanged(ByVal State As Integer) 

If State = icResponseCompleted Then 

Inbox.Text = Inet1.GetChunk(1000, icString) + vbCrLf ‘ incoming data assigned to a 

text box 

End If 

End Sub 

269

HTTP/ASP sample code 

Server side ASP code makes use of the STL COM object. The STL COM object must be 

registered on the IIS server prior to its use (ex: regsrv32 STLCOM.dll). The sample code below is 

taken as is from the provided ASP sample code fragments supplied by PaymentTrust Ltd.. 

 

 

' Submit to the STLink and store the result for handling. 

result = TMHTTP.submit() ß THE RESULT IS STORED HERE 

' Release the STL COM object 

set TMHTTP = nothing 

Code from this point onwards illustrates how the received data may be used. 

' In this sample the result is parsed and formatted to be displayed in a HTML table. 

' The result can be parsed and manipulated in any way such as: Stored in a database. 

' Arrays to split StringIn into tokens 

Dim tokens1 

Dim tokens2 

'Split the result into tokens at every '~' 

tokens1 = split(result, "~") 

' Build an HTML table to display data nicely. 

Dim table 

table = table & "" 



table = table & "Parameter" 

table = table & "Value" 


' Loop indexes 

Dim i1 

Dim i2 

' Loop through the tokens 

for i1=0 to UBound(tokens1) 

271 

table = table & ""

"" 

next 

272 

' Split the tokens even more at every '^' 

tokens2 = split(tokens1(i1), "^") 

for i2=0 to UBound(tokens2) 

next 


table = table & "" & tokens2(i2) & 




%> 

 

 

Untitled Document 

 

 

Result: 

 

 

 

Java sample code 

The following Java code fragments are intended for the Java JDK v1.3 or later. Java JSSE 1.0.2 

or later is required. Make sure the JSSE jar files are found within the extensions folder [JRE 

Home]/lib/ext. When compiling sample code, make sure JSSE jar files are within the 

CLASSPATH. The sample code below is taken as is from the provided Java sample code 

fragments supplied by PaymentTrust Ltd. 

import java.security.*; 

import java.net.*; 

import java.io.*; 

import java.util.*; 

public class HTTPClient 

{ 

public static void main(String[] args) 

{ 

// Set up a few system properties to be able to send transactions securely to 

// the HTTP server. For more information please visit: http://java.sun.com/products/jsse/ 

// 

// Dynamically register the sun SSL provider. 

Security.addProvider(new com.sun.net.ssl.internal.ssl.Provider()); 

// Add the JSSE URL handler to the list of packages which are searched by the 

// java URL class. 

System.setProperty("java.protocol.handler.pkgs", "com.sun.net.ssl.internal.www.protocol"); 

273 

// HTTP method to be used to communicate to HTTP server. 

// Values allowed: GET or POST. This is used to demonstrate how to use both 

// methods. It is recommended to use the POST method. 

String httpMethod = new String("POST"); 

// The URL location to connect to. 

// To connect to the HTTP server securely, http:// must be replaced with https:// 

String urlLocation = new String("https://www.paymenttrust.ca/stlinkssl/test/stlink.dll"); 

// The STL transaction string. 

// We use URLEncoder to encode any reserved characters by the HTTP protocol. 

String transaction = new 

String(URLEncoder.encode("https://www.paymenttrust.ca/stlinkssl/test/stlink.dll?StringIn=Version

Used^3~MerchantId^100000~UserName^Mariah~UserPassword^rr87uy~TransactionType^RG~I 

sTest^1~TimeOut^60000~MOP^CC~AcctName^John 



York~CountryCodeÛS~PhoneNumber^6188565656~REMOTE_ADDR^205.188.146.23")); 

274 

// THE HTTP GET and POST methods are sent differently to the HTTP server. 

// There for we must build the final query string to the specifications of 

// each method. 

// 

// The query string for the GET method is part of the HTTP header. To separate 

// the query string from the URL location we use '?'. POST does not require 

// this since it is sent to the HTTP server after the HTTP headers. 

String getString = new String("?StringIn=" + transaction); 

String postString = new String("StringIn=" + transaction); 

try 

{ 

// The URL class is used to connect to the HTTP server. 

URL url = null; 

// The URLConnection is an abstract class and provides more functionality then 

// the URL class. 

URLConnection urlConnection = null; 

// The Buffered writer and reader to send and receive data to the HTTP server. 

BufferedWriter out = null; 

BufferedReader in = null; 

// Proceed according to the HTTP method to be used. 

if(httpMethod.equals("GET")) 

{ 

// Build the final URL to the HTTP server. 

url = new URL(urlLocation + getString); 

try 

{ 

// Connect to the server.

275 

urlConnection = url.openConnection(); 

// Get the input stream from the socket and attach it to a BufferedReader. 

in = new BufferedReader(new InputStreamReader(urlConnection.getInputStream())); 

// Used to store incoming data from the HTTP server. 

String input = new String(); 

// Read the data coming from the HTTP server into the input string. 

input = in.readLine(); 

System.out.println("Result from GET method"); 

System.out.println("-----------------------------------------------"); 

parseInput(input); 

} 

catch(IOException ex) 

{ 

System.out.println("Error occurred while attempting GET: " + ex.toString()); 

} 

} 

else if(httpMethod.equals("POST")) 

{ 

// Build the final URL to the HTTP server. 

url = new URL(urlLocation); 

try 

{ 

// Connect to the server. 

urlConnection = url.openConnection(); 

// Set this flag to true to be able to post data to the HTTP server. 

urlConnection.setDoOutput(true); 

// Get the output stream from the socket and attach it to a BufferedWriter. 

out = new BufferedWriter(new OutputStreamWriter(urlConnection.getOutputStream())); 

// POST the STL transaction to the server.

276 

out.write(postString); 

out.close(); 

// Get the input stream from the socket and attach it to a BufferedReader. 

in = new BufferedReader(new InputStreamReader(urlConnection.getInputStream())); 

// Used to store incoming data from the HTTP server. 

String input = new String(); 

// Read the data coming from the HTTP server into the input string. 

input = in.readLine(); 

System.out.println("Result from POST method"); 

System.out.println("-----------------------------------------------"); 

parseInput(input); 

} 

catch(IOException ex) 

{ 

System.out.println("Error occurred while attempting POST: " + ex.toString()); 

} 

} 

} 

catch(MalformedURLException e) 

{ 

System.out.println("Error occurred while attempting URL connection: " + e.toString()); 

} 

} 

// Parses the response received from the HTTP server and displays it in a table. 

public static void parseInput(String input) 

{ 

// String is parsed into tokens of strings at each ~ 

StringTokenizer st1 = new StringTokenizer(input, "~"); 

while(st1.hasMoreTokens()) 

{ 

// String is parsed into tokens of strings at each ^

277 

StringTokenizer st2 = new StringTokenizer(st1.nextToken(), "^"); 

System.out.print(st2.nextToken() + " = " + st2.nextToken()); 

System.out.println(); 

} 

}

8 Appendices 

STLink Message Codes 

278 

Appendix A 

Message Code Description 

100 Ok 

200 Transaction does not exist 

300 Field(s) Missing (Basic) 

302 Wrong MerchantId, User Name or Password 

303 

DB/System undefined errors or packet loss during transmission - Please send 

again 

304 Time out during Transmission - Please send again 

305 HTTP(S) method not supported – Please call support 

306 Batch Transmission Error - Failed to write to file 

307 Invalid document or Wrong XML Format 

400 Wrong Format (Basic) 

401 Wrong Format (Transaction Specific) 

402 (GP) Wrong Format or Parameter(s) Missing 

499 Transaction not allowed 

500 Transaction Type not Supported 

900 Security ERROR - Please call Support

Currency IDs 

279 

Country Name 

Count 

ry 

Code 

Appendix B 

Currency Name 

Currency 

ID 

Currency Code 

AUSTRALIA AUS AUSTRALIAN DOLLAR 36 AUD 

AUSTRIA AUT SCHILLING 40 ATS 

BAHRAIN BHR BAHRAINI DINAR 48 BHD 

BELGIUM BEL BELGIAN FRANC 56 BEF 

BERMUDA BMU BERMUDIAN DOLLAR 60 BMD 

BRAZIL BRA BRAZILIAN REAL 986 BRL 

CANADA CAN CANADIAN DOLLAR 124 CAD 

COLOMBIA COL COLOMBIAN PESO 170 COP 

CYPRUS CYP CYPRUS POUND 196 CYP 

CZECH REPUBLIC CZE CZECH KORUNA 203 CZK 

DENMARK DNK DANISH KRONE 208 DKK 

EUROPEAN UNION EUR EURO 978 EUR 

FINLAND FIN MARKKA 246 FIM 

FRANCE FRA FRENCH FRANC 250 FRF 

FRENCH POLYNESIA PYF CFP FRANC 953 XPF 

GERMANY DEU DEUTSCHE MARK 280 DEM 

GREECE GRC DRACHMA 300 GRD 

HONG KONG HKG HONG KONG DOLLAR 344 HKD 

HUNGARY HUN FORINT 348 HUF 

ICELAND ISL ICELAND KRONA 352 ISK 

INDIA IND INDIAN RUPEE 356 INR 

INDONESIA IDN INDONESIAN RUPIAH 360 IDR 

IRELAND IRL IRISH POUND 372 IEP 

ISRAEL ISR SHEKEL 376 ILS 

ITALY ITA ITALIAN LIRA 380 ITL 

JAMAICA JAM JAMAICAN DOLLAR 388 JMD 

JAPAN JPN YEN 392 JPY 

JORDAN JOR JORDANIAN DOLLAR 400 JOD 

KOREA, REPUBLIC OF KOR WON 410 KRW 

KUWAIT KWT KUWAITI DINAR 414 KWD 

LUXEMBOURG LUX LUXEMBOURG FRANC 442 LUF 

MALAYSIA MYS MALAYSIAN RINGGITT 458 MYR 

MALTA MLT MALTESE LIRA 470 MTL 

MEXICO MEX MEXICAN NUEVO PESO 484 MXN 

MOROCCO MAR MOROCCAN DIRHAM 504 MAD 

NETHERLANDS NLD NETHERLANDS GUILDER 528 NLG 

NEW ZEALAND NZL NEW ZEALAND DOLLAR 554 NZD 

NORWAY NOR NORWEGIAN KRONE 578 NOK 

OMAN OMN RIAL OMANI 512 OMR 

PANAMA PAN BALBOA 590 PAB 

PHILIPPINES PHL PHILIPPINE PESO 608 PHP 

POLAND POL NEW ZLOTY 985 PLN 

PORTUGAL PRT PORTUGUESE ESCUDO 620 PTE 

QATAR QAT QATARI RIAL 634 QAR 

RUSSIAN FEDERATION RUS RUSSIAN RUBLE 643 RUB 

SAUDI ARABIA SAU SAUDI RIYAL 682 SAR 

SINGAPORE SGP SINGAPORE DOLLAR 702 SGD 

SOUTH AFRICA ZAF RAND 710 ZAR 

SPAIN ESP SPANISH PESETA 724 ESP 

SWEDEN SWE SWEDISH KRONA 752 SEK 

SWITZERLAND CHE SWISS FRANC 756 CHF 

TAIWAN TWD NEW TAIWAN DOLLAR 901 TWD 

THAILAND THA BAHT 764 THB 

TURKEY TUR TURKISH LIRA 792 TRL 

TURKEY TUR NEW TURKISH LIRA 949 TRY

280 

Country Name 

Count 

ry 

Code 

Currency Name 

Currency 

ID 

Currency Code 

UNITED ARAB EMIRATES (UAE) ARE UAE DIRHAM 784 AED 

UNITED KINGDOM GBR POUND STERLING 826 GBP 

UNITED STATES OF AMERICA USA US DOLLAR 840 USD 

UZBEKISTAN UZS UZBEKISTAN SUM 860 UZS 

VENEZUELA VEN BOLIVAR 862 VEB

PaymentTrust Result Codes 

281 

Appendix C 

Message 

Code 

Description Explanation 

2000 No answer Received no answer from banking network. Resend 

transaction. 

2001 Dropped the transaction No need to do this transaction 

2040 Pending to be finalized Request submitted and waiting for processing to be 

completed next cycle. 

2050 Request pending Request submitted and waiting for processing to be 


2051 Request Pending with Errors. Cannot find the BTID for the original request 

2053 Notification Received Notification Received 

2100 Transaction Authorized/Approved Transaction Authorized/Approved 

2101 Validated Validated 

2102 Verified Verified 

2103 Prenoted Prenoted 

2104 Transaction approved Transaction was approved - Base 24 

2105 Notification Cleared Notification Cleared 

2150 Funds deposited successfully Deposit request previously submitted has been 

processed successfully 

2160 Funds refunded successfully Refund request previously submitted has been 

processed successfully 

2170 Transaction cancelled successfully Cancellation request has been processed successfully 

2200 Transaction Declined Transaction Declined/Not Authorized/Not Settled 

2201 Acquirer/Issuer does not allow this Acquirer/Issuer does not allow this transaction 

transaction 

2203 Cancellation cannot be performed. Cancellation transaction failed. 

2204 Soft AVS Card was authorized but AVS did not match. Contact 

client. 

2206 Invalid currency Incoming record currency type does not match system 

stored currency 

2208 Invalid merchant account number Invalid merchant account number 

2210 Invalid credit card number Bad check digit, length, or other credit card problem 

2212 Invalid credit card expiration date Credit card has expired or incorrect date entered. 

Confirm date. 

2214 Credit card expired Credit card has expired 

2216 Invalid amount Amount sent was 0 or unreadable 

2218 Invalid method of payment Method of payment is invalid for this account number 

2219 Credit card is not valid for this 

transaction 

The specific credit card will not accept payment. 

2220 Invalid method of payment for 

merchant account number 

Method of payment is invalid for this merchant 

2222 Invalid field data Invalid information entered 

2223 No Sort code or Account Number in 

Payback system 

No Sort code or Account Number in Payback system 

2224 Data is inaccurate or missing Specific and relevant data within transaction is 

inaccurate or missing 

2226 Duplicated transaction Same transaction had been submitted 

2228 Invalid transaction Issuer does not allow this transaction

Message 

Code 


2229 Invalid transaction Processor permits only one deposit request per 

authorization 


2232 Invalid issuer Invalid issuer or institution 

2234 Invalid response code Invalid response code 

2235 Invalid Currency Code Entered Currency code submitted is different than code 

submitted with original authorization request 

2236 Invalid for credit Invalid for credit 

2237 Invalid refund not allowed (CFT) Invalid refund not allowed (CFT) 

2238 Invalid for debit Invalid for debit 

2240 Invalid SEC code - Amex Amex CID is incorrect 

2280 Incorrect start date Switch/Solo - Incorrect start date or requires an issue 

number. Please correct 

2282 Invalid issue number Switch/Solo - 1-digit number submitted when 2-digit 

number should have been sent. Please correct 

2284 Invalid transaction Switch/Solo - a format issue, re-examine transaction 

layout. Please correct 

2286 Bank not supported by Switch Bank not supported by Switch 

2300 Card does not exist No card record 

2302 Invalid transit routing number (ABA Invalid bank routing number 

282 

code) 

2304 Missing name Missing the check writer’s name. 

2306 Bank account closed Bank account has been closed 

2308 Invalid account type Account type is invalid or missing. Deposit transactions 

only 

2310 Account does not exist Account does not exist 

2312 No account Account number does not correspond to the individual 

2314 Account holder deceased Account holder deceased. No further debits will be 

accepted by the bank 

2316 Beneficiary deceased Beneficiary deceased. No further debits will be accepted 

by the bank 

2318 Account frozen The funds in this account are unavailable. No further 

debits will be accepted by the bank 

2320 Customer opt out Customer has refused to allow the transaction 

2322 ACH non-participant Banking institute does not accept ACH transactions (For 

US ECP) 

2324 Invalid account number Account number is incorrect 

2326 Authorization revoked by customer Customer has notified their bank not to accept these 

transactions 

2328 Customer advises not authorized Customer has not authorized bank to accept these 

transactions 

2330 Invalid CECP action code Pertains to Canadian ECP only. 

2332 Invalid account number format Format of account number does not pass check digit 

routine for that institution. (For CDN ECP) 

2334 Bad account number data Invalid characters in account number 

2350 Card surpassed daily limit Card has surpassed daily transaction amount limit 

2352 Times card used limit The limit of number of times used for the card has been 

surpassed 

2354 Over credit limit Card has surpassed its credit limit 

2356 Enter lesser amount Enter a lesser amount

Message 

Code 


2358 No credit amount No credit amount 

2360 One purchase limit Card is limited to one purchase 

2362 Over Sav limit Over Sav limit 

2364 Over Sav frequency. Over Sav frequency. 

2366 Card not supported Card not supported 

2368 Invalid PIN. Invalid PIN 

2370 Allowable PIN tries exceeded. Allowable PIN tries exceeded 

2372 PIN required PIN required 

2374 Card failed MOD 10 check Card failed MOD 10 check verification 

2380 On negative file Account number appears on negative file 

2382 Stop Payment Issued Stop Payment Issued 

2400 PTLF full PTLF full 

2401 Fraud suspected Fraud suspected 

2402 Unable to process transaction Unable to process transaction 

2403 Duplicate transaction Duplicate transaction 

2404 Cutoff in progress Cutoff in progress 

2405 Incorrect PIN Incorrect PIN 

2406 PIN tries exceeded PIN tries exceeded 

2407 Exceeds withdrawal frequency Exceeds withdrawal frequency 

2410 Invalid 3D Secure Data Invalid 3D Secure Data 

2610 Timeout error Timeout waiting for host response 

2611 Timeout error Internal timeout 

2612 Authorization host system down or 

unavailable 

Authorization host system is temporarily unavailable 

2614 Acquirer/Issuer unavailable. Authorization host network could not reach the bank, 

Resend 

which issued the card or Acquirer. 


2618 Unidentified error Unidentified error. Unable to process transaction 

2620 Unable to process. Unable to process transaction due to system 

malfunction 

2622 Unable to authorize. Unable to authorize due to system malfunction 

2624 Merchant information incomplete Merchant information incomplete 

2626 Invalid CVN value Invalid CVN value 

2627 Invalid track2 data The track2 format information is incorrect 

2628 Transaction not supported Merchant not Support this transaction 

2630 Invalid store ID No such store ID for the merchant 

2632 Invalid authcode Invalid authcode 

2634 Invalid format Invalid format 

2636 Invalid message type Invalid message type 

2638 Invalid POS system type Invalid POS system type 

2640 This transaction has been cancelled A message has be sent to reverse previous time out 

transaction 

2642 This TrxSource is not supported by 

the bank 

This TrxSource is not supported by the bank 

2644 Insufficient Terminal IDs, please try 

again 

Not enough terminal ID at the time of transaction 

2700 Invalid file General error for PC card 

2702 Amounts do not compute Amount is invalid 

283

Message 

Code 


2704 Line items do not add up to 

Line items do not add up to summary total 

284 

summary total 

2706 Not supported for batch Not supported for batch 

2712 Mandatory field is invalid or missing Mandatory field is invalid or missing 

2714 Total line items do not add up Total line items do not add up 

2716 Line items missing Line items missing 

2718 Commodity code is invalid or 

missing 

Commodity code is invalid or missing 

2720 Cross border information is invalid Cross border information is invalid or missing 

or missing 

2722 Invalid purchase card number Not a purchase card 

2802 Invalid ICC parameter. One of the ICC parameters submitted was invalid. 

2952 Pick up card Card issuer wants card returned. Call issuer 

2954 Card stolen Card reported as lost/stolen 

2956 Do not honor Generic decline. No other information is being provided 

by the issuer 

2958 Call Bank Issuer wants voice contact with cardholder 

2960 Insufficient funds Insufficient funds 

2962 CVV2 failure Issuer has declined request because CVV2 edit failed 

2964 Delinquent account. Delinquent account 

2990 Cancellation Cancellation is going to reverse the authorization 

3050 Transaction pending Transaction pending 

3051 Transaction pending with rate A new rate is assigned for the transaction 

escalated 

3100 Transaction approved FX transaction approved 

3111 Rate escalated Transaction rate escalated 

3170 Transaction cancelled successfully Transaction cancelled successfully 

3171 Transaction refunded Transaction refunded 

3200 Rate expired Rate requested has expired and no new rate is available 

3203 Cancellation cannot be performed 

The deposit/refund transaction being cancelled cannot 

be because it has already been submitted 

3204 Cancellation not enabled Cancellation disabled in merchant set-up 

3206 Invalid currency Invalid currency of record 

3207 Exchange currency not supported Exchange currency not setup in merchant account 

3208 CurrencyId matches 

ConvertedCurrencyId 

Conversion to same currency redundant 

3209 Currency pair not supported Cannot convert to requested currency 

3210 CurrencyId does not match FX Currency submitted does not match the original rate 

request 

request 

3216 Invalid amount Invalid amount 

3217 Invalid FXID Invalid FXID 

3218 Issuer is not available. Please try 

again 

Unexpected error 

3219 Credit card is not valid for this 

transaction 

Credit card is not valid for this transaction 

3220 Currency Not Supported Currency of card not supported 

3224 Data is inaccurate or missing One or more required parameters are not present 

3226 Duplicated transaction Duplicated transaction 

3228 Invalid transaction Generic error message for invalid transactions 

3321 Invalid account data Invalid account data 

3341 Non-executable rate Quoted rate is not executable 

3354 Refund amount over limit Refund is over the original value of the deal 

3361 Rate quote invalid Quoted rate is invalid 

3362 Rate expired not escalated Expired rate cannot be escalated

Message 

Code 


3371 Rate revoked Rate has been revoked 

3381 Transaction exceeds amount limit Transaction min/max limits reached 

3391 Batch size exceeds the maximum Batch size exceeds the Maximum allowable size 

allowed 

transaction/payment not written to database 

3614 FX system unavailable FX system cannot be reached 

3781 Refund not enabled Refund disabled in merchant set-up 

3783 Refund not possible Refund cannot be processed 

3785 Refund period expired Refund period expired 

4050 Cardholder enrolled Cardholder enrolled for 3D Secure 

4100 Cardholder authenticated Cardholder answered password/challenge question 

correctly 

4101 Cardholder authentication 

attempted 

Cardholder authentication attempted 

4200 Cardholder not enrolled Cardholder not enrolled for 3D Secure 

4202 Card not participating in 3D Secure Credit card is not recognized as a 3D Secure card 

4203 Cardholder enrolment not verified Cardholder enrolment not verified 

4204 Cardholder not authenticated Cardholder failed to answer password/challenge 

question 

4206 Invalid currency Invalid currency 


4210 Invalid credit card number Invalid credit card number 

4212 Invalid credit card expiration date Invalid credit card expiration date 

4216 Invalid amount Invalid amount 

4224 Data is inaccurate or missing Specific and relevant data within transaction is 

inaccurate or missing 

4228 Invalid transaction Invalid transaction 

4240 Cardholder enrolment failed Enrolment process failed 

4242 Cardholder authentication failed Authentication process failed 

4614 MPI not available MPI not available 

4616 Directory server not available Directory server not available 

4618 Internal MPI error Internal MPI error 

4626 Invalid SecureId Invalid SecureId 

4700 3D Secure transaction already 

processed 

3D Secure transaction already processed 

285

DataShare Result Codes 

286 

Appendix D 

Message 

Code 

6000 No answer 


No answer from 3 rd party service 

6001 Dropped the transaction No need to do this transaction 

6050 Transaction pending 

Request submitted and waiting for processing to be 


6100 Transaction processed Transaction processed 

6170 Transaction cancelled successfully Cancellation request has been processed successfully 

6200 Transaction NOT Authorized Transaction NOT Authorized 

Acquirer/Issuer does not allow this Acquirer/Issuer does not allow this transaction 

6201 

transaction 

6202 Cancellation declined Cancellation declined 

6203 Cancellation cannot be performed Cancellation transaction failed. 

Card was authorized but AVS did not match. Contact 

6204 Soft AVS 

client 

Incoming record currency type does not match system 

6206 Invalid currency 

stored currency 


Credit card has expired or incorrect date entered. 

6212 Invalid credit card expiration date Confirm date. 

6214 Transaction error, Please try again Submission error to service provider please try again 

6216 Invalid amount Amount sent was 0 or unreadable 

6218 Invalid method of payment Method of payment is invalid for this account number 

Credit card is not valid for this The specific credit card will not accept payment 

6219 transaction 

Invalid method of payment for Method of payment is invalid for this merchant 

6220 merchant account number 

6222 Invalid field data Invalid information entered 

Specific and relevant data within transaction is 

6224 Data is missing or inaccurate inaccurate or missing 

6226 Duplicated transaction Same transaction had been submitted 

6228 Invalid transaction Issuer does not allow this transaction 

Processor permits only one deposit request per 

6229 Invalid transaction 

authorization 



6234 Invalid response code Invalid response code 

6236 Invalid for credit Invalid for credit 

6237 Invalid refund not allowed (CFT) Invalid refund not allowed (CFT) 

6238 Invalid for debit Invalid for debit 

Switch/Solo - Incorrect start date or requires an issue 

6280 Incorrect start date 

number. Please correct 

Switch/Solo - 1-digit number submitted when 2-digit 

6282 Invalid issue number 

number should have been sent. Please correct 

Switch/Solo - a format issue, re-examine transaction 

6284 Invalid transaction 

layout. Please correct

Message 

Code 


6300 Card does not exist No card record 

Invalid transit routing number (ABA Invalid bank routing number 

6302 code) 

6304 Missing name Missing the check writer’s name. 

6306 Bank account closed Bank account has been closed 

Account type is invalid or missing. Deposit transactions 

6308 Invalid account type 

only 

6310 Account does not exist Account does not exist 

6312 No account Account number does not correspond to the individual 

Account holder deceased. No further debits will be 

6314 Account holder deceased 

accepted by the bank 

Beneficiary deceased. No further debits will be accepted 

6316 Beneficiary deceased 

by the bank 

The funds in this account are unavailable. No further 

6318 Account frozen 

debits will be accepted by the bank 

6320 Customer optout Customer has refused to allow the transaction 

Banking institute does not accept ACH transactions (For 

6322 ACH non-participant 

US ECP) 

6324 Invalid account number Account number is incorrect 

Customer has notified their bank not to accept these 

6326 Authorization revoked by customer transactions 

Customer has not authorized bank to accept these 

6328 Customer advises not authorized transactions 

6330 Invalid CECP action code Pertains to Canadian ECP only. 

Format of account number does not pass check digit 

6332 Invalid account number format routine for that institution. (For CDN ECP) 

6334 Bad account number data Invalid characters in account number 

6350 Card supassed daily limit Card has surpassed daily transaction amount limit 

The limit of number of times used for the card has been 

6352 Times card used limit 

surpassed 

6354 Over credit limit Card has surpassed its credit limit 

6356 Enter lesser amount Enter a lesser amount 

6358 No credit amount No credit amount 

6360 One purchase limit Card is limited to one purchase 

6362 Over Sav limit Over Sav limit 

6364 Over Sav frequency. Over Sav frequency. 

6366 Card not supported Card not supported 

6368 Invalid PIN. Invalid PIN 

6370 Allowable PIN tries exceeded. Allowable PIN tries exceeded 

6372 PIN required PIN required 

6374 Card failed MOD 10 check Card failed MOD 10 check verification 

6380 On negative file Account number appears on negative file 

6382 Stop Payment Issued Stop Payment Issued 

6400 PTLF full PTLF full 

6401 Fraud suspected Fraud suspected 

6402 Unable to process transaction Unable to process transaction 

6403 Duplicate transaction Duplicate transaction 

6404 Cutoff in progress Cutoff in progress 

287

Message 

Code 


6405 Incorrect PIN Incorrect PIN 

6406 PIN tries exceeded PIN tries exceeded 

6407 Exceeds withdrawal frequency Exceeds withdrawal frequency 

6410 Invalid 3D Security data Invalid 3D Secure Data 

6610 Timeout error / Re-Send Timeout waiting for host response 

6611 Timeout error /Re-Send Internal timeout 

Authorization host system down or Authorization host system is temporarily unavailable 

6612 unavailable 

6614 System unavailable Host network could not reach the service provider. 


6618 Unidentified Error Unidentified error. Unable to process transaction 

Unable to process transaction due to system 

6620 Unable to process. 

malfunction 

6622 Unable to authorize. Unable to authorize due to system malfunction 

6624 Merchant information incomplete Merchant information incomplete 

6626 Invalid CVN value Invalid CVN value 

6627 Invalid track2 data The track2 format information is incorrect 

6628 Transaction not supported Merchant not Support this transaction 

6630 Invalid storeId No such store ID for the merchant 

6632 Invalid authcode Invalid authcode 

6634 Invalid format Invalid format 

6636 Invalid message type Invalid message type 

6638 Invalid POS system type Invalid POS system type 

A message has be sent to reverse previous time out 

6640 This transaction has been cancelled transaction 

This TrxSource is not supported by This TrxSource is not supported by the bank 

6642 the bank 

Insufficient Terminal IDs - Please Not enough terminal ID at the time of transaction 

6644 try again 

6646 Acquirer cannot process transaction Acquirer cannot process transaction 

6648 Retain card if possible Retain card if possible 

6706 Not supported for batch Not supported for batch 

6712 Mandatory field is invalid or missing Mandatory field is invalid or missing 

6952 Pick up card Card issuer wants card returned. Call issuer 

6954 Card stolen Card reported as lost/stolen 

Generic decline. No other information is being provided 

6956 Do not honor 

by the issuer 

6958 Call Bank Issuer wants voice contact with cardholder 

6960 Insufficient funds Insufficient funds 

6962 CVN failure CVN failure 

6964 Delinquent account. Delinquent account 

6990 Cancellation Cancellation is going to reverse the authorization 

288

Country Codes 

289 

Appendix E 

Country Name ISO Country Code 

Afghanistan AF 

Albania AL 

Algeria DZ 

American Samoa AS 

Andorra AD 

Angola AO 

Anguilla AI 

Antarctica AQ 

Antigua and Barbuda AG 

Argentina AR 

Armenia AM 

Aruba AW 

Australia AU 

Austria AT 

Azerbaijan AZ 

Bahamas BS 

Bahrain BH 

Bangladesh BD 

Barbados BB 

Belarus BY 

Belgium BE 

Belize BZ 

Benin BJ 

Bermuda BM 

Bhutan BT 

Bolivia BO 

Bosnia and Herzegovina BA 

Botswana BW 

Bouvet Island BV 

Brazil BR 

British Indian Ocean Territory IO 

Brunei Darussalam BN 

Bulgaria BG 

Burkina Faso BF 

Burundi BI 

Cambodia KH 

Cameroon CM 

Canada CA 

Cape Verde CV 

Cayman Islands KY

290 


Central African Republic CF 

Chad TD 

Chile CL 

China CN 

Christmas Island (Australia) CX 

Cocos (Keeling) Islands CC 

Colombia CO 

Comoros KM 

Congo CG 

Cook Islands CK 

Costa Rica CR 

Cote D'Ivoire (Ivory Coast) CI 

Croatia (Hrvatska) HR 

Cuba CU 

Cyprus CY 

Czech Republic CZ 

Denmark DK 

Djibouti DJ 

Dominica DM 

Dominican Republic DO 

East Timor TP 

Ecuador EC 

Egypt EG 

El Salvador SV 

Equatorial Guinea GQ 

Eritrea ER 

Estonia EE 

Ethiopia ET 

Faeroe Islands FO 

Falkland Islands (Malvinas) FK 

Fiji FJ 

Finland FI 

France FR 

French Guiana GF 

French Polynesia PF 

Gabon GA 

Gambia GM 

Georgia GE 

Germany DE 

Ghana GH 

Gibraltar GI 

Great Britain GB 

Greece GR 

Greenland GL

291 


Grenada GD 

Guadeloupe GP 

Guam GU 

Guatemala GT 

Guinea GN 

Guinea Bissau GW 

Guyana GY 

Haiti HT 

Honduras HN 

Hong Kong HK 

Hungary HU 

Iceland IS 

India IN 

Indonesia ID 

Iran IR 

Iraq IQ 

Ireland IE 

Isle of Man (U.K.) IM 

Israel IL 

Italy IT 

Jamaica JM 

Japan JP 

Johnston Island JT 

Jordan JO 

Kazakhstan KZ 

Kenya KE 

Kiribati KI 

Korea (North) KP 

Korea (South) KR 

Kuwait KW 

Kyrgyzstan KG 

Lao P.Dem.R. LA 

Latvia LV 

Lebanon LB 

Lesotho LS 

Liberia LR 

Libyan Arab Jamahiriya LY 

Liechtenstein LI 

Lithuania LT 

Luxembourg LU 

Macau MO 

Macedonia MK 

Madagascar MG 

Malawi MW

292 


Malaysia MY 

Maldives MV 

Mali ML 

Malta MT 

Marshall Islands MH 

Martinique MQ 

Mauritania MR 

Mauritius MU 

Mexico MX 

Micronesia FM 

Midway Islands MI 

Moldova MD 

Monaco MC 

Mongolia MN 

Montserrat MS 

Morocco MA 

Mozambique MZ 

Myanmar MM 

Namibia NA 

Nauru NR 

Nepal NP 

Netherlands NL 

Netherlands Antilles AN 

New Caledonia NC 

New Zealand NZ 

Nicaragua NI 

Niger NE 

Nigeria NG 

Niue NU 

Norfolk Island NF 

Northern Mariana Islands MP 

Norway NO 

Oman OM 

Pakistan PK 

Palau PW 

Panama PA 

Papua New Guinea PG 

Paraguay PY 

Peru PE 

Philippines PH 

Pitcairn PN 

Poland PL 

Portugal PT 

Puerto Rico PR

293 


Qatar QA 

Reunion RE 

Romania RO 

Russian Federation RU 

Rwanda RW 

Saint Helena SH 

Saint Kitts and Nevis KN 

Saint Lucia LC 

Saint Pierre and Miquelon PM 

Saint Vincent and The Grenadines VC 

Samoa WS 

San Marino SM 

Sao Tome and Principe ST 

Saudi Arabia SA 

Senegal SN 

Seychelles SC 

Sierra Leone SL 

Singapore SG 

Slovakia SK 

Slovenia SI 

Solomon Islands SB 

Somalia SO 

South Africa ZA 

Spain ES 

Sri Lanka LK 

Sudan SD 

Suriname SR 

Svalbard and Jan Mayen Islands SJ 

Swaziland SZ 

Sweden SE 

Switzerland CH 

Syrian Arab Rep. SY 

Taiwan TW 

Tajikistan TJ 

Tanzania TZ 

Thailand TH 

Togo TG 

Tokelau TK 

Tonga TO 

Trinidad and Tobago TT 

Tunisia TN 

Turkey TR 

Turkmenistan TM 

Turks and Caicos Islands TC

294 


Tuvalu TV 

Uganda UG 

Ukraine UA 

United Arab Emirates AE 

United States US 

Uruguay UY 

Uzbekistan UZ 

Vanuatu VU 

Vatican City State (Holy See) VA 

Venezuela VE 

Viet Nam VN 

Virgin Islands (British) VG 

Virgin Islands (US) VI 

Wake Island WK 

Wallis and Futuna Islands WF 

Western Sahara EH 

Yemen YE 

Yugoslavia YU 

Zaire ZR 

Zambia ZM 

Zimbabwe ZW

State/Province/Region Codes 

295 

Appendix F 

State/Region Code Country 

Alabama AL us 

Alaska AK us 

American Samoa AS us 

Arizona AZ us 

Arkansas AR us 

Armed Forces - Europe AE us 

Armed Forces - Pacific AP us 

Armed Forces - The Americas AA us 

California CA us 

Colorado CO us 

Connecticut CT us 

Delaware DE us 

District of Columbia DC us 

Federated States of Micronesia FM us 

Florida FL us 

Georgia GA us 

Guam GU us 

Hawaii HI us 

Idaho ID us 

Illinois IL us 

Indiana IN us 

Iowa IA us 

Kansas KS us 

Kentucky KY us 

Louisiana LA us 

Maine ME us 

Marshall Islands MH us 

Maryland MD us 

Massachusetts MA us 

Michigan MI us 

Minnesota MN us 

Mississippi MS us 

Missouri MO us 

Montana MT us 

Nebraska NE us 

Nevada NV us 

New Hampshire NH us 

New Jersey NJ us 

New Mexico NM us 

New York NY us

296 


North Carolina NC us 

North Dakota ND us 

Northern Mariana Islands MP us 

Ohio OH us 

Oklahoma OK us 

Oregon OR us 

Palau PW us 

Pennsylvania PA us 

Puerto Rico PR us 

Rhode Island RI us 

South Carolina SC us 

South Dakota SD us 

Tennessee TN us 

Texas TX us 

Utah UT us 

Vermont VT us 

Virgin Islands VI us 

Virginia VA us 

Washington WA us 

West Virginia WV us 

Wisconsin WI us 

Wyoming WY us 

Alberta AB ca 

British Columbia BC ca 

Manitoba MB ca 

New Brunswick NB ca 

Newfoundland NF ca 

Nova Scotia NS ca 

Northwest Territories NT ca 

Nunavut NN ca 

Ontario ON ca 

Prince Edward Island PE ca 

Quebec QC ca 

Saskatchewan SK ca 

Yukon YT ca 

Eastern Cape EC za 

Free State FS za 

Gauteng GG za 

KwaZulu-Natal KN za 

Mpumalamanga MG za 

Northern Cape NO za 

Northern Province NP za 

North West NW za 

Western Cape WC za


Australian Capital Territory ACT au 

New South Wales NSW au 

Northern Territory NT au 

Queensland QLD au 

South Australia SA au 

Tasmania TAS au 

Victoria VIC au 

Western Australia WA au 

297

Appendix G 

Commodity codes for Purchasing Cards 

Commodity 

Code 

Description 

7461 ACCOUNTING/TAX CONSULTANCY SERVICES 

7464 ADVERTISING AND MARKETING SERVICES 

3100 AGRICULTURAL FERTILISERS 

8800 AIRCRAFT PARTS 

2200 ALCOHOLIC BEVERAGES 

1200 ANIMAL FEEDING STUFFS 

7300 BARBED WIRE/FENCING 

0900 BEVERAGES - NON-ALCOHOLIC 

8705 BICYCLES/TRICYCLES 

9000 BINOCULARS/TELESCOPES 

4900 BOOKS/PRINTED MATERIAL 

2500 BUILDING AGGREGATES 

6900 BUILDING BRICKS/TILES/STONES 

8507 BURGLAR & FIRE ALARMS 

9001 CAMERAS/FLASHES 

7160 CAR HIRE SERVICES: QUALIFYING CARS 

6562 CAR LEASING SERVICES: QUALIFYING CARS 

6565 CAR LEASING SERVICES: NON - QUALIFYING CARS 

5700 CARPETS/FLOOR COVERINGS 

5561 CATERING SERVICES 

6901 SINKS, BATHS, WASHBASINS; OTHER PLUMBING/HEATING PRODUCTS 

2800 CHEMICALS/ACIDS 

3400 CLEANING PRODUCTS 

7468 CLEANING SERVICES 

9100 CLOCKS, WATCHES & PARTS 

6200 CLOTHING 

8701 COMMERCIAL MOTOR VEHICLES 

6563 COMMERCIAL VEHICLE LEASING SERVICES 

7260 COMPUTER CONSULTANCY SERVICES 

8405 COMPUTER HARDWARE 

8406 COMPUTER SOFTWARE 

7163 COMPUTER/OFFICE MACHINE RENTAL 

4560 CONSTRUCTION/DEMOLITION SERVICES 

0400 DAIRY PRODUCE 

7261 DATA PROCESSING SERVICES 

8060 DRIVING TUITION SERVICES 

8509 ELECTRIC LAMPS 

4562 ELECTRICAL CONTRACTING 

8508 ELECTRICAL SWITCHES/FUSES/PLUGS/CIRCUITS 

8061 EMPLOYEE TRAINING 

298

Commodity 

Code 

Description 

9360 EMPLOYEE WELFARE SERVICES 

7466 EMPLOYMENT BUREAU SERVICES 

6561 EQUIPMENT LEASING SERVICES 

7061 ESTATE AGENCY SERVICES 

6564 FACTORING SERVICES 

6760 FINANCIAL ADMINISTRATION SERVICES 

6560 FINANCIAL SERVICES (NON INSURANCE) 

8404 FIRE EXTINGUISHERS 

3000 FIRST AID PRODUCTS 

0300 FISH/SEAFOOD PRODUCTS 

6400 FOOTWEAR 

FREIGHT / CARRIAGE CHARGES (NON COURIER / DELIVERY SERVICE 

6362 PROVIDERS) 

6061 FREIGHT TRANSPORT SERVICES 

0800 FRUIT AND FRUIT PRODUCTS 

8500 GENERATORS/ELECTRIC MOTORS 

7000 GLASSWARE 

8200 HAND TOOLS 

6500 HEADGEAR 

5560 HOTEL/RESTAURANT SERVICES 

8401 INDUSTRIAL ENGINES/PLANT: PARTS 

3600 INDUSTRIAL EXPLOSIVES 

8400 INDUSTRIAL MECHANICAL APPLIANCES/PARTS 

7100 INDUSTRIAL METALS (BASE/PROCESSED) 

8402 INDUSTRIAL PLANT/EQUIPMENT 

3800 INSECTICIDES/FUNGICIDES/DISINFECTANTS 

6660 INSURANCE SERVICES - GENERAL 

4565 JOINERY SERVICES 

8403 KITCHEN EQUIPMENT 

4200 LEATHER CASES AND BAGS 

7460 LEGAL SERVICES - LAWYERS/SOLICITORS 

9261 LIBRARY/ARCHIVING SERVICES 

0100 LIVE ANIMALS 

2702 LUBRICATING OILS 

8201 MACHINE TOOLS 

8202 MACHINE/HAND TOOL PARTS 

7262 MAINTENANCE/REPAIR - OFFICE EQUIPMENT 

7463 MANAGEMENT CONSULTANCY SERVICES 

7462 MARKET RESEARCH SERVICES 

9004 MEASURING EQUIPMENT 

0200 MEAT/MEAT PRODUCTS 

9260 MEDIA/NEWS AGENCY SERVICES 

8560 MEDICAL SERVICES 

9160 MEMBERSHIP SUBSCRIPTIONS 

299

Commodity 

Code 

Description 

9003 MICROSCOPES 

8700 MOTOR CARS 

8704 MOTOR CYCLES/SIDECARS 

8703 MOTOR VEHICLE PARTS (EXCLUDING TYRES) 

5060 MOTOR VEHICLE REPAIR/MAINTENANCE SERVICES 

9200 MUSICAL INSTRUMENTS 

4801 NEWSPRINT 

9400 OFFICE FURNITURE 

4800 OFFICE STATIONERY 

7472 OTHER BUSINESS SERVICES 

6300 PACKING MATERIALS/SACKS/BAGS 

7470 PACKING SERVICES 

PADLOCKS, LOCKS, KEYS. SAFES, STRONG BOXES, OTHER 

8300 IRONMONGERY PRODUCTS 

4566 PAINTING/GLAZING SERVICES 

3200 PAINTS/VARNISHES 

6060 PASSENGER TRANSPORT 

6761 PENSION ADVISORY/ADMINISTRATION SERVICES 

2701 PETROL/DIESEL - ROAD FUEL 

9002 PHOTOCOPIERS 

3700 PHOTOGRAPHIC FILM PRODUCTS 

7469 PHOTOGRAPHIC SERVICES 

0600 PLANTS, SHRUBS AND TREES 

4564 PLASTERING SERVICES 

4563 PLUMBING, HEATING AND DRAINAGE SERVICES 

6460 COURIER SERVICES (COURIER / DELIVERY SERVICES PROVIDERS) 

2261 PRINTING SERVICES 

7062 PROPERTY MANAGEMENT SERVICES 

7060 PROPERTY RENTALS 

2260 PUBLISHING SERVICES 

8505 RADIOS 

8600 RAILWAY LOCOMOTIVE PARTS 

8502 RECORD/CASSETTE/CD PLAYERS 

7161 RENTAL OF AGRICULTURAL MACHINERY 

7162 RENTAL OF CONSTRUCTION EQUIPMENT 

7164 RENTAL OF SPORTS/RECREATIONAL EQUIPMENT 

4561 ROOFING SERVICES 

5600 ROPE,CABLE, NETTING 

4000 RUBBER PRODUCTS 

7471 SECRETARIAL/TRANSLATION SERVICES 

7467 SITE SECURITY SERVICES 

2700 SOLID FUEL; HEATING/ INDUSTRIAL/ AGRICULTURAL OILS 

8702 SPECIAL PURPOSE VEHICLES 

7560 STATUTORY CHARGES/LICENSES 

300

Commodity 

Code 

Description 

6360 STORAGE/WAREHOUSING SERVICES 

8503 TAPE RECORDERS/ANSWERING MACHINES 

7465 TECHNICAL ANALYSIS SERVICES 

6461 TELECOMMUNICATIONS SERVICES 

8501 TELEPHONES 

8506 TELEVISION SETS 

2400 TOBACCO/TOBACCO PRODUCTS 

9500 TOYS, GAMES AND MODELS 

8706 TRAILERS/TRAILER PARTS 

6361 TRAVEL AGENCY SERVICES 

4001 TYRES - MOTOR VEHICLES 

6600 UMBRELLAS AND WALKING STICKS 

9999 VAT: INSURANCE REPAIRS 

0700 VEGETABLES AND VEGETABLE PRODUCTS 

8407 VENDING MACHINES 

8504 VIDEO RECORDERS 

4802 WALLPAPER 

3760 WASTE DISPOSAL SERVICES 

4700 WOOD, TIMBER PRODUCTS, PULP AND PAPER PRODUCTS 

301

Appendix H 

IdentifyMe Submission Best Results Criteria 

Country Submit Phone Number Submit Address 

Andorra 

302 

Australia 

Austria 

Belguim 

Canada 

Czech Republic 

Denmark 

Germany 

Finland 

France 

Holland / Netherlands 

Hungary 

Ireland 

Italy 

Luxembourg 

Norway 

Portugal 

Slovak Republic 

Spain 

Sweden 

Switzerland 

U.S.A.

Glossary of useful terms 

A 

ABA 

See American Bankers Association. 

303 

Appendix I 

ABA Routing Number 

The American Bankers Association (ABA) routing number is a unique, bank identifying number 

that directs electronic ACH deposits to the proper bank. The routing number precedes the 

account number printed at the bottom of a check and is usually printed with magnetic ink. 

Account Number 

A unique sequence of numbers assigned to a cardholder's account, which identifies the issuer 

and type of financial transaction card. 

ACH 

See Automated Clearing House. 

ACI 

See Authorization Characteristics Indicator. 

Acquirer 

A bank or financial institution that acquires data relating to transactions from a merchant or card 

acceptor for processing. The acquirer enters this data into interchange, either directly or 

indirectly. See Interchange. 

Acquiring Bank 

A bank that receives credit card transactions and then deposits them with the issuing banks. This 

is an acquirer. 

Address Verification Service 

A service that verifies the cardholder's billing address in order to help combat fraud in card-notpresent 

transactions (e.g. mail order, telephone order, internet, etc.). Used only in the United 

States. 

Agent Bank 

A bank that participates in another bank's acquiring program, usually by turning over its 

applicants for bank cards to the bank administering the acquiring program. 

American Banker's Association 

The trade association of American bankers. This body also has the responsibility of assigning the 

registration authority for identification numbers. 

American Express 

An organization that issues cards and acquires transactions, unlike Visa and MasterCard, which 

are bank associations. American Express processes their own transactions through their network. 

Amex 

See American Express. 

API 

The Application Programming Interface (API) is the interface by which an application program 

accesses the operating system and other services. An API is defined at source code level and

provides a level of abstraction between the application and the kernel to ensure the portability of 

the code. 

Approval 

Any transaction that is approved by the cardholder or the check issuer's bank. Approvals are 

requested via an authorization. An approval is the opposite of a declined transaction. 

Arbitration 

The procedure used to determine the responsibility for a chargeback-related dispute between a 

merchant and buyer. 

Asynchronous 

A method of transmitting data in which the data elements are identified with special start and stop 

characters. An asynchronous modem cannot communicate with a synchronous modem. Compare 

with Synchronous (e.g. standard Hayes compatible modem). 

ATM 

See Automated Teller Machine. 

Auth Only 

A transaction in which the merchant does not intend to charge the cardholder until a later time, if 

at all. See Prior Authorized Sale. 

Authorization 

An authorization is a request to charge a cardholder. It reduces the cardholder's open to buy, but 

does not actually capture the funds. An authorization is the first transaction in the delayed deposit 

process. It does not bill the card until a delayed capture transaction is issued. The authorization 

must be deposited in order to charge the account. If it is not used within a certain time period, it 

will drop off. The issuing bank determines the time period for drop off. Authorizations can only be 

used for credit card transactions. 

Authorization Code 

Approved sale and authorization transactions always receive a numeric or alphanumeric 

authorization code referencing the transaction for processing purposes. 

Automated Clearing House 

The Automated Clearing House (ACH) network is a nationwide, wholesale electronic payment 

and collection system. It is a method of transferring funds between banks via the Federal Reserve 

System. Most, but not all, financial institutions use it. 

Average Ticket 

The average dollar amount of merchant credit transactions. 

AVS 

See Address Verification Service. 

B 

Bank card 

A debit or credit card issued by a bank. 

Bank Identification Number 

The digits of a credit card that identifies the issuing bank. It is sometimes the first six digits and is 

often referred to as a BIN. Also referred to as Issuer Identification Number. 

Basis Point 

304

One one-hundredth of a percent. Discount rates are expressed as basis points. 

Batch 

A collection of transactions submitted for deposit. Usually a merchant has one batch per day or 

per shift. 

Batch ID 

Once a batch is deposited, it is assigned a batch ID. Every transaction in the batch shares this ID. 

If a transaction does not have a batch ID associated with it, the transaction has not been 

deposited. 

Batch Processing 

A type of data processing where related transactions are transmitted as a group for processing. 

Batch Deposit 

An electronic bookkeeping procedure that sends all funds from captured transactions to the 

merchant's acquiring bank for deposit. PaymentTrust TM automatically submits all captured 

transactions for deposit on a daily basis. The time span, in which funds reach the merchant 

account after deposit, is 1-5 days, but varies by acquiring bank. 

BIN 

See Bank Identification Number. 

Binary Executable 

A universal character coding system. 

Bundled Rate 

A discount rate that includes communication costs as well as transaction fees. Also referred to as 

a flat rate. 

C 

Cancellation 

Reversal of a partial or an entire authorization charge prior to the deposit process. It prevents a 

transaction from being deposited. A Cancellation does not remove any hold on the cardholder's 

open to buy. 

Capture 

The process of capturing funds from an authorized transaction. 

Card Issuer 

See Issuer, Issuing Bank. 

Card-Not-Present 

A merchant environment where the cardholder and the card are not physically present at the time 

of purchase. The following are typical card-not-present transactions: mail/telephone order, 

business to business and internet based transactions. 

Card-Present 

A merchant environment where the cardholder and the card are physically present at the time of 

purchase. Card-present transactions account for the majority of credit card transactions in the 

world. 

Card Verification Value 

A unique verification value encoded on the magnetic strip of a card to validate card information 

during the authorization process. The card verification value is calculated from the data encoded 

305

on the magnetic strip using a secure cryptographic process. This method is used by Visa and 

Master Card. 

CAV 

Cardholder Authentication Value used by PaymentTrust Ltd. and Acquirer. Base64 encoded data 

structure containing 3D Secure authentication results provided by the 3D Secure MPI, usually 

Visa’s CAVV or MasterCard’s UCAF. 

CAVV 

Visa’s Cardholder Authentication Verification Value. Base64 encoded data structure containing 

3D Secure authentication results provided by the 3D Secure MPI. 

CGI 

See Common Gateway Interface. 

Chargeback 

The act of taking back funds that have been paid to a merchant for a disputed or improper credit 

card transaction. The issuer can initiate this procedure 30 days after the deposit. 

Chargeback Period 

The number of calendar days in which a card member may charge sales back to the merchant, 

beginning with the day after the date the record is first received by the member or agent and 

continuing until the end of the day on which it is dispatched as a chargeback item. 

Chargeback Reason Code 

A two-digit code identifying the specific reason for the chargeback. 

Check Guarantee 

A service which guarantees check payments (up to the limit defined for the account) provided that 

the merchant follows correct procedures in accepting the check. The service determines whether 

the check issuer has previously written delinquent checks. Companies like TeleCheck provide 

this type of service. 

Chip Card 

Also known as a smart card. A chip card holds details on a computer chip, which can store and 

process information. It usually also has a traditional magnetic stripe. 

Clearing 

The process of exchanging financial details between an acquirer and an issuer to facilitate 

posting of a cardholder's account and reconciliation of a merchant's deposit position. 

Common Gateway Interface 

An interface program that enables an Internet server to run external programs to perform a 

specific function. Also referred to as gateways or CGI scripts; these programs generally consist of 

a set of instructions written in a programming language like C or PERL that process requests 

from a browser, executes a program and formats the results in HTML. Gateway scripts often add 

interactivity to a Web page by enabling users to fill out and submit forms for processing. 

Confirmation Letter 

A letter sent by a processor to a merchant on a daily or weekly basis to verify batch deposits. 

Converted Currency ID 

ISO standard numeric ids of the converted currency. 

Example: USA = 840, GBP = 826, JPY = 392 

306

Conversion Rate 

The conversion rate applied to the transaction amount in U.S. dollars. 

Copy Request 

See Retrieval Request. 

Credit 

Also known as a refund. A credit is a transaction that transfers funds from the merchant's account 

back in to the customer's credit card. This type of transaction is usually performed when a 

product is returned to the merchant. A credit can be performed through the e-Transaction 

Terminal area of PaymentTrust TM Payment Manager or through a merchant's storefront 

application. Check refunds can only be issued via credit card or through a non-electronic paper 

check. A credit can only be issued to an account that has not had a previous authorization. 

Credit Limit 

The limit of credit a cardholder is approved to borrow. Credit card purchases are loans to the 

cardholder by the issuer. 

Currency ID 

ISO standard numeric ids of the converted currency. 

Example: USA = 840, GBP = 826, JPY = 392 

CVC 

See Card Verification Code. 

CVV See Card Verification Value. 

CVV2 

See Card Verification Value. 

D 

DDA 

See Demand Deposit Account. 

Debit Card 

An ATM bank card used to purchase goods and services, and to obtain cash. A debit card debits 

the cardholder's bank account and requires a Personal Identification Number (PIN). Debit cards 

branded with a bank card logo (e.g. Visa) can be accepted without a PIN for Internet transactions. 

Decline 

A transaction in which the issuing bank will not authorize the transaction. 

Delayed Capture 

A delayed capture is a transaction type that uses the information from an authorization 

transaction to capture funds. This is the second step in the delayed deposit process and should 

be used by merchants who do not provide immediate shipment of goods. 

Delayed Deposit 

This is a two-phase process that utilizes an authorization and a delayed capture transaction to 

process customer orders. This procedure is recommended when the merchant delivers goods or 

307

services after a 48-hour period. 

Demand Deposit Account 

A standard checking or savings account into which electronic funds can be transferred. 

Deposit 

The process of transmitting a batch of transactions from the merchant to the acquiring institution 

for deposit preparation. It marks a previously authorized transaction for funds capture during the 

next deposit period. Merchants who do not ship goods immediately should use this transaction 

type after fulfilling their sales obligation. 

Discount fee 

Fee paid by the merchant to the merchant bank or other contracted party for processing the 

merchant's credit card sales transactions. 

Discount Rate 

Amount charged to a merchant by the acquiring bank for transaction processing. It usually 

represents a percentage of the transaction amount. The rate is typically based on monthly 

transaction volume (total dollars) and average ticket. The discount fee is the dollar amount 

charged. 

Downgraded ICC: 

A chip card that only contains track 2 information on it. 

Draft Capture 

Refers to Deposit. 

E 

ECR 

See Electronic Cash Register. 

EFT 

See Electronic Funds Transfer. 

Electronic Cash Register 

The combination of a cash register and a POS terminal, often PC based. 

Electronic Funds Transfer 

The paperless act of transmitting money through a computer network. 

External Sales Agent 

Amex term for ISO or MSP. 

F 

Floor Limit 

A preset limit established by an issuer that allowed merchants to accept credit card sales without 

authorization provided the merchant verifies the card number on a warning bulletin for lost or 

stolen cards. Floor limits are now rarely used. 

Fraudulent User 

An individual who is not the cardholder or designee and who uses a card to obtain goods or 

services without the cardholder's consent. 

308

Fraudulent Transaction 

A transaction unauthorized by the cardholder of a bank card. Such transactions are categorized 

as lost, stolen, not received, issued on a fraudulent application, counterfeit, fraudulent processing 

of transactions, account takeover, or other fraudulent conditions as defined by the card company 

or the member company. 

H 

HTTP Protocol 

Hardware and/or software that connects computer networks and allows them to communicate. 

I 

ICC (Integrated Circuit Card) 

See chip card. 

Independent Sales Organization 

Visa term for a company that is sponsored by an acquiring bank to solicit and sometimes support 

merchants. 

Interchange 

The flow of information between issuers and acquirers (e.g. transactions, retrieval requests, 

chargebacks). 

Interchange Fee 

The fee charged by Visa and MasterCard for each credit card transaction. This fee is part of the 

discount rate. 

Internet Merchant Bank Account 

A special account required for merchants who wish to sell goods and services over the Internet 

and accept credit cards as payment. This type of account is different than a typical merchant 

account and is considered similar to a card-not-present transaction. 

Internet Service Provider 

A company that offers access to individuals or companies to connect to the Internet. 

ISO 

See Independent Sales Organization. 

ISP 

See Internet Service Provider. 

Issuer 

An institution that issues plastic cards to cardholders. 

Issuing Bank 

See Issuer. 

M 

Magnetic Ink Character Recognition (MICR) 

The process used to read the string of numbers on the bottom of a check. The MICR characters 

(0-9 and 4 special characters) are printed in special toner or ink. When the check is passed 

309

through a reader/sorter, it passes through two magnetic heads. The first one magnetizes the 

MICR character and the second one reads the (now) magnetic MICR character. Also referred to 

as Magnetic Ink Check Reader. 

Manual Entry 

Credit card information that is entered via the e-Transaction Terminal of PaymentTrust TM 

Payment Manager. 

Manual Refund 

A transaction that returns the specified amount to the cardholder's account. 

MasterCard 

An association of banks that governs the issuing and acquiring of MasterCard credit card 

transactions and Maestro debit transactions. 

Member 

A financial institution that is a member of Visa USA and/or MasterCard International. A member is 

licensed to issue cards to cardholders and/or accept merchant drafts. 

Merchant 

A retailer, or any other entity (pursuant to a Merchant Agreement), that agrees to accept credit 

cards, debit cards, or both, when properly presented. 

Merchant Agreement 

A written agreement between a merchant and a bank (or possibly between a merchant, a bank 

and ISO) summarizing their respective rights, duties and warranties with respect to acceptance of 

the bank card and matters related to bank card activity. 

Merchant Bank 

A bank issuing an agreement to a merchant to accept (acquire) deposits generated by bank card 

transactions. 

Merchant Category Code 

A code assigned by an acquirer to a merchant to identify the merchant's principal trade, 

profession, or line of business. This 4-digit code is also know as the SIC code. 

Merchant Discount 

Compensation received by a bank from a merchant for processing and accepting credit card risk 

on the merchant's credit card sales. 

Merchant Number 

A series or group of digits that uniquely identifies the merchant to the merchant's signing bank for 

account and billing purposes. 

Merit 

Refers to the qualification levels for a MasterCard transaction. Merit III is the highest discount, 

followed by Merit II, Merit I, and then Standard. 

MICR Number 

See Magnetic Ink Character Recognition. 

MO/TO 

Mail Order/Telephone Order credit card transactions. 

MPI 

Merchant Plugin. 3 rd party software used by a merchant to authenticate 3D Secure transactions. 

310

MSP 

See Member Service Provider. 

N 

Network 

See Processor. Also used to refer to communication networks like AT&T or CompuServe. 

Non-Qualified 

A broad term that describes a transaction that did not interchange at the best rate, because it was 

entered manually, was not deposited in a timely manner, or the data set required for the best 

interchange was not provided. 

O 

ODFI 

See Originating Depository Financial Institution. 

Open to buy 

The amount of credit available at a given time on a cardholder's account. 

Operator 

A central clearing facility that provides distribution and deposit of ACH transactions. ACH 

operators clear debits and credits electronically, rather manually. Currently four ACH Operators 

exist: the Federal Reserve System, which clears approximately 80% of all ACH transactions, 

Visanet ACH, New York ACH, and American ACH. 

Original Draft 

The original copy of the forms and signatures used in the transaction. Also referred to as the hard 

copy. 

Originating Depository Financial Institution 

A financial institution that initiates and warrants electronic payments through the ACH network on 

behalf of its customers. 

Originator 

A company or other business entity that creates entries for introduction into the ACH network. For 

example, a billing company produces debit entries from customers' financial institution accounts 

who have authorized direct payment for products and services. 

P 

PAN 

See Primary Account Number. 

PIN 

Personal Identification Number used by a cardholder to authenticate card ownership for ATM or 

debit card transactions. The cardholder enters his/her PIN into a keypad. The PIN is required to 

complete an ATM/debit card transaction. 

Point Of Sale 

The place and time at which a transaction occurs. Point of Sale (POS) also refers to the devices 

or software used to capture transactions. 

311

POS 

See Point Of Sale. 

Post Authorization 

A transaction for which a voice authorization was received. See Prior Authorized Sale. 

Post-Auth 

See Post Authorization. 

Posting 

The process of recording debits and credits to a cardholder's account balances. 

Pre-Auth 

Same as Auth Only. 

Prenote 

See Pre-Notification. 

Pre-Notification 

Prior to the initiation of the first ACH entry to an ACH receiver or the ACH receiver's account with 

an RDFI, an ACH originator may, at its option, deliver or send a pre-notification through an ODFI 

to its ACH operator for transmittal to the appropriate RDFI. The pre-notification shall provide 

notice to the RDFI that the originator intends to initiate one or more entries to that receiver's 

account in accordance to the receiver's authorization. 

Primary Account Number (commonly called PAN) 

The number that is embossed, encoded, or both on a plastic card that identifies the issuer and 

the particular cardholder account. The PAN consists of a major industry identifier, issuer identifier, 

individual account identifier, and check digit. 

Prior 

See Prior Authorized Sale. 

Prior Authorized Sale 

A transaction for which authorization was obtained before a transaction takes place, e.g. when a 

merchant has to call for authorization before services are rendered. The approved authorization 

request may be held for an extended length of time before a card is present or not. 

Prior-Auth 

See Prior Authorized Sale. 

Private Label Card 

A bank card that can be used only in a specific merchant's store. Typically not a bank card. 

Processing Date 

The date on which the acquiring bank processes the transaction. 

Processor 

A large data center that processes credit card transactions and deposits funds to merchants. A 

processor connects to the merchant on behalf of an acquirer via a gateway or POS system to 

process payments electronically. Processors edit and format messages and switch to bank card 

networks. They provide files for clearing and deposit, and other value added services. 

Q 

312

Qualification 

A level at which a transaction interchanges. The level of qualification is dependent on how a 

credit card number is entered, how quickly a transaction is deposited, the type of industry, and 

other specific information. 

R 

RDFI 

See Receiving Depository Financial Institution. 

Receipt 

A hard copy description of the transaction that occurred at the point of sale. Minimum information 

contained on a receipt is date, merchant name and location, account number, type of account 

used (e.g. Visa, MasterCard, Amex, etc.), amount, reference number and/or authorization code, 

and action code. 

Receiver 

A consumer, customer, employee, or business who has authorized ACH payments by Direct 

Deposit or Direct Payment to be applied against a depository account. 

Receiving Depository Financial Institution 

A financial institution that provides depository account services to customers, employees and 

businesses, and accepts electronic debits and credits to and from these accounts. 

Recurring Transaction 

A transaction in which a cardholder has given a merchant permission to periodically charge the 

cardholder's account. 

Refund 

A transaction that returns the specified amount to the cardholder's account. 

Response Code 

A numeric code that indicates whether a transaction was approved or declined. Response codes 

are used in the PaymentTrust TM system to indicate transaction responses to merchants. 

Retrieval 

See Retrieval Request. 

Retrieval Request 

A request to a merchant for documentation concerning a transaction, usually initiated by a 

cardholder's dispute or suspicious sale/return. A retrieval request can lead to a chargeback. 

Return Code 

Any of the codes returned by PaymentTrust TM when a transaction is processed. 

S 

Secure Sockets Layer 

An encryption system that allows merchants to securely process electronic transactions. 

Deposit 

The process by which transactions with authorization codes are sent to the processor for 

payment to the merchant. Deposit is a sort of electronic bookkeeping procedure that causes all 

funds from captured transactions to be routed to the merchant's acquiring bank for deposit. 

PaymentTrust TM automatically submits all captured transactions for deposit on a daily basis. The 

313

time that it takes for these funds to reach the merchant account after deposit is 1-5 days, but 

varies according to the merchant's agreement with their respective card processing company. 

Also referred to as Deposit. 

SIC Code 

Refers to Standard Industry Classification. These codes are 4-digit numbers used to identify a 

business type. 

Simultaneous Authorization And Deposit 

Charges the specified amount against the account, and marks the transaction for immediate 

funds transfer during the next deposit period. 

Smart Card 

A credit or debit card embodying a computer chip with memory and interactive capabilities used 

for identification and to store additional data about the cardholder, cardholder's account, or both. 

Also called an integrated circuit card or a chip card. 

SSL 

See Secure Sockets Layer. 

Standard 

The lowest qualification level at which a Visa or MasterCard transaction may interchange. This 

occurs when a transaction is deposited several days after the original authorization. 

Surcharges 

Any additional charges to a merchant's standard processing fee. They are a result of nonqualified 

transactions of different communication methods. 

Suspense 

A state in which a batch of transactions is not released to interchange, because of problems 

noticed by the host computer. Requires human intervention to fix the problem and deposit the 

batch. 

Swiped Card 

Credit card information that is transferred directly as a result of swiping or sliding the credit card 

through a card reader. Swiped cards are used in retail and other card-present situations. The 

information magnetically encoded in the magnetic strip includes confidential data that helps 

validate the card. 

Synchronous 

A method of transmitting data in which the data elements are sent at a specific rate so that start 

and stop characters are not needed. Used by older modems such as, Amex PIP terminals. See 

Asynchronous. 

T 

T & E Card 

See Travel and Entertainment Card. 

Tender Type 

The type of "money" used when processing a transaction, for example, credit card, check, ACH, 

Purchase Card, etc. 

Third Party Processor 

A non-member agent employed by an acquiring bank, which provides authorization, deposit and 

merchant services to the bank's merchant. 

314

Track 1 

Bank discretionary data encoded on a magnetic stripe. Includes credit card account number, 

cardholder name, and expiry date. This magnetic strip is read-only, and its contents are defined in 

ISO 7813. 

Track 2 

Bank discretionary data encoded on a magnetic stripe. Track 2 includes credit card account 

number and expiry date. This magnetic strip is read-only, and its contents are defined in ISO 

7813. 

Transaction 

The action between a cardholder and a merchant that results in activity on the cardholder's 

account. 

Transaction Fee 

A per transaction charge in addition to the percentage discount fees, incurred by merchants who 

are on scale pricing. 

Transaction Date 

The date on which a transaction between a cardholder and a merchant, an acquirer, or a carrier, 

occurs. 

Transaction ID 

A is a 16-character numeric string that PaymentTrust TM assigns to every transaction that it 

processes. 

Transaction Type 

A specific financial detail transaction activity that can be submitted to the clearing system 

Travel and Entertainment Card 

Credit cards that typically require payment in full each month, (e.g. American Express, Diner's 

Club, and Carte Blanche). 

U 

UCAF 

MasterCard’s Universal Cardholder Authentication Field. Base64 encoded data structure 

containing 3D Secure authentication results provided by the 3D Secure MPI. 

Undeposited Transactions 

PaymentTrust TM automatically deposits deposit transactions on a daily basis. Please note that 

authorization transactions are not captured until they are completed by a deposit transaction. 

PaymentTrust TM transaction types that are automatically flagged for capture include simultaneous 

authorization, deposit, and refund. 

V 

Visa 

An association of banks that governs the issuing and acquiring of Visa credit card transactions. 

315

© 2000-2006 PaymentTrust Ltd. All rights reserved. 

PaymentTrust Developer’s Guide 

Version 08.24.25 


Document Control: 

Author: IT Department 

This document is protected by the copyright laws and treaties and may not be reproduced, stored in 

a retrieval system or transmitted in any form or by any means (photocopying, recording, or 

otherwise) without permission from PaymentTrust Ltd. 

RiskGuardian TM , PaymentTrust TM, and the PaymentTrust Ltd. logo are 

trademarks or service marks of WorldPay Limited. All other marks 

listed in this document may be trademarks of their respective owners and 

are mentioned for identification purposes only. 

PaymentTrust Canada 

9900 Cavendish Blvd, Suite 206 

Canada H4M 2V2 

Phone +1 514.336.4949 

Fax +1 514.336.0239 

316

Connecting to PaymentTrust's Secure Transaction Network - WorldPay

Create successful ePaper yourself

Delete template?

Save as template?