Blackhawk Network Integration

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

An integration with BHN can allow for automated processing of virtual gift cards. These may include selected products with a variable value, or products with fixed denominations.

To get started with BHN, you will need to complete an onboarding process with them, at the end of which you will receive a certificate, password, and other credentials to configure the integration in Kademi. This process also includes testing the integration in a live environment, so you should factor this in when configuring your account. 

Make sure you have an eCommerce store to add the products to. For a reminder on how to create eCommerce stores, please see the following tutorial:

https://docs.kademi.co/programs/ecom/ecom-010/ecom-010-010/pviewing-your-ecommerce-store.html

You will also need Product Categories for Open loop (variable denominations) and Closed loop (fixed denominations). For a reminder on how to create Categories, please see the following tutorial:

https://docs.kademi.co/programs/ecom/ecom-010/ecom-010-020/padding-products.html

 

To get started, the Blackhawk application needs to be installed.

1 Go to Website Manager, then Websites, click through to the settings for the site the integration will be used in, and click Find more apps.

2 Find the Blackhawk application, and install it in your site.

3 Click on Products & Stores, then BlackHawk Marketplace.

4 Upload the Certificate and Password files received from BHN.

5 Select the relevant environment, and enter the MerchantId, TenantId, and SuborgId from BHN.

6 Select the eCommerce store the products will be available in.

7 Enter all ClientProgramIds for Open Loop products from BHN, select the Category these should be added to in Kademi, and set the minimum value for redemption of these gift cards.

8 Enter all ClientProgramIds for Closed Loop products from BHN, select the Category these should be added to in Kademi, and select the available denominations for redemption of these gift cards.

9 Save the settings.

10 The next step is to sync the products from BHN into Kademi. At the top of the settings page, click Sync Products.

11 Once the background task for the sync has completed, you can confirm that the products have been added by going to Products & Stores, then Products.

If you need to update any products e.g. descriptions or titles, this can be done in Kademi, but note if you sync products from BHN in the future, these updates will be lost.

Next the products will need to be made available in the relevant eCommerce store

12 Add the relevant products to your eCommerce store.

For a reminder on adding products to a store, please see the following tutorial:

https://docs.kademi.co/blogs/docs-kb/adding-products-to-a-store/

Now the integration can be tested.

13 Log in as a test user, and place an order.

Note: The minimum purchase amount will only work in the live version of the site. Additionally, it does not support orders containing multiple products.

If there are any issues with orders sending, you can resend the orders from the BlackHawk Marketplace page. Go to Products & Stores, then BlackHawk Marketplace, and click Resend Orders to BHN.