iPay (planet payment) Payment Integration

About iPay:

With over ten years experience, Planet Payment’s iPAY Global Gateway is a trusted online payment gateway for e-commerce, call center, mail-order and telephone order merchants. Currently available in the US and Canada, the gateway enables acceptance of all major payment types and methods, and offers customized solutions that meet each merchant’s processing needs. Our broad-range of online payment services include credit card, purchase card, debit, and electronic check payments to both business-to-business and business-to-consumer platforms, as well as multi-currency processing. All service, support, processing, technology, billing and customer care is provided by Planet Payment, a multi-currency payment processor.

Implemented Features:

Feature	Level of Support
Auth	Implemented
Sale (Auth+Capture)	Implemented
Capture	Implemented
Void	Implemented
Credit	Implemented

Authentication and Security Credentials:

• Username
• Password
• Terminal 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.email	Alphanumeric	Optional	Customer’s Email Address
pxyCustomerInfo.customerIP	Numerical	Optional	Customer’s IP Address
pxyCustomerInfo.billingLocation.firstName	Alphabetical	Required	Customer’s First Name
pxyCustomerInfo.billingLocation.lastName	Alphabetical	Required	Customer’s Last 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

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]