How to configure Bank of America in Chargebee?

Modified on: Wed, 19 Apr, 2023 at 1:20 PM


How to configure Bank of America in Chargebee?

What are the integrations supported by Chargebee for BoA configuration?

What is the mandatory Email Notifications section that must be configured for Bank of America configuration?

What is the fraud management in Bank of America?


  • You must have a business account with Bank of America. Create one, if you don't have it already.

  • Retrieve the following details from your Bank of America account:

    • Merchant ID

    • Shared Secret Key

    • Key

If Bank of America payment gateway is not enabled, contact support to enable it on your site.
  •  Once enabled, click Settings > Configure Chargebee Payment Gateway > Add Payment Gateway > Click Bank of America.

1. Chargebee currently supports only Card payments with Bank of America
2. 3DS is not supported for this integration

3. For complying with the requirements of Bank of America, mandatory fields must be configured in Chargebee’s Email Notifications section.
4. Bank of America require Payment Address field to be enabled to allow any transactions.


The following are the prerequisites for configuring the Bank of America gateway in your Chargebee site:

  • You must have a business account with Bank of America. Create one, if you don't have it already.

  • Retrieve the following details from your Bank of America account:

    • Merchant ID

    • Shared Secret Key

    • Key

  • Enable TMS (Tokenization management service), Card payment method, and corresponding currencies on your merchant ID.

  • Card Address is mandatory to be passed to Bank of America for a successful payment.

  • Make sure to configure and enable the card billing address and the customer email address if you are using Chargebee’s hosted pages.

  • Sending payment receipts is mandatory, therefore, make sure to configure it in Chargebee.

  • While mapping tokens from Bank of America into Chargebee, make sure that the token format is Payment Instrument Identifier/ Instrument Identifier.

Integration Options

Listed below are the integration options available between Chargebee and Bank of America:




PCI Requirements


Chargebee Checkout + Bank of America Gateway

Card information of the customers is collected by Chargebee's checkout and passed on to Bank of America.

(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.)


Chargebee JS

Chargebee's Hosted Components and Fields  You will use Chargebee's Components to collect card details and Chargebee's temporary token. You will pass the token through Chargebee’s APIs to purchase a subscription or set up a payment method.



Chargebee API + Bank of America Gateway

The collection of card information should be handled at your end and passed on to Chargebee via API. Chargebee will route this card information to Bank of America.

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


Configuring Bank of America

To configure Bank of America in Chargebee, follow the below steps:

1. Click Settings > Configure Chargebee > Payment Gateway > Add Payment Gateway.
2. Click Bank of America.

3. Enter the Merchant ID, Key, and Shared Key retrieved from your Bank of America account.
4. Click Connect.

The Configure Bank of America page appears as shown below:

Configuring Card Settings

Follow these steps to configure the Cards Settings for Bank of America:

  1. Click Settings > Configure Chargebee > Payment Gateways > Bank of America, and click the Manage link in the Cards section. The Cards Settings page is displayed. Configure the following settings based on your business requirements:

    1. Cards verification: This option is enabled by default to validate your customers' cards by doing a test authorization. An amount of $0 is deducted from the customers' cards to collect mandatory information from Bank of America and for the integration to work properly. This amount will be refunded immediately. Cards that do not pass this validation, will not be added.

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

    3. Always retain card information in Bank of America when the customer updates it: If you have configured multiple payment gateways in Chargebee, enabling this option stores the updated card information in Bank of America rather than the default gateway.

    4. Display Card Logo: Click the drop-down, and select the card brands for which you want to display logos, on your Checkout and Self-serve Portal pages. (This setting is only applicable for Single Page Checkout and Self-serve portal).

  2. Click Save > Apply.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.