Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!



 

Home > Aria Crescendo Documentation > Account Management > Payments and Credits > Payments > Payment Gateways > Supported Payment Gateways > Ingenico

Ingenico

This article applies to:Aria Crescendo

Supported Features

ACH via Direct Debit

Ingenico now supports the ACH (Automated Clearing House-Electronic Check) payment type and refund transactions through the Direct Debit payment method. Adding ACH as a payment option via Direct Debit provides another method to manage subscriptions and recurring payments in a timely and secure manner. It allows customers to pay for transactions by debiting directly from their bank account, as opposed to processing through a card brand.

To add Direct Debit with ACH as a payment method on an account, select Direct Debit as the payment type and enter the bank account details along with these two new fields:

  • Bank Name
  • Bank City

The Bank Name and Bank City fields added have been added at the following locations in the Aria UI:

Account > select an account Account Overview > Payment Methods (New and Edit)

Fields appear when adding a new payment method (for Direct Debit).

Accounts > select an accountPlans > Add New Plan > Plans tab

Fields appear when adding a Primary or Backup/Secondary Pay Method Type (for Direct Debit).

Accounts > select an accountPlans > Billing Groups (New and Edit option)

Fields appear when adding a Payment Method or Secondary Payment Method (Create New Payment Method, for Direct Debit Payment Type).

Accounts > select an accountPayments and Credits > Apply a Payment

Select Alternate One-Time at the Account Level Payment Method drop-down list and select Direct Debit at the Alternate Billing Type drop-down list.

For this enhancement, two fields have been added as API inputs:

Field Description
<bank_name> Bank name for the account payment method
<bank_city> Bank city for the account payment method

To process an ACH payment via Direct Debit, call any of the APIs below and pass the following information:

Field Value
<pay_method_type> 26 for Direct Debit
<bank_name> Bank name for the account payment method
<bank_city> Bank city for the account payment method
<bank_country_cd> Must be US

The Bank Name and Bank City input fields added in support of ACH payments via Direct Debit have been added to the following APIs:

These input fields have been added to the following APIs:

Also, the "Used in Europe" Text has been removed for the <bank_branch_cd> and <bank_id_cd> input fields for these APIs.

The <bank_name> and <bank_city> fields have been also been added as outputs to the get_acct_payment_method_and_terms_m API.

The Bank Identifier Code (<bank_id_cd>) will pass the routing number value and use the Basic Bank Account Number (BBAN) (<bank_acct_num>) to pass the account number to do the ACH payment via Direct Debit. The Bank Identifier Code field is also now validated for length and character format for the Direct Debit payment method only when the Bank Country (the two-character <bank_country_cd>) is passed as US (ACH payments via Direct Debit are only supported for US banks at this time).

The Bank Swift Code (<bank_swift_cd>) input field (with validation on the length and character format) is now used in support of the Direct Debit payment method. It is required for the International Bank Account Number (IBAN).

API Endpoints

Ingenico has updated its API end point for both pre-production and production environments, as shown: Pre-Production: https://world.preprod.api-ingenico.com /Production: https://world.api-ingenico.com. To enter the updated endpoint, go to Configuration > Payments > Payment Gateways > Processor/Gateway Details > API Base URL.

UI Configuration Fields

The Ingenico integration requires the following fields be configured in the UI:

Getting here: Click Configuration > Payments > Payment Gateways > New

clipboard_e85d5e87e8b595348f98c6126503ec64d.png

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

The field descriptors are the following:

  • API Key ID: Ingenico-provided identifier for the secret API key. The apiKeyId can be retrieved from the Ingenico Configuration Center and is also used to identify the correct Ingenico account.
  • Secret API Key: Ingenico-provided shared secret API Key that can be retrieved from the Ingenico Configuration Center. The apiKeyId and secretApiKey always are used together, the difference is that secretApiKey is never visible in API calls to/from Ingenico.
  • API Base URL: Ingenico-distinct Server API endpoint that points to one of the Ingenico environments (sandbox, pre-production, or production). You must include the https:// as part of the URL.
  • Merchant ID: Ingenico-provided code that identifies the client.
  • WX File SFTP Host: Ingenico-provided hostname for receiving WX Files via SFTP.
  • WX File SFTP Username: Ingenico-provided username needed to receive WX Files via SFTP.
  • WX File SFTP Password: Ingenico-provided password for receiving WX Files via SFTP.

Payment Methods

Traditional Payment Methods Cards Alternate Payment Methods
Credit Card Visa iDEAL (Netherlands)
Tokenized Credit Card MasterCard Boleto Bancario (Brazil)
Tokenized Direct Debit American Express Web Money
  Discover SOFORT
  Diners Club/ Carte Blanche Yandex
  International Maestro PaySafeCard
  JCB Giropay
  ELO Qiwi
  Hipercard  

Tokenized SEPA (Single Euro Payments Area) Direct Debit

When paying by Tokenized SEPA Direct Debit, the account holder must sign a paper mandate before this method can be used. The mandate must be signed in advance of using this payment method and therefore it is not available as a payment method for one-time orders. Payments can only be made with Tokenized SEPA Direct Debit after the mandate has been approved with the record_mandate_approval_m call. It is your responsibility to ensure the end user signs the paper mandate. Once the electronic mandate is submitted and approved, neither Aria nor Ingenico will be able to intervene if the end user disputes signing the paper mandate.

If the payment status is returned to Aria as pending_approval you must approve the payment on the Ingenico website after a mandate is signed. You will not be able to approve the mandate and resubmit the payment using the Aria UI since Ingenico does not currently provide an update capability via APIs.

To add Tokenized SEPA Direct Debit as a payment method on an account click accounts > search for accounts > plans (left panel) > plan instance ID > Edit billing group.

There are two options for selection after making your primary payment method Tokenized Direct Debit.

  • Token/Agreement ID - used if there is an approved token associated with a signed mandate
  • Direct Debit - used to generate a new token by entering the International Bank Account Number

Ingenico_Payment_Options_B_0430.jpg

ELO, Hipercard and Maestro Credit Cards

These three credit cards are acceptable payment methods with the Ingenico integration. When making a payment with either of these cards the input in the <pay_method_type> parameter should be one of the following:

  • 1 – credit card
  • 13 – Tokenized credit card

Giropay and Qiwi

Giropay and Qiwi are two alternate payment methods that can support refund transactions. There is currently no recurring payment support from Ingenico for either alternate payment methods. Both methods are supported within the record_alternative_payment_m call. The <proc_payment_method_id> parameter should have one of the following as an input when using either payment method:

  • 41 - Giropay
  • 44 - Qiwi

Cardholder Initiated Transactions (CIT) and Merchant Initiated Transactions (MIT) for Visa, MasterCard, and Discover

This feature sends flags distinguishing cardholder initiated transactions (CIT) and merchant initiated transactions (MIT) within the <recurring_processing_model_ind> parameter of the following API calls:

The input values for the <recurring_processing_model_ind> are the following:

  • 0:  Cardholder-Initiated Transaction—Credentials on File: a credit card transaction initiated by the cardholder for a new order or a plan upgrade that uses a credit card that is currently stored in Aria. (Default)
  • 1:  Cardholder-Initiated Transaction—a credit card transaction initiated by the cardholder for a new account or creating an order that uses an alternate credit card that is not currently stored in Aria.
  • 2Merchant-Initiated Transaction—Standing Instruction – Recurring: a credit card transaction initiated by Aria’s clients for a recurring charge that uses a credit card that is currently stored in Aria.
  • 3: Merchant-Initiated Transaction—Unscheduled Credentials on File: a credit card transaction initiated by Aria’s clients for a non-recurring charge (one-time order or plan upgrade) that uses a credit card that is currently stored in Aria.

The output field is <proc_initial_auth_txn_id>.  This feature is available for Visa, MasterCard, and Discover.

Soft Descriptor

The <soft_descriptor> input supports the Visa subscription regulations update. This supports "authorization" and "payment" actions for the following card types: Visa, MasterCard, American Express, and Japan Credit Bureau (JCB).

The soft descriptor configuration allows for a transaction description to be shown on the buyer’s credit card statement. This field allows for a Merchant Name or Item Description of a specified length when paying by credit card (25 characters for Visa, American Express and JCB and 23 for MasterCard). This field is normally passed via the API; however, it can be set in the UI at the payment gateway or collection group level.

The following APIs contain the <soft_descriptor> field:

The soft_descriptor field can be configured in the UI as shown:

Configuration > Payments > Payment Gateways > Field Options:

Ingenico_UI_SD_0506a.jpg

Configuration > Payments > Collection Groups > Advanced Options:

Ingenico_UI_SD_0506b.jpg

Note:

If the soft_descriptor value is blank when running an API listed in this section, then the value configured in either of the Aria UI dialogs will be used (the Collection Group value takes precedence over the Payment Gateway value).

Transaction Reference IDs

Aria will parse unique transaction reference IDs returned from Ingenico in the <proc_payment_id> parameter for declined transactions. Transactions include but are not limited to the following:

  • Payments
  • Authorizations
  • Captures
  • Voices
  • Reverses
  • Refunds
  • Balance Inquires

If no reference ID is returned from Ingenico, Aria returns a NULL value for <proc_payment_id>. The following API calls include the <proc_payment_id> output parameter:

** - The <soft_descriptor> input to the create_order_m API supports the Visa subscription regulations update. This supports "authorization" and "payment" actions for the following card types: Visa, MasterCard, American Express, and Japan Credit Bureau (JCB).

$0 Authorization / Authorization Reversal

When authorizing a card, Aria provides the option to authorize a $0 or $1 transaction on the card to ensure the card is in good standing prior to offering a service to the account. The system override settings listed in the image below are to reverse the authorizations on the card after the verifications. The settings can be enabled for all or specific card types accepted with this integration. This configuration in the UI is at the Collection Group level (Configuration > Payments > Collection Groups).

Ingenico_AAR_B_0430.jpg

Card Verification Value (CVV)/ Address Verification Service (AVS) Configuration

With the Ingenico integration, error codes can be returned by Aria for a specific Card Verification Value (CVV) response. This configuration lies within the Collection Groups and Payment Gateways tab in the UI (Configuration > Payments).

Ingenico_CVV_B_0430.jpg

The integration with Ingenico also offers Address Verification Service responses. This configuration is also within the Collection Groups and Payment Gateways tab of the UI (Configuration > Payments). See image below for possible configuration options:

Ingenico_AVS_Sys_OR_B_0430.jpg

Configuration Notes

  • When you send a transaction to Ingenico, be sure the currency you specify matches the account's currency in Aria. The record_alternative_payment record_alternative_payment_m API uses the currency specified in the Ingenico transaction, and does not validate it against the Aria account.
  • Due to testing limitations, WebMoney can only be tested in a Production environment.
  • Tokenized SEPA Direct Debit:
    • requires the account holder sign a mandate before it can be implemented. Payments can only be made with SEPA Tokenized Direct Debit after the mandate has been approved with the record_mandate_approval record_mandate_approval_m API. It is the client's full responsibility to ensure the end user signs a paper mandate that verifies this electronic mandate is valid. Neither Aria nor Ingenico can intervene if the end user disputes signing the mandate later.
    • Because this payment method requires setting up the client mandate in advance, it is not available as an alternative one-time payment method when creating orders.
    • The client must collect in the account's currency (which SEPA Direct Debit must support).
    • If the payment status for a SEPA Direct Debit payment returns “PENDING_APPROVAL,” you must approve the payment on the Ingenico website after a mandate has been signed. You cannot approve the mandate and resubmit the payment using the Aria UI because Ingenico does not provide an update API.

Links

Return to top

Regarding Processor/Gateway Integration Certifications

If you previously implemented a custom payment processor/gateway integration, you likely completed a certification process with that processor/gateway. Aria maintains certifications with each of the processors with which it integrates. Though you may wish to certify your Aria-related processor/gateway integration before going live on Aria, this is not necessary and could add significant time and Services costs to your Aria implementation process. Please consult your Aria Implementation representative for more detailed information.

Regarding Processor- and Gateway-specific Information

All Processor- and Gateway-specific information provided on Developer Central exists as publicly accessible information from the respective companies, and is presented here for your convenience. We update this information from time to time as necessary.

Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.