Frequently Asked Questions

Product Questions

What is a Client Program Number, a Quote ID or a Product ID?

This is the program identification number automatically assigned when a quote is created. It is an eight digit long number.

Note: Client Program Number, Quote ID and Product ID are different names for the same number.

How can I get my Client Program Number

Your account manager will provide details for your product setup and Client Program Number.

Is there a website that can be used to check orders and product details?

Yes, the Hawk Marketplace portal can be used to check order status and product details. Your account manager will be able to share the details with you on how to access the portal.

How many products can I add under one Client Program Number?

For open loop reward, gift or disbursement programs only one product can be added to a client program number. If more than one product is required, a separate client program number will be provided for each product.

For closed loop merchant digital and physical gift products multiple products can be added to a single client program number. When ordering the content provider code is used to specify which product you would like to order within the client program.

Connectivity Questions

How can I connect to the Hawk Marketplace pre-production and production environment?

Please work with your project manager to obtain a signed client certificate. Certificates are different for both pre-production and production environments.

What is the base URL for pre-production environment?

https://apipp.blackhawknetwork.com/rewardsOrderProcessing/v1

What is the base URL for production environment?

https://api.blackhawknetwork.com/rewardsOrderProcessing/v1

What SSL/TLS versions are supported for digital certificates?

TLSv1.2 and above.

Are digital certificates required for ordering via APIs?

Digital certificates are required in both pre-production and production environments and must be sent with every request.

Hawk Marketplace Portal

How can I get access to the Hawk Marketplace portal?

Your account manager will provide the credentials and URLs for the Hawk Marketplace portal.

What type of details can be checked on the Hawk Marketplace portal?

The Hawk Marketplace portal is useful for placing orders manually, checking the status of orders, seeing the product details, fees, merchants and discounts.

Technical Questions

What is a Merchant ID?

The Merchant ID (MID) is a string identifier, provided by your account manager that varies based on the product type you are ordering.

What is a Request ID?

The Request ID is a globally unique string identifier specified by your client application, to be used during reconciliation. Every request must have a unique Request ID.

What is the purpose of MillisecondsToWait?

The MillisecondsToWait HTTP header value indicates that how long your application is willing to wait for a response. A value of 0 milliseconds means that the transaction type will be processed asynchronously. The maximum value is 30000 (30 seconds). Different products and program types have different recommended best practice values for the millisecondsToWait parameter. Please consult with your implementation project manager to ensure you use the value recommended for your program and implementation type.

What is the purpose of SYNCHRONOUS_ONLY?

The SYNCHRONOUS_ONLY HTTP header only applies to real-time eGift orders. The purpose of this parameter is to specify if the behavior of the POST call will be asynchronous or synchronous.

If the value is true and order processing is not completed within the initial order request's millisecondsToWait time, then the order request will be cancelled.

If false is provided (or the header is omitted) the order request will continue to process after the millisecondsToWait period has expired and any reward URLs or codes will need to be retrieved separately by calling /eGiftBulkCodeRetrievalInfo/byKeys.

Does Blackhawk Network perform any maintenance to the API?

Blackhawk Network has a daily platform maintenance window from 11:00 PM - 3:00 AM Central Time. In most cases there will be little to no impact on the APIs during that period. However, your implementation should be built with enough resilience to handle potential downtime or additional latency.

Which API method is used for retrieving eGift card details?

GET - /eGiftBulkCodeRetrievalInfo/byKeys is the method for retrieving eGift card information by passing orderNumber or requestId and clientProgramNumber.

Is there an API for cancelling an order request?

Cancelling an order cannot be performed through the API. To cancel an order request, please notify your Account Manager and provide them with the order number.

Is there any method for checking order shipping status?

GET - /queryShippingInfo is the method used to get the shipping information by passing orderNumber, cardholderFirstName, cardholderLastName.

Which API method is used for retrieving virtual codes?

GET - /virtualCodeRetrievalInfo/byKeys is the method for retrieving virtual code information by passing orderNumber or requestId and clientProgramNumber.

Which API method is used to check my order status after submission?

GET - /orderInfo/byKeys is the method used to get the order information by passing orderNumber or requestId and clientProgramNumber

Do these API methods support an Asynchronous Service Model?

The ordering APIs are a hybrid synchronous-asynchronous model, where the response behavior may be either synchronous or asynchronous depending on current processing load, request complexity, and input from your client application. The MillisecondsToWait parameter is used to indicate how long the client application is willing to wait for a response.

A response object or error object (if the operation was unsuccessful) will be returned within that time frame. If the request is still in process after the time specified in the MillisecondsToWait parameter has been exceeded, the interaction becomes asynchronous, and a transactionId value is provided. All GET requests within Rewards Order Processing API are synchronous.

Learn More

What types of HTTP response codes API will return?

The following response codes may be returned from these APIs.

  • 200: Operation complete - Your request completed successfully, no further action is needed.
  • 201: Operation complete - Your request completed successfully, no further action is needed.
  • 202: Operation is in process - Your request is still in process. Check back later by making a GET request using the transaction id.
  • 400: Invalid Request - There was an error in the request. Check your request payload and retry with a new request id.
  • 409: Conflict - Usually this means you used a duplicate request id. Retry the request with a new request id.
  • 5XX: Gateway or service error - There is a temporary issue with the service or gateway. Please try again later.

Which characters are allowed for placing orders via API?

Allowed characters vary by field. Please refer to the appropriate order guide and specific field for more information.

Is it required to send email content using the API if we configure the content within Hawk Marketplace directly?

No, it is not required to send email content through the API. However, email content sent using the API will override what is configured within Hawk Marketplace.


Did this page help you?

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.