Sage Payment
About Sage Payment:
Sage Payment Solutions is is a multi-level payment processor that assist their clients with a number of services such as software manages accounting, ERP, HR, payroll, payments, assets, construction, and real estate. The Sage solutions can travel with you or stay where you want them—in the cloud, on-premises, or both—giving you the freedom to work where you need.
Sage supplies products to all sorts of businesses no matter how big or small the company is.
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:
- Merchant ID
- Merchant 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” |
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.fax | Numerical | Optional | Billing Fax 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 for Shipping |
pxyCustomerInfo.shippingLocation.lastName | Alphabetical | Optional | Customer’s Last Name for Shipping |
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 |
pxyOrder.shippingAmount | Numerical | Optional | Cost for Shipping |
pxyOrder.taxAmount | Numerical | Optional | Tax Amount |
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]
Sage Payments 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] |
Sage Payments 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_SAGE&apiType=pxyhpci
Response:
status=success&operId=&tokenId=584445354&mappedCC=4444000015201111&ccBIN=&pxyResponse.threeDSEnrolled=&pxyResponse.threeDSAcsUrl=&pxyResponse.threeDSErrorDesc=&pxyResponse.processorType=sagepayResponse&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=da729e9b94f64df6958fea7728d5bb2f&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=vaultResponse.status%3D1%26vaultResponse.message%3DSUCCESS%26vaultResponse.data%3Dda729e9b94f64df6958fea7728d5bb2f%26status%3DApproved&pxyResponse.threeDSAcsPageData=&pxyResponse.gatewaySubToken2=&pxyResponse.threeDSTransactionId=&pxyResponse.gatewaySubToken1=&pxyResponse.gatewaySubToken3=&pxyResponse.merchantRefId=&pxyResponse.threeDSErrorId=&pxyResponse.txnPayName=DEF_SAGE&pxyResponse.responseStatus.code=Approved&pxyResponse.threeDSSRS=