Checkout.com 

Checkout.com is a unified platform that manages all the stages of a payment cycle. Chargebee's integration with Checkout.com enables card payments for merchants from North America, and Europe.

Types of Platforms 

The following are the types of platforms supported by Checkout.com.

  • ABC platform: This platform is the previous version that only supports single entity-based payment.
  • NAS platform: This latest platform supports new business workflows like sub-entities , marketplaces , and more. NAS platform supports backward compatibility.

There are minor changes in the configuration steps that vary based on the platform you are using and will configure in Chargebee.

Note

To know about the platform type of your Checkout.com account, contact your Account Manager or support team from Checkout.com.

Limitations of NAS Platform 

The following are the limitations:

  • dLocal  is not supported.
  • SEPA  is not supported.
  • Reconciliation is not supported for the NAS platform using API.
  • Automatic webhook configuration is possible only for the ABC platform. For the NAS platform, you have to configure the Webhook notifications manually.

Types of Accounts 

Checkout.com has two types of accounts - Test account and Live account. You can integrate the Test Account of Checkout.com with the Test Site of Chargebee and the Live Account of Checkout.com with the Live Site of Chargebee.

Prerequisites 

Contact Checkout.com's support and get full API access for your Test and Live site.

Integration Options 

Listed below are the integration options available between Chargebee and Checkout.com

# Methodology Description PCI Requirements 3DS supported?
1 Chargebee API + Checkout.com Gateway In this method, collecting card information should be handled at your end and passed on to Chargebee via the API. Chargebee will route this card information directly to Checkout.com. High
(card information will be collected by you directly, you will have to take care of PCI Compliance requirements)
No

For more info, contact [email protected] 
2 Chargebee Checkout + Checkout.com Gateway In this method, the card information of the customers are collected by Chargebee's checkout and directly passed on to Checkout.com. Low
(Your PCI compliance requirements are greatly reduced because of Chargebee's checkout. As a merchant using Chargebee's checkout, all you have to do is submit a Self Assessment Questionnaire to stay compliant.)
Yes
3 Checkout.com.js + Chargebee API In this method, the card details are captured and tokenized on your side by Checkout.com's javascript library and the token is sent to Chargebee. Low
(card details are tokenized by Checkout.com)
Yes
4 Chargebee.js (JS helper) + Checkout.com gateway There are multiple ways to interact with Chargebee.js.
  • You can use Chargebee Components and Hosted Fields to collect the card details.
  • You can also collect the card details at your end and send to Chargebee.js directly.







Low





High
(card information will be collected by you directly, you will have to take care of PCI Compliance requirements)
Yes

Configuring Checkout.com 

In order to set up this integration, you will need to obtain your Secret API and Public API key from Checkout.com (You can find the API Secret Key under Settings > Channels > API Keys in checkout.com .)
Once you have noted the keys, follow the steps to integrate with Checkout.com

  1. Click Settings > Configure Chargebee > Payment Gateways > Add Payment Gateway > Checkout.com

  2. Enter the API Secret Key and API Public key.

Note

For the NAS platform, you must enter the API Secret Key as Bearer space Secret Key. For example, Bearer sk_sbox_pcbqzzjczm5p72kqdgfrsfrkjhg

You have now successfully configured the integration between Checkout.com and Chargebee. You can manage the settings from the Configure Checkout.com Settings page shown below.

Due to recent world events, you may experience failures for payments originating from Russian financial institutions or instruments. We recommend reviewing guidelines issued by respective payment gateways for additional information.

Cards 

To change the Cards Setting, click the Manage link. The Cards Settings page is displayed.

  • Card Verification: This is a mandatory option. An amount of $1 is deducted from the customers' card for validation. This amount is refunded immediately. Cards that do not pass this validation, will not be added.

    Checkout.com mandates to send the Source Transaction ID for recurring payments which helps in better payment approval rates. This setting is made mandatory as it allows Chargebee to send the information to Checkout.com even for cases where there are delayed payments (like trial). It ensures that all cards are verified before being vaulted in the gateway.

  • Allow Prepaid cards: Enabling this option allows your customers to use a prepaid card for their transaction.

  • Always retain card information in Checkout.com when customer updates it: Enabling this option stores the updated card information in Checkout.com rather than the default gateway.

Once you have made the necessary changes, click Save.

Webhooks 

Configuring ABC Platform 

Webhooks are indispensable when it comes to integrating Chargebee with Checkout.com as they pass crucial payment information. This is essential because most of the payment operations in Checkout.com are asynchronous and Webhooks are the only way to communicate the status to Chargebee. Webhooks in this integration is configured automatically. You can use the URL in the Webhooks section to setup Webhooks manually in case the automatic update fails.

Configuring NAS Platform 

The configuration of Webhooks is a mandatory prerequisite for this integration to function effectively. Follow the steps below to configure Webhooks:

  1. Copy Notification URL, this URL must be used on your Checkout.com site to ensure that Chargebee receives notifications for all events associated with this account.

  2. Login to your Checkout.com account, and Navigate to Settings > Notification > + New notification.

  3. Enter the notification name in the Name field.

  4. Select all event types to receive notifications.

  5. Paste the Notification URL to the URL field.
    Note: In the Webhook keys section, leave the Authorization header Key fields blank.

  6. In the Webhook keys section, enter Chargebee's API Secret Key as Signature Key.

  7. Select entities  you want to filter notifications for; else, the parent entity is selected by default.

  8. Click Create notification.

Automated Account Updater 

This integration supports automated account update for cards.
Payment failures and recovery are the most difficult aspects of recurring billing businesses due to the sheer complexities involved. In most cases, payment failures occur as a result of an expired or updated card. Chargebee supports an automated account update for Checkout.com. Each time there is an update to the customer's card number, expiry, or Customer Verification Value (CVV), the details are updated in Chargebee (in real-time) with the help of card networks and the Checkout.com gateway. This helps avoid any manual efforts for your customers and more importantly avoid payments failing due to outdated card information.

Supported Currencies 

Checkout and Chargebee support 100+ different currencies for charging customers across different geographical locations. If you intend to use Checkout+Chargebee for your business, ensure that your transactional currencies are supported by both. Find the complete list of currencies supported by:

Was this article helpful?
Loading…