(c) PCI Pal 2020. The content on this page is subject to the Disclaimer Section (found on the Introduction page)
QualPay Payment Gateway
This page details the inputs, secure inputs and outputs available for the QualPay payment gateway, how to complete each field, and an external link to the QualPay 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
merchantId
Y
12 num
Unique identifier on the Qualpay system
amtTran
Y
12 num
Total amount of transaction including sales tax, convenience fee, and/or surcharge if applicable.
tokenize
N
True or false
In an authorization, credit, force, sale, or verify request the merchant can set tokenize to "true" and the payment gateway will store the cardholder data in the Card Vault and provide a card_id in the response. If the card_number or card_id in the request is already in the Card Vault, this flag instructs the payment gateway to update the associated data (e.g. avs_address, avs_zip, exp_date) if present.
tranCurrency
Y
3 num
ISO 4217 numeric currency code for the transaction
customerId
Y
32 char
ID of the customer being registered in the QualPay system
motoEcommInd
N
1 num
Default: 7
Description: Indicates type of MOTO transaction:
0 = Card Present (not MOTO/e-Commerce)
1 = One Time MOTO transaction
2 = Recurring
3 = Installment
5 = Full 3D-Secure transaction
6 = Merchant 3D-Secure transaction
7 = e-Commerce Channel Encrypted (SSL)
merchRefNum
N
128 char
Merchant provided reference value that will be stored with the transaction data and included with transaction data in reports within Qualpay Manager. This value will also be attached to any lifecycle transactions (e.g. retrieval requests and chargebacks) that may occur.
billingAddr1
N
128 char
Billing street address. This address will also be used for AVS verification if AVS verification is enabled.
billingAddr2
N
128 char
Billing Address line item 2.
billingCity
N
64 char
Billing city.
billingCountry
N
128 char
Billing country.
billingState
N
3 char
Billing state.
billingZip
Y
10 char
Billing zip. This field will also be used for AVS verification if AVS verification is enabled.
billingZip4
N
4 num
Billing zip+4 code if applicable.
customerEmail
N
64 char
Customer's email address.
customerFirmName
N
64 char
Customer business name if applicable.
customerFirstName
Y
32 char
Customer's first name.
customerLastName
Y
32 char
Customer's last name.
customerPhone
N
16 char
Customer's phone number.
shippingFirstName
N
32 char
Shipping first name.
shippingLastName
N
32 char
Shipping last name.
shippingFirmName
N
64 char
Business name of the shipping address, if applicable.
shippingAddr1
N
128 char
Shipping address line item 1.
shippingAddr2
N
128 char
Shipping address line item 2.
shippingCity
N
64 char
Shipping city.
shippingState
N
3 char
Shipping state.
shippingZip
N
10 char
Shipping zip.
shippingZip4
N
4 num
Shipping zip+4 code if applicable.
shippingCountry
N
128 char
Shipping country.
shippingPrimary
N
True or false
Set this field to true if this should be the default address.
Secure Inputs
Input Fields
Required
Character Limits/Required Input
Description
cardNumber
Yes
19 chars
Secure input of the card number
expDate
Yes
4 chars
Secure input of the card expiry in MMYY format
cv2
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
Rmsg
Response text from the payment gateway.
pgId
32-byte unique identifier generated by the payment gateway, returned in all valid responses
Rcode
Response code from the payment gateway. "000" indicates success.
cardId
32-byte value returned after successful tokenize request or when an authorization or sale transaction requests tokenization of the cardholder data.
authCode
Card issuer authorization code returned on successful authorization request.
cardNumberOut
Masked PAN
authAvsResult
AVS result from card issuer (if avs_zip and optionally avs_address were provided in the request).
authCvv2Result
CVV2 result from card issuer (if CVV2 data was sent in the request).
Further information can be found by viewing the integration documentation:
