(c) PCI Pal 2020. The content on this page is subject to the Disclaimer Section (found on the Introduction page)
Payeezy Payment Gateway
This page details the inputs, secure inputs and outputs available for the Payeezy Payment Gateway, how to complete each field, and an external link to the Payeezy 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
merchantRef
No
n/a
Merchant reference code – used by Payeezy system will be reflected in your settlement records
ApiKey
Yes
n/a
Payeezy credential for the API application
token
Yes
n/a
Payeezy merchant token for authentication
transactionType
Yes
“authorize” or “purchase”
The type of transaction
method
Yes
credit_card
The transaction method. Always set to credit_card
amount
Yes
num
The amount in pence/cents. eg. 1299 = £12.99
currencyCode
Yes
3 char
ISO 4217 currency span Ex: USD
cardholderName
No
char
Name of the card holder
billingStreet
No
char
Customer Street Address associated with Billing Address.
billingCity
No
char
Country of the Customer Billing Address.
billingState
No
char
State of the Customer Billing Address.
billingCountry
No
char
Country of the Customer Billing Address.
billingZip
No
char
Zip code of the Customer Billing Address.
billingEmail
No
char
Customer Email address
phoneType
No
char
Type of the phone - Ex. Cell, Landline, Work.
phoneNumber
No
char
Phone number.
Secure Inputs
Input Fields
Required
Character Limits/Required Input
Description
cardNumber
Yes
19 chars
Secure input of the card number
expDate
Yes
3 or 4 chars
Secure input of the card CVV, either three or four digits long depending on the card
cvv
Yes
4 chars
Secure input of the card expiry - in the format MMYY
Outputs
Output Fields
Description
cvvResult
Card Verification Value (CVV2) Response Codes.
amountOut
Processed Amount in cents.
1299 = $12.99
methodOut
Inputted transaction method.
Ex:"3DS" / "Credit_Card" / "EMV"
currencyOut
ISO 4217 currency span Ex: USD. As sent in the request
cardTypeOut
Card type used for the transaction. Values - “American Express", "Visa", "Mastercard", “JCB”, “Diners Club” or "Discover"
bankMessage
Payeezy will return a standardized bank response for each of your transactions. It’s a description / translation for the 3-digit bank response code.
expDateOut
Returned in MMYY format - Expiration Date on the card. eg:1014
bankRespCode
Payeezy will return a standardized response code from the card issuing bank for each of your transactions.
correlationId
Payeezy Internal log id
transactionId
Needed as part of the url to process secondary transactions like capture/void/refund/recurring
gatewayMessage
Payeezy gateway message is a description / translation for the gateway response code.
transactionTag
Needed as part of the payload to process secondary transactions like capture/void/refund/recurring/split-shipment.
cardLast4
Last 4 digits of the card used to make the transaction is returned.
retrievalRefNo
Unknown
tokenType
Type of tokenization performed on card info. Values = FDToken
transactionTypeOut
It is the transaction_type provided in request. values = authorize, capture
gatewayRespCode
Payeezy gateway Response code indicates the status of a transaction as it is sent to the financial institution and returned to the client.
Ex: The Response Code "00"
validationStatus
values - “success” / ”failure”.
Input validation errors enspantered if status returned is failure.
transactionStatus
Approved = Card Approved
Declined = Gateway declined
Not Processed = For any internal errors this status is returned.
errorCode
Code representing an error, where applicable
tokenValue
Tokenized card number.
errorMessage
Human readable error message for the request.
Further information can be found by viewing the integration documentation:
