Merchant eSolution Documentation

About Merchant eSolution:

Merchant eSolutions is a leading online money flow available for most businesses. This includes every aspect of everyday end-to-end eCommerce, including their unique Money IN Money OUT solutions.

Feature Level of Support
Auth Implemented
Sale (Auth+Capture) Implemented
Capture Implemented
Void Implemented
Credit Implemented
Gateway Tokenize Implemented

Authentication and Security Credentials:

  • ProfileID
  • ProfileKey

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”
pxyTransaction.txnComment Alphabetical Optional Short comment
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
pxyCustomerInfo.shippingLocation.firstName Alphabetical Optional Customer’s First Name
pxyCustomerInfo.shippingLocation.lastName Alphabetical Optional Customer’s Last Name
pxyCustomerInfo.shippingLocation.phoneNumber Numerical Optional Billing Phone Number
pxyCustomerInfo.shippingLocation.address Alphanumeric Optional Customer’s Billing Address
pxyCustomerInfo.shippingLocation.address2 Alphanumeric Optional Secondary Billing Address
pxyCustomerInfo.shippingLocation.city Alphabetical Optional Customer’s Billing City
pxyCustomerInfo.shippingLocation.state Alphabetical Optional Customer’s Billing State or Province
pxyCustomerInfo.shippingLocation.zipCode Numerical Optional Customer’s Billing Zip Code or Postal Code
pxyCustomerInfo.shippingLocation.country Alphabetical Optional Customer’s Billing Country

API Endpoint URL:

https://[HPCI_API_HOSTENAME]/iSynSApp/paymentAuth.action

API Request Body:

pxyTransaction.cardOnFileTxnType=C&pxyCreditCard.creditCardNumber=545454..........&pxyCustomerInfo.shippingLocation.address=1+main+St&pxyCustomerInfo.billingLocation.city=Old+City&pxyOrder.description=New+Product+Statement&userPassKey=9dG-............................&pxyCustomerInfo.billingLocation.address2=main+St&pxyTransaction.txnAmount=1500.00&pxyCustomerInfo.shippingLocation.zipcode=12345&pxyCreditCard.cardCodeVerification=737&pxyTransaction.txnPayName=DEF&pxyCustomerInfo.shippingLocation.lastName=Jones&pxyCustomerInfo.shippingLocation.city=Old+City&apiVersion=1.0.1&pxyCustomerInfo.shippingLocation.state=ZZ&pxyCustomerInfo.shippingLocation.phoneNumber=444-456-1234&pxyCustomerInfo.customerIP=127.0.0.1&pxyCustomerInfo.shippingLocation.firstName=Jane&pxyCustomerInfo.billingLocation.firstName=Jane&pxyCustomerInfo.billingLocation.state=ZZ&pxyTransaction.merchantPhoneNum=123-456-7890&pxyCustomerInfo.billingLocation.country=US&pxyCustomerInfo.billingLocation.phoneNumber=444-456-1234&pxyTransaction.merchantProductName=New+Product+Statement&pxyCreditCard.expirationMonth=03&pxyCustomerInfo.customerId=CST2&pxyCustomerInfo.shippingLocation.country=US&userName=[APIUsername]&pxyTransaction.txnCurISO=GBP&pxyTransaction.merchantAccountName=Merchant1&pxyCustomerInfo.email=null%40email.com&pxyTransaction.cardOnFileTxnRef=0&pxyCreditCard.expirationYear=2030&pxyCustomerInfo.billingLocation.lastName=Jones&pxyCustomerInfo.billingLocation.address=1&apiType=pxyhpci&pxyCustomerInfo.billingLocation.zipcode=12345
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]