|
Ingenico Payment Gateway
Also known as Ingenico Global.
This page details the inputs, secure inputs and outputs available for the Ingenico Logic Item, how to complete each field, and an external link to the Ingenico 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
|
|
apiKeyId
|
No (C) **
|
n/a
|
API Key provided by Ingenico for verification purposes
|
|
secretApiKey
|
No (C) **
|
n/a
|
Secret API Key provided be Ingenico for hashing purposes
|
|
merchantId
|
No (C)**
|
n/a
|
Unique Merchant ID provided by Ingenico to the client
|
|
cardPaymentProductId
|
No
|
5 num
|
Unique reference code for the individual transaction
|
|
amount
|
Yes
|
0.01 to 100,000.00
|
Two decimal places are allowed, for example '3.25' is allowed, '3.256' will be rejected
|
|
currencyCode
|
Yes
|
3 chars
|
Standard currency codes are permitted, for example GBP or EUR
|
|
descriptor
|
No
|
n/a
|
Description of what the payment is for, or what it is about
|
|
cardHolderName
|
No
|
51 chars
|
This should be the name listed on the card
|
|
companyName
|
No
|
15 chars
|
Company name
|
|
contactEmailAddress
|
No
|
70 chars
|
Email address for the payment
|
|
contactFaxNumber
|
No
|
20 chars
|
Fax number for the payment
|
|
contactPhoneNumber
|
No
|
20 a/n
|
Phone number for the payment
|
|
billingHouseNumber
|
No (C)*
|
15 chars
|
Customer billing address house number
|
|
billingStreet
|
No (C)*
|
50 chars
|
Customer billing street
|
|
billingCity
|
No (C)*
|
40 chars
|
Customer billing city
|
|
billingZip
|
No (C)*
|
10 chars
|
Customer billing postcode which follows the format of postcodes. Can include a space
|
|
billingCountryCode
|
No (C)*
|
2 chars
|
Customer billing country, ISO format, for example, GB, IE, DE
|
|
billingState
|
No (C)*
|
9 a/n
|
Customer billing US state codes, for example AL, MS, NY
|
|
customerTitle
|
No (C)*
|
20 chars
|
Customer title, e.g. Mr, Mrs, Miss
|
|
customerSurname
|
No (C)*
|
20 chars
|
Customer surname
|
|
customerFirstName
|
No (C)*
|
20 chars
|
Customer firstnames
|
|
customerSurnamePrefix
|
No (C)*
|
100 chars
|
Customer surname prefix
|
|
customerVatNumber
|
No (C)*
|
100 chars
|
Customer VAT number
|
|
shippingFirstName
|
No (C)*
|
40 chars
|
Shipping first name
|
|
shippingSurname
|
No (C)*
|
10 chars
|
Shipping surname
|
|
shippingTitle
|
No (C)*
|
35 chars
|
Shipping title, e.g. Mr, Mrs, Miss
|
|
shippingAdditionalInfo
|
No (C)*
|
50 chars
|
Additional information for shipping
|
|
shippingCity
|
No (C)*
|
40 chars
|
Shipping city
|
|
shippingCountryCode
|
No (C)*
|
2 chars
|
Shipping country, ISO format, for example, GB, IE, DE
|
|
shippingHouseNumber
|
No (C)*
|
15 chars
|
Shipping address house number
|
|
shippingState
|
No (C)*
|
9 a/n
|
Shipping US state codes, for example AL, MS, NY
|
|
shippingStreet
|
No (C)*
|
50 chars
|
Shipping street
|
|
shippingZip
|
No (C)*
|
10 chars
|
Shippinh postcode which follows the format of postcodes. Can include a space
|
|
merchantCustomerId
|
No (C)*
|
15 chars
|
Merchant Customer ID provided by Ingenico, will be unique to the client
|
|
merchantOrderId
|
No
|
10 chars
|
Merchant Order ID for the payment
|
|
merchantReference
|
No
|
30 chars
|
Merchants reference for their own systems
|
|
tokenise
|
No
|
true or false
|
Boolean value 'true' or 'false' to indicate whether or not the card is to be tokenised
|
(C) * - Conditional on whether or not tokenisation is used or not.
(C)** - Conditional on whether or not the Logic Item fields have been populated or not. Highly recommended to use the Logic Item.
Secure Inputs
|
Input Fields
|
Required
|
Character Limits/
Required Input
|
Description
|
|
cardNumber
|
Yes
|
19 chars
|
Secure Input of the Card Number
|
|
cardExpiryDate
|
Yes
|
4 chars
|
Secure Input of the Card Expiry - in the format MMYY
|
|
cardSecurityCode
|
Yes
|
3 or 4 chars
|
Secure Input of the Card Security Code, either three or four digits long depending on the card
|
Outputs
|
Output Fields
|
Description
|
|
additionalReference
|
Additional reference number in order to track the payment
|
|
externalReference
|
External reference for the payment
|
|
isNewToken
|
Boolean response as to whether the token is new or not
|
|
token
|
Token back from the transaction
|
|
paymentId
|
The unique ID of the payment
|
|
paymentStatus
|
The status of the payment
|
|
paymentOutputAmount
|
The amount of the payment
|
|
paymentOutputCurrencyCode
|
The currency code of the paymeny
|
|
paymentOutputAmountPaid
|
The amount paid from the payment (not to be confused with the total amount)
|
|
paymentOutputAuthorisationCode
|
Authorisation code back from the payment
|
|
paymentOutputCardNumber
|
The card number from which the payment was made from
|
|
paymentOutputCardExpiryDate
|
The card expiry date from which the payment was made from
|
|
avsResult
|
AVS Response for the payment
|
|
cvvResult
|
CVV Response for the payment
|
|
fraudServiceResult
|
Fraud Response for the payment
|
|
paymentOutputMerchantOrderId
|
Merchant Order ID output from the payment
|
|
paymentOutputMerchantReference
|
Merchant Reference output from the payment
|
|
paymentOutputPaymentReference
|
Payment Reference output from the payment
|
|
paymentOutputStatus
|
Payment status response
|
|
errorMessage
|
PCI Pal Specific Error Message. If anything goes wrong in the sending of a request, our internal error handling will respond with a message on the output of the flow
|
Ingenico Logic Item
The Ingenico Logic Item contains the following properties:
Further information can be found by viewing the integration documentation: