About Global Collect:

The Ingenico ePayments platform allows you to integrate via a modern, clean REST API. This API is platform independent and can be used from any programming platform that supports http requests. Our Software Development Kits (SDKs) make integrating with us even easier.

Our SDKs bridge the gap between platform independent REST calls and the programming language your (native) mobile clients or e-commerce server uses. We have multiple SDKs for various platforms:

GlobalCollect is a 100% subsidiary of Ingenico Group, global leader in seamless payment. Headquartered in Amsterdam, GlobalCollect has regional offices in North America, Asia Pacific, South America and the EU focused on bringing local presence with global reach and services to our clients.

Implemented Features: 

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

Authentication and Security Credentials:

• API Key ID
• Secret API Key
• Merchant 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	Optional	Customer’s First Name
pxyCustomerInfo.billingLocation.middleName	Alphabetical	Optional	Customer’s Middle 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.countryCode	Alphabetical	Optional	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
pxyCustomerInfo.gender	Alphabetical	Optional	Customer’s Gender

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]