eBanx Documentation

About eBanx:

Ebanx is an international cloud-based digital security API provider, available in approximately 15 different markets worldwide.

Feature Level of Support
Auth Implemented
Sale (Auth+Capture) Implemented
Capture Implemented
Void Implemented
Credit Implemented
Card on File Implemented
3DS 2 Passthrough Implemented

Authentication and Security Credentials:

  • Public Integration Key
  • Integration Key

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:

pxyCreditCard.creditCardNumber=411100..........&pxyCustomerInfo.shippingLocation.address=1+main+St&pxyCustomerInfo.billingLocation.city=Burlington&userPassKey=%3AZxr............&pxyTransaction.txnAmount=50&pxyCreditCard.cardCodeVerification=***&pxyTransaction.txnPayName=DEF_EMerchant&pxyCustomerInfo.shippingLocation.city=Burlington&apiVersion=1.0.1&pxyCustomerInfo.shippingLocation.state=MA&pxyCustomerInfo.customerIP=127.0.0.1&pxyCustomerInfo.billingLocation.firstName=Jane&pxyCustomerInfo.billingLocation.state=MA&pxyTransaction.merchantPhoneNum=123-456-7890&pxyCustomerInfo.billingLocation.country=US&pxyTransaction.merchantCity=Toronto&pxyCustomerInfo.billingLocation.phoneNumber=987-654-3210&pxyCustomerInfo.shippingLocation.zipCode=12345&pxyTransaction.merchantProductName=New+Product+Statement&pxyCreditCard.expirationMonth=**&pxyCustomerInfo.customerId=900740&pxyCustomerInfo.shippingLocation.country=US&userName=[APIUsername]&pxyTransaction.txnCurISO=USD&pxyCustomerInfo.billingLocation.zipCode=12345&pxyCustomerInfo.email=null%40email.com&pxyCreditCard.cardType=visa&pxyCreditCard.expirationYear=20**&pxyCustomerInfo.billingLocation.lastName=Jones&pxyCustomerInfo.billingLocation.address=1+main+St&apiType=pxyhpci&pxyTransaction.merchantRefId=1234567

3DS 2.0 Passthrough implementation with Cardinal Commerce

eBanx has been implemented with Cardinal Commerce for 3DS pass-through Authentication.

The parameters listed on the page are required along with the mandatory AUTH transaction parameters to make a successful 3DSecure transaction.

3DS 2.0 “Verifyenroll” Call

PARAMETERS VALUE
pxyTransaction.txnPayName [3ds payment profile name]
pxyThreeDSecAuth.actionName [verifyenroll]
pxyThreeDSecAuth.callMode reportall
pxyThreeDSecAuth.authSessionId [cruiseSessionId returned within threeDSValuesObj in hpciSiteSuccessHandlerV4 and later versions]
pxyThreeDSecAuth.authOrderId [threeDSOrderId returned within threeDSValuesObj in hpciSiteSuccessHandlerV4 and later versions]
pxyCustomerInfo.browserUserAgentHeader [Browser User Agent Header]
pxyCustomerInfo.browserAcceptHeader [Browser Accept Header]

3DS 2.0 “verifyresp” Call

PARAMETERS VALUE
pxyTransaction.txnPayName [3ds payment profile name]
pxyThreeDSecAuth.actionName [verifyresp]
pxyThreeDSecAuth.authSessionId [cruiseSessionId returned within threeDSValuesObj in hpciSiteSuccessHandlerV4 and later versions]
pxyThreeDSecAuth.authCAVV [response from the first API call “pxyResponse.threeDSCAVV”]
pxyThreeDSecAuth.authVerifyTxnId [response from the first API call “pxyResponse.threeDSXid”]
pxyThreeDSecAuth.paReq [response from the first API call “pxyResponse.threeDSPARequest”]
pxyThreeDSecAuth.protocolVersion [response from the first API call “pxyResponse.threeDSProtoVersion”]
pxyThreeDSecAuth.authECI
pxyThreeDSecAuth.scaVisaMID
pxyThreeDSecAuth.exemptionIndicator

3DS 2.0 Verifyenroll Request Call:

pxyCreditCard.creditCardNumber=400000..........&pxyOrder.orderItems[0].itemPrice=65.65&pxyCustomerInfo.billingLocation.city=Toronto&pxyOrder.orderItems[0].itemQuantity=1&pxyOrder.description=Test+Order&pxyOrder.orderItems[0].itemDescription=Best&pxyOrder.orderItems[0].itemTaxable=N&pxyOrder.invoiceNumber=Order%3A+AAA69142615&userPassKey=9dG-............................&pxyThreeDSecAuth.authSessionId=0_8884c755-3b4c-41ce-87fc-aeacf512b513&pxyTransaction.txnAmount=65.65&pxyCreditCard.cardCodeVerification=737&pxyTransaction.txnPayName=DEF&pxyCustomerInfo.browserAcceptHeader=text%2Fhtml%2Capplication%2Fxhtml%2Bxml%2Capplication%2Fxml%3Bq%3D0.9%2Cimage%2Favif%2Cimage%2Fwebp%2Cimage%2Fapng%2C*%2F*%3Bq%3D0.8%2Capplication%2Fsigned-exchange%3Bv%3Db3%3Bq%3D0.9&pxyThreeDSecAuth.actionName=verifyenroll&apiVersion=1.0.1&pxyCustomerInfo.customerIP=127.0.0.1&pxyCustomerInfo.billingLocation.firstName=AUTHORISED&pxyCustomerInfo.billingLocation.country=CA&pxyCustomerInfo.billingLocation.phoneNumber=4168351525&pxyOrder.orderItems[0].itemName=item&pxyOrder.totalAmount=65.65&pxyCreditCard.expirationMonth=03&pxyCustomerInfo.customerId=hpcitest1&userName=[APIUsername]&pxyTransaction.txnCurISO=GBP&pxyCustomerInfo.billingLocation.zipCode=M9K8U6&pxyCustomerInfo.browserUserAgentHeader=Mozilla%2F5.0+%28X11%3B+Linux+x86_64%29+AppleWebKit%2F537.36+%28KHTML%2C+like+Gecko%29+Chrome%2F83.0.4103.61+Safari%2F537.36&pxyCustomerInfo.email=hpcitest1%40mailinator.com&pxyOrder.orderItems[0].itemId=Item-1-AAA69142615&pxyCreditCard.cardType=VISA&pxyThreeDSecAuth.authOrderId=67UDMNKVH1RE1001821&pxyCreditCard.expirationYear=2030&pxyThreeDSecAuth.callMode=reportall&pxyCustomerInfo.billingLocation.address=22+Hilltop+St&apiType=pxyhpci&pxyTransaction.merchantRefId=AAA69142615
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]