(c) PCI Pal 2020. The content on this page is subject to the Disclaimer Section (found on the Introduction page)
FreedomPay Payment Gateway
This page details the inputs, secure inputs and outputs available for the FreedomPay Payment Gateway, how to complete each field, and an external link to the FreedomPay 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
storeId
Y
62 alphanumeric
Unique Store ID provided to the client by FreedomPay
terminalId
Y
64 alphanumeric
Unique Terminal ID provided to the client by FreedomPay
trackKsn
Y
50 alphanumeric
Unique trackKsn provided to the client by FreedomPay
company
N
40 char
Company Name
dateOfBirth
N
8 num
Date of Birth - in the format YYYYMMDD
title
N
5 char
Title, e.g. Mr, Mrs, Miss, Dr, Sir
firstName
N
60 char
First name of the customer making the payment
middleName
N
60 char
Middle name of the customer making the payment
lastName
N
60 char
Last name of the customer making the payment
street1
N
60 char
Customer address line 1
street2
N
60 char
Customer address line 2
city
N
50 char
Customer address city
state
N
3 char
Customer address state - 2 digit code e.g. NY, NC, TX
postalCode
N
9 alphnumerical
Customer postal/zip code
country
N
2 char
Customer country code in 2 digit ISO format e.g. GB, US, CA
phoneNumber
N
15 num
Customer phone number
email
N
255 alphanumerical
Customer email address
enableAVS
Y
1 char
Flag to enable AVS checking on the payment or not to enable. N or Y
transType
Y
n/a
Sets the transaction type, this is either set to verify or payment
type
N
(tokenization only)
2 num
Type of token to be used on the payment. Please consult FreedomPay to know the correct one to use
comments
N
255 alphanumerical
Comments on the transaction
invoiceNumber
Y
20 num
Unique invoice number to be used throughout the lifetime of the transaction.
nameOnCard
Y
60 char
Card Holder Name on the front of the payment card.
taxAmount
Y
decimal
Amount of tax to be taken on the payment
chargeAmount
Y
decimal
Amount to be charged to the card
currency
Y
3 char
3 letter currency code e.g. USD, GBP, EUR
merchantReferenceCode
N
50 alphanumerical
Unique merchant reference code for the transaction
productSKU
N
30 alphanumerical
Product SKU number
productName
N
35 char
Name of product being ordered
quantity
N
decimal
Quantity of product being ordered
Secure Inputs
Input Fields
Required
Character Limits/
Required Input
Description
PAN
Yes
19 num
Secure input of the card number
Expiry
Yes
2 num
Secure input of the card expiry - in the format MM
CVV
Yes
3 or 4 num
Secure input of the card CVV, either three or four digits long depending on the card
Outputs
Output Fields
Description
brand
Card brand from the payment request
token
Token returned from FreedomPay, this will match the format of the token specified in the 'type' field should the tokenization service be used.
amount
Amount taken. This should match the chargeAmount in the request.
network
Internal FreedomPay network data
decision
Decision of the payment, this will be the result on whether the request was a success or decline
requestID
Unique Request ID provided from FreedomPay. This can be used for refund requests and further downstream functionality.
reasonCode
FreedomPay Reason Code. Please consult FreedomPay for a full list of the reason codes.
authRequestID
Authorisation Request ID.
partialAmount
Y or N flag. If amount authorized is different to the amount captured in the transaction, flag will be set to Y.
requestDateTime
Date Time value of when the request was processed in the FreedomPay system.
tokenExpiration
Expiration date time value of when the token will expire (this will only be received it the tokenization service is used)
reconciliationID
Reconciliation ID
authorizationCode
Authorization Code for the transaction.
authorizedDateTime
Date time value of when the payment was authorized through the FreedomPay system.
cardExpirationMonth
Card Expiry Month
cardExpirationYear
Card Expiry Year
accountNumberMasked
Masked credit card number
enhancedDataEnabled
true or false flag for if the enhancedData functionality is enabled
merchantReferenceCode
Merchant Reference Code, this should match what was passed on the request.
processorResponseCode
Processor Response Code
processorTransactionID
Processor Transaction ID
processorResponseMessage
Processor Response Message
errormessage
PCI Pal error message
For more details, please contact support@pcipal.com, and ask for a copy of the integration documentation for FreedomPay.
