Skip to main content

Checkout.com payment gateway integration

Zuora

Checkout.com payment gateway integration

Checkout.com allows you to build flexible payment flows, collect payments quickly and securely, and accept payments from various payment methods. Zuora’s integration with Checkout.com makes it simple to accept recurring and one-off payments via credit cards, bank transfer, or ACH.

In addition, 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.

Supported payment methods

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

  • Credit Cards, including:
    • Visa
    • Mastercard
    • American Express
    • Discover
    • Diners Club
    • JCB
    • China Union Pay 
  • SEPA
  • ACH
  • 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.

Stored credential transactions

This feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available.

The checkout.com gateway integration supports the Stored Credential Transactions framework of Visa and Mastercard.

Supported payment operations

The checkout.com integration supports the following payment operations:

  • Validate
  • Payment
  • Refund

Supported Gateway Reconciliation event types

The checkout.com integration supports the following Gateway Reconciliation event types for all supported payment methods:

  • Settlement
  • Rejection
  • Chargeback

Compliance with PSD2

The checkout.com gateway integration provides support for 3D Secure 2.0. To learn how to enable 3D Secure 2.0 for checkout.com, see Enable 3DS2 for Checkout.com gateway integration.

Set up checkout.com integration

After the checkout.com gateway integration is enabled in your tenant, set up the payment gateway.

  1. Click your username at the top right, and navigate to Settings > Payments > Set Up Payment Gateway.
  2. From the Gateway Type dropdown list, select checkout.com.
  3. Click create gateway.
  4. Complete the information for the gateway instance. See below for more information about the fields.
  5. Click save gateway information.

Common configuration fields

There are some common fields you must complete for every gateway configuration. Zuora recommends that you review Setting Up Payment Gateways for information about these fields: 

  • Type
  • Name
  • Use Gateway Test Environment
  • Cards Accepted
  • Default Authorization Amount: This field is used only for credit card validation. You can validate the credit card payment method using 0 or non-zero authorization amount. Defaults to 1 in Zuora. 
  • Verify new payment method (optional):
    With this checkbox selected, the validate call is triggered for any supported payment method when a new payment method is created.
    For ACH and SEPA, Source ID from checkout.com must be entered in the MandateID field during the payment method creation if this checkbox is selected. 
  • Verify updated payment method (optional): 
    With this checkbox selected, the validate call is triggered for any supported payment method when an existing payment method is updated.
    This checkbox must be selected for ACH and SEPA to have updated payment information reflected in checkout.com.
  • Enable gateway reconciliation: If you select this checkbox, it will trigger a daily job to reconcile all payment events processed through the gateway. See the Gateway Reconciliation for checkout.com section below for details.

Additional configuration fields

The following fields are specific to this gateway integration:

  • API Key: It is required by all endpoints for authentication. This field corresponds to the secret key in your Checkout.com merchant account. You can obtain it by navigating to Settings > Channels.
  • SFTP Username (optional): This field is required for Gateway Reconciliation. Enter your Zuora username for this field. Your Zuora username and public key will be used to access the SFTP server. See the Gateway Reconciliation for checkout.com section below 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.
  • Merchant's Company Name (optional): This field is required if your customers try to add an ACH payment method and select Business Checking as the account type. The checkout.com payment gateway requires that the Company Name is included in the request if the account type iscorporate; otherwise, the gateway will mark the transaction as failed. The value is a maximum of 50 characters. Zuora recommends that you always specify this field for both existing and new gateway instances.

Gateway Reconciliation for checkout.com

Before using Gateway Reconciliation for checkout.com, you have to 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.

Zuora set up an SFTP server 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, ACH, and SEPA.
  • The Disputes report contains chargeback data for credit cards, ACH, and SEPA.

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

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.

Follow the instructions in Apple Pay on Web to learn how to configure Apple Pay in Zuora.

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.

Testing Your Configuration 

We recommend that you test your payment gateway using both your payment gateway's test and production (live) environments.  Once you have completed testing in the gateway's test environment, it is recommended that you perform a test in your live production environment with a real credit card. If there are any differences in the configuration of your testing and production accounts, testing in production ensures your production merchant account is set up properly and can successfully connect to the production environment.

You can use the test card information and testing scenarios provided by the gateway vendor to test your integration. See the following checkout.com documentation for details:

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.
  • Limitations specific to Apple Pay:
    • Apple Pay is enabled by default on Checkout.com unless payments are to be processed in the United Arab Emirates or Saudi Arabia. If you operate in these regions, contact your Customer Success Manager at Checkout.com to have Apple Pay enabled.
    • If you plan to process any Apple Pay payments through an entity outside of the European Economic Area (EEA), contact your Customer Success Manager or integration engineer at Checkout.com to have Apple Pay enabled.