(Payments Made Simple) offers seamless payment processing solutions, ensuring secure and efficient transactions for your business. By integrating with Chargebee, you can effortlessly manage subscriptions, automate billing processes, and provide a seamless payment experience for your customers. This document will walk you through the steps required to set up and configure the integration, enabling you to maximize the benefits of both platforms.

Integration Options 

You can integrate Card via Pay.Com using the following:

Supported Currencies and Countries 

Supported Countries 

This integration supports merchants onboarding from the following countries only:

  • European Economic Area (EEA)
  • Switzerland (CH)
  • United Kingdom (UK)
  • United States (USA)
  • Australia (AU)
  • New Zealand (NZ)

Supported Currencies 

This integration supports the following zero and three decimal currencies:

Currency Currency Type
BIF - Burundian Franc Zero Decimal Currency
CLP - Chilean Peso Zero Decimal Currency
DJF - Djiboutian Franc Zero Decimal Currency
GNF - Guinean Franc Zero Decimal Currency
JPY - Japanese Yen Zero Decimal Currency
KRW - South Korean Won Zero Decimal Currency
PYG - Paraguayan Guarani Zero Decimal Currency
VND - Vietnamese Dong Zero Decimal Currency
XAF - Central African CFA Franc Zero Decimal Currency
XOF - West African CFA Franc Zero Decimal Currency

ISK and UGX are mentioned as zero-decimal currencies in, but Chargebee does not treat them as zero-decimal currencies.

This integration is divided into the following set of steps required to complete the integration successfully:

  1. Retrieving the API Key from your Account.
  2. Configuring in your Chargebee site.
  3. Configuring Webhooks in your Chargebee site.

Let us dive deeper into these.

Retrieving API Key from your Account 

While configuring Gateway in Chargebee, you will require the API Key from your account to be entered in Chargebee. API Key is mandatory for Chargebee to invoke the APIs and complete the integration.

Follow these steps to retrieve it from your account:

  1. Login to your Sandbox Account  if you are connecting to a Chargebee Sandbox Domain  or Live Account  if connecting to a Chargebee Live Domain .

  2. Navigate to the Developers section from the left navigation pane and select the API Keys tab.

  3. Copy the API key if you already have one. If not, create a new key and copy it for further use while configuring in your Chargebee site.

Configuring Gateway in your Chargebee Site 

Follow these steps to enable and configure in Chargebee:

  1. Log into your Chargebee site .

  2. Go to Settings > Configure Chargebee > Payment Gateways.

  3. Click Add Gateway and select from the list.

  4. Enter the API Key fetched from your account and click Connect.

  5. The gateway configuration is completed and the Configure page appears.

  6. Click Manage against Cards to manage your Cards-related settings.

  7. Enable the following options as required:
    a. Cards verification: This option is enabled by default to validate your customers' cards by doing a test authorization. A micro amount is deducted from the customers' card to collect mandatory information from and for the integration to work properly. This amount will be refunded immediately. Cards that do not pass this validation, will not be added.
    b. Allow Prepaid cards: Enabling this option allows your customers to use a prepaid card for their transactions.
    c. Always retain card information in when the customer updates it: If you have configured multiple payment gateways in Chargebee, enabling this option stores the updated card information in rather than the default gateway.
    d. Enable 3D Secure: Check with your gateway whether Payment Authentication for 3DS is enabled for your account. If not, enable it at your gateway and then in Chargebee. Also, make sure you complete the SCA checklist  in Chargebee before accepting 3DS payments. This is to ensure that you can recover failed payments easily, without compromising your revenue. Learn more about PSD2 and Strong Customer Authentication .

  8. Click Save.

Configuring Webhooks 

Before you proceed towards the webhook configuration, you must retrieve the Webhook Secret Key from your account. This key is required to complete the configuration in your Chargebee site.

Retrieving Webhook Secret Key 

To create and retrieve the Webhook Secret Key in, first complete the configuration of Chargebee's Webhook endpoint in your account. Once configured, generates a unique Webhook Secret Key for each webhook endpoint set up in your account.

Follow these steps to configure the Chargebee Webhook endpoint and retrieve the Webhook Secret Key from your account:

  1. Log in to your Sandbox Account  if not logged in already.

  2. Go to the Developers section from the left navigation pane and select the Webhooks tab.

  3. Click + Add Webhook.

  4. Copy and paste the Notification URL from the Chargebee Gateway Configuration Page in the Endpoint URL field and provide a relevant Webhook Name.

  5. Select all the Dispute events and click Save Changes.

  6. Copy the Secret Key from the saved Webhook Endpoint and save it for later use.

Configuring Webhook in your Chargebee Site 

Follow these steps to complete the Webhook configuration in your Chargebee site:

  1. In your Chargebee app, go to Settings > Configure Chargebee > Payment Gateways. Select your instance from the list of gateways.

  2. On the Configure page, click + Add Webhook Secret Key under the Webhooks section.

  3. Enter the Webhook Secret Key copied from your account as shown in the previous section and click Save.

Your webhook configuration is complete now. You can start viewing the webhook logs for the set events in your account dashboard.

Supported Tokens 

This integration supports the following tokens in the mentioned format:

Token Description Formal and Sample
Raw Card Information Raw Card details like Card number, expiry and CVV can be given as input if applicable. First Name, Last Name, Card number, Card expiry, CVV, and Card billing address.
Permanent Token Permanent token is a combination of the customer ID and payment method ID available at the gateway. Format - customer_id/payment_method_id
Sample: 2844355640/pm_card_365001528248893440
Chargebee Token Chargebee.js token  token_id
(Chargebee token can be created by giving a permanent payment method ID)
Chargebee Payment Intent ID This is the Payment Intent ID returned after a successful bank authorization process. Format - payment_intent[id]
Sample - __dev__8assMTnewj7fO__dev__cLD08udLibvNLcunV3uq81iAIujLLibhD

Payment Flow 

  1. Checkout Initiation: The customer initiates the checkout process.
  2. Payment Method Selection: The customer selects a credit card as the payment method during checkout.
  3. Initial Data Collection:
    a. The End Customer's details (Name, Billing Address, etc.) are collected based on the checkout page configuration.
    b. Card Details such as card number, expiry month & year, and CVV are collected.
  4. Non-3DS - If 3DS is not enabled, then payment is initiated directly & checkout is completed. (In this scenario, Auth Capture is a one-step process which means the payment is collected in a single step.)
  5. 3DS Authorization via Payment Intent
    a. If 3DS is enabled under Manage Cards on the Configure page, then the payment goes through the Payment Intent flow, where the end customer is challenged with 3DS authentication. (Auth + Capture as two separate steps)
    b. The Auth API endpoint is invoked by which the respective checkout amount is held.
    c. 3DS challenge is enforced by redirecting the end customer to the 3DS challenge page.
    d. Post challenge completion, the Chargebee Payment Intent is moved to the Authorized Status.
  6. Payment Summary Page: The customer is presented with a payment summary page, encompassing essential details like account information and billing particulars.
  7. Subscription Creation
    a. Upon clicking Pay & Subscribe, the subscription creation process is initiated.
    b. When the authorized payment intent is consumed for the subscription/invoice creation, the Charge API endpoint is invoked where the amount is deducted from the end customer account.
    c. Since is a synchronous payment gateway, the transaction is settled instantly.

Adding or Updating Cards as a Payment Method 

You can add cards as a payment method for for this integration via the following methods:

  1. Via API
    a. Non-3DS Flow: card can be added as a payment method via API using raw card information as well as a permanent token.
    b. 3DS Flow (if 3DS is enabled in the Gateway Configuration): Authorized payment intent is used as input to create a payment method via API, which implies that the payment method is added after the 3DS challenge.
  2. Via Checkout & Portal
    a. When the customer goes through the Checkout process and checks the box at the end for vaulting (storing or saving) the payment method for future/recurring use, it automatically gets saved for that customer.
    b. You can also send Add Payment Method / Update Payment Method requests to the end customers, upon which the payment method gets added.

Automated Account Updater 

Chargebee seamlessly integrates with to automatically update customer account details. Whenever there's a change in the customer's card number, expiration date, or CVV, Chargebee instantly reflects these updates in realtime. This automated process occurs during any subsequent transaction utilizing the vaulted Payment Method Token. By eliminating the need for manual intervention, this integration ensures a hassle-free experience for your customers while preventing payment failures caused by outdated card information.

Let us see how the Automated Account Updater works with an example:

  1. Initially, a customer completes a transaction using a credit card, which is securely stored in with the unique token T1.
  2. If any modifications occur to the card linked with token T1, such as changes in the card number, expiration date, or CVV, automatically updates this information.
  3. Subsequently, if a renewal transaction is initiated from Chargebee utilizing the token T1, notifies Chargebee about the updated card details in the transaction response.
  4. Chargebee promptly detects and integrates the new card details provided by, ensuring that customer information remains accurate and up-to-date.

Statement Descriptor 

We support the utilization of Statement Descriptors for transactions. It's crucial to understand that enforces a character limit of 22 characters for these descriptors.


If you configure a longer string, automatically truncates it to 22 characters to adhere to this restriction.

Chargeback Management 

Chargebee supports Chargeback Management with integration. notifies about both Chargeback Initiated & Chargeback Lost events, hence you can configure the required settings in the Chargeback Management settings in the Chargebee app. Learn more  about configuring Chargeback Management.


It is mandatory to complete the Webhook Endpoint configuration for the dispute management to function properly in Chargebee, as disputes are notified to the Chargebee system by via webhooks only.

Checkout Flow 

The checkout process for is a typical card checkout flow with a 3DS challenge (if applicable). It contains the following steps:

  1. The checkout is initiated, and the Your Order page appears. Click Proceed to Checkout to initiate a purchase.

  2. Enter your email address and click Next.

  3. Enter your Account Details field, i.e. First Name, Last Name, and Email Address, and click Next.

  4. Enter the Billing Address details and click Next.

  5. Select **Credit Card as the payment method.

  6. Enter the Card details - Card Number, Expiry (Month & Year) and CVV. Click Next.

  7. Once reviewed, click Pay & Subscribe .

  8. If 3DS is enabled and the added credit card is applicable for the 3DS challenge, you will be redirected to the 3DS challenge page.

  9. Once the challenge is completed, you will be redirected back to Chargebee's checkout. Checkout is now completed and the subscription is created successfully.

Was this article helpful?