First Data Payeezy
About First Data Payeezy:
Payeezy Gateway is a dynamic eCommerce solution that helps you create a seamless customer experience on your website by offering more payment options, impressive security features, and easier integration. Accept more payment types than any provider. Customers can pay with any card, PayPal account or electronic checks—all in their native currencies. From tablets to mobile devices, buying habits are always changing. Payeezy Gateway is built to grow with your business, including mobile shopping for your customers.
| Feature | Level of Support |
|---|---|
| Auth | Implemented |
| Sale (Auth+Capture) | Implemented |
| Capture | Implemented |
| Void | Implemented |
| Credit | Implemented |
| Gateway Tokenization | Implemented |
| Credentials on File | Implemented |
Authentication and Security Credentials:
- API Key
- API Secret
- Merchant Token
Supported Parameters:
| Key Name | Format | Mandatory | Descriptions |
|---|---|---|---|
| apiVersion | Numerical | Required | “1.0.1” |
| apiType | Alphabetical | Required | “pxyhpci” |
| userName | Alphanumeric | Required | API Username |
| userPassKey | Alphanumeric | Required | API PassKey |
| pxyCreditCard.creditCardNumber | Numerical | Required | HostedPCI Token Representing Credit Card |
| pxy.CreditCard.cardCodeVerification | Numerical | Optional | HostedPCI Token Representing CVV Code |
| pxyCreditCard.expirationMonth | Numerical | Required | Expiration month with 2 digits for example, for December use “12” |
| pxyCreditCard.expirationYear | Numerical | Required | Expiration year with 4 digits for example, for 2025, use “2025” |
| pxyTransaction.txnCurISO | Alphabetical | Required | 3 letter ISO Currency Code for example, “USD” or “CAD” |
| pxyTransaction.txnAmount | Numerical | Required | Amount to Authorize, for example for $10.50 use 10.50 |
| pxyTransaction.merchantRefId | Numerical | Required | Merchant reference number can be order id or invoice id |
| pxyTransaction.txnPayName | Alphanumeric | Required | HostedPCI payment profile name, for example “DEF” |
| pxyOrder.description | Alphabetical | Optional | Description |
| pxyCustomerInfo.email | Alphanumeric | Optional | Customer’s Email Address |
| pxyCustomerInfo.billingLocation.firstName | Alphabetical | Optional | Customer’s First Name |
| pxyCustomerInfo.billingLocation.lastName | Alphabetical | Optional | Customer’s Last Name |
| pxyCustomerInfo.billingLocation.phoneNumber | Numerical | Optional | Billing Phone Number |
| pxyCustomerInfo.billingLocation.address | Alphanumeric | Optional | Customer’s Billing Address |
| pxyCustomerInfo.billingLocation.address2 | Alphanumeric | Optional | Secondary Billing Address |
| pxyCustomerInfo.billingLocation.city | Alphabetical | Optional | Customer’s Billing City |
| pxyCustomerInfo.billingLocation.state | Alphabetical | Optional | Customer’s Billing State or Province |
| pxyCustomerInfo.billingLocation.zipCode | Numerical | Optional | Customer’s Billing Zip Code or Postal Code |
| pxyCustomerInfo.billingLocation.country | Alphabetical | Optional | Customer’s Billing Country |
Additional Parameters
| KEY NAME | FORMAT | DESCRIPTIONS |
|---|---|---|
| pxyTransaction.merchantAccountName | Alphabetical | Required for Soft Descriptors |
| pxyTransaction.merchantProductName | Alphabetical | Required for Soft Descriptors |
| pxyTransaction.merchantPhoneNum | Alphabetical | Required for Soft Descriptors |
API Endpoint URL:
https://[HPCI_API_HOSTENAME]/iSynSApp/paymentAuth.action
API Request Body:
apiVersion=1.0.1&apiType=pxyhpci&userName=[APIuserName]&userPassKey=[APIPassKey]&pxyCreditCard.creditCardNumber=[CreditCardToken]&pxyCreditCard.cardCodeVerification=[CVVToken]&pxyCreditCard.expirationMonth=[ExpiryMonth]&pxyCreditCard.expirationYear=[ExpiryYear]&pxyTransaction.txnCurISO=[Currency]&pxyTransaction.txnAmount=[Amount]&pxyTransaction.merchantRefId=[UniqueMerchantRefID]&pxyTransaction.txnPayName=[ProfileName]&pxyTransaction.txnComment=[ShortComment]&pxyCustomerInfo.billingLocation.firstName=[CustomerFirstName]&pxyCustomerInfo.billingLocation.lastName=[CustomerLastName]&pxyCustomerInfo.billingLocation.address=[BillingStreetAddress]&pxyCustomerInfo.billingLocation.city=[BillingCity]&pxyCustomerInfo.billingLocation.state=[State/Province]&pxyCustomerInfo.billingLocation.zipCode=[ZipCode/PostalCode]&pxyCustomerInfo.billingLocation.country=[Country]&pxyCustomerInfo.shippingLocation.firstName=[ShippingFirstName]&pxyCustomerInfo.shippingLocation.lastName=[ShippingLastName]&pxyCustomerInfo.shippingLocation.address=[ShippingStreetAddress]&pxyCustomerInfo.shippingLocation.city=[ShippingCity]&pxyCustomerInfo.shippingLocation.state=[ShippingState/Province]&pxyCustomerInfo.shippingLocation.zipCode=[ShippingZipCode/PostalCode]&pxyCustomerInfo.shippingLocation.country=[ShippingCountry]
First Data PayEezy Gateway Tokenization
Parameters Required for Gateway Tokenization:
| PARAMETERS | VALUE |
|---|---|
| pxyCreditCard.creditCardNumber | [HostedPCI Token] |
| pxyCreditCard.cardCodeVerification | [HostedPCI CVV place holder] |
| pxyCreditCard.expirationMonth | [Credit Card expire month] |
| pxyCreditCard.expirationYear | [Credit Card expire year] |
| pxyTransaction.txnPayName | [Profile Name provided by HostedPCI] |
| pxyCustomerInfo.billingLocation.firstName | [Client’s first name as it appears on the card] |
| pxyCustomerInfo.billingLocation.lastName | [Client’s last name as it appears on the card] |
First Data PayEezy Gateway Tokenization API Call:
Request:
pxyCreditCard.creditCardNumber=4444000015201111&apiVersion=1.0.1&userPassKey=[APIPasskey]&pxyCreditCard.expirationMonth=09&pxyCreditCard.expirationYear=2022&pxyCustomerInfo.billingLocation.lastName=Customer&pxyCustomerInfo.billingLocation.firstName=Test&userName=[APIUsername]&pxyCreditCard.cardCodeVerification=200&pxyTransaction.txnPayName=DEF_PAYEEZY&apiType=pxyhpci
Response:
status=success&operId=&tokenId=583732205&mappedCC=4444000015201111&ccBIN=&pxyResponse.threeDSEnrolled=&pxyResponse.threeDSAcsUrl=&pxyResponse.threeDSErrorDesc=&pxyResponse.processorRefId=124.0529221017227&pxyResponse.processorType=firstdataPEzyResponse&pxyResponse.threeDSMessageId=&pxyResponse.threeDSSessionId=&pxyResponse.cardOnFileIssuerId=&pxyResponse.mappedParams=txnResponse.ccTypeEst%3DVISA&pxyResponse.threeDSARS=&pxyResponse.threeDSOrderId=&pxyResponse.gatewayToken.status=&pxyResponse.responseStatus.name=&pxyResponse.responseAVS2=&pxyResponse.responseStatus=approved&pxyResponse.gatewayToken=1589718713441111&pxyResponse.responseAVS1=&pxyResponse.responseAVS4=&pxyResponse.responseStatus.description=success&pxyResponse.threeDSCAVV=&pxyResponse.responseAVS3=&pxyResponse.gatewayToken.fullNativeResp=&pxyResponse.threeDSXid=&pxyResponse.threeDSProtoVersion=&pxyResponse.responseStatus.reasonCode=&pxyResponse.threeDSPARequest=&pxyResponse.responseCVV1=&pxyResponse.threeDSECI=&pxyResponse.responseCVV2=&pxyResponse.fullNativeResp=%7B%22correlation_id%22%3A%22124.0529221017227%22%2C%22status%22%3A%22success%22%2C%22type%22%3A%22FDToken%22%2C%22token%22%3A%7B%22type%22%3A%22Visa%22%2C%22cardholder_name%22%3A%22Test+Customer%22%2C%22exp_date%22%3A%220922%22%2C%22value%22%3A%221589718713441111%22%7D%7D&pxyResponse.threeDSAcsPageData=&pxyResponse.gatewaySubToken2=&pxyResponse.threeDSTransactionId=&pxyResponse.gatewaySubToken1=&pxyResponse.gatewaySubToken3=&pxyResponse.merchantRefId=&pxyResponse.threeDSErrorId=&pxyResponse.txnPayName=DEF_PAYEEZY&pxyResponse.responseStatus.code=&pxyResponse.threeDSSRS=
First Data Payeezy Credentials on File
Credentials on FIle can be set up during the Payment profile setup. In Order to set up the payment profile as Card on File the parameter Card On File defaults needs to be set up as enable=Y;merInitReason=U. The parameter enable=Y tells the system to income the Credentials on the FIle process. The parameter merInitReason=U will set cardOnFileTxnType to U (Unscheduled). It can be overridden with the parameter listed below. Otherwise, the Card on FIle process is initiated based on the availability of CVV.
First Data Payeezy Credentials on File Override Parameters
| PARAMETERS | VALUES |
|---|---|
| pxyTransaction.cardOnFileTxnRef | [0 /1] – 1 for MIT transaction |
| pxyTransaction.cardOnFileOrigAmt | [originalAmount] |
| pxyTransaction.cardOnFileFraudIndicator | [Fraud Indicator] |
| pxyTransaction.cardOnFileTxnType | [C/R/U] – CIT or Reaccuring MIT or Unscheduled MIT |
| pxyTransaction.cardOnFileIssuerId | [cardOnFile Issuer ID] |
First Data PayEezy API Call:
Request:
pxyTransaction.cardOnFileTxnType=R&pxyCreditCard.creditCardNumber=4000000000100002&pxyOrder.orderItems[0].itemPrice=22.21&pxyCustomerInfo.billingLocation.city=Toronto&pxyOrder.orderItems[0].itemQuantity=1&pxyTransaction.cardOnFileOrigAmt=22.21&pxyOrder.orderItems[0].itemDescription=Split Amoont Pkan&userPassKey=[APIpasskey]&pxyTransaction.txnAmount=22.21&pxyTransaction.cardOnFileIssuerId=338526131104033&pxyTransaction.txnPayName=DEF_payezzy_ssens&apiVersion=1.0.1&pxyCustomerInfo.customerIP=127.0.0.1&pxyCustomerInfo.billingLocation.firstName=Test&pxyCustomerInfo.billingLocation.state=ON&pxyTransaction.merchantPhoneNum=123-456-7890&pxyCustomerInfo.billingLocation.country=CAN&pxyOrder.orderItems[0].itemName=Split Aknout Lakn&pxyTransaction.merchantProductName=wkz*Resume Builder&pxyCreditCard.expirationMonth=09&userName=[APIUsername]&pxyTransaction.txnCurISO=CAD&pxyCustomerInfo.billingLocation.zipCode=M7H6G5&pxyCustomerInfo.email=null@email.com&pxyCustomerInfo.profileAction=add&pxyOrder.orderItems[0].itemId=CTEST034&pxyTransaction.merchantAccountName=MerchantAccntr&pxyCreditCard.cardType=visa&pxyTransaction.cardOnFileTxnRef=1&pxyCreditCard.expirationYear=2022&pxyCustomerInfo.billingLocation.lastName=Customer&pxyCustomerInfo.billingLocation.address=12596 West Bayaud Ave&apiType=pxyhpci&pxyTransaction.merchantRefId=2145789541
Response:
status=success&operId=&saleId=53854&pxyResponse.threeDSEnrolled=&pxyResponse.threeDSAcsUrl=&pxyResponse.threeDSErrorDesc=&pxyResponse.processorRefId=4601132271&pxyResponse.processorType=firstdataPEzyResponse&pxyResponse.threeDSMessageId=&pxyResponse.threeDSSessionId=&pxyResponse.cardOnFileIssuerId=&pxyResponse.mappedParams=txnResponse.ccTypeEst%3DVISA&pxyResponse.threeDSARS=&pxyResponse.threeDSOrderId=&pxyResponse.gatewayToken.status=&pxyResponse.responseStatus.name=&pxyResponse.responseAVS2=&pxyResponse.responseStatus=approved&pxyResponse.gatewayToken=9505209161140002&pxyResponse.responseAVS1=1&pxyResponse.responseAVS4=&pxyResponse.responseStatus.description=Transaction+Normal&pxyResponse.threeDSCAVV=&pxyResponse.responseAVS3=&pxyResponse.gatewayToken.fullNativeResp=&pxyResponse.threeDSXid=&pxyResponse.threeDSProtoVersion=&pxyResponse.responseStatus.reasonCode=&pxyResponse.threeDSPARequest=&pxyResponse.responseCVV1=M&pxyResponse.threeDSECI=&pxyResponse.responseCVV2=&pxyResponse.fullNativeResp=%7B%22correlation_id%22%3A%22228.0675598818723%22%2C%22transaction_status%22%3A%22approved%22%2C%22validation_status%22%3A%22success%22%2C%22transaction_type%22%3A%22purchase%22%2C%22transaction_id%22%3A%22ET147027%22%2C%22transaction_tag%22%3A%224601132271%22%2C%22method%22%3A%22credit_card%22%2C%22amount%22%3A%222221%22%2C%22currency%22%3A%22CAD%22%2C%22avs%22%3A%221%22%2C%22cvv2%22%3A%22M%22%2C%22token%22%3A%7B%22token_type%22%3A%22FDToken%22%2C%22token_data%22%3A%7B%22value%22%3A%229505209161140002%22%7D%7D%2C%22card%22%3A%7B%22type%22%3A%22Visa%22%2C%22cardholder_name%22%3A%22Test+Customer%22%2C%22card_number%22%3A%220002%22%2C%22exp_date%22%3A%220922%22%7D%2C%22bank_resp_code%22%3A%22100%22%2C%22bank_message%22%3A%22Approved%22%2C%22gateway_resp_code%22%3A%2200%22%2C%22gateway_message%22%3A%22Transaction+Normal%22%2C%22stored_credentials%22%3A%7B%22cardbrand_original_transaction_id%22%3A%22338526131104033%22%2C%22initiator%22%3A%22M%22%2C%22indicator%22%3A%22S%22%2C%22schedule%22%3A%22S%22%7D%7D&pxyResponse.threeDSAcsPageData=&pxyResponse.gatewaySubToken2=&pxyResponse.threeDSTransactionId=&pxyResponse.gatewaySubToken1=&pxyResponse.gatewaySubToken3=&pxyResponse.merchantRefId=&pxyResponse.threeDSErrorId=&pxyResponse.txnPayName=DEF_payezzy_ssens&pxyResponse.responseStatus.code=00&pxyResponse.threeDSSRS=