Payment Gateway Configuration by Client

Last updated
Save as PDF

Overview

This article contains an explanation of the client-specific settings you need when setting up a payment gateway.

Special Note: Payment Gateway configuration and integration are extremely sensitive settings with respect to security of payment card and other personally identifiable information. You should carefully control and routinely monitor your Payment Gateway(s). Given your role as controller of the data that flows through the gateway, you should limit access to this module to your qualified, authorized resources, and ensure compliance with PCI and other applicable data security and privacy laws, regulations and standards.

The following information is provided for each payment gateway.

Prerequisites, if any, that are unique to the payment gateway.
Fields you must value when setting up the payment gateway. Obtain the values for these fields from the payment gateway representative before you begin configuring the payment gateway.

Getting Here: Add or edit a payment gateway and/or collection group.

Payment Gateways

Adyen

Fields

Notification HMAC: Hash-based Message Authentication Codes (HMAC) can be used as an extra layer of security for data verification and message authentication for notifications. To enable HMAC signing of the Adyen notifications for additional security, use the following steps:

Log into the Adyen Customer Area (CA) and navigate to Settings > Server Communication.
For standard notification, click Edit & Test.
Expand Additional Settings.
Click Generate New HMAC Key, and copy the key to this field use it for your server configuration.

Notification Password: Password for HTTP authentications that the client recieves.
Notification User ID: User name for HTTP authentications that the client recieves.
Notification URL: The client URL where notifications are directed.
API URL: The client URL where API calls are directed.
Adyen Password: Password for authenticating requests sent to the Adyen server or to log in to the Adyen Customer Area..
Adyen User ID: User name for authenticating requests sent to the Adyen server or to log in to the Adyen Customer Area..
Adyen Merchant Account: Name that identifies the client to the Adyen server. This name/value is provided by your Adyen support representative.

Authorize.net

Fields

Login: The merchant’s API login ID (up to 25 characters) which is required to submit transactions.
tran_key: The merchant's transaction key (16 characters) obtained by the merchant from the Authorize.net Merchant Interface.

Braintree

Fields

Merchant ID: The unique identifier for your Braintree Gateway Account, which is different than your merchant account ID.
Public Key: A user-specific public identifier.
Private Key: A user-specific secure identifier that must not be shared, even with Braintree.

Note: These credentials can be found in the Braintree Production Control Panel.

CyberSource

Prerequisites

If you use CyberSource as your payment gateway and you have Advanced Fraud Services enabled, you must complete the following fields in your payment gateway options in Aria based on information provided to you by CyberSource:

afsService_customRiskModel
afsService_run
Fields beginning with merchantDefinedData_field

If you plan to use tokenized credit cards as a payment method, you must enable user profiles in CyberSource.

Fields

Server Port (optional): Identifies the server port where transactions are sent.
Server Host: Identifies the server host end-point where transactions are sent. The default setting for CyberSource is ics2wstest.ic3.com.
Merchant ID: A unique value that identifies a merchant in the CyberSource system. CyberSource merchants have access to a CyberSource business center, and this ID is used to log into the Business Center. The ID is also submitted with every payment transaction sent from Aria to CyberSource.
Keys: The Private Key can be obtained from CyberSource's Business Center following the Simple Order API instructions for retrieving the file.

DIBS

Prerequisite

If you use DIBS Payment Services as your payment gateway and you plan to use tokenized credit cards as a payment method, you must enable tickets in the DIBS web portal.

Fields

DIBS Merchant ID number: A unique value that identifies a merchant in the DIBS system.
DIBS account (optional): This field typically is left blank.
MD5 k1 and MD5 k2: DIBS offers MD5-key control to ensure the data sent between Aria and the DIBS system has not been tampered with, either due to communication errors, hacking, or interfering malware. The control works for both the request from Aria to DIBS and for the response from DIBS back to Aria. You can find your MD5-key pair in DIBS Administration Section of their web portal.
API username: This information is available in the DIBS Administration section of their web portal.
API password: This information is available in the DIBS Administration section of their web portal.

First Data Payeezy

Fields

JS Secret Key: JavaScript Secret Key used to identify the merchant.
Merchant Token: The token value assigned to the merchant.
Merchant API URL:https://api-cert.payeezy.com/v1/. The API URL endpoint used to communicate with Payeezy.
API Secret: The API Secret is used for authorization and helps provide better security.
API Key: A unique value that is assigned to an authorized user of this service.

First Data PayPoint

Fields

These field values are provided by First Data and allow administrative users to securely access the administrative interface and manage payment transactions for your business.

Application ID
Application Token
Web Services URL

Global Collect (Deprecated)

Prerequisite

This payment gateway has been deprecated. Clients who are currently using it can continue to do so, but it can no longer be added as a payment gateway. GlobalCollect has been replaced by Worldline/Ingenico.

If you are using GlobalCollect, please note that this payment gateway prefers an implementation that uses batch reporting. This batch reporting requires a special Universal Activity Loader (UAL) job to be set up by Aria using your secure copy credentials provided by GlobalCollect.

Fields

Merchant ID (required): A unique numeric value of up to 10 digits provided to you by GlobalCollect.
Service End Point (optional): This field is typically left blank.

Merchant e-Solutions

Fields

The following fields are supplied by the Merchant e-Solutions Certification Manager. You must obtain these values before setting up this payment gateway.

Profile ID
Profile Key
MeS Login ID
MeS Login Password
API URL
Batch API URL

Mercury Pay

Fields

The following fields are supplied by Mercury Pay. You must obtain these values before setting up this payment gateway.

Primary Web Services URL
Secondary Web Services URL
WebServices Password
MerchantID

NETS Collect

Fields

The set-up information for NETS Collect listed under the "Options" tab is provided by NETS Collect.

Paypal Payflow Pro

Prerequisite

If you use PayFlow Pro as your payment gateway and you plan to use tokenized credit cards as a payment method, you must enable reference transactions in PayFlow Pro.

Fields

User: The ID that you specified when you got the Payflow account.
Vendor: The ID that you specified when you got the Payflow account, (typically same as USER). That is, the merchant login ID for the account.
Partner: The Payflow partner/reseller. The value of this field is "PayPal" if the account was purchased directly from PayPal. If an account was provided by an authorized PayPal reseller, who registered a Payflow user, then the ID provided by the reseller is used.
Password: The password that you specified when you received the Payflow account.
Gateway URL: The URL provided by Payflow Pro to use as an endpoint.

PayJunction

Prerequisite

If you use PayJunction as your payment gateway and you plan to use tokenized credit cards as a payment method, you must enable recurring instant transactions in PayJunction Trinity.

Fields

Trinity Gateway API Login: The API Login provided by PayJunction.
Trinity Gateway API Password: The API Password provided by PayJunction.

Paymentech

Prerequisite

To use Aria to process payments made using card-present transactions (US only), you must set up card-present (retail transactions) with Paymentech.

Fields

Division Code: This field contains the Merchant ID (MID) number assigned to you by Chase Paymentech. This is your Salem Division number. The MID may also be referred to as the Transaction Division (TD) code or Presenter ID.
Division Code Format: There are two host platforms available for the Orbital Gateway: Salem and Tampa. The Orbital Gateway (Salem Platform) uses a 6-digit numeric MID while the Orbital Gateway (Tampa Platform) uses a 12-digit numeric MID.
Merchant division country code: If you are a US-based merchant, use this field to specify your country code (ISO 3166-1 alpha-3 code) to be used when processing all payments (for US and non-US cardholders). You can also specify your country code when you create or edit a collection group.

Paymetric

Fields

The following fields are supplied by Paymetric. You must obtain these values before setting up this payment gateway.

Paymetric WS Username
Paymetric WS Password
Routing Merchant ID
Paymetric WS URL
cartridge_name: This field should contain the value of one of the supported cartridges.

PayPal Express Checkout

Prerequisites

If you use Express Checkout as your payment gateway:

You must enable Reference Transactions in your PayPal setup. Aria uses reference transactions as the basis for the billing agreement between your company and your customers that use PayPal.
You must have your PayPal Payment Receiving Preferences set to block pay with eCheck. If this is not done, any customers who need to pay remaining balances (beyond the amount in their PayPal account) with a bank account will be unable to do so. When the pay with eCheck option is disabled, payments of remaining balances will be secured by the customer's credit card if all else fails.

If you want to collect payments in multiple currencies, you can use PayPal to have your alternate currencies converted to your primary currency or open new currency balances.

Fields

API Username (required): The API Username provided by PayPal.
API Password (required): The API Password provided by PayPal.
Agreement Confirmation URL at PayPal: The Agreement Confirmation URL provided by PayPal.
API Signature (required): The API Signature provided by PayPal.
API URL: The API URL provided by PayPal.
Transaction Soft Description: Specifies the merchant's name or product soft descriptor information, for example, "Description of the service or product being delivered."

Note: Contact PayPal for information on the format of the checkout page.

Agreement Header Image: The Agreement Header Image to be used on the checkout page.
Agreement Page Style: The Agreement Page Style to be used on the checkout page.
Agreement Header Color: The Agreement Header Color to be used on the checkout page.
Agreement Cancellation URL (required): The Agreement Cancellation URL provided by PayPal.
Agreement Success URL (required): The Agreement Success URL provided by PayPal.
Agreement Header Border Color: The Agreement Header Border Color to be used on the checkout page.
Agreement Header Background Color: The Agreement Header Background Color to be used on the checkout page.
Agreement Outer Frame Background Color: The Agreement Outer Frame Background Color to be used on the checkout page.

Authorization Reversal: Select True to automatically reverse payment authorizations for payments processed by Express Checkout. Select False if you do not want to automatically reverse payment authorizations for payments processed by Express Checkout.

Notes:

If you select False and you choose to reverse the authorization later, you can call the reverse_authorized_electronic_payment_m API.
When you perform a payment authorization, Aria will apply your application settings in this order of precedence: 1) collection group settings, then 2) payment gateway settings.

TNS

Fields

Merchant API URL: The URL provided by TNS to use as an endpoint.
API Password: To generate your API Password you must log in to TNS Merchant Administration and follow these steps. You must obtain your Merchant Administration login credentials from TNS before setting up this payment gateway.

Log into Merchant Administration (MA) and navigate to Admin > Operators and create a new Operator with the May Configure Integration Settings privilege.
Log in to Merchant Administration with your new operator and select Admin from the top menu.
Select API Integration Settings from the left menu.
Click Edit under the API Authentication section.
Select the Enable API Access via password check box for Password 1.
Click Generate New for Password 1.
Click Submit to save the configuration.

Merchant ID: Obtain your Merchant ID from TNS before setting up this payment gateway.

Vantiv (Litle)

Prerequisites

If you use Vantiv as your payment gateway and you plan to use tokenized credit cards as a payment method, you must enable the register token feature in Vantiv.

The Vantiv Connector automatically pushes level 3 data for credit card transactions. If level 3 data is unavailable, Aria seamlessly degrades to sending only level 2 or level 1 data, as appropriate.

Fields

API Username: The API Username provided by Vantiv.
API Password: The API Password provided by Vantiv.
Merchant ID: The Merchant ID provided by Vantiv.
Litle Reporting Group: Defines how the transactions appear in the Reporting UI. Depending on how you want to group the transactions you send, Vantiv can provide guidance on how best to name this field to fit your reporting needs.
URL for Online Processing: The URL for Online Processing provided by Vantiv.
URL for Batch Processing: The URL for Batch Processing provided by Vantiv.

Worldline/Ingenico

The following fields are supplied by Worldline/Ingenico. You must obtain these values before setting up this payment gateway.

API Key ID: Identifier for the secret API key. The apiKeyId can be retrieved from the Worldline/Ingenico Configuration Center and is also used to identify the correct Worldline/Ingenico account.
Secret API Key: Shared secret API Key that can be retrieved from the Worldline/Ingenico Configuration Center. The apiKeyId and secretApiKey always are used together, the difference is that secretApiKey is never visible in API calls to/from Worldline/Ingenico.
API Base URL: Worldline/Ingenico-distinct Server API endpoint that points to one of the Worldline/Ingenico environments (sandbox, pre-production, or production). You must include the https:// as part of the URL. For example, https://api.globalcollect.com is the Worldline/Ingenico Production endpoint.
Merchant ID: Code that identifies the client.
WX File SFTP Host: Hostname for receiving WX Files via SFTP.
WX File SFTP Username: Username needed to receiving WX Files via SFTP.
WX File SFTP Password: Password for receiving WX Files via SFTP.

WorldPay

Fields

Merchant ID: The Merchant ID provided by WorldPay.
Public Key: The Public Key provided by WorldPay.
Private Key: The Private Key provided by WorldPay.