Overview of Ingenico ePayments gateway integration
The following table provides a quick reference for the supported features. For details about each feature, see the later sections in this article.
|Supported payment methods||
Credit Card/Prepaid Card/Gift Card, ACH, SEPA, Direct Debit UK (BACS)
|Supported payment operations||
Credit card validation, Payment creation, Payment cancel, Referenced refund
|Support 3D Secure 2.0||Yes|
|Support Delayed Capture||Yes|
|Support Level 2 and Level 3 card data||Yes|
|Support stored credential transactions||Yes|
|Support Gateway Options fields||Yes|
|Ingenico ePayments production endpoint used for Zuora gateway integration service||
|Support Gateway Reconciliation||Yes|
|Ingenico ePayments production endpoint used for Gateway Reconciliation service||
|Support Payment Method Updater||No|
Supported payment methods
The Ingenico ePayments gateway integration supports the following payment methods:
- Credit Card/Prepaid Card/Gift Card
- American Express
- Diners Club
- Union Pay
- Direct Debit UK (BACS)
Support for mandate creation
Among the supported payment methods, Zuora supports mandate creation for the following payment methods. Zuora will generate and pass the mandate to the gateway.
Supported payment operations
The Ingenico ePayments gateway integration supports the following operations:
- Credit card validation
- Payment creation
- Payment cancel
- Referenced refund (partial refunds are supported)
Support for 3D Secure 2.0
The Ingenico ePayments gateway integration supports 3D Secure 2.0 for the following credit card brands:
- American Express
A positive amount for the
authorizationAmount field is required to enable 3D Secure 2.0. If you use the value
0, Ingenico ePayments will skip the 3D Secure 2.0 process. Zuora uses the following authorization amounts for different card brands:
1for American Express cards,
0for other credit card brands.
Ingenico ePayments requires that the authentication amount must be equal to or higher than the authorization amount to enable 3D Secure 2.0. For 3DS2 transactions, the specified value for
authorizationAmount will be used as the authentication amount. Therefore, if you want to use 3D Secure 2.0 with American Express credit cards, the authorization amount must be equal to or greater than 1.
Zuora recommends that you use the first transaction amount to be sent as the authorization amount. If you do not populate the
authorizationAmount field in the request to Zuora, Zuora will fetch the default authorization amount from the gateway settings to be populated as the authentication amount.
You can specify the order amount for 3D Secure 2.0 authorization on the gateway settings page for the Ingenico ePayments Gateway. The specified value will be passed to the gateway and will be shown as the canceled transaction on the end user's card statement. See Set up and configure an Ingenico ePayments gateway instance for details.
To skip the 3DS2 authentication for specific card brands, you can use the
skipAuthenticationCardType gateway option field in API requests or your implementation. You should list all the credit card brands that need to be skipped by the 3DS2 authentication, separated with commas (
,). For example, "
Visa, AmericanExpress, MaterCard". For more information about how to use gateway options in Payment Pages 2.0, see Gateway Options.
See Enable 3DS2 for Ingenico ePayments gateway integration for more information about how to enable 3D Secure 2.0.
Support for Delayed Capture
The Delayed Capture feature allows you to authorize the availability of funds for a transaction but delay the capture of funds until a later time. The Ingenico ePayments gateway integration supports Delayed Capture, which involves the use of the following API operations:
Zuora also supports capturing authorizations that were generated externally to call the Zuora's Create authorization API operation.
Support for Level 2 and Level 3 card data processing
The Ingenico ePayments gateway integration supports processing Level 2 and Level 3 credit card data. For more information, see the following articles:
Support for stored credential transactions
The Ingenico ePayments gateway integration includes support for the Stored Credential Transactions framework. For details about the supported payment methods, see Support for stored credential transactions overview.
Support for Gateway Reconciliation
Before enabling Gateway Reconciliation for the Ingenico ePayments gateway in Zuora, you must ensure that you receive the WX file in the XML format on the SFTP directory. This might have to be configured separately by Ingenico ePayments.
To enable the Gateway Reconciliation feature for Ingenico ePayments, in addition to the required fields, you must complete the following optional gateway settings:
- SFTP Username: The username of the SFTP server used for reconciliation
- SFTP Password: The password of the SFTP server used for reconciliation
- Enable Gateway Reconciliation
The Ingenico ePayments gateway integration supports the following Gateway Reconciliation event types:
The Ingenico ePayments gateway integration supports only the following Gateway Reconciliation status:
|Gateway Reconciliation event type||Supported Gateway Reconciliation status||Corresponding response from the gateway|
|Transaction Settled||Credit Card payment settled||recordCategory = "+" and recordType = "ON"|
|Direct Debit settled||recordCategory = "+" and recordType = "AP"|
|Credit Card refund settled||recordCategory = "-" and recordType = "CR"|
|Transaction Rejected||Credit Card payment settlement refused||recordCategory = "-" and recordType = "ON"|
|An online settlement for an authorized Credit Card payment was refused||recordCategory = "X" and recordType = "RS"|
|Credit Card payment rejected after successful authorization||recordCategory = "X" and recordType = "RN"|
|A Direct Debit payment has been rejected by the bank of the consumer||recordCategory = "X" and recordType = "AB"|
|A Direct Debit payment has been rejected by GlobalCollect||recordCategory = "X" and recordType = "AG"|
|A Direct Debit payment previously reported as settled (recordCategory = "+" and recordType = "AP") has been reversed for some reason||recordCategory = "-" and recordType = "AR"|
|Transaction Reversed||Chargeback on collected Credit Card payment||recordCategory = "-" and recordType = "CB"|
To understand how Zuora will subsequently process these Gateway Reconciliation events, see Gateway Reconciliation for more information.
Gateway Reconciliation job status can be viewed beginning at 3:00 pm (PST).
Supported Gateway Options fields
You can submit additional information to the Ingenico ePayments gateway using gateway options. Currently, Ingenico ePayments supports the following gateway option fields:
You can use these fields in Payment Pages 2.0 or the following REST API:
- The custom Merchant ID hierarchy is used only when you have multiple Merchant IDs.
- You cannot modify an existing Merchant ID, or use a different Merchant ID for cancel (void payment) or refund transactions compared to the original payment. Zuora will store the Merchant ID used during payments and use the same Merchant ID to make any cancel or refund transactions against the payment to ensure successful transactions.
- For the Delayed Capture flow (authorize, capture payment, and cancel authorization API calls), the Merchant ID must be used in API calls as the
gwOptions_merchantIdgateway option field to ensure successful transactions. You must ensure that the same Merchant ID value from the authorize call is used for payment capture and void authorization calls as well. See Create authorization for more information.
- Non-referenced refunds are not supported.