(c) PCI Pal 2020. The content on this page is subject to the Disclaimer Section (found on the Introduction page)
Worldpay Online Payment Gateway
This page details the inputs, secure inputs and outputs available for the WorldpayOnline Logic Item, how to complete each field, and an external link to the Worldpay integration documentation. Note this payment gateway is also known as Worldpay Business.
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
secretKey
Yes
Unique per client
Unique merchant code given by Worldpay to the client
clientKey
Yes
Unique per client
Unique account username
orderCode
Yes
20 chars
Unique identifier for the specific transaction
orderDescription
Yes
n/a
Description for the transaction
currencyCode
Yes
3 chars
Three digit currency code in ISO format
amount
Yes
0 - 2147483647
The amount of the transaction
cardholderName
Yes
N/A
Card holders name
deliveryFirstName
No (C)
N/A
Customer delivery first name(s)
deliveryLastName
No (C)
N/A
Customer delivery surname
deliveryAddress1
No (C)
N/A
Customer delivery address line 1
deliveryAddress2
No (C)
N/A
Customer delivery address line 2 (optional)
deliveryAddress3
No (C)
N/A
Customer delivery address line 3 (optional)
deliveryPostCode
No (C)
N/A
Customer delivery postcode which follows the format of postcodes. Can include a space
deliveryCity
No (C)
N/A
Customer delivery city
deliveryState
No (C)
N/A
Customer delivery US state codes, for example AL, MS, NY
deliveryCountryCode
No (C)
N/A
Customer delivery country, ISO format, for example, GB, IE, DE
billingAddress1
No (C)
N/A
Customer billing address line 1
billingPostcalCode
No (C)
N/A
Customer billing postcode which follows the format of postcodes. Can include a space
billingCity
No (C)
N/A
Customer billing city
billingState
No (C)
N/A
Customer billing US state codes, for example AL, MS, NY
billingCountryCode
No (C)
N/A
Customer billing country, ISO format, for example, GB, IE, DE
shopperEmail
No (C)
N/A
Shopper email address
shopperAccountNumber
No (C)
N/A
Shopper account number
shopperLastName
No (C)
N/A
Shopper surname
shopperPostalCode
No (C)
N/A
Shopper postcode which follows the format of postcodes. Can include a space
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 CVN, either three or four digits long depending on the card type
Output
Output Fields
Description
orderCodeResponse
The orderCode which was supplied in the original transaction request
paymentMethodResponse
Responds with the payment method which was used in the transaction, for example VISA or Mastercard
amountValueResponse
Shows the amount processed in the transaction
exponentResponse
Returns the exponent set in the original transaction request, aka. the number of decimal places for the amount
debitCreditIndicatorResponse
Indicates that the amount is positive ("credit") or negative ("debit")
currencyCodeResponse
Specifies the currency (ISO 4217) code for the relevant country. For example, GBP, USD or EUR
lastEventResponse
Specifies the latest payment status
CVCResultCodeResponse
The following response will be returned:
A - CVC Matched
B - CVC Not supplied
C - CVC Not checked
D - CVC Not matched
AVSResultCodeResponse
The following response will be returned:
A - Postcode and address matched
B - Postcode matched; address not checked
C - Postcode matched; address not matched
D - Address matched; postcode not checked
E - Postcode and address not checked
F - Address matched; postcode not matched
G - Postcode not checked; address not matched
H - Postcode and address not supplied by shopper/you
I - Address not checked; postcode not matched
J - Postcode and address not matched
AAVAddressResultCodeResponse
The following response will be returned:
A - Data matched. The data entered by the shopper matches the data held by American Express for the Amex card.
B - Data not checked. American Express has not checked the data (either the cardholder name, telephone number or email address).
C - Data not supplied. The data (either the cardholder name, telephone number or email address) was not received by American Express. The shopper may not have entered the data.
D - Data not matched. The data (either the cardholder name, telephone number or email address) entered by the shopper does not match the data held by American Express for the Amex card.
AAVPostcodeResultCodeResponse
The following response will be returned:
A - Data matched. The data entered by the shopper matches the data held by American Express for the Amex card.
B - Data not checked. American Express has not checked the data (either the cardholder name, telephone number or email address).
C - Data not supplied. The data (either the cardholder name, telephone number or email address) was not received by American Express. The shopper may not have entered the data.
D - Data not matched. The data (either the cardholder name, telephone number or email address) entered by the shopper does not match the data held by American Express for the Amex card.
AAVCardholderNameResultCodeResponse
The following response will be returned:
A - Data matched. The data entered by the shopper matches the data held by American Express for the Amex card.
B - Data not checked. American Express has not checked the data (either the cardholder name, telephone number or email address).
C - Data not supplied. The data (either the cardholder name, telephone number or email address) was not received by American Express. The shopper may not have entered the data.
D - Data not matched. The data (either the cardholder name, telephone number or email address) entered by the shopper does not match the data held by American Express for the Amex card.
AAVTelephoneResultCodeResponse
The following response will be returned:
A - Data matched. The data entered by the shopper matches the data held by American Express for the Amex card.
B - Data not checked. American Express has not checked the data (either the cardholder name, telephone number or email address).
C - Data not supplied. The data (either the cardholder name, telephone number or email address) was not received by American Express. The shopper may not have entered the data.
D - Data not matched. The data (either the cardholder name, telephone number or email address) entered by the shopper does not match the data held by American Express for the Amex card.
AAVEmailResultCodeResponse
The following response will be returned:
A - Data matched. The data entered by the shopper matches the data held by American Express for the Amex card.
B - Data not checked. American Express has not checked the data (either the cardholder name, telephone number or email address).
C - Data not supplied. The data (either the cardholder name, telephone number or email address) was not received by American Express. The shopper may not have entered the data.
D - Data not matched. The data (either the cardholder name, telephone number or email address) entered by the shopper does not match the data held by American Express for the Amex card.
cardNumberResponse
The first and last four digits of the card number are returned in the cardNumber element.
fullResponse
The full response message that comes back from the gateway.
errorMessage
PCI Pal specific error message. Should any errors occur our internal error handling will respond with a message on the output of the flow
WorldpayOnline Logic Item
The WorldpayOnline Logic Item contains the following properties:
Exponent
Point at which the decimal place should be for amountValue, almost always should be set to 2.
For added security the Worldpay endpoints have been hardcoded into the integration. Test or Live needs to be selected from the Select Endpoint drop down list, depending on the transaction being conducted.
