(c) PCI Pal 2020. The content on this page is subject to the Disclaimer Section (found on the Introduction page)
Barclaycard Smartpay Payment Gateway
This page details the inputs, secure inputs and outputs available for the Barclaycard Smartpay 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
enterpriseID
Yes
n/a
The Enterprise ID value assigned by Barclaycard to identify an enterprise
clientID
Yes
n/a
This value identifies a particular PoS or client.
transNo
Yes
n/a
An alphanumerical value provided by the merchant to identify the transaction. This should be unique for each whole transaction; ideally an incrementing sequence number.
authType
Yes
n/a
The type of authorisation to perform. e.g.
AuthOnly - Authorises the transaction without settling.
Settle - Settles a previously authorised transaction. If it has not been authorised it will be authorised, thereby equivalent to AuthAndSettle.
AuthAndSettle - (default) Authorises the transaction and marks for settlement. If already authorised it will be settled.
postcode
Yes
20 a/n
Postcode
currencyCode
Yes
3 char
Transaction currency code in ISO 4217 numeric format.
purchaseAmount
Yes
n/a
The transaction amount in lowest currency denomination. e.g. 1000 = £10
purchaseDescription
No
125 a/n
A mandatory description of transaction displayed to the customer in the absence of basket information.
merchantTransactionID
Yes
n/a
The merchant transaction reference
version
Yes
2 num
The response version required. Default = 1
secretKey
Yes
n/a
Hashing key provided by Barclaycard
Secure Inputs
Inputs Fields
Required
Character Limits/Required Input
Description
PAN
Yes
19 num
Secure input of the card number
expiry
Yes
4 num
Secure input of the card expiry - in the format MMYY
CV2
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
acquirerID
-
acquirerName
-
authType
The authType sent in on the request
authCode
The transaction authorisation code.
hostResponseCode
Response code provided by the acquirer
hostResponseMessage
Response message provided by the acquirer
merchantNo
Configured Merchant Number.
paymentMethod
The payment method used: Card
tid
Transaction Identifier
bankID
-
bankName
-
postcode
Postcode as sent in on the request
captureAmount
-
captureOutcome
-
source
Used in the request, this holds transaction source enumerated as follows: keyed
maskedPAN
The masked loyalty card number.
onlineToken
-
updateOnlineToken
-
onlineTokenUpdated
-
expiry
Expiry date of the card
displayBasketDetails
Indicates if the Payment Page displays the basket items. This is configured by Barclaycard
merchantStates
Indicates the merchant-handled transaction status
storeID
Merchant's store ID.
currencyCode
Transaction currency code in ISO 4217 numeric format
rawCv2
Status of the CV2 - i.e. CSC (Card Security Code) - validation. Possible values are: not_matched no_information not_checked partial_match matched
rawAddress
Status of the Address - validation. Possible values are: not_matched no_information not_checked partial_match matched
rawPostcode
Status of the postcode - validation. Possible values are: not_matched no_information not_checked partial_match matched
authEntity
Indication of which entity has performed verification on CV2 or address data. Possible values are: merchant_host acquirer_host card_scheme issuer
mappedCV2
Risk ranking of rawCv2.
mappedAddress
Risk ranking of rawAddress.
mappedPostcode
Risk ranking of rawPostcode.
result
The overall outcome of the risk decision. Possible values are:
NoDecision - PoS needs to make a decision (complete or cancel).
Approve - system auto-completed or auto-cancelled internally.
Reject - system auto-completed or auto-cancelled internally.
A transaction may be auto-cancelled when the CV2/AVS risk criteria are not met; a reversal is requested and the transaction status is set to FAIL.
environment
The environment in which the transaction is being processed. Possible values are: MOTO
merchantTransactionID
Returns the merchant transaction ID as provided in the WebPaymentRequest.
purchaseAmount
Returns the transaction amount as provided in the WebPaymentRequest.
purchaseDescription
Returns the purchase description as provided in the WebPaymentRequest.
enterpriseID
The Enterprise ID value assigned by Barclaycard to identify an enterprise.
clientID
This value identifies a particular PoS or client.
version
The response version required.
Default = 1
responderName
-
responderVersion
-
responderReleaseDate
-
responderID
-
response
-
status
The final status of the transaction
totalAmount
Total transaction amount including all surcharges.
transactionReference
In the case of the beginWebPayment web method returns the generated unique transaction reference. In all other cases returns the transaction reference as provided in the request.
validPayment
One or more payment methods that are available for user-selected payment choice:
- Card
errorCode
Error code in case of a transaction declining
errorMessage
Error message in case of a transaction declining
pcipalErrorMessage
Internal PCI Pal error message
Please contact support@pcipal.com to request further details if required.
