Skip to main content

Overview of Checkout.com gateway integration

Zuora

Overview of Checkout.com gateway integration

  1. Last updated
  2. Save as PDF

Supported features 

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 ACH, Apple Pay, Credit Card/Gift Card/Prepaid Card, SEPA
Supported payment operations Validate, Payment, Referenced Refund
Support 3D Secure 2.0 Yes
Support Delayed Capture No
Support Level 2 and Level 3 card data Yes
Support stored credential transactions Yes
Support Gateway Options fields Yes
Checkout.com production endpoint used for Zuora gateway integration service https://api.checkout.com
https://api.checkout.com/payments
Support Batch Gateway Reconciliation Yes
Checkout.com production endpoint used for Gateway Reconciliation service sftp.vault.checkout.com
Support Payment Method Updater Yes (Visa, MasterCard)
Checkout.com production endpoint used for PMU service sftp://sftp.vault.checkout.com
Support Real Time Account Updater Yes
Support Real Time Reconciliation Yes

Supported payment methods 

The Checkout.com gateway integration supports the following payment methods:

  • Credit Card/Gift Card/Prepaid Card, including:
    • Visa
    • Mastercard
    • American Express
    • Discover
    • Diners Club
    • JCB
    • China Union Pay 
  • SEPA
  • ACH
  • Apple Pay

For more information about setting up payment methods in Zuora, see Define and set up payment methods.

Support for mandate creation

Among the supported payment methods, Zuora supports mandate creation for SEPA payment methods. Zuora will generate and pass the mandate to the gateway.

Support for ACH

  • ACH payment method verification on Checkout.com is supported through the ValidiFi account validation service or the Plaid account validation solution.
  • When adding an ACH payment method to a Corporate type of account, you can pass in the company name information through the following approaches:

    The value passed in will be mapped to the account_holder > first_name and account_holder > last_name fields. Zuora splits the string specified in the Account Holder Name field into two parts at the first space from the left. The first part will be passed to Checkout.com and populated in the first_name field. The second part will be passed and populated in the last_name field. Additionally, the company name passed in will also be mapped to the account_holder > company_name field.

Support for Apple Pay

Support for the Apple Pay payment method on Checkout.com is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters.

For implementation instructions, see Set up Apple Pay.

You can also refer to Checkout.com's Set up Apple Pay guide to get a better understanding of the Apple Pay setup. Note that you should skip Step 2: Add Checkout.com as a payment processor of this guide because Zuora's payment processing certificates will be used here.

For enablement requirements for processing Apple Pay payments in some regions, see Checkout.out documentation.

Support for Credit Card

You can create non-tokenized Credit Card payment methods with card information through the UI, API operation, Payment Pages 2.0, or Payment Form. 
Additionally, by using the “Create a payment method” API operation, you can save any combination of a Checkout.com token and clear PAN data. You can also request Checkout.com tokens for existing cards on file. When both a relevant gateway token and PAN exist at the time of transaction, Zuora will prioritize the submission of the gateway token. See Tokenize Credit Card payment methods on Checkout.com for more information.

Supported payment operations 

The Checkout.com integration supports the following payment operations:

  • Validate
  • Payment
  • Referenced refund
  • Payment void 

Support for 3D Secure 2.0  

Zuora's Checkout.com gateway integration provides support for 3DS2 through the embedded iFrame of Payment Pages 2.0. To enable 3DS2, see Enable 3DS2 for Checkout.com gateway integration and Zuora’s implementation of 3D Secure 2.0 for more information.

After 3DS2 is enabled in the Payment Pages settings, you can use the 3DS Challenge Indicator configuration field to indicate your preference for whether or not a 3DS challenge should be performed. See Additional configuration fields for more information.

The "Best practices" section in Zuora’s implementation of 3D Secure 2.0 also provides best practices for reducing the possibility of failed transactions due to 3DS2 authentication errors.

Support for Level 2 and Level 3 card data processing

The Checkout.com payment gateway integration provides you the flexibility to submit Level 2 and Level 3 card data to the gateway for the following card brands in the U.S.:

  • Visa
  • Mastercard
  • American Express (only Level 2)

If this feature is enabled, additional information such as the amount of sales tax and order and line items is sent to the gateway when processing a credit card transaction. This information might result in lower interchange rates on eligible commercial, corporate, and purchasing cards.

For more information, see the following articles:

Support for stored credential profiles

The Checkout.com gateway integration includes support for the Stored Credential Transactions framework for Credit Card and Apple Pay payment methods. For Apple Pay, it supports generating stored credential profiles when processing payments, but it does not support generating stored credential profiles when creating payment methods is not supported.

For more information about Stored Credential Transactions, see Support for stored credential transactions overview.

Support for Batch Gateway Reconciliation 

Batch Gateway Reconciliation for Checkout.com is supported for Credit Card and SEPA payment methods. It is not available for ACH or Apple Pay for now.

The Checkout.com integration supports the following Gateway Reconciliation event types:

  • Settlement
  • Rejection
  • Chargeback

Before configuring and using Gateway Reconciliation for Checkout.com, complete the following tasks:

  • Send an email to support@checkout.com to add your merchant account's Daily-Full-Edition and Disputes Hub reports to Zuora's checkout.com gateway integration.
  • Get your API key from Checkout.com dashboard. This API key is required for configuring Gateway Reconciliation for Checkout.com gateway integration when setting up the gateway integration.
  • Contact Checkout.com to get your SFTP username. This SFTP username is required for configuring Gateway Reconciliation for Checkout.com gateway integration when setting up the gateway integration.

Checkout.com hosts an SFTP server for Zuora, where Checkout.com uploads transaction reports for merchants. These reports are aggregated in a single folder for each merchant. Each merchant folder contains its day-to-day reports. Two reports are generated on a daily basis, including a Full edition report and a Disputes report. 

  • The Full edition report contains settlements and rejections for credit cards and SEPA.
  • The Disputes report contains chargeback data for credit cards and SEPA.

For the detailed columns in the two reports, see Checkout.com's documentation for more information.

For more information about enabling and configuring the Gateway Reconciliation service, see the following articles:

Support for Payment Method Updater

Zuora provides a Payment Method Updater to work with the Account Updater of Checkout.com. This feature helps keep Zuora and you informed when card members change, replace, or upgrade their card information. For more information, see Configure Checkout.com Payment Method Updater.

Support for Real Time Account Updater 

Zuora provides the integration with Checkout.com’s Real-Time Account Updater for credit card transactions on the Checkout.com payment gateway integration. For more information, see Real Time Account Updater.

Supported Gateway Options fields 

You can submit additional information to the Checkout.com gateway by using Gateway Options fields. For details about the fields supported by Checkout.com, see Gateway Options fields supported by Checkout.com.

Limitations 

  • Since Checkout.com uses auto-capture by default, payment requests are captured very quickly. Therefore, payments cannot be cancelled or voided using the Checkout.com gateway. Once made, payments can only be refunded later.
  • Non-referenced refunds (credits) are not supported by the Checkout.com gateway integration.