(c) PCI Pal 2020. The content on this page is subject to the Disclaimer Section (found on the Introduction page)
iATS Payment Gateway
This page details the inputs, secure inputs and outputs available for the iATS Payment Gateway, how to complete each field, and an external link to the iATS integration documentation.
PCI Pal must check any payment gateway integrations prior to going live. The documentation disclaimer (which applies throughout this guide) should be read before commencing any configuration of payment gateways.
Inputs
Input Fields
Required
Character Limits/Required Input
Description
agentCode
Yes
10 char
Username for authentication
password
Yes
10 char
Password for authentication
customerIPAddress
No
IP Address
The IP address of the cardholder
invoiceNum
No
40 char
The invoice number for the transaction
cardType
Yes
NA: VISA, MC, AMX, DSC
UK: VISA, MC, AMX, MAESTR
firstName
Yes
30 char
Cardholder first name
lastName
No
30 char
Cardholder last name
address
No
40 char
First line of address for the cardholder
city
No
30 char
City
state
No
30 char
State or province
zipCode
No
19 char
The zip code for the billing address
total
Yes
The total amount for the transaction
comment
No
110 char
An additional free field for the transaction to attach any comment
title
No
10 char
Optional title for the cardholder. For example - Mr, Mrs, Dr
phone
No
30 char
The phone number for the cardholder
email
No
30 char
Email address for the cardholder
country
No
30 char
Country for the cardholder’s address
Secure Inputs
Input Fields
Required
Character Limits/Required Input
Description
creditCardNum
Yes
19 chars
Secure input of the card number
creditCardExpiry
Yes
4 chars
Secure input of the card expiry in MMYY format
cvv2
Yes
3 or 4 chars
Secure input of the card CVV, either three or four digits long depending on the card
Outputs
Output Fields
Description
transactionId
Return information when Status = Success; and the transaction has been processed; value is transactionID.
authorizationResult
Return information when Status = Success.
This value represents the application-level result that iATS processed the request:
OK - Request has been approved
Error - Request not approved, an error has occurred—possibly due to problems in delivery, attempt by end-user to submit invalid or missing data, etc.
status
The system-level acknowledgement code that indicates the iATS system status:
Success - iATS system processing succeeded.
Failure - An error has occurred on the iATS system side, such as a database or server down.
settlementBatchDate
Timestamp for the settlement of the transaction batch
settlementDate
Timestamp for the settlement of the transaction
fullResponse
The full response returned by iATS
Further information can be found by viewing the integration documentation:
