Home > Aria6 User Documentation > Processing Payments > Payment Gateways > Supported Payment Gateways > Worldline (formerly Ingenico)

Worldline (formerly Ingenico)

Supported Payment Methods and Credit/Debit Cards

  • Credit Card
  • Tokenized Credit Card
  • Boleto Bancario
  • iDEAL
  • Tokenized Direct Debit
  • WebMoney
  • Yandex
  • PaySafeCard
  • Giropay
  • QIWI

Note: The Qiwi and Yandex payment methods are unavailable until further notice.

  • Visa
  • Mastercard
  • American Express
  • Discover
  • Diners Club/Carte Blanche
  • International Maestro
  • JCB
  • ELO
  • Hipercard

Supported Features

ACH via Direct Debit

Worldline 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 have been added at the following locations in the Aria UI:

Accounts > select an account Account Overview > Payment Methods

Fields appear when adding/changing a new Primary or Secondary payment method (for Direct Debit).

Accounts > select an accountPayments and Credits > Apply Payments > Alternate One-Time

Select Direct Debit as the Alternate Billing Type.

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 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 following API outputs have been added to the get_acct_payment_methods API in support of ACH via Direct Debit:

Field Description
<bank_branch_cd> Up to 10-digit numeric bank branch code. Used for the Direct Debit payment method.
<bank_id_cd> Up to 10-digit numeric bank identifier code. Used for the Direct Debit payment method.
<bank_country_cd> Country of the bank. The ISO-compliant 2-character country code abbreviation in uppercase. Used for the Direct Debit payment method. It is required for IBAN and BBAN.
<bank_swift_cd> SWIFT code is a standard format of Bank Identifier Codes (BIC). It is used for the Direct Debit payment method. It consists of 8 or 11 alphanumeric characters. Only hyphen and space are allowed to format the SWIFT code. It is required for IBAN.
<bank_city> Bank city for the account payment method.
<bank_name> Bank name for the account payment method.

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

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

Level 2/Level 3 Enhancements

This feature adds Level 2 and 3 data processing support to the Worldline payment gateway. Level 2 data are included for determining a card's affluence, which may influence your marketing initiatives, and Level 3 data includes invoice line item details that allow you to receive lower transactional fees from credit card processors. Level 2 and Level 3 data are supported by the Credit Card and Tokenized Credit Card payment methods and the Visa® and Mastercard® card types.

Note: Aria sends Level 2 and 3 data to Worldline only when making a single API call to collect a payment. Level 2/3 data cannot be sent to Worldline when payment collection is made with 2 separate API calls (e.g., using authorize_electronic_payment to authorize a $3 payment and collect_from_account to capture the $3 authorized amount).

3DS Support for American Express Card Type

The Worldline 3D Secure integration now supports transactions using the American Express® (Amex) card in addition to the Visa® and Mastercard® card types.

The existing Amex credit card type is now supported in Worldline's 3DS configuration for the following APIs:

Enter the following inputs to enable this feature:


Input Description
<cc_prefix> First six digits of Amex card (starting with 3)


Input Description
<cc_number> Amex card number (starting with 3 - 15-character numeric value)
<attempt_3d_secure> True

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 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).

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 soft_descriptor field can be configured in the UI as shown:

Configuration > Payments > Payment Gateways > Field Options:


Configuration > Payments > Collection Groups > Advanced Options:



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).

Account Updater

The Aria Worldline integration is now enhanced by the addition of the Account Updater, which automatically updates your account holders’ card information (Tokenized cards only). This feature supports Visa® and Mastercard® card types issued in the U.S. and Canada.

When an account holder's card information is updated (associated with the particular token), Worldline provides the "push" notification via the Webhooks tool, which sends real-time data from one application to another based on system events as part of a larger integration. You must configure an endpoint that will act as a "listener" to receive these notifications. A typical URL as part of a listener configuration is as follows:


Note: Please contact your payment gateway representative for more information on configuring your Worldline listener endpoint.

On the Worldline configuration center, once Webhooks is enabled, you can subscribe to the token.updated and token.deleted events supported by the Account Updater.

Aria now supports the Webhook Key and Webhook Secret configuration fields from Worldline that are used to validate the incoming Webhooks notifications. These fields accept alphanumerics and special characters.

Note: Set these two field values on the Worldline configuration center for your merchant account. After doing so, configure those values in your Worldline payment gateway configuration.

These fields appear at the Payment Gateway (Configuration > Payments > Payment Gateways) for Worldline as shown:


These fields appear at the Collection Group Configuration > Payments > Collection Groups) for Worldline as shown:



  • The Collection Group configuration takes precedence over the Payment Gateway configuration.
  • The Webhook Key and Webhook Secret values are honored in the Worldline Payment Gateway configuration only and not the Collection Group configuration at this time.
  • The values for the existing Secret API Key field and the new Webhook Secret field are hashed for security reasons.

Refund ID Mapping

Refund transactions generated from Aria now appear on the Worldline payment portal (the Aria refund payment ID appears in the Worldline Merchant Reference ID field). Previously, only original payments were supported and not payment refunds. Refunds can be generated for any payment method accepted by Worldline (e.g., credit card, tokenized credit card, Giropay, etc.).

Learn more about refunds from here.

Aria Configuration Fields

  • API Key ID: Identifier for the secret API key. The apiKeyId can be retrieved from the Worldline Configuration Center and is also used to identify the correct Worldline account.
  • Secret API Key: Shared secret API Key that can be retrieved from the Worldline Configuration Center. The apiKeyId and secretApiKey always are used together, the difference is that secretApiKey is never visible in API calls to/from Worldline.
  • API Base URL: Worldline-distinct Server API endpoint that points to one of the Worldline 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 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.

Configuration Notes

  • When you send a transaction to Worldline, be sure the currency you specify matches the account's currency in Aria. The record_alternative_payment record_alternative_payment API uses the currency specified in the Worldline 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 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 Worldline 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 Worldline website after a mandate has been signed. You cannot approve the mandate and resubmit the payment using the Aria UI because Worldline does not provide an update API.


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



This page has no classifications.