|
CharityClear (LibertyPay)
This page details the inputs, secure inputs and outputs available for the LibertyPay Logic Item, how to complete each field.
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
|
|
merchantID
|
Yes
|
n/a
|
Your Gateway Merchant ID
|
|
action
|
Yes
|
n/a
|
Type of payment, possible values are: PREAUTH, SALE, REFUND_SALE
|
|
amount
|
Yes
|
n/a
|
The amount of the transaction in decimal value
|
|
countryCode
|
Yes
|
3 AN
|
ISO-3166 alpha or numeric country code value
|
|
currencyCode
|
Yes
|
3AN
|
ISO-4217 alpha or numeric currency code value
|
|
transactionUnique
|
No
|
n/a
|
Unique transaction reference value
|
|
orderRef
|
No
|
n/a
|
Free format field to store order details for merchant records
|
|
captureDelay
|
No
|
n/a
|
Number of days to wait between authorising and settling a payment
|
|
xref
|
No
|
n/a
|
Reference to a previous transaction
|
|
customerAddress
|
No
|
n/a
|
Customer address
|
|
customerPostcode
|
No
|
n/a
|
Customer postal code
|
|
avscv2CheckRequired
|
No
|
1 char
|
Flag to whether or not AVS CV2 checking is enabled, either Y or N
|
|
cv2CheckPref
|
No
|
n/a
|
List of cv2check response values to be accepted in a comma separated list
|
|
addresCheckPref
|
No
|
n/a
|
List of addresscheck response values to be accepted in a comma separated list
|
|
postcodeCheckPref
|
No
|
n/a
|
List of postcodecheck response values to be accepted in a comma separated list
|
|
customerName
|
No
|
n/a
|
Cardholder name
|
|
customerCompany
|
No
|
n/a
|
Cardholder company name
|
|
customerTown
|
No
|
n/a
|
Cardholder town
|
|
customerCounty
|
No
|
n/a
|
Cardholder county
|
|
customerCountryCode
|
No
|
3 AN
|
Cardholder country code in ISO-3166 format
|
|
customerPhone
|
No
|
n/a
|
Cardholder phone number
|
|
customerMobile
|
No
|
n/a
|
Cardholder mobile number
|
|
customerFax
|
No
|
n/a
|
Cardholder fax number
|
|
customerEmail
|
No
|
n/a
|
Cardholder email address
|
|
customerOrderRef
|
No
|
n/a
|
Cardholder order reference
|
|
customerMerchantRef
|
No
|
n/a
|
Cardholder merchant reference
|
|
customerTaxRef
|
No
|
n/a
|
Cardholder tax reference
|
|
merchantName
|
No
|
n/a
|
Merchant contact name
|
|
merchantCompany
|
No
|
n/a
|
Merchant company name
|
|
merchantAddress
|
No
|
n/a
|
Merchant contact address
|
|
merchantTown
|
No
|
n/a
|
Merchant contact town
|
|
merchantCounty
|
No
|
n/a
|
Merchant contact county
|
|
merchantPostcode
|
No
|
n/a
|
Merchant contact postal code
|
|
merchantCountryCode
|
No
|
3 AN
|
Merchant contact country code in ISO-3166 format
|
|
merchantPhone
|
No
|
n/a
|
Merchant contact phone number
|
|
merchantMobile
|
No
|
n/a
|
Merchant contact mobile number
|
|
merchantFax
|
No
|
n/a
|
Merchant contact fax number
|
|
merchantEmail
|
No
|
n/a
|
Merchant contact email address
|
|
merchantWebsite
|
No
|
n/a
|
Merchant contact website
|
|
merchantOrderRef
|
No
|
n/a
|
Merchant contact order reference
|
|
merchantCustomerRef
|
No
|
n/a
|
Merchant contact customer reference
|
|
merchantTaxRef
|
No
|
n/a
|
Merchant contact tax reference
|
|
merchantOriginalOrderRef
|
No
|
n/a
|
Merchant contact original transaction order reference
|
|
merchantCategoryCode
|
No
|
n/a
|
Merchant contact category code
|
|
supplierName
|
No
|
n/a
|
Suppliers contact name
|
|
supplierCompany
|
No
|
n/a
|
Suppliers company name
|
|
supplierAddress
|
No
|
n/a
|
Suppliers company address
|
|
supplierTown
|
No
|
n/a
|
Suppliers company town
|
|
supplierCounty
|
No
|
n/a
|
Suppliers company county
|
|
supplierPostcode
|
No
|
n/a
|
Suppliers company postal code
|
|
supplierCountryCode
|
No
|
3 AN
|
Suppliers company code in ISO-3166 format
|
|
supplierPhone
|
No
|
n/a
|
Suppliers phone number
|
|
supplierMobile
|
No
|
n/a
|
Suppliers mobile number
|
|
supplierFax
|
No
|
n/a
|
Suppliers fax number
|
|
supplierEmail
|
No
|
n/a
|
Suppliers email address
|
|
deliveryName
|
No
|
n/a
|
Name of the person recieving delivery
|
|
deliveryCompany
|
No
|
n/a
|
Name of company recieving delivery
|
|
deliveryAddress
|
No
|
n/a
|
Delivery address
|
|
deliveryTown
|
No
|
n/a
|
Delivery town
|
|
deliveryCounty
|
No
|
n/a
|
Delivery county
|
|
deliveryPostcode
|
No
|
n/a
|
Delivery postal code
|
|
deliveryCountryCode
|
No
|
3 AN
|
Delivery country code in ISO-3166 format
|
|
deliveryPhone
|
No
|
n/a
|
Delivery phone number
|
|
deliveryMobile
|
No
|
n/a
|
Delivery mobile number
|
|
deliveryFax
|
No
|
n/a
|
Delivery fax number
|
|
deliveryEmail
|
No
|
n/a
|
Delivery email address
|
|
receiverName
|
No
|
n/a
|
Recievers contact name
|
|
receiverCompany
|
No
|
n/a
|
Recievers company name
|
|
receiverAddress
|
No
|
n/a
|
Recievers address
|
|
receiverTown
|
No
|
n/a
|
Recievers town
|
|
receiverCounty
|
No
|
n/a
|
Recievers county
|
|
receiverPostcode
|
No
|
n/a
|
Recievers postal code
|
|
receiverCountryCode
|
No
|
3 AN
|
Recievers country code in ISO-3166 format
|
|
receiverPhone
|
No
|
n/a
|
Recievers phone number
|
|
receiverMobile
|
No
|
n/a
|
Recievers mobile number
|
|
receiverFax
|
No
|
n/a
|
Recievers fac number
|
|
receiverEmail
|
No
|
n/a
|
Recievers email address
|
|
receiverAccountNo
|
No
|
n/a
|
Recievers account number
|
|
receiverDateOfBirth
|
No
|
n/a
|
Recievers date of birth
|
|
shippingTrackingRef
|
No
|
n/a
|
Shipping tracking reference
|
|
shippingMethod
|
No
|
n/a
|
Shipping method, e.g. courier, post, etc.
|
|
shippingAmount
|
No
|
n/a
|
Cost of shipping
|
|
shippingGrossAmount
|
No
|
n/a
|
Gross cost of shipping
|
|
shippingNetAmount
|
No
|
n/a
|
New cost of shipping
|
|
shippingTaxRate
|
No
|
n/a
|
Shipping tax rate as a percentage
|
|
shippingTaxAmount
|
No
|
n/a
|
Shipping tax amount
|
|
shippingTaxReason
|
No
|
n/a
|
Tax reason i.e. VAT
|
|
shippingDiscountAmount
|
No
|
n/a
|
Discount on shipping
|
|
shippingDiscountReason
|
No
|
n/a
|
Reason for discount
|
|
statementNarrative1
|
No
|
n/a
|
-
|
|
statementNarrative2
|
No
|
n/a
|
-
|
|
subMerchantID
|
No
|
n/a
|
Payment facilitator submerchant ID
|
|
hashKey
|
Yes
|
n/a
|
Hashing key provided for your account by LibertyPay.
|
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
|
|
cardCvv
|
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
|
|
addressCheck
|
Possible values are: not known, not checked, matched, not matched, partially matched.
|
|
amountReceived
|
The amount the Acquirer authorised. This should always be the full amount requested.
|
|
authorisationCode
|
Authorisation code received from Acquirer.
|
|
avscv2CheckEnabled
|
Is AVS/CV2 checking enabled for this Merchant Account? Possible values are: N – Merchant account is not enabled. Y – Merchant account is enabled.
|
|
avscv2ResponseCode
|
The result of the AVS/CV2 check.
|
|
cardIssuer
|
The card issuer
|
|
cardIssuerCountry
|
The card issuer country
|
|
cardIssuerCountryCode
|
The card issuer country code
|
|
cardNumberMask
|
Masked card number
|
|
cardScheme
|
Card Scheme
|
|
cardSchemeCode
|
Card Scheme code
|
|
cardType
|
Card Type
|
|
cardTypeCode
|
Card Type code
|
|
customerCountryCode
|
Customer country code
|
|
customerTown
|
Customer town
|
|
cv2Check
|
Value is a comma separated list containing one or more of the following: not known, not checked, matched, not matched, partially matched
|
|
merchantCategoryCode
|
Merchant’s VISA MCC
|
|
postcodeCheck
|
Value is a comma separated list containing one or more of the following: not known, not checked, matched, not matched, partially matched.
|
|
responseCode
|
Response code from CharityClear
|
|
responseMessage
|
Response message from CharityClear
|
|
state
|
Customer state
|
|
timestamp
|
Timestamp of the transaction
|
|
transactionID
|
Transaction ID
|
|
transactionUnique
|
Transaction Unique value as passed in on the request
|
|
xref
|
Referenced transaction ID as passed in on the request
|
|
action
|
Type of payment, possible values are: PREAUTH, SALE, REFUND_SALE
|
|
addressCheckPref
|
Value is a comma separated list containing one or more of the following not known, not checked, matched, not matched, partially matched
|
|
amount
|
Amount sent to the gateway
|
|
amountApproved
|
Amount approved from the original transaction
|
|
amountRefunded
|
Total amount of original SALE that has so far been refunded. Returned when action is REFUND_SALE.
|
|
amountRetained
|
-
|
|
avscv2AuthEntity
|
Possible values are: not known, merchant host, acquirer host, card scheme, issuer.
|
|
avscv2ResponseMessage
|
The message received from the Acquiring bank, or any error message with regards to the AVS/CV2 check.
|
|
caEnabled
|
-
|
|
cardCVVMandatory
|
-
|
|
cardExpiryDate
|
Expiration date of the card used in the transaction
|
|
cardExpiryMonth
|
Card expiration month
|
|
cardExpiryYear
|
Card expiration year
|
|
cardFlags
|
-
|
|
cftEnabled
|
-
|
|
countryCode
|
Buyer's country code
|
|
currencyCode
|
Currency code
|
|
currencyExponent
|
Exponent of the transaction
|
|
customerAddress
|
Customer address
|
|
customerCompany
|
Customer company name
|
|
customerCounty
|
Customer county
|
|
customerEmail
|
Customer email address
|
|
customerFax
|
Customer fax number
|
|
customerMerchantRef
|
Customer merchant reference number
|
|
customerMobile
|
Customer mobile number
|
|
customerName
|
Customer name
|
|
customerOrderRef
|
Customer order reference
|
|
customerPhone
|
Customer phone number
|
|
customerPostcode
|
Customer postal code
|
|
customerReceiptsRequired
|
Customer receipt flag
|
|
customerTaxRef
|
Customer tax reference
|
|
cv2CheckPref
|
Value is a comma separated list containing one or more of the following: not known, not checked, matched, not matched, partially matched.
|
|
deliveryAddress
|
Delivery address
|
|
deliveryCompany
|
Delivery company name
|
|
deliveryCountryCode
|
Delivery country code
|
|
deliveryCounty
|
Delivery county
|
|
deliveryEmail
|
Delivery email address
|
|
deliveryFax
|
Delivery fax number
|
|
deliveryMobile
|
Delivery mobile number
|
|
deliveryName
|
Delivery name
|
|
deliveryPhone
|
Delivery phone number
|
|
deliveryPostcode
|
Delivery postal code
|
|
deliveryTown
|
Delivery town
|
|
eReceiptsEnabled
|
-
|
|
eReceiptsStoreID
|
-
|
|
merchantAddress
|
Merchant address
|
|
merchantCompany
|
Merchant company name
|
|
merchantCountryCode
|
Merchant country code
|
|
merchantCounty
|
Merchant county
|
|
merchantCustomerRef
|
Merchant customer reference
|
|
merchantEmail
|
Merchant email address
|
|
merchantFax
|
Merchant fax number
|
|
merchantID
|
Merchant ID
|
|
merchantMobile
|
Merchant mobile number
|
|
merchantName
|
Merchant name
|
|
merchantOrderRef
|
Merchant order reference number
|
|
merchantOriginalOrderRef
|
Merchant original order reference
|
|
merchantPhone
|
Merchant phone number
|
|
merchantPostcode
|
Merchant postal code
|
|
merchantTaxRef
|
Merchant tax reference
|
|
merchantTown
|
Merchant town
|
|
merchantWebsite
|
Merchant website
|
|
orderRef
|
Order reference
|
|
paymentMethod
|
Payment method
|
|
postcodeCheckPref
|
Value is a comma separated list containing one or more of the following: not known, not checked, matched, not matched, partially matched.
|
|
processMerchantID
|
ID of Merchant Account request was processed by.
|
|
receiverAccountNo
|
Account number. If a PAN is supplied the only the first 6 and last 4 digits will be used.
|
|
receiverAddress
|
Reciever address
|
|
receiverCompany
|
Reciever company name
|
|
receiverCountryCode
|
Reciever country code
|
|
receiverCounty
|
Reciever county
|
|
receiverDateOfBirth
|
Reciever date of birth
|
|
receiverEmail
|
Reciever email address
|
|
receiverFax
|
Reciever fax number
|
|
receiverMobile
|
Reciever mobile number
|
|
receiverName
|
Reciever name
|
|
receiverPhone
|
Reciever phone number
|
|
receiverPostcode
|
Reciever postal code
|
|
receiverTown
|
Reciever town
|
|
referralPhone
|
Telephone number supplied by Acquirer to phone for voice authorisation. Most Acquirers do not provide this number
|
|
requestID
|
-
|
|
requestMerchantID
|
-
|
|
resellerGatewayUrl
|
-
|
|
responseStatus
|
-
|
|
riskCheckEnabled
|
-
|
|
rtsEnabled
|
-
|
|
shippingAmount
|
Shipping amount
|
|
shippingDiscountAmount
|
Shipping discount amount
|
|
shippingDiscountReason
|
Shipping discount reason
|
|
shippingGrossAmount
|
Shipping gross amount
|
|
shippingMethod
|
Shipping net amount as sent in request
|
|
shippingNetAmount
|
Shipping net amount
|
|
shippingTaxAmount
|
Shipping tax amount
|
|
shippingTaxRate
|
Shipping tax rate in percentage
|
|
shippingTaxReason
|
Shipping tax reason
|
|
shippingTrackingRef
|
Shipping tracking referencr
|
|
signature
|
Signature of the transaction
|
|
supplierAddress
|
Supplier address
|
|
supplierCompany
|
Supplier company name
|
|
supplierCountryCode
|
Supplier country code
|
|
supplierCounty
|
Supplier county
|
|
supplierEmail
|
Supplier email address
|
|
supplierFax
|
Supplier fax number
|
|
supplierMobile
|
Supplier mobile number
|
|
supplierName
|
Supplier name
|
|
supplierPhone
|
Supplier phone number
|
|
supplierPostcode
|
Supplier postal code
|
|
supplierTown
|
Supplier town
|
|
surchargeEnabled
|
Whether or not surcharge is enabled on the account or not
|
|
threeDSCheckPref
|
Value is a comma separated list containing one or more of the following values: ‘not known', 'not checked', ' not authenticated', 'attempted authentication', 'authenticated’.
|
|
threeDSEnabled
|
Is 3DSEnabled on the merchant account - will either be Y or N
|
|
type
|
-
|
|
vcsResponseCode
|
VCS Error Code
|
|
vcsResponseMessage
|
VCS Error Message
|
|
pcipal.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
|