Glossary of Terms
Common PromoB2B Terms
These Blackhawk Network terms will be used frequently throughout the API documentation.
| Term | Definition | Example |
|---|---|---|
| Campaign | A promotional program with a fixed start and end date used to process and validate rebate and incentive submissions. | Park & Company Memorial Day Paint Sale for New Jersey. |
| Campaign Code | An alpha-numeric code identifying a single campaign and published publically. These codes can be assigned by Blackhawk Network following a standard pattern or can be provided by the client. Each campaign must have a unique code. | 19-83281 |
| Business Partner | In most cases this represents a single client. All campaigns are tied to a single business partner. | Park & Company |
| Business Partner ID (BPID) | A five digit number used as the primary key for a business partner. | 91247 |
| Sponsor | A sponsor is a business partner other than Blackhawk Network's client that is associated with the campaign. They may need reporting or may be involving in billing for the promotion. | Blackhawk Network |
Blackhawk Network Platforms
The following platforms may be referenced in this document. Not all of these platforms are available externally or can be accessed by clients.
| Term | Definition | Platform Access |
|---|---|---|
| PromoB2B (Hawk Redeem) | The PromoB2B platform is Blackhawk Network's rebate and incentives processing and validation platform. The platform consists of the Synergy backend processing and validation engine, and the Promocenter consumer facing front-end web platform. | Mixed |
| Synergy | The PromoB2B backend platform consisting of a central state processing engine with microservices for validation and communication services. | Blackhawk Network |
| Promocenter | A web based front-end platform allowing consumers to view campaigns, submit applications and track submissions for rebate and incentives programs. | Consumer Facing |
| Hawk Marketplace | The Blackhawk Network reward ordering and processing platform for digital and physical open loop prepaid cards and closed loop gift cards. | Client Facing |
| Customer Care | An internal Blackhawk Network platform used by the customer support team to view consumer submissions and make notes. | Blackhawk Network |
| Quickbase | Used by clients to provide Blackhawk Network campaign setup information. | Client Facing |
| QuickCare / Care Site | A Blackhawk Network platform used by client contacts to view consumer submissions and submit notes. | Client Facing |
| QuickTrack / Track Site | A website allowing consumers to track the status of their rebate submission. In the case a Promocenter site is used a separate track site is not provided. | Consumer Facing |
Submission Terms
| Term | Definition |
|---|---|
| Submission | An entry made against a campaign. Generally this is through a rebate application made via mail or made online through a Promocenter website. Submissions can also be created through the import of a data file. All submissions flow through states as defined in the Synergy state processing engine. Campaign, product and reward rules configured on the campaign are run on submissions to determine which states they will flow though and end in. |
| Valid Submission | Valid submissions have passed all validation rules and are considered qualifying. In most cases valid submissions will receive a reward. |
| Invalid Submission | Invalid submissions failed one or more of the validation rules for the campaign they were submitted to. Depending on the reason why the submission was determined not to be qualifying an invalid notification may be sent to the applicant (if configured). In the case the submission was missing proof of qualification (for example a receipt or UPC was not provided) it may be considered resubmittable and a resubmission may be made by the original applicant. |
| Resubmission | Applicants may provide missing qualifying information for a submission. Generally this is when they did not initially provide receipts or UPCs. Resubmissions can be sent by mail or in some cases may be completed through a Promocenter website. |
| Deduplication | The process of removing duplicate submissions. |
| Dup / Duplicate Submission | A result of deduplication, duplicate submissions (often referred to as dups) are non-qualifying submissions that should not receive a reward due to the program rules. For example the program may specific a household limit of 2 rebate submissions, or a limit of 1 submission per product type. Subsequent submissions that do not meet these rules will be considered duplicates. |
| Third Party Validation (TPV) | When a client or other third party is required to review and approve valid submissions before they can receive a reward. This is usually done by providing the client with a TPV file in a CSV format in which they can indicate if the submission is a PASS or FAIL. A common scenario where TPV is used is when submissions have to be verified to have a valid account with the client but the client does not want to provide an API or recurring file of account information to Blackhawk Network to validate. |
| Pending All Submission Data (PASD) | Used for programs that require additional information from a third party source before validation can be attempted. A common scenario would be purchase data from a client's POS system. No validation is performed on the submission until the data is received or until a predefined aging period has passed. |
| Product | The product, product line or product category the consumer purchased to qualify for the campaign. A single submission may be associated with multiple products. |
| Product Attribute | Product attributes are only associated with a specific product. For example if the submission is being made through a Promocenter different attributes may be collected depending on which product was selected. |
| Reward | The reward the submission qualifies for. For example this could be a prepaid card, gift card, check or merchandise reward. |
| Reward Rule(s) | Reward rules are used to determine which reward on the campaign the consumer qualifies for. For example: - If product = HVAC POD Carrier AND Price > 200 Then Reward="Park & Company $25 Visa Prepaid Card" - If product = HVAC POD Carrier AND Price > 500 Then Reward="Park & Company $50 Visa Prepaid Card" |
| Validation Rule(s) | Validation rules are used to determine if the submission is qualifying or non-qualifying. Submissions that qualify will be considered valid and will generally be processed for a reward based on the reward rules configured for the campaign. Submissions that do not qualify will be considered invalid. See Invalid Submission above.For Example: - Total Contract Amount >= 3000 - AccountNumber Length > 12 |
| Must Be Captured | Attributes marked as must be captured require a non-null value to create a submission. |
| Campaign Attribute | Campaign attributes are general attributes configured for the campaign. Usually attributes on a campaign become submission attributes when a submission is created as the campaign defines the requirements for the submission. |
| Submission Attribute | General attributes that are collected (or associated) with a submission regardless of the product selected. |
Reward Terms
| Term | Definition |
|---|---|
| Prepaid Card | A network branded open-loop card that is intended for general use. - Prepaid cards may be restricted to specific merchants or merchant types. - Prepaid cards issued by Blackhawk Network use the Visa, Mastercard or Discover networks. |
| Merchant Gift Card | A merchant branded gift card that can only be used at the issuing merchant and does not travel over a credit card processor network. For example: Best Buy, Applebees and Target are all merchant gift cards. |
| Closed Loop Card | See Merchant Gift Card. |
| Open Loop Card | See Prepaid Card. |
| Open Loop Gift Card | A network branded gift card that is intended for general use. Open Loop Gift Cards issued by Blackhawk Network use the Visa, Mastercard or Discover network. |
| Happy Cards | Similar to merchant gift cards these cards can only be used at the merchant locations identified on the card. However, unlike close loop merchant gift cards Blackhawk Network's original content Happy Cards can be used at multiple merchant locations. |
| Reloadable Prepaid Card | A reloadable prepaid card can have funds added multiple times after it has been issued. Reloadable prepaid cards from Blackhawk Network run on the Visa, Mastercard or Discover networks. |
| eGift | An eGift is an electronic version of a merchant gift card generally sent via email. |
| Virtual Prepaid Card | A virtual prepaid card is an electronic version of an open loop prepaid card. Information on how to access the card information is generally sent by email. Blackhawk Network Mastercard prepaid cards may be added to a digital wallet (Apple Pay, Samsung Pay and Google Pay are supported). |
Updated almost 4 years ago