EBizCharge Payment Integration
About EBizCharge:
EbizCharge is a flexible gateway that can help merchants accept credit card payments online, integrate payments with their ERP, CRM, or accounting system, and control all the payments. Ebiz Charge services were integrated by HostedPCI since 2020.
Implemented Features:
| Feature | Level of Support |
|---|
| Auth | Implemented |
| Sale (Auth+Capture) | Implemented |
| Capture | Implemented |
| Void | Implemented |
| Credit | Implemented |
| Gateway Tokenization | Implemented |
Authentication and Security Credentials:
- UserID
- Password
- Security ID
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” |
| pxyCustomerInfo.billingLocation.address | Alphanumeric | Optional | Customer’s Billing Address |
| pxyCustomerInfo.billingLocation.zipCode | Numerical | Optional | Customer’s Billing Zip Code or Postal Code |
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]
EBiz Charge 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] |
Additional Parameters Required for Ebiz Charge Gateway Tokenization:
| PARAMETERS | VALUE |
|---|
| pxyCustomerInfo.profileGatewayId | [Gateway ID] |
| pxyTransaction.txnCurISO | [currency ISO] |
| pxyTransaction.typeCode | [Transaction type code] |
dLocal Gateway Tokenization API Call
Request:
pxyCreditCard.creditCardNumber=4111000018801111&pxyCustomerInfo.profileGatewayId=14105-970000002&userPassKey=[APIPasskey]&pxyCreditCard.expirationMonth=09&pxyTransaction.typeCode=7&userName=[APIUsername]&pxyCreditCard.cardCodeVerification=200&pxyTransaction.txnPayName=Ebiz_Def&pxyTransaction.txnCurISO=USD&apiVersion=1.0.1&pxyCreditCard.expirationYear=2022&pxyCustomerInfo.billingLocation.lastName=Paul&pxyCustomerInfo.billingLocation.firstName=Test&apiType=pxyhpci
Response:
status=success&operId=&tokenId=583657015&mappedCC=4111000018801111&ccBIN=&pxyResponse.threeDSEnrolled=&pxyResponse.threeDSAcsUrl=&pxyResponse.threeDSErrorDesc=&pxyResponse.processorRefId=2d8948b0-7342-49c6-adf7-73ebf65eaff9&pxyResponse.processorType=ebizchargeResponse&pxyResponse.threeDSMessageId=&pxyResponse.threeDSSessionId=&pxyResponse.cardOnFileIssuerId=&pxyResponse.mappedParams=txnResponse.ccTypeEst%3DVISA&pxyResponse.threeDSARS=&pxyResponse.threeDSOrderId=&pxyResponse.gatewayToken.status=&pxyResponse.responseStatus.name=Success&pxyResponse.responseAVS2=&pxyResponse.responseStatus=approved&pxyResponse.gatewayToken=11418636_TKNSEP_78&pxyResponse.responseAVS1=&pxyResponse.responseAVS4=&pxyResponse.responseStatus.description=&pxyResponse.threeDSCAVV=&pxyResponse.responseAVS3=&pxyResponse.gatewayToken.fullNativeResp=%3Cs%3AEnvelope+xmlns%3As%3D%22http%3A%2F%2Fschemas.xmlsoap.org%2Fsoap%2Fenvelope%2F%22+xmlns%3ASOAP-ENV%3D%22http%3A%2F%2Fschemas.xmlsoap.org%2Fsoap%2Fenvelope%2F%22%3E%3CSOAP-ENV%3AHeader%2F%3E%3Cs%3ABody+xmlns%3Axsd%3D%22http%3A%2F%2Fwww.w3.org%2F2001%2FXMLSchema%22+xmlns%3Axsi%3D%22http%3A%2F%2Fwww.w3.org%2F2001%2FXMLSchema-instance%22%3E%3CAddCustomerResponse+xmlns%3D%22http%3A%2F%2FeBizCharge.ServiceModel.SOAP%22%3E%3CAddCustomerResult%3E%3CCustomerId%3E0HW5NYEAO24F1Y8%3C%2FCustomerId%3E%3CCustomerInternalId%3E2d8948b0-7342-49c6-adf7-73ebf65eaff9%3C%2FCustomerInternalId%3E%3CStatus%3ESuccess%3C%2FStatus%3E%3CStatusCode%3E1%3C%2FStatusCode%3E%3CError%2F%3E%3CErrorCode%3E0%3C%2FErrorCode%3E%3C%2FAddCustomerResult%3E%3C%2FAddCustomerResponse%3E%3C%2Fs%3ABody%3E%3C%2Fs%3AEnvelope%3E%26%3Cs%3AEnvelope+xmlns%3As%3D%22http%3A%2F%2Fschemas.xmlsoap.org%2Fsoap%2Fenvelope%2F%22+xmlns%3ASOAP-ENV%3D%22http%3A%2F%2Fschemas.xmlsoap.org%2Fsoap%2Fenvelope%2F%22%3E%3CSOAP-ENV%3AHeader%2F%3E%3Cs%3ABody+xmlns%3Axsd%3D%22http%3A%2F%2Fwww.w3.org%2F2001%2FXMLSchema%22+xmlns%3Axsi%3D%22http%3A%2F%2Fwww.w3.org%2F2001%2FXMLSchema-instance%22%3E%3CAddCustomerPaymentMethodProfileResponse+xmlns%3D%22http%3A%2F%2FeBizCharge.ServiceModel.SOAP%22%3E%3CAddCustomerPaymentMethodProfileResult%3E78%3C%2FAddCustomerPaymentMethodProfileResult%3E%3C%2FAddCustomerPaymentMethodProfileResponse%3E%3C%2Fs%3ABody%3E%3C%2Fs%3AEnvelope%3E&pxyResponse.threeDSXid=&pxyResponse.threeDSProtoVersion=&pxyResponse.responseStatus.reasonCode=0&pxyResponse.threeDSPARequest=&pxyResponse.responseCVV1=&pxyResponse.threeDSECI=&pxyResponse.responseCVV2=&pxyResponse.fullNativeResp=Status%3DSuccess%26CustomerInternalId%3D2d8948b0-7342-49c6-adf7-73ebf65eaff9%26Error%3D%26CustomerId%3D0HW5NYEAO24F1Y8%26ErrorCode%3D0%26StatusCode%3D1&pxyResponse.threeDSAcsPageData=&pxyResponse.gatewaySubToken2=78&pxyResponse.threeDSTransactionId=&pxyResponse.gatewaySubToken1=11418636&pxyResponse.gatewaySubToken3=&pxyResponse.merchantRefId=0HW5NYEAO24F1Y8&pxyResponse.threeDSErrorId=&pxyResponse.txnPayName=Ebiz_Def&pxyResponse.responseStatus.code=1&pxyResponse.threeDSSRS=