USA ePay
About USAePay
Founded and owned by GorCorp Inc., USAePay is a family-owned company with offices on both the East and West coast. Since the beginning, USAePay has taken pride in only hiring the best and brightest onto the USAePay team. USAePay works with the best builders and creators who care deeply about the quality of their work and what we’re collectively building towards. USAePay is proud to enforce the latest and strictest security requirements in the payment industry. As one of the first payment gateways to become Level 1 PCI compliant, develop “tokenization,” and partner with multiple 3rd party security scanners we ensure the most top-level security for our transactions. USAePay is always working on developing the newest methods for credit card processing. The gateway, which started for eCommerce, is now certified for multiple industries such as Mail Order, Telephone Order, Retail, Online and Mobile.
For over 15 years, USAePay has been working with Resellers, Merchants, and Developers to provide quick, secure, credit card and check transaction processing. USAePay’s payment gateway supports all major platforms in the credit card industry and works with most of the leading check platforms. USAePay is also pleased to work with many large merchant service banks in the US and abroad.
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:
- Source Key
- Pin
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.customerIP | Numerical | Optional | Customer’s IP 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 | Required | Customer’s Billing Country |
pxyCustomerInfo.shippingLocation.firstName | Alphabetical | Optional | Customer’s First Name for Shipping |
pxyCustomerInfo.shippingLocation.lastName | Alphabetical | Optional | Customer’s Last Name for Shipping |
pxyCustomerInfo.shippingLocation.phoneNumber | Numerical | Optional | Shipping Phone Number |
pxyCustomerInfo.shippingLocation.address | Alphanumeric | Optional | Customer’s Shipping Address |
pxyCustomerInfo.shippingLocation.address2 | Alphanumeric | Optional | Secondary Shipping Address |
pxyCustomerInfo.shippingLocation.city | Alphabetical | Optional | Customer’s Shipping City |
pxyCustomerInfo.shippingLocation.state | Alphabetical | Optional | Customer’s Shipping State or Province |
pxyCustomerInfo.shippingLocation.zipCode | Alphabetical | Optional | Customer’s Shipping Zip Code or Postal Code |
pxyCustomerInfo.shippingLocation.country | Alphabetical | Optional | Customer’s Shipping Country |
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]
USA ePay 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] |
USA ePay 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_USA&apiType=pxyhpci
Response:
status=success&operId=&tokenId=584447542&mappedCC=4444000015201111&ccBIN=&pxyResponse.threeDSEnrolled=&pxyResponse.threeDSAcsUrl=&pxyResponse.threeDSErrorDesc=&pxyResponse.processorType=usaepayResponse&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=q47j-6o6q-35s0-sht2&pxyResponse.responseAVS1=&pxyResponse.responseAVS4=&pxyResponse.threeDSCAVV=&pxyResponse.responseAVS3=&pxyResponse.gatewayToken.fullNativeResp=&pxyResponse.threeDSXid=&pxyResponse.threeDSProtoVersion=&pxyResponse.responseStatus.reasonCode=&pxyResponse.threeDSPARequest=&pxyResponse.responseCVV1=&pxyResponse.threeDSECI=&pxyResponse.responseCVV2=&pxyResponse.fullNativeResp=cardRef%3Dq47j-6o6q-35s0-sht2%26resultCode%3DA%26cardExpiration%3D2022-09%26cardNumber%3DXXXXXXXXXXXX1111%26cardType%3DVisa%26serverUrl%3Dsandbox.usaepay.com&pxyResponse.threeDSAcsPageData=&pxyResponse.gatewaySubToken2=&pxyResponse.threeDSTransactionId=&pxyResponse.gatewaySubToken1=&pxyResponse.gatewaySubToken3=&pxyResponse.merchantRefId=&pxyResponse.threeDSErrorId=&pxyResponse.txnPayName=DEF_USA&pxyResponse.responseStatus.code=A&pxyResponse.threeDSSRS=