(c) PCI Pal 2020. The content on this page is subject to the Disclaimer Section (found on the Introduction page)
PTX (Bottomline)
This page details the inputs, secure inputs and outputs available for the PTX Payment Gateway and 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
customerAddress
No
n/a
Customer address
customerPostCode
No
n/a
Customer postal code
customerName
No
n/a
Cardholder name
signatureKey
Yes
n/a
Hashing key provided for your account by PTX.
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
customerName
Customer name
customerOrderRef
Customer order reference
customerPostcode
Customer postal code
cv2CheckPref
Value is a comma separated list containing one or more of the following: not known, not checked, matched, not matched, partially matched.
eReceiptsEnabled
-
eReceiptsStoreID
-
merchantID
Merchant ID
orderRef
Order reference
paymentMethod
Payment method
requestID
-
requestMerchantID
-
resellerGatewayUrl
-
responseStatus
-
riskCheckEnabled
-
rtsEnabled
-
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
