Welcome to Zuora Product Documentation

Explore our rich library of product information

Additional Configuration fields for Checkout.com Payment Gateway Integration

This section details the configuration fields specific to the Checkout.com gateway integration, including API keys for transactions, SFTP credentials for reconciliation, and options for Level 2 and Level 3 data processing.

The following fields are specific to this gateway integration:

  • API Key : The bearer API key used for Credit Card and ACH transactions. You can obtain this API key by navigating to Developers > Keys in the Checkout.com dashboard.
    Note: The API key required in this field was updated in the 2022.10.R1 release.
    • The creation of a new Checkout.com gateway instance with the old deprecated API key is not allowed.

    • For ACH transactions, if you have not provided a new bearer API key since the 2022.10.R1 release, your ACH transactions cannot be processed because the existing API key has been deprecated as requested by the Checkout.com gateway. Please obtain a new bearer API key from the Checkout.com dashboard and enter it in this field.

    • For existing gateway instances using the old deprecated API key, only credit card transactions are supported.

  • SFTP Username(optional): This field is required for Gateway Reconciliation. Contact Checkout.com to get your username and enter it in this field. Your Zuora username and public key will be used to access the SFTP server. See the Gateway Reconciliation for Checkout.com for more information about Gateway Reconciliation.

  • Default Soft Descriptor(optional): The default soft descriptor for payments. It is required for all Direct Debit payment methods.

  • 3DS Challenge Indicator: Controls whether Zuora enables 3DS2 and which challenge indicator is sent to Checkout.com when you process a credit card payment through Payment Pages 2.0.

    • Select Disabled to disable 3DS2 for one-leg-out (OLO) payments. An OLO payment is a payment in which either you or the customer's bank is based outside the EEA or the UK.

    • Select any other challenge indicator to enable 3DS2 and send the selected indicator to Checkout.com.

    • If you do not select an option, Zuora treats the field as Disabled.

    The value that Zuora sends to Checkout.com depends on your selection:

    Disabled3ds2.enabled=false
    No selection3ds2.enabled=false
    Any other challenge indicator3ds2.enabled=true and the selected challenge indicator

    The Disabled option is selected by default. Use it when the transaction is outside thescope of the 3DS2 requirement, such as an OLO payment. For transactions that require or benefit from 3DS2, select the appropriate challenge indicator instead.

    For more information about enabling 3DS2 for Checkout.com, see Enable 3DS2 for Checkout.com gateway integration.

  • Soft Description: Soft Descriptor is used to define the merchant name or product description that will appear on the customer's statement. This field is required if you want to use Soft Descriptor. For more detailed information, seeConfigure dynamic soft descriptors

  • The following fields are related to Level 2 and Level 3 data processing: If Level 2 and Level 3 data processing is enabled, additional information such as the amount of sales tax and order and line items is passed to the gateway when processing a credit card transaction. This information might result in lower interchange rates on eligible commercial, corporate, and purchasing cards. See Level 2 and Level 3 data processing on Checkout.com for more information

    • Enable L2

    • Enable L3

    • ProductCode Custom Field API Name

    • CommodityCode Custom Field API Name