Blackhawk Network Integration

Blank 22/7/2024 11:13 - 22/7/2024 11:13
Incentives

An integration with Blackhawk Network (BHN) allows for automated processing of virtual gift cards within your Kademi platform. This includes both open-loop gift cards, which have variable denominations, and closed-loop gift cards with fixed values. By connecting your Kademi eCommerce store to BHN, you can streamline product syncing, simplify order fulfillment, and reduce manual administrative work.

To begin, you’ll need to complete onboarding with Blackhawk Network. As part of this process, BHN will provide a certificate file and password, along with your Merchant ID, Tenant ID, and Suborg ID. These credentials are required to establish a secure connection between the two systems. Testing the integration in a pre-production environment is also recommended before going live, so you should factor this into your implementation timeline.

Before setting up the integration, ensure that your Kademi eCommerce environment is properly configured. This includes having an active and published eCommerce store. If you need a refresher on this process, refer to the guide on previewing your eCommerce store. You will also need product categories created for both open-loop and closed-loop products. For guidance, see the tutorial on padding products and creating categories

Once these foundational elements are in place, you can proceed to install the Blackhawk application in your site, configure your credentials, and begin syncing products from BHN into your Kademi store.

This guide outlines that process step by step.

Let's jump right in.

1 Navigate to the app marketplace.

From your Kademi admin console, go to Website Manager, then select Websites. Choose the site where the Blackhawk integration will be used by clicking through to its settings.

In the site settings view, click on the green Find more apps button. This will open the Kademi app marketplace, where you’ll be able to search for and install the Blackhawk integration.

Installing apps at the site level ensures the integration is scoped correctly and available for use with your store, products, and customer journeys.

2 Install the Blackhawk application.

In the app marketplace, use the search bar to find Blackhawk. Once located, click on the tile to install the application into your site.

The Blackhawk app enables secure communication between Kademi and Blackhawk Network, allowing you to sync gift card products, configure pricing and category mappings, and send fulfillment instructions automatically.

If the app is already installed, you’ll see an “Already installed” label instead of the install option.

3 Access the Blackhawk Marketplace settings.

Once the app is installed, go to the Products & Stores section in the admin console. In the sidebar, click on Blackhawk Marketplace.

This section allows you to configure the integration, manage settings, and access sync and fulfillment tools.

If you don’t see “Blackhawk Marketplace” in the menu, make sure the app was installed for the correct site and refresh your admin panel.

4 Upload the certificate and password.

On the Blackhawk Marketplace API settings page, upload the Certificate and Password files provided to you by BHN during onboarding.

These are used to authenticate API access and establish a secure connection between Kademi and Blackhawk Network.

The certificate and password must match the ones associated with your BHN environment (pre-production or production). If you are unsure, confirm with your Blackhawk contact before proceeding.

Once both files are uploaded, you will see confirmation messages showing that the files are active

5 Select the environment and enter your BHN credentials.

From the Environment dropdown, select whether you are connecting to the Pre-Production (Testing) or Production (Live) environment. This determines which Blackhawk system Kademi will interact with.

Once selected, enter the credentials provided to you by Blackhawk Network:

  • MerchantId

  • TenantId

  • SuborgId

These fields are critical for authentication and must match the values issued by BHN. If you're switching between environments (e.g., moving from testing to live), make sure you update the certificate and password files accordingly.

6 Select the eCommerce store and configure sync behavior.

From the Ecommerce store dropdown, choose the store where products synced from BHN will be made available. This store should be linked to a website where end users can log in, browse, and redeem gift cards.

Next, configure the available sync options:

Use Base Cost multiplied by Quantity workflow
If enabled, Kademi will send the Base Cost multiplied by the quantity to Blackhawk, instead of the total order cost. This is useful when you're using Pricing Rules or other internal markup strategies that shouldn’t affect the value sent to BHN.

Leave this unchecked if you want to send the final order cost to BHN as-is.

Override products when sync
When enabled, this allows BHN products to overwrite existing product data in Kademi during sync. This ensures that updates from Blackhawk (such as product names, SKUs, or pricing) are applied automatically.

Disable this if you’ve made custom modifications to products in Kademi that you want to preserve

These settings offer greater control over how synced products behave and are especially useful when working with dynamic or frequently updated gift card catalogs.

7 Configure open-loop program settings and physical card support

Start by entering the ClientProgramIds for your open-loop BHN products. These are comma-separated values provided by Blackhawk and represent the individual gift card programs that will be synced into your store.

Next, select the Category in Kademi that these products should be added to. This ensures they’re properly organized when displayed in your eCommerce catalog.

Then, set the Minimum virtual card value. This defines the lowest card value that can be redeemed at checkout and helps you control gift card issuance thresholds.

If your setup includes physical reloadable cards, you will also see a field for Product IDs for Physical Cards. These are BHN-issued identifiers used to support card issuing and reloading functionality through Kademi.

Note: The Product IDs for Physical Cards field will only appear if you have set up your company details in the Third Party Info tab. This is a required step for enabling reloadable card support.

To configure this, go to the Third Party Info tab within the Blackhawk Marketplace settings and provide your business’s city, state, postal code, country, and tax ID.

This setup is essential for use cases like CardFunding, where users may receive physical cards that can be topped up over time. Kademi stores the card ID securely and can manage subsequent loads, replacements, or deletions as needed.

8 Configure closed-loop program settings

Enter the ClientProgramIds for your closed-loop BHN products. These are comma-separated values provided by Blackhawk for fixed-denomination products like e-gift cards and vouchers.

Then select the Category in Kademi where these products will be added, and specify the available Denominations that users can choose from at checkout.

9 Set the default payment type.

Use the Default Payment Type dropdown to choose how payments will be processed. The default value is ACH_DEBIT, but you may also select options like BANK_TRANSFER or DRAW_DOWN, depending on your program requirements with BHN.

This setting defines the payment instruction method for transactions processed through this integration.

10 Configure per-store client program IDs (for multi-store setups).

If your Kademi instance uses multiple stores, you can define store-specific ClientProgramIds for both open-loop and closed-loop programs. This ensures that during product synchronization, BHN products are correctly routed to their corresponding eCommerce stores.

Click the “Click here to configure per store settings” link, and fill in the appropriate ClientProgramIds for each store. If a field is left empty, all products will default to that store.

This feature is helpful for managing different catalogs or audiences across multiple storefronts while using a single BHN account.

11 Save the settings.

After entering all required fields, click Save at the bottom of the configuration panel.

Saving your settings activates the integration and allows you to begin syncing products from BHN into your Kademi eCommerce store.

12 Sync products from BHN into Kademi.

Once all configuration settings are complete, scroll to the top of the Blackhawk Marketplace settings page and click the Sync Products button.

This action will pull available products from Blackhawk—based on the ClientProgramIds you provided—and store them in Kademi. These products will be assigned to the selected eCommerce store and categories.

Be sure all your settings are correct before syncing. Running the sync again will overwrite product data in Kademi (unless you’ve disabled the "Override products when sync" option in Step 6)

13 Verify that products were successfully synced.

After the sync process completes in the background, you can confirm that products have been imported by navigating to Products & Stores > Products.

Here you’ll see a list of all items pulled from Blackhawk, including both open-loop and closed-loop gift cards. If you need to update product names, descriptions, or metadata, you can do so directly within Kademi.

However, note that syncing again from BHN in the future may overwrite any local changes.

14 Add products to your eCommerce store.

Once verified, the imported products need to be added to your Kademi eCommerce store to make them visible and redeemable by end users.

Go to Products & Stores > eCommerce Stores, select your store, and add the relevant gift card products to your catalog.

For a step-by-step refresher, refer to our guide on adding products to a store.

15 Test the integration.

After adding products to your eCommerce store, it's time to test the setup.

Log in as a test user and place an order for one of the synced BHN products. This will allow you to validate that the integration is working end-to-end—from product visibility and cart behavior to order submission.

Keep in mind:

  • The minimum virtual card value validation will only work on the live version of your site.

  • BHN integration does not support multi-product orders. Each order must contain only one gift card product.

In the event of a failed fulfillment (e.g. system timeout or sync error), you can manually resend the order.

Go to Products & Stores > Orders, open the relevant order detail page, and click Send to Blackhawk.

This replaces the older "Resend Orders to BHN" button, which has been removed from the Marketplace settings page.

Your Blackhawk Network integration is now fully configured. You can begin managing gift card products, syncing updates, and processing orders directly through your Kademi site.

If you run into any issues or have questions, feel free to reach out to our support team.