Chargebee
Last updated: November 28, 2024
To get started using the Checkout.com Chargebee plugin, you must first set up and test your integration in the Test environment, and then move your integration to the Live environment.
The plugin supports the following payment methods:
- Card payments
- Apple Pay
- ACH direct debit
Before you configure the plugin, you must create a public and private key.
- Sign in to the Test environment in the Dashboard.
- Select the Developers icon in the top navigation bar and open the Keys tab.
- Select Create a new key.
- Under Type of key, select Public API key.
- Give the API key a description. This will help you identify what it's used for.
- Disable the Allow any processing channel setting.
- Select the processing channel you want to use for Chargebee payments from the list.
- Select Create key.
- Copy your public API key. You'll need it to configure the plugin.
Information
You can view your public API key in the Dashboard at any time.
- Sign in to the Test environment in the Dashboard.
- Select the Developers icon in the top navigation bar and open the Keys tab.
- Select Create a new key.
- Under Type of key, select Secret API key.
- Give the API key a description. This will help you identify what it's used for.
- Under Scopes, select Default.
- Disable the Allow any processing channel setting.
- Select the same processing channel you created the public API key for from the list.
- Select Create key.
- Copy your secret API key securely. You'll need it to configure the plugin.
Note
For security, you cannot view the secret API key again after you've left the Create a new key page. Ensure you copy its value securely before you exit or close the window.
- Sign in to your Chargebee account.
- Go to Settings > Configure Chargebee > Payment Gateways.
- Select the Checkout.com gateway that you configured previously.
- Select Manage.
- In the NAS API Secret Key field, enter
Bearer
followed by the secret key you created in the Dashboard Test environment. For example,Bearer <SECRET_KEY>
. - In the NAS API Public Key field, enter the public key you created in the Dashboard Test environment.
You can manage your settings in the Configure Checkout.com Settings page.
Before you can configure your webhooks in the Dashboard, you'll need to retrieve the notification URL from Chargebee:
- Sign in to your Chargebee account.
- Go to the Webhooks section.
- Copy the Notification URL.
To configure webhooks in the Dashboard:
- Sign in to the Test environment in the Dashboard.
- Select the Developers icon in the top navigation bar and open the Webhooks tab.
- Select New webhook.
- Enter a name for the webhook.
- Enter the notification URL you copied from Chargebee in the Endpoint URL field.
- Leave the Authorization Header Key field blank.
- In the Signature Key field, enter
Bearer
followed by the secret key you created in the Dashboard Test environment. For example,Bearer <SECRET_KEY>
. - Under Events, select the event types you want to receive notifications for.
- Under Entities and processing channels, select the entities you want to receive webhook notifications for. If you leave this blank, the parent entity is selected by default.
- Select Create webhook.
- Sign in to your Chargebee account.
- Go to the Customers page.
- Select Create customer.
- Enter the customer details. Use a real email address to to receive the order confirmation.
- Select Create.
- In the left navigation, select Payment methods.
- Enter the following card details:
- Number –
4242 4242 4242 4242
- Expiry date – Any date in the future
- CVV –
100
- Number –
- Select a Gateway Account from the drop-down.
- Confirm the card creation.
- Select the Create Quick Charge option from the right navigation.
- Configure the quick charge settings and select Add.
To view the test order in your Chargebee account:
- Go to the History tab.
- Select the payment in the History report to view additional details.
- Sign in to the Live environment in the Dashboard.
- Follow the previous steps to create a public key and create a private key.
- Follow the previous steps to Configure the app webhook. Use the new secret key you created as the webhook's Signature Key.
- Sign in to your Chargebee account and follow the Chargebee – Go-live checklist steps.
You can refund, return, or void an order from the Dashboard.
Chargebee updates the status of the order automatically.