Getting Started
Introduction
Overview
Choosing an Integration Method
Getting Started Checklist
Direct Integration
Introduction
Intended Audience
Simplifying the Integration Process
Important_Notes
Gateway URLs
Gateway Messages
Notation Explained
CardDetailsTransaction
Introduction
Request
Response
Response
Cross-Reference Transaction
CrossReferenceTransaction
Three-D-Secure Authentication
ThreeDSecureAuthentication
PayByLinkQuery
PayByLinkQuery
TransactionQuery
TransactionQuery
Get CardType
Get CardType
Get GatewayEntryPoints
Get Gateway Entry Points
Payment Gateway High Availability
Introduction
Gateway Entry Points
Gateway Entry Point Metric
Gateway Entry Point Selection Methods
Entry Point State Awareness
Appendix 1: Gateway Response StatusCodes
Appendix 1: Gateway Response StatusCodes
Appendix 2: Message Schema Diagrams
CardDetailsTransaction – Request–PaymentMessage
Response – CardDetailsTransactionResponse
CrossReferenceTransaction
Request –PaymentMessage
Response – CrossReferenceTransaction
ThreeDSecureAuthentication
Request –ThreeDSecureMessage
Response –ThreeDSecureAuthentication
GetCardType
Request –GetCardTypeMessage
Response –GetCardTypeResponse
GetGatewayEntryPoints
Request – GetGatewayEntryPointsMessage
Response – GetGatewayEntryPointsResponse
Appendix 3: Example Messages
CardDetailsTransaction Request –CardDetailsTransaction
Response– CardDetailsTransactionResponse (Notrequiring3DSecure authentication)
Response–CardDetailsTransactionResponse (Requiring3DSecure authentication)
Cross Reference Transaction
Request –CrossReferenceTransaction
Response – CrossReferenceTransactionResponse
ThreeDSecure Authentication
Request –ThreeDSecureAuthentication
Response – ThreeDSecureAuthenticationResponse
Get Card Type
Request –GetCardType
Response –GetCardTypeResponse
Get Gateway Entry Points
Request –GetGatewayEntryPoints
Response – GetGatewayEntryPointsResponse
Appendix 4: Override Policy Codes & Explanations
OverrideAVSPolicy Codes
Character 1 Codes
Character 2 Codes
Character 3 Codes
Character 4 Codes
Examples
Questions
OverrideCV2Policy Codes
Character 1 Codes
Character 2 Codes
Examples
Questions
Appendix 5: List of Card Types
Appendix 5: List of Card Types
Appendix 6: The 3D Secure System
The 3D Secure System Explained
API Transaction Flow – Including 3D Secure Authentication
API Transaction Flow – Including 3D Secure Authentication
API Transaction Flow – 3D Secure Disabled or Card Not Enrolled
API Transaction Flow – 3D Secure Disabled or Card Not Enrolled
API Transaction Flow – 3D Secure Disabled
API Transaction Flow – 3D Secure Disabled
ACS Simulator
Appendix 7: Country (ISO 3166-1) Codes
Appendix 7: Country (ISO 3166-1) Codes
Appendix 8: Currency (ISO 4217) Codes
Appendix 8: Currency (ISO 4217) Codes
Hosted Payment Form
Introduction
Intended Audience
Simplifying the Integration Process
Important Notes
Gateway URLs
Hashing Explained
Simple Hashing Example
Notation Explained
Notation Explained
Data Types
Result Delivery Methods
Result Delivery Methods
POST
SERVER
SERVER_PULL
Required Input Variables
Required Input Variables
Incoming Hash Digest
Incoming Hash Digest
Result Delivery Methods – Implementation
POST Result Delivery Method
Output Variables
Outgoing Hash Digest
Request Variables Pushed To Merchants ServerResultURL
Request Hash Digest Pushed To Merchants ServerResultURL
Expected Response From Merchant’s ServerResultURL
SERVER Output Variables
SERVER Output Hash Digest
SERVER_PULL Result Delivery Method
SERVER_PULL Output Variables
SERVER_PULL Output Hash Digest
SERVER_PULL Request Variables
Transaction Result PULL Response
SERVER_PULL Transaction Result Variables
SERVER Result Delivery Method
Appendix 1: Gateway Response Status Codes
Appendix 1: Gateway Response Status Codes
Appendix 2: Transaction Data Flow
SERVER Result Delivery Method
Appendix 2: Transaction Data Flow
All Result Delivery Methods
POST Result Delivery Method
POST Transaction Flow – Including 3D Secure Authentication
POST Transaction Flow – 3D Secure Card Not Enrolled
POST Transaction Flow – 3D Secure Disabled (MMS Settings)
SERVER Transaction Flow – Including 3D Secure Authentication
SERVER Transaction Flow – 3D Secure Card Not Enrolled
SERVER Transaction Flow – 3D Secure Disabled (MMS Settings)
SERVER_PULL Result Delivery Method
SERVER_PULL Transaction Flow – Including 3D Secure Authentication
SERVER_PULL Transaction Flow – 3D Secure Card Not Enrolled
SERVER_PULL Transaction Flow – 3D Secure Disabled (MMS Settings)
Appendix 3: Example HPF Messages
POST Result Delivery Method – Request
SERVER Result Delivery Method – Request
SERVER Result Delivery Method – Reply to Gateway Response
SERVER_PULL Result Delivery Method – Request
Hosted Payment Form – Response
Appendix 4: Transaction Result Status Codes
Appendix 4: Transaction Result Status Codes
Appendix 5: Override Policy Codes & Explanations
Override AVS Policy Codes
Character 1 Codes
Character 2 Codes
Character 3 Codes
Character 4 Codes
Examples
Questions
Override CV2 Policy Codes
Character 1 Codes
Character 2 Codes
Examples
Questions
Appendix 6: Country (ISO 3166-1) Codes
Appendix 6: Country (ISO 3166-1) Codes
Appendix 7: Currency (ISO 4217) Codes
Appendix 7: Currency (ISO 4217) Codes
Transparent Redirect
Introduction
Intended Audience
Simplifying the Integration Process
Important Notes
Gateway URLs
Hashing Explained
Simple Hashing Example
Notation Explained
Data Types
"Initial Request"
Input Variables
Incoming Hash Digest
3D Secure "Authentication Required"
Output Variables
Outgoing Hash Digest
3D Secure "Post Authentication"
Input Variables
Incoming Hash Digest
"Payment Complete"
Output Variables
Outgoing Hash Digest
Appendix 1: Gateway Response StatusCodes
Appendix 1: Gateway Response StatusCodes
Appendix 2: Transaction Data Flow
Appendix 2: Transaction Data Flow
Transparent Redirect Data Transaction Flow – Including 3D Secure Authentication
Transparent Redirect Transaction Flow – 3D Secure Card Not Enrolled
Transparent Redirect Transaction Flow – 3D Secure Disabled (MMS Setting)
ACS Simulator
Appendix 3: Example Transparent Redirect Messages
Initial Request
3D Secure Authentication Required – Response
3D Secure Post Authentication – Response
3D Secure Post Authentication – Request
Transaction Complete – Response
Appendix 4: Transaction Result Status Codes
Appendix 4: Transaction Result Status Codes
Appendix 5: Override Policy Codes & Explanations
OverrideAVSPolicy Codes
Character 1 Codes
Character 2 Codes
Character 3 Codes
Character 4 Codes
Examples
Questions
OverrideCV2Policy Codes
Character 1 Codes
Character 2 Codes
Examples
Questions
Appendix 6: Country (ISO 3166-1) Codes
Appendix 6: Country (ISO 3166-1) Codes
Appendix 7: Currency (ISO 4217) Codes
Appendix 7: Currency (ISO 4217) Codes
Digital Wallet Integration
Introduction
Using Digital Wallets with the ai Gateway
APM specific data elements and values
The transaction details
1.1 Merchant Responsibilities
1.2 Accepted Wallet Types
1.3 Sample Wallet Transaction
Plugins
Woocommerce
1. Introduction
2. Installation Instructions
3. Plugin Configuration
4. Setting Plugin Live
Shopify
1. Installing the Payment Gateway for Shopify
MMS
Registration and Logging In
1. Registration
2. Logging in
MMS Navigation
1. MMS Navigation
Account Admin
1. Account Settings
Menu
