The SDK requires minimum java version 1.7.
The SDK requires minimum Android version 5.
The SDK requires minimum IOS version 9.1.
The SDK requires minimum version 16.04.
The SDK requires minimum .NET C# version 4.5.1.
When downloading our SDK there is also an option to download our latest sample application along with it. Our sample application can be a good foundation for your integration as you can view the code to see how certain functions are expected to work. This can also be useful for comparing to your application and troubleshooting.
As part of the cardholder verification method some cards require signature to be collected. The SDK gives you 2 options to choose from.
sale.setSignatureCollection(SignatureCollection.AUTOMATIC);
sale.setSignatureCollection(SignatureCollection. MANUAL);
A - Approval
Transaction was approved.D - Declined
Transaction was declined.C - Pick Up
Transaction was declined. This type of decline means that the card has been marked as lost or stolen by the cardholder.R - Referral
Transaction was declined. A referral means that the merchant should call the authorization center because more information is needed regarding the cardholder.When a transaction is approved, the response code of A is returned. Your solution NEEDS TO VERIFY THE RESPONSE CODE before continuing. Receiving any response doesn't indicate that the transaction was approved. For the transaction to be approved, the response code must be A.
On a First Data terminal, transactions below $100.00 will receive an Approved response.
Transactions in the amount of $45.67 will receive No Host Response to simulate Time-out Reversal testing.
Transactions above $100.00 will receive a specific Error response (last three digits of amount, despite the decimal separator).
E.g., for the amount $101.23 response code 123 will be returned
On a TSYS Sierra terminal, the following cent values will trigger different responses:
CENT VALUE | RESPONSE |
---|---|
0.01 | Declined |
0.02 | Referral |
0.03 | CVV failure (Decline) |
Any other | Authorised |
An American Express card and a value of $10.00 will trigger a timeout response.
Input method allows you to configure how a card is read using the device readers.
The following input methods are supported and should be self explanatory:
You can choose the input method you would like to use for your integration by setting the following SALE object property.
Eg. sale.setTransactionInputMethod(CoreTransactionInputMethod.SWIPE_OR_INSERT_OR_TAP_OR_KEYED);
Stored value cards are also referred as Gift cards. Unlike other bank cards where the monetary value is stored in a bank account, for gift cards monetary value is stored in the card itself.
Currently we don't support processing the gift card payments through our gateway however we will be able to send the gift card data to the merchant for them to process locally on their system for Ingenico devices. To use this option the merchants have to share the bin ranges of their gift cards to our integrations team and they will help configuring the devices with these bin ranges which will allow the device to send the unencrypted gift card data.
When a device is shipped with Test/Live keys there is an extra step to add the KSN of the device to our HSM for decryption. This is a common error that is usually easily resolved by contacting %CompanyContact with the EMV and TRACK KSNs from your device.
The first 10 digits of the EMV and TRACK KSNs should be provided.
All issues should be reported to %CompanyContact
When contacting our integrations team please include the following information:
To begin your testing process you should have the following:
The integration team will give you login credentials to the Virtual Terminal and SelfCare reporting system. These credentials should also be used to point your integration to our test host simulator.
You can use SelfCare to view transactions and perform actions such as Refunds/Voids etc.Training on SelfCare/ Virtual Terminal can provided by our support team on request.
To work with our TEST system please note you must have a device with TEST firmware and TEST encryption keys injected in it. Please make sure the firmware is a version that we have validated.
We recommend that you have test cards for each brand you want to use as part of your integration. We also recommend that the cards are capable of the features you wish to support. If needed, test cards can be purchased from ICC Solutions.
(Cards such as Live cards and expired cards should not be used as part of the testing stage of the integration)
The payconfig.xml file is the GoChip configuration file that contains URLs used to access the servers. This file should be added to your project.
The payconfig file contains the following configurations which are described below:
<?xml version="1.0" encoding="utf-8"?> <resources> <string name="gatewayLiveUrl">https://</string> <string name="gatewayTestUrl">https://</string> <string name="gatewayDevUrl">https://</string> <string name="isvToken"></string> </resources>
By switching to test mode the SDK will point to gatewayTestUrl when communicating with the server. Test mode should be used for development.
terminal.setMode(CoreMode.TEST);
After finishing the development of your app, don't forget to change the mode to Live which will point the SDK to gatewayLiveUrl defined in payconfig file.
terminal.setMode(CoreMode.LIVE);
The Dev Mode is used to point to gatewayDevUrl defined in payconfig.xml file. This mode should only be used to test unreleased server features.
terminal.setMode(CoreMode.DEV);
When you begin your integration we will provide you a generated test token to add to your payconfig file. You can then add this to the isvToken string which is located underneath the list of hosts.
Once the integration is finished you will be provided with a production token. This will need to replace the test token in the payconfig file.
Device | RBA 21.0.2 | RBA 23.0.2 | RBA 23044 |
IUC285 | - | Supported | *Supported |
IPP320 | Supported | Supported | *Supported |
IPP350 | Supported | Supported | *Supported |
*Recommended RBA.
The getDeviceInfo call will return your firmware or RBA version in the logs.