SafeCharge

About SafeCharge:

SafeCharge services were integrated by HostedPCI since 2018, we support the following credit card processing features provided by SafeCharge.

Implemented Features:

FEATURE LEVEL OF SUPPORT
Auth Implemented
Sale (Auth+Capture) Implemented
Capture Implemented
Void Implemented
Credit Implemented
3DS Passthrough Implemented
Gateway Tokenization Implemented

Authentication and Security Credentials:

  • MerchantID
  • Merchant Key
  • Merchant Site 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”
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.fax Numerical Optional Billing Fax Phone Number
pxyCustomerInfo.billingLocation.companyName Alphanumeric Optional Billing Company Name
pxyCustomerInfo.billingLocation.address Alphanumeric Optional Customer’s 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
pxyTransaction.merchantPhoneNum Numerical Optional Display phone number on the clients statement
pxyCustomerInfo.browserUserAgentHeader Alphaumeric Optional The customers browsers header
pxyCustomerInfo.billingLocation.tax1 Numerical Optional Billing Tax 1
Additional Parameters
KEY NAME FORMAT DESCRIPTIONS
pxyTransaction.merchantAccountName Alphabetical Required for Soft Descriptors
pxyTransaction.merchantProductName Alphabetical Required for Soft Descriptors
pxyTransaction.merchantPhoneNum Alphabetical Required for Soft Descriptors

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]&pxyTransaction.merchantPhoneNum=[MerchantPhoneNumber]&pxyCustomerInfo.browserUserAgentHeader=[BrowseruserAgentHeader]

SafeCharge 3DS implementation with Cardinal Commerce

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

In Order to implemented 3DS Authentication with SafeCharge follow the Cardinal Commerce 3D Secure documentation page.

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

Safe Charge 3DS 1.0 “verifyenroll” Required Parameters

PARAMETER VALUES
pxyThreeDSecAuth.actionName [verifyenroll]
pxyTransaction.txnPayName [3ds payment profile name]
pxyThreeDSecAuth.callMode [reportall]

3DS 1.0 “Verifyresp” call

PARAMETERS VALUE
pxyTransaction.txnPayName [3ds payment profile name]
pxyThreeDSecAuth.actionName [verifyenroll]
pxyThreeDSecAuth.callMode reportall
pxyThreeDSecAuth.authTxnId [response from the first API call “pxyResponse.threeDSXid”]
pxyThreeDSecAuth.authAcsUrl [response from the first API call “pxyResponse.threeDSAcsUrl”]
pxyThreeDSecAuth.paReq [response from the first API call “pxyResponse.threeDSPARequest”]
pxyThreeDSecAuth.protocolVersion [response from the first API call “pxyResponse.threeDSProtoVersion”]
pxyThreeDSecAuth.authECI [response from the first API call “pxyResponse.threeDSECI”]

Safe 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 Safe Charge Gateway Tokenization:
PARAMETERS VALUE
pxyCustomerInfo.billingLocation.address [billingAddress]
pxyCustomerInfo.billingLocation.city [billing city]
pxyCustomerInfo.billingLocation.country [billing country]
pxyCustomerInfo.billingLocation.state [billing state]
pxyCustomerInfo.billingLocation.zipCode [billing ZIP]
pxyCustomerInfo.customerId [customerID]
pxyCustomerInfo.email [customer Email]