Click on "Settings" in the navigation menu, then select "Payment Gateway" from the drop-down list to access this section. Here, you can set up payment gateways for both your online transactions and reader transactions across all locations.
Payment Gateway - Online Transactions
In this section, you can configure the payment gateways for three payment types: Credit/Debit, Digital Wallets and PayPal, respectively. By default, the payment gateway has been selected as “------".
Payment Type: Credit/Debit
For the Credit/Debit payment type, you can select a payment gateway from the drop-down menu, and the payment gateway options that are available in the country will be provided. Once a payment gateway is selected, the related parameters will be required to fill in.
In addition, the "Add Another Gateway" button, highlighted in blue, allows you to add multiple payment gateways. The payment gateway listed first will serve as the default gateway in general for all locations. Other payment gateways will appear in the drop-down list at the location level, enabling you to specify a different gateway for a particular location.
Multipass, IBX, Stripe, Evertec, Ebanx, Intertrade, d.local, Heartland Portico, First Data and Mercado Pago are supported so far.
The six-dot drag control in the front of each gateway can be used to adjust the gateway order. You can hover over the drag control and drag it to the desired place of order.
The delete icon, represented by a trash bin, can be used to remove the payment gateway option. This action is effective immediately upon clicking, so please proceed with caution.
You can click to unfold the Payment Gateway Credential Description below for explanations of the parameters associated with the payment gateways.
Moreover, you can consult the "Payment Processor Instructions," which provide guidance on how to obtain the payment processor credentials from the third-party websites.
Payment Gateway Credential Description-Heartland
Field Name | Value Needed | Description |
Portico Merchant ID | Alpha-Numeric | This field requires the unique identifier for your Heartland-Portico merchant account. It helps identify your account during payment transactions. |
Google Pay Merchant ID | Alpha-Numeric | This field requires the unique identifier associated with your Google Pay merchant account. It is defined by you when you set up your Google Pay merchant account. You can obtain this ID from the Google Pay developer portal or through the configuration settings provided by Heartland-Portico. |
Google Pay Merchant Name | Alpha-Numeric | This field requires the name of your business or organization as it should appear on Google Pay receipts or transaction details. It is defined by you when you set up your Google Pay merchant account. |
Apple Pay Merchant ID | Alpha-Numeric | This field requires the unique identifier associated with your Apple Pay merchant account. It is defined by you when you set up your Apple Pay merchant account. You can obtain this ID from the Apple Developer portal or through the configuration settings provided by Heartland-Portico. |
Apple Pay Merchant Name | Alpha-Numeric | This field requires the name of your business or organization as it should appear on Apple Pay receipts or transaction details. It is defined by you when you set up your Apple Pay merchant account. |
AVS Verification | Drop-down list | AVS stands for Address Verification System. This field offers options to choose the level of address verification required during payment processing. The available options are "None," "Address+Zip," "Zip Only," or "Address Only." The specific AVS verification level to choose depends on your business requirements and risk management practices. It determines how thorough the system should verify the address provided by the customer during the payment transaction. |
CVV VERIFICATION | Drop-down list | Card Verification Value (CVV) is a series of unique numbers that, in addition to bank card number, is embossed or printed on the card that may be used in completing transactions to provide added security against scams. You can enable/disable CVV Verification for Heartland. If enabled, a prompt for CVV will appear when user register credit card, and if disabled, CVV will be hided. |
Working Environment | Radio button choice | This field allows you to select the working environment for the Heartland-Portico payment integration. Here you can choose between "Test" and "Production." The "Test" environment is used for testing and simulating payment transactions without actually processing real payments. The "Production" environment is for live transactions and should be used when your system is ready to accept real payments. |
Apple Pay Merchant Domain | Upload Document | This field is originated through Apple Pay developer portal when a merchant ID is registered. A merchant identity certificate generated can be utilized to authenticate communications with the Apple Pay servers. However, the support team will be in help to configure this field. |
Apple Pay Merchant Identity Certificate | Upload Document | This field refers to the certificate associated with your merchant ID which is used to identify the merchant with Apple Pay and secure the transaction data by encrypting the payment information. However, the support team will be in help to configure this field. |
Apple Pay Merchant Identity Certificate Password | Alpha-Numeric | This field refers to the access password created through Apply Pay developer portal that is used to protect the transaction data. The support team will be in help to configure this field. |
Payment Gateway Credential Description-Multipass
Field Name | Value Needed | Description |
Merchant ID | Alpha-Numeric | This is a unique identifier assigned to you by Multipass when you register for their services. It identifies your account and is used for tracking transactions. |
Device ID | Alpha-Numeric | This is an identifier for the device or system you are using to process transactions through Multipass. It helps ensure secure communication between your system and the payment gateway. |
Developer ID | Alpha-Numeric | This ID is provided to developers or organizations that integrate Multipass into their systems. It helps Multipass track usage and provide support to developers. |
Transaction Key | Alpha-Numeric | This is a secret key used for encrypting and decrypting transaction data. It's essential for securing communication between your system and the Multipass payment gateway. |
Working Environment | Alpha-Numeric | This field allows you to select the working environment for the Heartland-Portico payment integration. Here you can choose between "Test" and "Production." The "Test" environment is used for testing and simulating payment transactions without actually processing real payments. The "Production" environment is for live transactions and should be used when your system is ready to accept real payments. |
Payment Gateway Credential Description-IBX
Field Name | Value Needed | Description |
Merchant ID | Alpha-Numeric | This is a unique identifier assigned to you by IBX when you register for their services. It identifies your account and is used for tracking transactions. |
AVS Verification | Drop-down list | AVS stands for Address Verification System. This field offers options to choose the level of address verification required during payment processing. You can choose to enable or disable it. |
Working Environment | Radio button choice | This field allows you to select the working environment for the Heartland-Portico payment integration. Here you can choose between "Test" and "Production." The "Test" environment is used for testing and simulating payment transactions without actually processing real payments. The "Production" environment is for live transactions and should be used when your system is ready to accept real payments. |
Payment Gateway Credential Description-Stripe
Field Name | Value Needed | Description |
API Public Key | Alpha-Numeric | This is a key provided by Stripe that is used for client-side interactions, such as token generation and submitting payment information securely from your website or application to Stripe. |
API Private Key | Alpha-Numeric | This is a key provided by Stripe that is used for server-side interactions, such as creating charges, handling refunds, and managing subscriptions. It should be kept confidential and never shared publicly. |
Webhook Signing key | Alpha-Numeric | This is a key provided by Stripe for verifying the authenticity of webhook events sent from Stripe to your server. It ensures that the events are coming from Stripe and haven't been tampered with during transit. |
Working Environment | Radio button choice | This field allows you to select the working environment for the Heartland-Portico payment integration. Here you can choose between "Test" and "Production." The "Test" environment is used for testing and simulating payment transactions without actually processing real payments. The "Production" environment is for live transactions and should be used when your system is ready to accept real payments. |
Stripe
We currently do not support refunds for Stripe. Therefore, it is recommended that vendors disable the Credit Card Refund feature in the Value Code Settings to prevent it from being displayed in the app, which might lead to consumer confusion. But vendors can process refund requests in Stripe management system as needed.
Payment Gateway Credential Description-PayPal
Field Name | Value Needed | Description |
Login with PayPal Merchant ID | Alpha-Numeric | This field allows you to log in your PayPal’s account to add PayPal as the payment processor for the payment type. Click on “Login with PayPal Merchant ID” to log in PayPal account in the PayPal’s landing page. Upon the completion of successful login, it will skip back to the Settings page where the Merchant ID and the Sign Out button will be shown (the Sign Out button allows users to disconnect the PayPal merchant account and it will go back to the page before the login). In addition, you should manually tick “Enable” radio button to fully enable PayPal as the payment processor for the payment type. If it keeps as “Disable” , PayPal will not take effect as the payment processor in actual transactions. |
Payment Gateway Credential Description-EVERTEC
Field Name | Value Needed | Description |
Login | Alpha-Numeric | An identifier assigned by EVERTEC. It serves as a credential for accessing their payment gateway services. |
Secret Key | Alpha-Numeric | This is a secret key provided by EVERTEC for authentication purposes. It should be kept confidential and not shared publicly. |
Country Code | Drop-down list | This is the country code associated with your business location or the country where your transactions will primarily take place. |
Currency Type | Drop-down list | This is the currency code for the currency in which transactions will be processed (e.g., USD for US dollars). |
TAX Type | This field specifies the type of tax applicable to your transactions, such as sales tax or value-added tax (VAT). | |
Tax Amount | Numeric | This is the amount of tax to be applied to each transaction, if applicable. |
Create Request URL | Alpha-Numeric | This is the URL provided by EVERTEC for creating payment requests or transactions. |
Collect URL | Alpha-Numeric | This is the URL where customers will be directed to complete their payment transactions securely. |
Get Request Information URL | Alpha-Numeric | This is the URL provided by EVERTEC for retrieving information about payment requests or transactions. |
Working Environment | Radio button choice | This field allows you to select the working environment for the Heartland-Portico payment integration. Here you can choose between "Test" and "Production." The "Test" environment is used for testing and simulating payment transactions without actually processing real payments. The "Production" environment is for live transactions and should be used when your system is ready to accept real payments. |
Payment Gateway Credential Description-EBANX
Field Name | Value Needed | Description |
Integration Key | Alpha-Numeric | This is the integration key provided by EBANX for accessing their payment gateway services. |
Working Environment | Radio button choice | This field allows you to select the working environment for the Heartland-Portico payment integration. Here you can choose between "Test" and "Production." The "Test" environment is used for testing and simulating payment transactions without actually processing real payments. The "Production" environment is for live transactions and should be used when your system is ready to accept real payments. |
Payment Gateway Credential Description-INTERTRADE
Field Name | Value Needed | Description |
API Key | Alpha-Numeric | This is a unique key provided by INTERTRADE that grants access to their API for processing transactions and accessing other gateway functionalities. It serves as a form of authentication for your account. |
Create Transaction URL | Alpha-Numeric | This is the URL provided by INTERTRADE for initiating and creating payment transactions through their gateway. You will use this URL to send transaction requests from your system to INTERTRADE's servers. |
Check Information URL | Alpha-Numeric | This is the URL provided by INTERTRADE for retrieving information about transactions, such as transaction status, details, and history. You will use this URL to query transaction information from INTERTRADE's servers. |
Working Environment | Radio button choice | This field allows you to select the working environment for the Heartland-Portico payment integration. Here you can choose between "Test" and "Production." The "Test" environment is used for testing and simulating payment transactions without actually processing real payments. The "Production" environment is for live transactions and should be used when your system is ready to accept real payments. |
Payment Gateway Credential Description-D.LOCAL
Name | Value Needed | Description |
X login | This is your login or account token provided by D.LOCAL. | |
X Trans Key | Alpha-Numeric | This is a transaction key or token provided by D.LOCAL for transaction authentication purposes. |
Secret Key | Alpha-Numeric | This is a secret key provided by D.LOCAL for additional security measures. It should be kept confidential and not shared publicly. |
Smartfields API Key | Alpha-Numeric | This is an API key provided by D.LOCAL for integration with their Smartfields API. |
Country Code | Drop-down list | This is the country code associated with your business location or the country where your transactions will primarily take place. |
Currency Type | This is the currency code for the currency in which transactions will be processed (e.g., USD for US dollars). | |
Working Environment | Radio button choice | This field allows you to select the working environment for the Heartland-Portico payment integration. Here you can choose between "Test" and "Production." The "Test" environment is used for testing and simulating payment transactions without actually processing real payments. The "Production" environment is for live transactions and should be used when your system is ready to accept real payments. |
Payment Gateway Credential Description-Mercado Pago
Field Name | Value Needed | Description |
Public Key | Alpha-Numeric | This is a key provided by Mercado Pago for client-side interactions, such as token generation and submitting payment information securely from your website or application to Mercado Pago. |
ACCESS TOKEN | Alpha-Numeric | This is a token provided by Mercado Pago for server-side interactions, such as creating charges, handling refunds, and managing subscriptions. It serves as an authentication credential for accessing Mercado Pago's API. |
Secret Key | Alpha-Numeric | This is a secret key provided by Mercado Pago for additional security measures. It should be kept confidential and not shared publicly. |
Currency Type | Drop-down list | Currency Type: This is the currency code for the currency in which transactions will be processed (e.g., USD for US dollars, ARS for Argentine pesos). |
Create Preferences URL | Alpha-Numeric | This is the URL provided by Mercado Pago for creating payment preferences or preferences settings. You will use this URL to send preferences configurations from your system to Mercado Pago's servers. |
Get Payments URL | Alpha-Numeric | This is the URL provided by Mercado Pago for retrieving information about payments, such as payment status, details, and history. You will use this URL to query payment information from Mercado Pago's servers. |
Working Environment | Radio button choice | This field allows you to select the working environment for the Heartland-Portico payment integration. Here you can choose between "Test" and "Production." The "Test" environment is used for testing and simulating payment transactions without actually processing real payments. The "Production" environment is for live transactions and should be used when your system is ready to accept real payments. |
Payment Gateway Credential Description-First Data
Field Name | Value Needed | Description |
Merchant ID | Alpha-Numeric | This is a unique identifier assigned to you by Fiserv when you register for their services. It identifies your account and is used for tracking transactions. |
App ID | Alpha-Numeric | The App ID is a unique identifier assigned to your application by the payment gateway provider. It helps the service recognize which application is making requests. |
App Secret | Alpha-Numeric | The App Secret is a confidential key associated with your App ID. It is used to securely authenticate your application with the payment gateway. This secret should be kept private and not shared or exposed, as it can grant access to your account if misused. |
API Token | Alpha-Numeric | An API Token is a string of characters that serves as a credential for accessing certain functionalities or data through the payment gateway's API. It acts as a password for authenticating API requests and is used to ensure that only authorized applications or users can interact with the system. |
Access Token | Alpha-Numeric | An Access Token is a security token granted after successful authentication, allowing your application to access specific resources or perform actions on behalf of a user. Access tokens are typically short-lived and must be refreshed periodically, enhancing security by limiting the duration of access. |
Working Environment | Radio button choice | This field allows you to select the working environment for the payment integration. Here you can choose between "Test" and "Production." The "Test" environment is used for testing and simulating payment transactions without actually processing real payments. The "Production" environment is for live transactions and should be used when your system is ready to accept real payments. |
Payment Type: Digital Wallets (Apple Pay/Google Pay)
For Digital Wallets (Apple Pay/Google Pay) payment type, you can also select a payment gateway from the drop-down menu. The options of payment gateway will be determined by the available payment gateways supported by the vendor’s country.
At present, digital wallets (Apple pay/Google pay) support Stripe, Heartland and PayPal.
By default, the payment gateway field will be shown as “------" meaning no digital wallet will be supported to make online payment . Besides, if a country doesn’t support any payment gateway for digital wallet, the drop-down menu will only include “------".
Payment Type: PayPal
PayPal can also be added as a payment type for online transactions in Settings. It would follow the same procedures when PayPal should be selected as the payment gateway for a payment type: click on “Login PayPal with Merchant ID” to log in to your PayPal account and go back to the Settings to check the merchant ID along with a Sign-out button that can be used to disconnect your PayPal account.
If PayPal has already been added as the payment gateway for a payment type, it indicates that PayPal has been fully activated at vendor’s level. Then there is no need for users to perform “Login with PayPal Merchant ID” again if PayPal should be added as the payment type. Similarly, if PayPal has been already successfully added as a payment type, there will be no extra requirements to log in PayPal with merchant ID again if PayPal should be selected as the payment gateway for a payment type. One-time login of PayPal would be widely usable in payment settings.
Remember to click the Save Changes button to save the payment gateways you’ve configured for your online transactions.
Payment Gateway - Reader
The section “Payment Gateway – Reader” allows you to set the gateway for transactions happening at KioSoft readers. Click the input box of Payment Gateway to select the desired one.
You can add multiple gateways for reader transactions by clicking the Add Another Gateway button and the first one among them will be the default gateway for locations. The six-dot drag control in the front of each gateway can be used to adjust the gateway order. You can hover over the drag control and drag it to the desired place of order.
At present, four gateways are supported: TSYS for USA vendors, Everlink for Canada vendors, AIB for UK, Romania, Denmark and Netherlands vendors and Moneris for Canada vendors. The corresponding gateway type will be bifurcated according to vendor’s country.
Remember to click the Save Changes button to save the payment gateway you’ve configured for your reader transactions.