|
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
|
