GuidesAPI ExplorerFTP Reference
GuidesAPI Explorer
GuidesAPI ExplorerFTP ReferenceLog In
Guides

Accessing the Card Catalog

Introduction

The Hawk Marketplace Rewards Catalog Processing API allows you to access the catalog of card products that have been made available for you to order.

📘

The card catalog is specifically configured to your sub-organization and client programs in the Hawk Marketplace platform. It is not a global catalog of all products available from Blackhawk Network. If you do not see a product you believe should be available for you to order, or you would like to add a new product to your catalog, reach out to your Account Manager.

Using the Catalog API

We recommend syncing with the catalog API once a day to pull the most current information about the products available to you. This will ensure you always have the latest card images, terms and conditions and available product denominations to order.

The image below shows a sample use case where pulling products via the Catalog API would be useful.

1504

Diagram showing a sample Hawk Marketplace API Integration

The catalog API can be called by Client Program or by Sub Organization ID.

Calling the Catalog API by Client Program

To call the Catalog API by Client Program we will be using /clientProgram/byKey.

MethodServiceAPIType
GETrewardsCatalogProcessingclientProgram/byKey → ExploreSynchronous

URI: https://api.certification.blackhawknetwork.com/rewardsCatalogProcessing/v1/clientProgram/byKey

From our application, when calling /clientProgram/byKey, we need to send the following parameters in the HTTP header.

ParameterDescriptionTypeRequired
merchantIdThe Merchant ID (MID) is a string identifier, provided to you by your account manager.StringYes
requestIdA globally unique string identifier specified by the application making the request.StringYes
accept

This should be set to the following string to ensure all characters are correctly encoded in the response:

Accept: application/json; charset=utf-8

StringNo

In our example we will be sending the following values in the header:

Content-Type: application/json
Accept: application/json; charset=utf-8
merchantId:1234
requestId:2759594006

We will also need to send the clientProgramId in the URL as follows:
https://api.certification.blackhawknetwork.com/rewardsCatalogProcessing/v1/clientProgram/byKey?clientProgramId=43586508

The following HTTP status codes may be returned in the response header:

HTTP Status CodeMeaningNotes
200Operation CompleteThe query returned successfully.
4XXInvalid RequestCheck the JSON error response provided. In most cases you will find the request had missing information or was formatted improperly.
5XXSystem ErrorBlackhawk Network encountered an internal error trying to process your order. Reach out to your Account Manager for more information.

Assuming the query was successful a JSON object will be returned in the response containing the following information.

ClientProgram

NameDescriptionTypePossible Values
clientProgramIDThe queried Program ID. Also known as Quote ID.Integer
programNameThe descriptive name of the programString
programTypeThis indicates if the program is physical or digital.StringPHYSICAL, DIGITAL
currencyThe product currency.StringExample: USD, CAD
productsList of available productsObject

Products

The products object contains the following information about each product.

🚧

Attributes Vary by Product Type

Available attributes vary by product type and not all attributes are available for all products. Please review the sample responses below.

NameDescriptionType
contentProviderCodeContent provider codeString
productNameProduct NameString
productDescriptionProduct DescriptionString
parentBrandNameParent Brand NameString
redemptionInfoRedemption InformationString
termsAndConditionsThe terms and conditions for the productObject
productImageURL to the image for the product. This is usually a representative card image that can be presented to the customer.String
logoImageURL to the logo image for the merchant. This is only available for some kind of products for some merchants.String
valueRestrictionsIndicates what values/denominations the product can be ordered in. Orders that do not fit this criteria will be rejected.Object
offFaceDiscountPercentIf there is a face discount the percentage will be provided here.Number
expirationDescriptionA textual value that can be used to describe the expiration terms to the customer. For example: "3 months".
Note: Expiration information is only available for open loop digital and physical products, it is not available for closed loop merchant gift cards.		String
expirationMore detailed information about the expiration for this product.Object
cardholderFeesDetails of all the fees that will be applied to the cardholder.Object Array
isSweepIndicates if this is a sweep product.boolean
eGiftFormatIndicates the eGift reward type.String

Terms and Conditions

NameDescriptionType
type

This indicates if the terms and conditions are included directly as a string or if a link has been provided.

Possible values are: INLINE,LINK

String
urlThe URL to the terms and conditions.String
textThe text of the terms and conditions.String

Value Restrictions

NameDescriptionType
minimumMinimum value for the denomination that can be ordered.Number
maximumMaximum value for the denomination that can be ordered.Number
exclusivelyAllowedValuesList of exclusively available values.Array of numbers

Expiration

🚧

Note: Expiration information is only available for open loop digital and physical products, it is not available for closed loop merchant gift cards.

NameDescriptionType
typeType of expiration applicable to the product.
Possible values are: ROLLING,STATIC		String
numberofMonthsExpiry time in number of months.Integer
dateSpecific date of expiration.String (date-time)

Cardholder Fees

Note this is an array of objects. One object will be returned for each fee.

NameDescriptionType
calculationTypeThe type of calculation use for the fee.
Possible values are: AMOUNT,PERCENT		String
nameFee name. For example: "Conversion Currency Fee".String
amountFee amount.Number
percentFee percentageNumber

Shown below are some different examples of information returned for different kinds of products:

{
    "clientProgramId": 43308603,
    "programName": "Virtual Prepaid Account",
    "programType": "DIGITAL",
    "currency": "USD",
    "products": [   
    { 
      "productImage": "https://d30xemkaawaj37.cloudfront.net/resized/default-virtual-disc-385x245.png",
      "valueRestrictions":
	    {
         "minimum": 0,
         "maximum": 1000
      },
      "expirationDescription": "3 months",
      "expiration":
	    {
         "type": "ROLLING",
         "numberOfMonths": 3
      },
      "cardholderFees":
	    [{
         "calculationType": "PERCENT",
         "name": "Conversion Currency Fee",
         "percent": 2
       },
       {
         "calculationType": "AMOUNT",
         "name": "Cardholder Replacement Fee",
         "amount": 15
       },
       {
         "calculationType": "AMOUNT",
         "name": "Virtual Conversion Cardholder Fee",
         "amount": 3
       },
       {
         "calculationType": "AMOUNT",
         "name": "Expedited Delivery Fee",
         "amount": 20
       }]
   }]
}
{
   "clientProgramId": 95005262,
   "programName": "egift",
   "programType": "DIGITAL",
   "currency": "USD",
   "products":    [
            {
         "contentProviderCode": "Barnes&NobleFRC_USD_en_eGift",
         "productName": "Barnes & Noble eGift FRC",
         "productDescription": "Choose from an incredible selection of books, NOOK Booksâ„¢, toys, games, music, and movies.  Can also be redeemed for NOOK devices and accessories.",
         "parentBrandName": "Barnes & Noble",
         "redemptionInfo": "In store and onlinePrint out this email. Make sure it includes the eGift Card number and PIN. Give this print-out to your cashier.How to Redeem Online for NOOK Books™:  Save your Barnes & Noble eGift Card to your account by clicking the Manage Gift Cards for NOOK Books™ link on your account page. Shop the NOOK Book Store and click “Buy Now† to purchase the NOOK Book™ of your choice. Any available Gift Card or eGift Card balance will be automatically redeemed first, and your default credit card will be charged for the remaining balance, if any. \n\nFor Products other than NOOK Books™:\nVisit BN.com. Shop the BN.com site, select your items, and add them to your Shopping Cart.\nProceed to Checkout.  Enter your Barnes & Noble eGift Card number and PIN in the spaces provided on the Payment page. Submit your order.",
         "termsAndConditions":          {
            "type": "INLINE",
            "text": "Barnes & Noble Gift Cards can be used at any Barnes & Noble store nationwide and at BN.com (www.bn.com). They can also be used at any Barnes & Noble College location. Maintenance, dormancy or service fees do not apply to balances on Gift Cards. Gift Cards have no expiration dates. Barnes & Noble Gift Cards may be used to purchase annual memberships in the Barnes & Noble Membership program (continuous billing memberships require a valid credit card).   Barnes & Noble Gift Cards will not be replaced if lost or stolen.  Barnes & Noble Gift Cards will not be exchangeable for cash except where required by law.  Barnes & Noble Gift Cards are issued by Barnes & Noble Marketing Services LLC.  Other conditions may apply. See www.bn.com and the back of a Barnes & Noble Gift Card for details."
         },
         "productImage": "https://content.blackhawknetwork.com/gcmimages/product/xlarge/79158.png",
         "logoImage": "https://content.blackhawknetwork.com/gcmimages/manufacturer/xsmall/PL00103703.jpg",
         "valueRestrictions":          {
            "minimum": 15,
            "maximum": 500
         },
         "offFaceDiscountPercent": 0,
         "locale": "EN"
      },
            {
         "contentProviderCode": "BuffaloWildWingsFRC_USD_en_eGift",
         "productName": "Buffalo Wild Wings eGift FRC",
         "productDescription": "Buffalo Wild Wings® is a sports bar with beer and wings and a crazy amount of TVs showing all the games. And rowdy fans and all the sauces for all the wings. Did we mention beer? Because we pour more beer than anyone in the country. So bring your friends, your outside voice and cheer on your favorite team to victory at any of our 1,200+ locations nationwide. Why aren’t you here already? www.buffalowildwings.com",
         "parentBrandName": "Buffalo Wild Wings®",
         "redemptionInfo": "In-store and Online<ol><li>Print this page.<\/li><li>Bring it to any Buffalo Wild Wings in the U.S.<\/li><li>Present it to your server at the time of payment.<\/li><\/ol>Select \"PAY WITH GIFT CARD\" as your Payment Method - up to two gift cards can be applied and only cards with an 8-Digit PIN can be used.Manually key-in the 16-digit gift card number and PIN (for cards with PIN).Select \"PAY WITH GIFT CARD\" as your Payment Method - up to two gift cards can be applied and only cards with an 8-Digit PIN can be used.",
         "termsAndConditions":          {
            "type": "INLINE",
            "text": "This Card never expires and there are no fees. To get your Card balance, visit buffalowildwings.com. Purchase, use or acceptance of this Card constitutes acceptance of these Terms. This Card is redeemable up to the balance for food, product, beverage or alcohol (where permitted by law) at participating Buffalo Wild Wings locations in the U.S. This Card is not redeemable for cash or refundable unless required by law. It is not reloadable or usable to purchase gift cards. Blazin Wings, Inc. is the Card issuer and sole obligor to Card owner, and may delegate its issuer obligations to an assignee, without recourse. If delegated, the assignee, and not Blazin Wings, Inc. will be sole obligor to Card owner. This Card may not be resold without authorization; Blazin Wings, Inc. has the right to deactivate or reject Cards sold by unauthorized sellers or Cards involved in fraudulent activity. This Card is not a debit or credit card. It will not be replaced if lost, stolen, damaged or used without authorization. Other Terms apply, visit: buffalowildwings.com. TM & © 2021 Buffalo Wild Wings, Inc."
         },
         "productImage": "https://content.blackhawknetwork.com/gcmimages/product/xlarge/75610.png",
         "logoImage": "https://content.blackhawknetwork.com/gcmimages/manufacturer/xsmall/VG6YL5ZQ93Z7LMZWRTSBXJJPWC_null_0929202219:30:01.PNG",
         "valueRestrictions":          {
            "minimum": 5,
            "maximum": 200
         },
         "offFaceDiscountPercent": 0,
         "locale": "EN"
      },

{
   "clientProgramId": 13066088,
   "programName": "Park and Company Reloadable Visa",
   "programType": "PHYSICAL",
   "currency": "USD",
   "products": [   {
      "productImage": "https://d30rrwwq6cckt4.cloudfront.net/resized/53ef8db0-ae9e-40a4-9c25-00c945bb5b22-385x245.png",
      "valueRestrictions":       {
         "minimum": 0,
         "maximum": 0,
         "exclusivelyAllowedValues": []
      },
      "expirationDescription": "2020-06-30",
      "expiration":       {
         "type": "STATIC",
         "date": "2020-06-30"
      },
      "cardholderFees":       [
                  {
            "calculationType": "AMOUNT",
            "name": "Monthly Maintenance Fee",
            "amount": 2.5
         },
                  {
            "calculationType": "AMOUNT",
            "name": "Check Refund Fee",
            "amount": 0
         },
                  {
            "calculationType": "AMOUNT",
            "name": "Card Refund Fee",
            "amount": 15
         },
                  {
            "calculationType": "PERCENT",
            "name": "Conversion Currency Fee",
            "percent": 2
         },
                  {
            "calculationType": "AMOUNT",
            "name": "Expedited Delivery Fee",
            "amount": 20
         }
      ]
   }]
}
{
   "clientProgramId": 95006871,
   "programName": "Create new AOD Cp",
   "programType": "PHYSICAL",
   "currency": "USD",
   "products":    [
            {
         "contentProviderCode": "Aeropostale",
         "productName": "Aeropostale Gift Card",
         "productDescription": "Aéropostale is a specialty retailer of casual apparel and accessories, principally targeting 16 to 22 year-old young women and men through its Aéropostale stores and online at www.aeropostale.com.",
         "parentBrandName": "Aéropostale",
         "redemptionInfo": "Retail stores located nationwideRefer to www.aeropostale.com for instructions.Refer to www.aeropostale.com for instructions.",
         "termsAndConditions":          {
            "type": "INLINE",
            "text": "This card may be used at any Aéropostale store in the US and Puerto Rico , or online at www.aeropostale.com.  For card balance please call 1-800-832-0656 or visit any Aéropostale store.  This gift card is issued by Aero GC Mgmt LLC.This card may be used at any Aéropostale store in the US and Puerto Rico , or online at www.aeropostale.com.  For card balance please call 1-800-832-0656 or visit any Aéropostale store.  This gift card is issued by Aero GC Mgmt LLC.This card may be used at any Aéropostale store in the US and Puerto Rico , or online at www.aeropostale.com.  For card balance please call 1-800-832-0656 or visit any Aéropostale store.  This gift card is issued by Aero GC Mgmt LLC."
         },
         "productImage": "https://d29xemkaawaj37.cloudfront.net/resized/egift_112953-385x245.png",
         "logoImage": "https://content.blackhawknetwork.com/gcmimages/manufacturer/xsmall/PL00103649.jpg",
         "valueRestrictions":          {
            "minimum": 15,
            "maximum": 500
         },
         "offFaceDiscountPercent": 0,
         "locale": "EN"
      },
            {
         "contentProviderCode": "AIRBNB",
         "productName": "Airbnb Gift Card",
         "productDescription": "Amazing places to stay and things to do, all around the world.",
         "parentBrandName": "Airbnb",
         "redemptionInfo": "<p>Here’s how to redeem your gift:\n<\/p><ol>\n  <li>Sign up or log in at  <a href=https://www.airbnb.com/gift target=\"_blank\">airbnb.com/gift<\/a><\/li>\n  <li>Follow the on-screen prompts<\/li>\n  <li>We’ll automatically apply the credit when you book<\/li>\n<\/ol>\n\n<p><\/p>",
         "termsAndConditions":          {
            "type": "INLINE",
            "text": "Card balance does not expire. No fees apply to purchase/activation of Card. Redeemable by residents of the U.S., not including U.S. territories and possessions, for goods and services on airbnb.com only. Card cannot be reloaded, resold, transferred for value, refunded or redeemed for cash, except as required by law. Safeguard this Card like cash; issuer not responsible for lost, damaged or stolen cards, or unauthorized use. Issued by Airbnb Gift Card Services, LLC. Terms apply and are subject to change without notice; visit  <a href=https://www.airbnb.com/terms/gift_cards target=\"_blank\">airbnb.com/terms/gift_cards<\/a> for current terms."
         },
         "productImage": "https://content.blackhawknetwork.com/gcmimages/product/xlarge/1015558.png?dt=1648222108258",
         "logoImage": "https://content.blackhawknetwork.com/gcmimages/manufacturer/xsmall/7993LLJC3GJHS5LWWK3Q410M5C-en_US.jpeg?dt=1638831039506",
         "valueRestrictions":          {
            "minimum": 25,
            "maximum": 500
         },
         "offFaceDiscountPercent": 0,
         "locale": "EN"
      },
            {
         "contentProviderCode": "1800Flowerscom",
         "productName": "1800Flowers.com Gift Card",
         "productDescription": "1-800-Flowers and their family of brands offers a wide selection of flowers, gift baskets and specialty items to help deliver smiles!",
         "parentBrandName": "1800 flowers.com",
         "redemptionInfo": "To use the Gift Cards and Promotional Offers, present them at the time of payment. You will  be required to supply the PIN number that came with your Gift Card. If you do not have your PIN, please contact our toll-free number 1-800-993-1192.",
         "termsAndConditions":          {
            "type": "INLINE",
            "text": "The Gift Card and Gift Certificate is a prepaid payment device that comes with a set dollar value. It is not a credit card, charge card or debit card. The Gift Card and Gift Certificate has no associated service or dormancy fees and no expiration date. The Gift Card and Gift Certificate can be used at the brands, the company owned and participating franchised retail stores, web sites and on phone orders, as listed at www.FreshGift.com <http://www.freshgift.com/> . We reserve the right to require credit card or alternate non-promotional payment method information for verification purposes, even if the Gift Card or Gift Certificate fully covers the transaction order total. We do not allow the purchase of a Gift Card with another Gift Card, Gift Certificate, Savings Pass, Appreciation Award, Award Card, or Rewards Pass. Your 19-digit Gift Card may become redeemable at additional brands and locations, which information will be updated on this page. The Gift Card and Gift Certificates may only be used to purchase products and services and may not be redeemed for cash, unless otherwise prohibited by law. The Gift Cards and Gift Certificates are not transferable and may not be used for unlawful purposes. Please visit www.freshgift.com http://www.freshgift.com/ or full terms and conditions.The Gift Card and Gift Certificate is a prepaid payment device that comes with a set dollar value. It is not a credit card, charge card or debit card. The Gift Card and Gift Certificate has no associated service or dormancy fees and no expiration date. The Gift Card and Gift Certificate can be used at the brands, the company owned and participating franchised retail stores, web sites and on phone orders, as listed at www.FreshGift.com <http://www.freshgift.com/> . We reserve the right to require credit card or alternate non-promotional payment method information for verification purposes, even if the Gift Card or Gift Certificate fully covers the transaction order total. We do not allow the purchase of a Gift Card with another Gift Card, Gift Certificate, Savings Pass, Appreciation Award, Award Card, or Rewards Pass. Your 19-digit Gift Card may become redeemable at additional brands and locations, which information will be updated on this page. The Gift Card and Gift Certificates may only be used to purchase products and services and may not be redeemed for cash, unless otherwise prohibited by law. The Gift Cards and Gift Certificates are not transferable and may not be used for unlawful purposes. Please visit www.freshgift.com http://www.freshgift.com/ or full terms and conditions.The Gift Card and Gift Certificate is a prepaid payment device that comes with a set dollar value. It is not a credit card, charge card or debit card. The Gift Card and Gift Certificate has no associated service or dormancy fees and no expiration date. The Gift Card and Gift Certificate can be used at the brands, the company owned and participating franchised retail stores, web sites and on phone orders, as listed at www.FreshGift.com <http://www.freshgift.com/> . We reserve the right to require credit card or alternate non-promotional payment method information for verification purposes, even if the Gift Card or Gift Certificate fully covers the transaction order total. We do not allow the purchase of a Gift Card with another Gift Card, Gift Certificate, Savings Pass, Appreciation Award, Award Card, or Rewards Pass. Your 19-digit Gift Card may become redeemable at additional brands and locations, which information will be updated on this page. The Gift Card and Gift Certificates may only be used to purchase products and services and may not be redeemed for cash, unless otherwise prohibited by law. The Gift Cards and Gift Certificates are not transferable and may not be used for unlawful purposes. Please visit www.freshgift.com http://www.freshgift.com/ or full terms and conditions."
         },
         "productImage": "https://d29xemkaawaj37.cloudfront.net/resized/egift_112961-385x245.png",
         "logoImage": "https://content.blackhawknetwork.com/gcmimages/manufacturer/xsmall/DXXJQXXQHKJV7FNN07FLQP0FH0_0906202323:16:46.PNG",
         "valueRestrictions":          {
            "minimum": 15,
            "maximum": 500
         },
         "offFaceDiscountPercent": 0,
         "locale": "EN"
      }
   ]
}

Calling the Catalog API by Sub Organization ID

To call the Catalog API by Sub Organization ID we will be using /clientProgramsBySubOrg.

MethodService NameService Type
GETclientProgramsBySubOrg → ExploreSynchronous

From our application, when calling /clientProgramsBySubOrg, we need to send the following parameters in the HTTP header.

ParameterDescriptionTypeRequired
MerchantIdThe Merchant ID (MID) is a string identifier issued by BHN to each merchant for billing purposes.StringYes
RequestIdA unique identifier for each order provided by you (the caller). The requestId value must be unique for each request and can have a maximum of 50 characters.StringYes
Accept

This should be set to the following string to ensure all characters are correctly encoded in the response:

Accept: application/json; charset=utf-8

StringNo

In our example we will be sending the following values in the header:

Content-Type: application/json
Accept: application/json; charset=utf-8
merchantId:1234
requestId:2019-08-16T16:41:00-0600

We will also need to send the subOrgId in the URL as follows:
https://api.certification.blackhawknetwork.com/rewardsCatalogProcessing/v1/clientProgramsBySubOrg?subOrgId=12345

The following HTTP status codes may be returned in the response header:

HTTP Status CodeMeaningNotes
200Operation CompleteThe query returned successfully.
4XXInvalid RequestCheck the JSON error response provided. In most cases you will find the request had missing information or was formatted improperly.
5XXSystem ErrorBlackhawk Network encountered an internal error trying to process your order. Reach out to your Account Manager for more information.

Assuming the query was successful a JSON object will be returned in the response containing the following information.

In our case, since we are querying by subOrgID the response is an array of client programs associated with the provided Sub Organization ID instead of just one program. Refer to the detailed object information in the Calling the Catalog API by Program section above.

Here is a sample JSON response when calling by subOrgID:

{
   "current": "https://api.certification.blackhawknetwork.com/rewardsCatalogProcessing/v1/clientProgramsBySubOrg",
   "totalCount": 10,
   "currentResults":    [
            {
         "clientProgramId": 95000309,
         "programName": "VISA Reload ATM ACH CK BT NO FEES Alternative FIS",
         "programType": "PHYSICAL",
         "currency": "USD",
         "products": [         {
            "productImage": "https://d29xemkaawaj37.cloudfront.net/resized/default-visa-385x245.png",
            "valueRestrictions":             {
               "minimum": 0,
               "maximum": 99999
            },
            "expirationDescription": "2027-06-01",
            "expiration":             {
               "type": "STATIC",
               "date": "2027-06-01"
            },
            "cardholderFees":             [
                              {
                  "calculationType": "AMOUNT",
                  "name": "ACH Transfer Fee",
                  "amount": 10
               },
                              {
                  "calculationType": "AMOUNT",
                  "name": "AME ATM Domestic Withdrawal Fee",
                  "amount": 1.75
               }
            ]
         }]
      },
      {
         "clientProgramId": 95000375,
         "programName": "Open Loop Visa Bulk ANO CC Standard Activation",
         "programType": "PHYSICAL",
         "currency": "USD",
         "products": [         {
            "productImage": "https://d29xemkaawaj37.cloudfront.net/resized/20190506201514_Executive Silver Visa-no denom-3-4 line.png-385x245.png",
            "valueRestrictions": {"minimum": 0},
            "expirationDescription": "5 months",
            "expiration":             {
               "type": "ROLLING",
               "numberOfMonths": 5
            },
            "cardholderFees":             [
                              {
                  "calculationType": "AMOUNT",
                  "name": "Expedited Replacement Fee $20.00",
                  "amount": 20
               },
                              {
                  "calculationType": "PERCENT",
                  "name": "Currency Conversion 2%",
                  "percent": 2
               },
                              {
                  "calculationType": "AMOUNT",
                  "name": "Replace Card Fee $10",
                  "amount": 5
               }
            ]
         }]
      },
      {
         "clientProgramId": 95000383,
         "programName": "Promo Visa Bulk ANO - Data Validation-Activation Code",
         "programType": "PHYSICAL",
         "currency": "USD",
         "products": [         {
            "productImage": "https://d29xemkaawaj37.cloudfront.net/resized/20190506201514_Executive Silver Visa-no denom-3-4 line.png-385x245.png",
            "valueRestrictions": {"minimum": 0},
            "expirationDescription": "20 months",
            "expiration":             {
               "type": "ROLLING",
               "numberOfMonths": 20
            },
            "cardholderFees":             [
                              {
                  "calculationType": "PERCENT",
                  "name": "Currency Conversion 2%",
                  "percent": 2
               },
                              {
                  "calculationType": "AMOUNT",
                  "name": "Expedited Replacement Fee $20.00",
                  "amount": 20
               },
                              {
                  "calculationType": "AMOUNT",
                  "name": "Replace Card Fee $10",
                  "amount": 10
               }
            ]
         }]
      },
      {
         "clientProgramId": 95000402,
         "programName": "Visa Personalized Bulk no PID",
         "programType": "PHYSICAL",
         "currency": "USD",
         "products": [         {
            "productImage": "https://d29xemkaawaj37.cloudfront.net/resized/20190506201514_Executive Silver Visa-no denom-3-4 line.png-385x245.png",
            "valueRestrictions":             {
               "minimum": 1,
               "maximum": 2000
            },
            "expirationDescription": "23 months",
            "expiration":             {
               "type": "ROLLING",
               "numberOfMonths": 23
            },
            "cardholderFees":             [
                              {
                  "calculationType": "AMOUNT",
                  "name": "Replacement Fee $6.95 No Free",
                  "amount": 6.95
               },
                              {
                  "calculationType": "AMOUNT",
                  "name": "Expedited Replacement Fee $20.00",
                  "amount": 20
               },
                              {
                  "calculationType": "PERCENT",
                  "name": "Currency Conversion 2%",
                  "percent": 2
               }
            ]
         }]
      },
      {
         "clientProgramId": 95000403,
         "programName": "Visa Personalized Bulk - Client Supplied PID",
         "programType": "PHYSICAL",
         "currency": "USD",
         "products": [         {
            "productImage": "https://d29xemkaawaj37.cloudfront.net/resized/20190506201514_Executive Silver Visa-no denom-3-4 line.png-385x245.png",
            "valueRestrictions":             {
               "minimum": 0,
               "maximum": 0
            },
            "expirationDescription": "6 months",
            "expiration":             {
               "type": "ROLLING",
               "numberOfMonths": 6
            },
            "cardholderFees":             [
                              {
                  "calculationType": "PERCENT",
                  "name": "Currency Conversion 2%",
                  "percent": 2
               },
                              {
                  "calculationType": "AMOUNT",
                  "name": "Expedited Replacement Fee $20.00",
                  "amount": 20
               },
                              {
                  "calculationType": "AMOUNT",
                  "name": "Replacement Fee $6.95 No Free",
                  "amount": 6.95
               }
            ]
         }]
      },
      {
         "clientProgramId": 95000417,
         "programName": "Visa Personalized Individual - System Generated PID",
         "programType": "PHYSICAL",
         "currency": "USD",
         "products": [         {
            "productImage": "https://d29xemkaawaj37.cloudfront.net/resized/20190506201514_Executive Silver Visa-no denom-3-4 line.png-385x245.png",
            "valueRestrictions":             {
               "minimum": 1,
               "maximum": 2000
            },
            "expirationDescription": "12 months",
            "expiration":             {
               "type": "ROLLING",
               "numberOfMonths": 12
            },
            "cardholderFees":             [
                              {
                  "calculationType": "AMOUNT",
                  "name": "Expedited Replacement Fee $20.00",
                  "amount": 20
               },
                              {
                  "calculationType": "AMOUNT",
                  "name": "Replacement Fee $6.95 No Free",
                  "amount": 6.95
               },
                              {
                  "calculationType": "PERCENT",
                  "name": "Currency Conversion 2%",
                  "percent": 2
               }
            ]
         }]
      },
      {
         "clientProgramId": 95000422,
         "programName": "Visa PERS Individual Suppress Carrier Msg - Waive Shipping",
         "programType": "PHYSICAL",
         "currency": "USD",
         "products": [         {
            "productImage": "https://d29xemkaawaj37.cloudfront.net/resized/20190506201514_Executive Silver Visa-no denom-3-4 line.png-385x245.png",
            "valueRestrictions":             {
               "minimum": 1,
               "maximum": 2000
            },
            "expirationDescription": "22 months",
            "expiration":             {
               "type": "ROLLING",
               "numberOfMonths": 22
            },
            "cardholderFees":             [
                              {
                  "calculationType": "PERCENT",
                  "name": "Currency Conversion 2%",
                  "percent": 2
               },
                              {
                  "calculationType": "AMOUNT",
                  "name": "Replacement Fee $6.95 No Free",
                  "amount": 6.95
               },
                              {
                  "calculationType": "AMOUNT",
                  "name": "Expedited Replacement Fee $20.00",
                  "amount": 20
               }
            ]
         }]
      },
      {
         "clientProgramId": 95000436,
         "programName": "Bulk ANO Suppress 4th Line & Carrier Msg - No Defined Denom",
         "programType": "PHYSICAL",
         "currency": "USD",
         "products": [         {
            "productImage": "https://d29xemkaawaj37.cloudfront.net/resized/20190506201514_Executive Silver Visa-no denom-3-4 line.png-385x245.png",
            "valueRestrictions":             {
               "minimum": 0,
               "exclusivelyAllowedValues":                [
                  100,
                  25,
                  50,
                  75
               ]
            },
            "expirationDescription": "24 months",
            "expiration":             {
               "type": "ROLLING",
               "numberOfMonths": 24
            },
            "cardholderFees":             [
                              {
                  "calculationType": "AMOUNT",
                  "name": "Expedited Replacement Fee $20.00",
                  "amount": 20
               },
                              {
                  "calculationType": "PERCENT",
                  "name": "Currency Conversion 2%",
                  "percent": 2
               },
                              {
                  "calculationType": "AMOUNT",
                  "name": "Replace Card Fee $10",
                  "amount": 10
               }
            ]
         }]
      },
      {
         "clientProgramId": 95000461,
         "programName": "Bulk Anonymous Data Capture",
         "programType": "PHYSICAL",
         "currency": "USD",
         "products": [         {
            "productImage": "https://d29xemkaawaj37.cloudfront.net/resized/20190506201514_Executive Silver Visa-no denom-3-4 line.png-385x245.png",
            "valueRestrictions": {"minimum": 0},
            "expirationDescription": "18 months",
            "expiration":             {
               "type": "ROLLING",
               "numberOfMonths": 18
            },
            "cardholderFees":             [
                              {
                  "calculationType": "AMOUNT",
                  "name": "Replace Card Fee $10",
                  "amount": 10
               },
                              {
                  "calculationType": "AMOUNT",
                  "name": "Expedited Replacement Fee $20.00",
                  "amount": 20
               },
                              {
                  "calculationType": "PERCENT",
                  "name": "Currency Conversion 2%",
                  "percent": 2
               }
            ]
      },
         }]
      {
         "clientProgramId": 95000465,
         "programName": "Personalized Ind Credit Card - Client Supplied PID",
         "programType": "PHYSICAL",
         "currency": "USD",
         "products": [         {
            "productImage": "https://d29xemkaawaj37.cloudfront.net/resized/default-mc-385x245.png",
            "valueRestrictions":             {
               "minimum": 1,
               "maximum": 75000
            },
            "expirationDescription": "24 months",
            "expiration":             {
               "type": "ROLLING",
               "numberOfMonths": 24
            },
            "cardholderFees":             [
                              {
                  "calculationType": "AMOUNT",
                  "name": "Replace Card Fee $10",
                  "amount": 10
               },
                              {
                  "calculationType": "AMOUNT",
                  "name": "Expedited Replacement Fee $20.00",
                  "amount": 20
               },
                              {
                  "calculationType": "PERCENT",
                  "name": "Currency Conversion 2%",
                  "percent": 2
               },
                              {
                  "calculationType": "AMOUNT",
                  "name": "Replacement Fee $6.95",
                  "amount": 6.95
               }
            ]
         }]
      }
   ]
}

Updated 2 months ago

What’s Next

Developer Agreement

Note: You will not be able to click "I Agree" until you have reached the bottom of this agreement.

This Developer Agreement (“Agreement”) is an agreement between you and Blackhawk Network, Inc. (“Blackhawk”) that applies to your access to and use of Blackhawk Developer Central (“Developer Portal”) located at https://developer.blackhawknetwork.com and related application programming interfaces (API), sandbox environments, digital certificates, tools, materials and documentation made available by Blackhawk (collectively, including all updates and other modifications thereto, the “Blackhawk Developer Tools”). You must read, agree with and accept all of the terms and conditions contained in this Agreement. By registering for or accessing the Developer Portal, and/or using the Blackhawk Developer Tools, you or the entity that you represent acknowledge that you have read, understand and agree to be bound by this Agreement. If you do not agree to these terms and conditions, you may not access the Developer Portal or use the Blackhawk Developer Tools.

This Agreement and the Terms of Use apply to your access to and use of the Blackhawk Developer Tools. For clarity, the Developer Portal and Blackhawk Developer Tools are “Services” provided to you under the Terms of Use, or “Blackhawk Services”. In the event of any inconsistency between this Agreement and the Terms of Use, the terms of this Agreement will control. Blackhawk reserves the right, at our sole discretion, to change or modify portions of this Agreement at any time. If we do this, we will post the changes on this page. Any such changes will become effective once they are posted.

  1. License from Blackhawk. Subject to your full compliance with all of the terms and conditions of this Agreement and the Terms of Use, Blackhawk grants you a non-exclusive, revocable, non-sublicensable, nontransferable license to use and integrate the Blackhawk Developer Tools into your Application solely to test them in Blackhawk’s sandbox environment.
  2. Passwords, Credentials and Access. Blackhawk will provide (or you will be requested to establish) a password or other procedures for verifying that only designated personnel have access to Blackhawk Developer Tools. Blackhawk may provide you with unique confidential identification codes, credentials and certificates that enable you to use the Blackhawk Developer Tools. You may not share any such items with any third party without the prior written consent of Blackhawk, and you agree to notify Blackhawk immediately of any violation of your foregoing obligations. You are responsible for maintaining the security of your account, passwords, credentials, codes, certificates and other files, and for all uses of your account, and you are liable for all activities performed under your account or otherwise with your credentials, codes and certificates.
  3. Restrictions and Obligations. You may not use the Blackhawk Developer Tools for any purpose other than as expressly set forth herein without Blackhawk’s prior written consent, including without limitation to access Blackhawk user data or information without authorization or in any manner or for any purpose that violates any law or regulation or any right of any person (including but not limited to intellectual property rights or rights of privacy). You may not use the Blackhawk Developer Tools to build a product or service that is competitive with the Blackhawk Services, or engage in any practices that discriminate against or discourage the use of Blackhawk Services. In addition, you shall not use the Blackhawk Developer Tools or Blackhawk Services in connection with or to promote any Applications or other products, services, or materials that constitute, promote or are used for the purpose of dealing in: spyware, adware, or other malicious programs or code; counterfeit goods; items subject to U.S. embargo; unsolicited mass distribution of email; multi-level marketing proposals; hate materials; hacking/surveillance/interception/descrambling equipment; libelous, defamatory, obscene, pornographic, abusive or otherwise offensive content; prostitution; gambling; stolen products or items used for theft; fireworks, explosives, or hazardous materials; or weapons. Without limiting the foregoing, you shall not use the Blackhawk Developer Tools or Blackhawk Services for any illegal purpose. Except as expressly and unambiguously authorized under this Agreement, you may not (i) copy, rent, lease, sell, transfer, assign, sublicense, disassemble, reverse engineer or decompile (except to the limited extent such restrictions are expressly prohibited by applicable statutory law), modify or alter any part of the Blackhawk Developer Tools or Blackhawk Services, or (ii) otherwise use the Blackhawk Developer Tools or Blackhawk Services on behalf of any third party.   You may not use any robot, spider, or other automatic device to create accounts for use of the Blackhawk Developer Tools and you will not take any action that imposes an unreasonable or disproportionately large load on Blackhawk’s infrastructure.
  4. Support; Other Conditions of Use. Blackhawk may provide you with support or modifications for the Blackhawk Developer Tools (collectively, “Support”) in its sole discretion. Blackhawk may terminate such Support at any time without notice to you. Blackhawk may change, suspend, or discontinue any aspect of the Blackhawk Developer Tools, at any time, including the availability of any APIs. Blackhawk may release subsequent versions of APIs, and you may be required to use those subsequent versions. Blackhawk may also impose limits on certain features and services or restrict your access to parts of or all of the Blackhawk Developer Tools without notice or liability. Your networks, operating systems, software, web server(s), routers, databases and other computer systems must be properly configured to Internet industry standards, as required to securely operate your Application.
  5. Sandbox Environment; Data. You may use the sandbox environment provided as part of the Blackhawk Developer Tools (“Sandbox”) in order to test the Blackhawk Services. If you access the Sandbox with a digital certificate provided by Blackhawk, your use of the Sandbox and any data or information you input into the Sandbox will be available only to users that access the Developer Portal with your account. Important: If you access the Sandbox without a digital certificate provided by Blackhawk, your use of the Sandbox, and any data or information that you input into the Sandbox, will be available to all users that access the Developer Portal. You may only use anonymous, non-live data and you may not enter any confidential, sensitive or personally identifiable information into the Sandbox. Data and other information provided to or made available in the Sandbox is not encrypted. Blackhawk will have no responsibility or liability for any information you enter into the Sandbox, or otherwise from your use of the Sandbox. You are fully responsible for the security of any data or information you provide in connection with the Developer Portal, and you must comply with all applicable laws and rules in connection with your provision and use of such data and information.
  6. Proprietary Rights. As between you and Blackhawk, the Blackhawk Developer Tools, Blackhawk Services and all intellectual property rights therein are and shall at all times remain the sole and exclusive property of Blackhawk and are protected by applicable intellectual property laws and treaties. As between you and Blackhawk, your Application and all intellectual property rights therein (but excluding any Blackhawk intellectual property therein) are and shall at all times remain your sole and exclusive property. You acknowledge and agree that any questions, comments, suggestions, ideas, feedback or other information about the Blackhawk Developer Tools or Blackhawk Services (“Submissions”), provided by you to Blackhawk are voluntary, non-confidential and Blackhawk will be entitled to the unrestricted use and dissemination of these Submissions for any purpose, commercial or otherwise, without acknowledgment or compensation to you.
  7. Trademarks. This Agreement does not include any right for you to use any trademark, service mark, trade name or any other mark of Blackhawk or any other party or licensor. You agree that Blackhawk may list your name and/or your Application (including by displaying any trademarks related thereto) and identify the business relationship between the parties on Blackhawk’s websites, the Blackhawk Services and in other marketing and advertising collateral. No rights or licenses are granted except as expressly and unambiguously set forth herein.
  8. Confidentiality. “Confidential Information” means all information related to the Developer Portal, including but not limited to the following: (i) any information you receive or enter via the Blackhawk Developer Tools (including the sandbox environment), (ii) the Blackhawk Developer Tools and all related information and materials, including without limitation API credentials and all access IDs and passwords, (iii) all information disclosed in writing and marked “confidential”, proprietary,” or with a substantially similar marking, (iv) all information disclosed orally and identified as confidential at the time of the disclosure, and (v) any other information that by its nature you understand or would reasonably be expected to understand to be Blackhawk’s confidential information. You must maintain Blackhawk’s Confidential Information in confidence and must not disclose it to third parties or use it for any purpose other than as necessary and required to develop your Application as permitted herein. In the event that Confidential Information is required to be disclosed by a court, government agency, regulatory requirement, or similar disclosure requirement, you shall immediately notify Blackhawk and use reasonable efforts to obtain confidential treatment or a protection order of any disclosed Confidential Information. Your obligations hereunder shall survive the termination of this Agreement. You acknowledge that monetary damages may not be a sufficient remedy for unauthorized use or disclosure of Confidential Information and that Blackhawk will be entitled (without waiving any other rights or remedies) to injunctive or equitable relief as may be deemed proper by a court of competent jurisdiction, without obligation to post any bond.
  9. Warranty Disclaimer. THE BLACKHAWK DEVELOPER TOOLS AND BLACKHAWK SERVICES ARE PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND. BLACKHAWK AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY, REGARDING THE BLACKHAWK DEVELOPER TOOLS AND BLACKHAWK SERVICES, INCLUDING WITHOUT LIMITATION ANY AND ALL IMPLIED WARRANTIES OF MERCHANTABILITY, ACCURACY, RESULTS OF USE, RELIABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE, INTERFERENCE WITH QUIET ENJOYMENT, AND NON-INFRINGEMENT OF THIRD PARTY RIGHTS. FURTHER, BLACKHAWK DISCLAIMS ANY WARRANTY THAT YOUR USE OF THE BLACKHAWK DEVELOPER TOOLS OR BLACKHAWK SERVICES WILL BE UNINTERRUPTED OR ERROR FREE.
  10. Limitation of Liability. REGARDLESS OF WHETHER ANY REMEDY SET FORTH HEREIN FAILS OF ITS ESSENTIAL PURPOSE OR OTHERWISE, AND EXCEPT FOR BODILY INJURY, IN NO EVENT WILL BLACKHAWK OR ITS SUPPLIERS BE LIABLE TO YOU OR TO ANY THIRD PARTY UNDER ANY TORT, CONTRACT, NEGLIGENCE, STRICT LIABILITY OR OTHER LEGAL OR EQUITABLE THEORY FOR (A) ANY LOST PROFITS, LOST OR CORRUPTED DATA, COMPUTER FAILURE OR MALFUNCTION, INTERRUPTION OF BUSINESS, OR OTHER SPECIAL, INDIRECT, INCIDENTAL OR CONSEQUENTIAL DAMAGES OF ANY KIND ARISING OUT OF THE USE OR INABILITY TO USE THE BLACKHAWK DEVELOPER TOOLS OR BLACKHAWK SERVICES, EVEN IF BLACKHAWK HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS OR DAMAGES AND WHETHER OR NOT SUCH LOSS OR DAMAGES ARE FORESEEABLE, OR (B) ANY DAMAGES RELATING TO THE BLACKHAWK DEVELOPER TOOLS OR YOUR USE THEREOF. 
  11. Indemnification. You agree that Blackhawk shall have no liability whatsoever for any use you make of the Blackhawk Developer Tools or Blackhawk Services. You shall indemnify and hold harmless Blackhawk from any and all claims, damages, liabilities, costs and fees (including reasonable attorneys’ fees) arising from your Applications or otherwise from your use of the Blackhawk Developer Tools or Blackhawk Services, or your breach of this Agreement.
  12. Term and Termination. This Agreement shall continue until terminated as set forth in this Section. Either party may terminate this Agreement upon written notice to the other party at any time, for any reason, or for no reason including, but not limited to, if you violate any provision of this Agreement. Any termination of this Agreement shall also terminate the license(s) granted hereunder. Upon termination of this Agreement for any reason, you shall destroy and remove from all computers, hard drives, networks and other storage media all copies of the Blackhawk Developer Tools, and shall so certify to Blackhawk upon request that such actions have occurred. Sections 2, 3 and 6 through 13 and all accrued rights to payment (if any) shall survive termination of this Agreement.
  13. Government Use. If you are part of an agency, department, or other entity of the United States Government (“Government”), the use, duplication, reproduction, release, modification, disclosure or transfer of the Blackhawk Developer Tools are restricted in accordance with the Federal Acquisition Regulations as applied to civilian agencies and the Defense Federal Acquisition Regulation Supplement as applied to military agencies. The Blackhawk Developer Tools is a “commercial item,” “commercial computer software” and “commercial computer software documentation.” In accordance with such provisions, any use of the Blackhawk Developer Tools by the Government shall be governed solely by the terms of this Agreement.
  14. Export Controls. You shall comply with all export laws and restrictions and regulations of the Department of Commerce, the United States Department of Treasury Office of Foreign Assets Control (“OFAC”), or other United States or foreign agency or authority, and you shall not export, or allow the export or re-export of the Blackhawk Developer Tools or Blackhawk Services in violation of any such restrictions, laws or regulations. By accessing or using the Blackhawk Developer Tools, you agree to the foregoing and represent and warrant that you (and the organization you represent, if any) are not located in, under the control of, or a national or resident of any restricted country.
  15. Miscellaneous. Unless the parties have entered into a written amendment to this agreement that is signed by both parties regarding the Blackhawk Developer Tools or the Blackhawk Services, this Agreement constitutes the entire agreement between you and Blackhawk pertaining to the subject matter hereof, and supersedes any and all written or oral agreements with respect to such subject matter. This Agreement, and any disputes arising from or relating to the interpretation thereof, shall be governed by and construed under California law without reference to its conflict of laws principles or the United Nations Conventions on Contracts for the International Sale of Goods. Except to the extent otherwise elected by Blackhawk, any action or proceeding arising from or relating to this Agreement must be brought in a federal court in the Northern District of California or in state court in San Francisco County, California, and each party irrevocably submits to the jurisdiction and venue of any such court in any such action or proceeding. The prevailing party in any action arising out of this Agreement shall be entitled to an award of its costs and attorneys’ fees. If any provision of this Agreement is held to be unenforceable for any reason, such provision shall be reformed only to the extent necessary to make it enforceable. The failure of Blackhawk to act with respect to a breach of this Agreement by you or others does not constitute a waiver and shall not limit Blackhawk’s rights with respect to such breach or any subsequent breaches. This Agreement is personal to you and may not be assigned or transferred for any reason whatsoever without Blackhawk’s prior written consent and any action or conduct in violation of the foregoing shall be void and without effect. Blackhawk may freely transfer or assign this Agreement and delegate any of its obligations hereunder.