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

Types of Platforms 

The following are the types of platforms supported by

  • 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.


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

Supported Payment Methods 

Click on the links below learn more about configuring the desired payment method:

  1. Direct Debit (SEPA)
  2. Apple Pay
  3. ACH Payments
  4. iDEAL
  5. Bancontact
  6. Sofort

SEPA, iDEAL, Bancontact, and Sofort are supported only for the ABC platform.

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 has two types of accounts - Test account and Live account. You can integrate the Test Account of with the Test Site of Chargebee and the Live Account of with the Live Site of Chargebee.


Contact'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


In order to receive payments from customers via, it is necessary for Chargebee to have customer's billing address.

# Methodology Description PCI Requirements 3DS supported?
1 Chargebee API + 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 High
(card information will be collected by you directly, you will have to take care of PCI Compliance requirements)

For more info, contact support 
2 Chargebee Checkout + Gateway In this method, the card information of the customers are collected by Chargebee's checkout and directly passed on to 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.)
3 + Chargebee API In this method, the card details are captured and tokenized on your side by's javascript library and the token is sent to Chargebee. Low
(card details are tokenized by
4 Chargebee.js (JS helper) + 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.


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

Retrieving the API Key and Secret Key 

While configuring in your Chargebee site, you are required to enter the API Key and Secret Key. You must get these keys from your account. While there are two platforms: ABC and NAS, the steps involved in retrieving the keys differ slightly between the two.

NAS Platform 

Follow these steps to retrieve the API Key and Secret Key:

  1. Login to your account (NAS platform) .

  2. Go to Developers > Keys.

  3. Click on any existing Public key and Secret key, and copy the Value. If you don't have an existing key, create a new one using the Create a new key button in the top-right corner.


Whether you are creating a new key or using an existing one, make sure to uncheck Allow any processing channel and select the required channel from the list below. You can do this while creating a new key or updating an existing key.

ABC Platform 

Follow these steps to retrieve the API Key and Secret Key:

  1. Login to your account (ABC platform) .

  2. Go to Settings.

  3. Click Channels and select the desired channel under Business Name.

  4. Copy the Secret Key and Public Key. Click Regenerate to create a new one.


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

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

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


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 and Chargebee. You can manage the settings from the Configure 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.


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. 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 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 when customer updates it: Enabling this option stores the updated card information in rather than the default gateway.

Once you have made the necessary changes, click Save.

Enable 3D Secure Authentication 

Complete the steps below to enable 3DS for this integration:

  1. Click Manage to view the Card settings screen.

  2. Toggle Enable 3D Secure and click Save.

  3. Click Save.


Configuring ABC Platform 

Webhooks are indispensable when it comes to integrating Chargebee with as they pass crucial payment information. This is essential because most of the payment operations in are asynchronous and Webhooks are the only way to communicate the status to Chargebee. Webhooks in this integration are 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 site to ensure that Chargebee receives notifications for all events associated with this account.

  2. Log in to your account (NAS platform) , and navigate to Developers > Webhooks.

  3. Click + New webhook.

  4. Enter the notification name in the Name field.

  5. Paste the Notification URL copied from your Chargebee site in the Endpoint URL field.

  6. In the Webhook keys section, enter the API Secret Key retrieved from your account in the Signature Key field.
    Make sure to use 'Bearer' as a prefix term, followed by a space, and then the API Secret Key. For example, Bearer sk_sbox_pcbqzzjczm5p72kqdgfrsfrkjhg

  7. Skip the Authorization header key field.

  8. Select all the events under the Events section.

  9. Select the All Entities checkbox under the Entities and processing channels section.

  10. Click Create webhook.

Automated Account Updater 

This integration supports automated account updates 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 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 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:

Additional Fields for Fraud Screening, a trusted payment gateway provider, understands the critical need for robust fraud screening and efficient payment approval processes. recommends sending specific information or fields about payers to enhance these measures. By collecting this valuable data, you can bolster your defences against fraudulent transactions and streamline the payment approval process, ensuring a safer and smoother experience for businesses and customers.

The fields include:

  • firstName
  • lastName
  • email
  • phone
  • addressLine1
  • addressLine2
  • addressLine3
  • city
  • state
  • stateCode
  • countryCode
  • zip
  • paymentIp

Please contact Chargebee Support  to enable the paymentIp field to be passed.

Lets us see how you can enable and send these fields when using Chargebee's Hosted Pages  or Chargebee JS :

Using Chargebee Hosted Pages 

Follow the steps below to enable these fields when using Chargebee's Hosted Pages:

  1. Go to Settings > Configure Chargebee > Checkout and Self-Serve Portal.

  2. Switch to the Fields tab and select Payments.

  3. You must enable the above-listed fields. Click Publish. Address fields will appear only if None is selected from the In checkout, prefill address information from drop-down menu.

  4. Choose to prefill address-related information from Billing or Shipping details by selecting the relevant option under the In checkout, prefill address information from drop-down menu.

Using Chargebee JS 

Chargebee JS provides a comprehensive set of tools and functionalities that allow you to harness the capabilities of within your billing and subscription management workflows.

If you are utilizing Chargebee JS, it is recommended to pass these fields as parameters via appropriate handler methods based on your chosen payment method. The following payment method handlers are supported via Chargebee JS:

Was this article helpful?