GuidesAPI ExplorerFTP Reference
GuidesAPI Explorer
GuidesAPI ExplorerFTP ReferenceLog In

REST API Ordering Error Code Reference

Suggest Edits

This page can be used as a reference for error codes returned by the Hawk Marketplace Ordering APIs.

Sample Error Response

📘

The error response payload received may include an item number intended to specify which line the error occurred in, for this reason item numbers are not included the in the below documentation.

{"errors": [{
   "errorCode": "orderDetails.contentProvider.invalid",
   "message": "Item Number : 0. Content Provider Code is invalid for this program"
}]}

Error Code Reference

HTTP Status CodeError CodeError MessageApplies toError TypeError CauseWhat to doWhen can you retry the order?
400Card carrier messageThe card carrier message is invalid. Allowed characters are: a-z A-Z 0-9 ,[email protected]#$%^&*)(+:=;._-PhysicalData IssueThe card carrier message contains an invalid character.Verify the card carrier message.Immediately after correcting the order request.
400clientProgramNumber.expiredClient program expired. Cannot process request.AllClient ProgramThe Client Program expired. No order can be placed on this program.Contact your account manager with the quote you are using to verify it is correct.Contact your account manager with the quote you are using to verify it is correct.
400creditCardPaymentInformation.billingAddress.city.invalidInvalid city.AllPayment - Credit CardThe credit card billing address city contains an invalid character. Allowed characters are digits 0-9, alpha (a-z, A-Z), space, period, hyphen, and apostrophe.Verify the billing address city.Immediately after correcting the order request.
400creditCardPaymentInformation.billingAddress.country.invalidInvalid country.AllPayment - Credit CardThe credit card billing address country is invalid. You must use the three-character ISO code corresponding to the country name.Verify the billing address country.Immediately after correcting the order request.
400creditCardPaymentInformation.billingAddress.country.invalidOrder order credit card address country id is a required field.AllPayment - Credit CardThe credit card billing address country was not included in the request.Add the billing address country to the order request.Immediately after correcting the order request.
400creditCardPaymentInformation.billingAddress.invalidCredit card billing address does not match the one associated with the card.AllPayment - Credit CardThe credit card billing address does not match the one associated with the card.Verify the billing address.Immediately after correcting the order request.
400creditCardPaymentInformation.billingAddress.line1.invalidInvalid address line 1.AllPayment - Credit CardThe credit card billing address line 1 contains an invalid character. Allowed characters are digits 0-9, alpha (a-z, A-Z), space, period, comma, hyphen, forward slash (/), and apostrophe.Verify the billing address line 1.Immediately after correcting the order request.
400creditCardPaymentInformation.cardNumber.invalidInvalid credit card number.AllPayment - Credit CardThe credit card number is invalid.Verify the credit card number.Immediately after correcting the order request.
400creditCardPaymentInformation.cardType.invalidInvalid credit card type.AllPayment - Credit CardThe credit card type is invalid. Allowed types are: Visa, Mastercard, Discover, or American Express.Verify the card type to ensure it is one of the allowed types.Immediately after correcting the order request.
400creditCardPaymentInformation.declinedThe credit card has been declined. Contact your bank for more information.AllPayment - Credit CardThe credit card has been declined. Contact your bank for more information.Contact your bank to resolve the payment issue, or use a different card.Contact the card holder bank, once resolved retry.
400creditCardPaymentInformation.expirationMonth.invalidInvalid card expiration month.AllPayment - Credit CardThe credit card expiration month is invalid.Verify the card expiration month.Immediately after correcting the order request.
400creditCardPaymentInformation.expirationYear.invalidInvalid card expiration year.AllPayment - Credit CardThe credit card expiration year is invalid.Verify the card expiration year.Immediately after correcting the order request.
400creditCardPaymentInformation.invalidCredit card information is invalid.AllPayment - Credit CardThe credit card information is invalid.Verify the credit card information.Immediately after correcting the order request.
400creditCardPaymentInformation.processing.failedCredit card processing failed.AllPayment - Credit CardThere is an issue processing the credit card.Contact your bank to resolve the payment issue, or use a different card.Contact your bank for more information.
400creditCardPaymentInformation.requiredCredit card is required for this payment type.AllPayment - Credit CardThe credit card array is required when the credit card payment type is used.Either change the payment type, or add credit card information.Immediately after correcting the order request.
400creditCardPaymentInformation.requiredOrder credit card is required for this payment type.AllPayment - Credit CardThe client program is set to use the credit card payment type but credit card information was not provided.Either add credit card info, or contact account manager to have them adjust the program so it no longer requires credit card payments.Immediately after correcting the order request.
400eGiftBulk.order.not.foundEGift bulk order not found.eGift BulkThe order number passed to the eGiftBulkCodeRetrievalInfo API is invalid.You must use a completed order with a valid order number. If the problem continues, contact your account manager.Immediately after making a correction on their end.
400eGiftIndividual.order.cannot.be.viewedEGift individual order cannot be viewed.eGift IndividualeGift Individual orders send all order information to the recipient, so the eGiftBulkCodeRetrievalInfo API will not pull order information for the client.Use an eGift Bulk order number for the eGiftBulkCodeRetrievalInfo API.Do not retry with the order numbers submitted using individual API.
400input.json.mapping.errorUnable to map the request JSON to an entity.AllPayload ProblemThere is a problem with the JSON formatting. This error usually occurs if there is a closing bracket or comma missing in the request.Validate the JSON formatting of the request.Validate the JSON and retry immediately.
400order.clientProgramNumber.notReadyThe Client Program number is invalid.AllClient ProgramThe Client Program number is invalid for this order type.The program number being used doesn’t match the endpoint of the API URL. Contact your account manager with the quote you are using to verify it is correct.Immediately after correcting the order request.
400order.errorFailure fulfilling real time request.Real TimeBHN IssueThere was a downstream issue or timeout during the real-time order.Retry the request. If the problem continues, contact your account manager.Wait 5 minutes after retrying. If the order still fails, contact your account manager.
400order.errorInsufficient draw down funds for this order.AllPaymentThere are insufficient draw-down funds for this order.Contact your account manager to secure funds for your draw-down account.Once funds are secured, retry.
400order.errorThe real-time request cannot be processed at this time. Please contact 1-833-835-5030. Reference code VEL.Real TimeRiskYour order could not be processed at this time.First orders should not be real-time.Contact Blackhawk Network for risk review, or your account manager to change velocity limits.Immediately after correcting the order request, or after the account manager corrects velocity issues.
400order.errorUnable to fulfill - There is no inventory available for the specified eGift product, please contact your Account Manager.Closed Loop eGiftProductOut of inventoryContact your Account Manager.Do not retry the order.
400order.paymentType.invalidThe payment type selected is not allowed for this order.AllPaymentThe payment type listed in the POST request or set up for the program is invalid.Place the order with a different payment type, or contact the account manager to change the program's set payment type.Immediately after correcting the order request.
400orderDetails.amount.exceeds.maxAmountFace value exceeds.AllProductThe amount entered is greater than the face value of the card.Reduce the amount or contact your account manager if you have questions about the provider's max amount restrictions.Immediately after correcting the order request.
400orderDetails.amount.invalidAmount entered is invalid.AllProductAn invalid amount was sent in the order request.Verify the amount.Immediately after correcting the order request.
400orderDetails.amount.invalidFunding amount exceeds the maximum allowed for this product.AllProductAn amount greater than the maximum allowed for the product was sent in the order request.Call the Catalog API to see the minimum and maximum values for the product.Immediately after having the correct min and max values for the product.
400orderDetails.amount.invalidFunding amount is less than the required minimum for this product.AllProductAn amount less than the minimum amount allowed for the product was sent in the order request.Call the Catalog API to see the minimum and maximum values for the product.Immediately after having the correct min and max values for the product.
400orderDetails.amount.invalidThe funding amount does not match one of the standard denominations defined for the content provider.AllProductThe amount does not match the denomination provided by Content Provider.Call the Catalog API to see the standard denominations for the product.Immediately after having the correct denominations for the product.
400orderDetails.amount.requiredAmount is required.AllThe amount was not provided in the order request.The amount was not provided in the order request.Immediately after correcting the order request.
400orderDetails.ClientRef.id.uniqueDuplicate order exists with ClientRefNumber.AllThe Client Reference ID has already been used.Generate a unique Client Reference ID and resubmit the order.Immediately after generating an unique Client Reference ID.
400orderDetails.ClientRef.id.unique.sameOrderClientRefId must be unique.AllThe same Client Reference ID was used on two orders.Generate a unique Client Reference ID on each order line item and resubmit the order.Immediately after generating an unique Client Reference ID on each order line item.
400orderDetails.clientRefId.lengthClient Ref Id length text must be 30 characters or less.AllThe length of the Client Reference ID exceeds the maximum limit.The length of the Client Reference ID exceeds the maximum limit.Immediately after correcting the order request.
400orderDetails.contentProvider.invalidContent Provider Code is invalid for this program.Closed LoopThe Content Provider code does not match one available to the program.Review your content provider code and verify against that it is available to you. Contact your accout manager if the code needs to be added.Immediately after correcting the order request.
400orderDetails.contentProvider.lengthContent provider must be 118 characters or less.Closed LoopThe length of the Content Provider code is greater than 118 characters.Length of the content provider code was greater than 118 charactersImmediately after correcting the order request.
400orderDetails.contentProvider.notFoundContent Provider specified but not found.Closed LoopThe Content Provider is in the client's program, but is not found on Blackhawk's side.Contact your account manager with the error and the content provider for further research.reach out to account manager, once they fix the issue retry
400orderDetails.contentProvider.requiredItem Number : 0. Content Provider is required.Closed LoopThe Content Provider field was left blank when placing the order.Call the Catalog API to retreive the available content provider codes and send it in API order request.Immediately after having all the content provider codes from Catalog API.
400orderDetails.deliveryAddress.company.lengthCompany must be 35 characters or less.PhysicalThe length of the company exceeds the maximum limit.Reduce the length of the delivery address company.Immediately after correcting the order request.
400orderDetails.deliveryAddress.country.invalidDelivery address country is invalid.PhysicalAn invalid delivery address country was sent in the order request. Country must be the three-character ISO code corresponding to the country.Verify the delivery address country.Immediately after correcting the order request.
400orderDetails.deliveryAddress.country.requiredCountry is required.PhysicalThe delivery address country was not included in the order request.Add the delivery address country to the order request.Immediately after correcting the order request.
400orderDetails.deliveryAddress.line1.invalidShipment to a PO Box is not allowed.PhysicalThe client used a PO Box address which is not allowed.Provide a non-PO Box address bulk delivery address.Immediately after correcting the order request.
400orderDetails.deliveryAddress.postalCode.invalidDelivery address postal code is invalidPhysicalAn invalid delivery address postal code was sent in the order request.Verify the delivery address postal code.Immediately after correcting the order request.
400orderDetails.deliveryAddress.region.invalidRegion is invalidPhysicalThe delivery address region is not a valid state or province.Verify the delivery address region.Immediately after correcting the order request.
400orderDetails.deliveryAddress.region.requiredRegion is required.PhysicalThe delivery address region was not included in the order request.Add the delivery address region to the order request.Immediately after correcting the order request.
400orderDetails.deliveryAddress.requiredDelivery address is required.PhysicalThe delivery address was not included in the order request.Add the delivery address to the order request.Immediately after correcting the order request.
400orderDetails.description.lengthDescription must be 40 characters or less.AllThe description exceeds the maximum limit.Reduce the length of the order details description.Immediately after correcting the order request.
400orderDetails.emailContent.emailClosingName.requiredEmail closing name is required.eGift Individual. Virtual Individual.Email ConfigurationThe email closing name was not included in the order request.Add the order details email closing name to the order request.Immediately after correcting the order request.
400orderDetails.emailContent.message.requiredEmail message is required.eGift Individual. Virtual Individual.Email ConfigurationThe email message was not included in the order request.Add the order details email message to the order request.Immediately after correcting the order request.
400orderDetails.emailContent.senderEmail.invalidSenderEmail is not valid.eGift Individual. Virtual Individual.Email ConfigurationThe sender email contains an invalid email address.Verify the sender email.Immediately after correcting the order request.
400orderDetails.emailContent.senderName.requiredSender name may not be empty.eGift Individual. Virtual Individual.Email ConfigurationThe sender name was not included in the order request.Add the email content sender name to the order request.Immediately after correcting the order request.
400orderDetails.emailContent.subject.requiredSubject is required.eGift Individual. Virtual Individual.Email ConfigurationThe subject is a required field.Add the email content subject to the order request.Immediately after correcting the order request.
400orderDetails.emailContent.unsubscribeData.addressCity.requiredAddress city is required.eGift Individual. Virtual Individual.Email ConfigurationThe address city was not included in the order request.Add the unsubscribe data address city to the order request.Immediately after correcting the order request.
400orderDetails.emailContent.unsubscribeData.addressCountry.requiredAddress country is required and must be either UNITED STATES or CANADA.eGift Individual. Virtual Individual.Email ConfigurationThe address country was not included in the order request.Add the unsubscribe data address country to the order request.Immediately after correcting the order request.
400orderDetails.emailContent.unsubscribeData.addressLine1.requiredAddress line 1 is required.eGift Individual. Virtual Individual.Email ConfigurationThe address line 1 was not included in the order request.Add the unsubscribe data address line 1 to the order request.Immediately after correcting the order request.
400orderDetails.emailContent.unsubscribeData.addressState.requiredAddress state is required.eGift Individual. Virtual Individual.Email ConfigurationThe address state was not included in the order request.Add the unsubscribe data address state to the order request.Immediately after correcting the order request.
400orderDetails.emailContent.unsubscribeData.addressZip.requiredAddress zip is required.eGift Individual. Virtual Individual.Email ConfigurationThe address zipcode was not included in the order request.Add the unsubscribe data address zip to the order request.Immediately after correcting the order request.
400orderDetails.emailContent.unsubscribeData.companyName.requiredCompany is required.eGift Individual. Virtual Individual.Email ConfigurationThe company name was not included in the order request.Add the unsubscribe data company name to the order request.Immediately after correcting the order request.
400orderDetails.emailContent.unsubscribeData.value.invalidUnsubscribe value is invalid.eGift Individual. Virtual Individual.Email ConfigurationThe unsubscribe data value is invalid.Verify the unsubscribe data value.Immediately after correcting the order request.
400orderDetails.emailContent.unsubscribeData.value.lengthValue cannot exceed 255 characters.eGift Individual. Virtual Individual.Email ConfigurationThe unsubscribe data value exceeds the maximum limit.Reduce the length of the unsubscribe data value.Immediately after correcting the order request.
400orderDetails.empty.shippingaccountnumberThe same courierShippingAccountNumber must be passed for all line items that have the same shipping address.PhysicalSending the shipping account number in a request must be the same for each line. Each line has its own attribute for courier.Make sure the courier shipping account number is the same for each line item.Immediately after correcting the order request.
400orderDetails.expediteFulfillment.invalidInvalid value for expediteFulfillment in request. Valid values are true and falsePhysicalExpedite Fulfillment contains an invalid value. Allowed values are true or false.Either remove the attribute or choose true/false.
400orderDetails.invalid.bomidThe bomId provided is not valid for this sub-org.PhysicalClient ProgramReach out to the onboarding Program Manager or Account Specialist for your program.BOM ID wasn’t configured in sub-organization screen. The BOM ID actually has to exist in the shipping section. Product operations has to create the BOM ID first before it can be added in the sub-organization.Immediately after correcting the order request.
400orderDetails.invalid.shippingaccountnumberThe courierShippingAccountNumber provided is not valid for this sub-org or shipper.PhysicalClient ProgramThe correct courier shipping account number was not provided for the sub-organization or shipper used.Add the courier shipping account number to the program.Immediately after correcting the order request.
400orderDetails.manyLinesThere are too many lines to process in real time.Real TimeThere are too many line items to process in the real-time order. The quantity  must be 1 or less for real-time orders.Change the quantity of the order.Immediately after correcting the order request.
400orderDetails.no.shippingaccountnumberNo value provided for courierShippingAccountNumber.PhysicalNo value was provided for the courier shipping account number.Add a value to the courier shipping account number.Immediately after correcting the order request.
400orderDetails.notpresent.activation_codeActivation codes are not present. Client supplied activation codes are required for this program type.Physical Open LoopThe program or sub-organization is configured to require activation code and it was not included in the request.Either change the program/sub-organization to stop requiring activation code, or include the activation code in the request.Immediately after correcting the order request.
400orderDetails.quantity.exceedsTotal quantity exceeds the maximum quantity.Real TimeThere are too many line items to process in the real-time order. The quantity  must be 1 or less for real-time orders.Real-time orders must contain a quantity of 1 or less.Immediately after correcting the order request.
400orderDetails.quantity.invalidQuantity must be greater than 0.AllAn invalid quantity was sent in the order request.Verify the order details quantity.Immediately after correcting the order request.
400orderDetails.recipient.address.city.invalidCity is not valid.PhysicalThe recipient address city is invalid.Verify the recipient address city.Immediately after correcting the order request.
400orderDetails.recipient.address.city.lengthCity must be 35 characters or less.PhysicalThe length of the recipient address city exceeds the maximum limit.Reduce the length of the recipient address city.Immediately after correcting the order request.
400orderDetails.recipient.address.city.requiredCity is required.PhysicalThe recipient address city was not included in the in order request.Add the recipient address city to the order request.Immediately after correcting the order request.
400orderDetails.recipient.address.country.invalidCountry must be the 3 alphabetic ISO code corresponding to the country.PhysicalAn invalid recipient address country code was included in the order request.Add a valid country code.Immediately after correcting the order request.
400orderDetails.recipient.address.line1.lengthLine1 must be 35 characters or less.PhysicalThe length of recipient address line 1 exceeds the maximum limit.Reduce the length of the recipient address line 1.Immediately after correcting the order request.
400orderDetails.recipient.address.line1.requiredLine1 is required.PhysicalThe recipient address line 1 parameter was not included in the order request.Add the recipient address line 1 to the order request.Immediately after correcting the order request.
400orderDetails.recipient.address.line2.lengthLine2 must be 35 characters or less.PhysicalThe length of recipient address line 2 exceeds the maximum limit.Reduce the length of the recipient address line 2.Immediately after correcting the order request.
400orderDetails.recipient.address.line3.lengthLine3 must be 35 characters or less.PhysicalThe length of recipient address line 3 exceeds the maximum limit.Reduce the length of the recipient address line 3.Immediately after correcting the order request.
400orderDetails.recipient.address.postalCode.invalidPostal code is invalid.PhysicalThe recipient address postal code is either invalid or does not match the provided region or state.Verify the recipient address postal code.Immediately after correcting the order request.
400orderDetails.recipient.address.postalCode.lengthPostal code must be 10 characters or less.PhysicalThe length of the postal code is exceeds the maximum limit.Reduce the length of the recipient address postal code.Immediately after correcting the order request.
400orderDetails.recipient.address.postalCode.requiredPostal code is invalid.PhysicalThe recipient address postal code was not included in the in order request.Add the recipient address postal code to the order request.Immediately after correcting the order request.
400orderDetails.recipient.address.region.invalidState or region is invalid.PhysicalThe recipient address region is invalid.Verify the recipient address region.Immediately after correcting the order request.
400orderDetails.recipient.address.region.invalidRegion is invalid.PhysicalThe region abbreviation is invalid.Verify the recipient address region.Immediately after correcting the order request.
400orderDetails.recipient.address.region.lengthAddress region must be a valid 2-character uppercase abbreviation for a U.S. state or a Canadian province or contain an international region less than 36 characters.PhysicalThe length of the recipient address region exceeds the maximum limit.Reduce the length of the recipient address region.Immediately after correcting the order request.
400orderDetails.recipient.address.requiredRecipient address cannot be empty.PhysicalThe recipient address was not included in the order request.Add the recipient address to the order request.Immediately after correcting the order request.
400orderDetails.recipient.cardNumber.expiredThe instant issue card is expired.The instant issue card is expired.Submit a request for a new card to replace expired one.Immediately after correcting the order request.
400orderDetails.recipient.cardNumber.fundedThe instant issue card has already been funded.The instant issue card has already been funded.The instant issue card can only be loaded once. Change the PID to fund a different card.Immediately after correcting the order request.
400orderDetails.recipient.cardNumber.invalidCard number is not valid.The recipient card number entered in the order request is not valid.Verify the recipient card number.Immediately after correcting the order request.
400orderDetails.recipient.proxyNumber.invalidProxy number is not valid for the client program.The proxy number used either doesn’t exist or belongs to a different Program Number.Try a different proxy or verify that the Program Number is correct.Check the proxy value and correct, then resubmit
400orderDetails.recipient.proxyNumber.invalidProxy number is not valid for the product.The proxy number is invalid for the client program.Check the proxy value and correct, then resubmit.Immediately after correcting the order request.
400orderDetails.recipient.email.invalidEmail is not valid. Expecting standard format, which includes a period (.) and at symbol (@).The recipient email contains an invalid email address.Verify the recipient email.Immediately after correcting the order request.
400orderDetails.recipient.email.lengthEmail must be 50 characters or less.The length of the recipient email exceeds the maximum limit.Reduce the length of the recipient email.Immediately after correcting the order request.
400orderDetails.recipient.email.requiredEmail is required.The recipient email address was not included in the order request.Add the recipient email address to the order request.Immediately after correcting the order request.
400orderDetails.recipient.firstName.invalidFirst name is not valid.The recipient first name contains an invalid character.Verify the recipient first name.Immediately after correcting the order request.
400orderDetails.recipient.firstName.lengthFirst name must be 25 characters or less.Individual Merchant Gift CardThe recipient first name must be less than 25 characters.Reduce the length of the recipient first name.Immediately after correcting the order request.
400orderDetails.recipient.firstName.lengthFirst name must be 50 characters or less.Individual Virtual PrepaidThe recipient first name must be less than 50 characters.Reduce the length of the recipient first name.Immediately after correcting the order request.
400orderDetails.recipient.firstName.requiredFirst name is required.The recipient first name was not included in the order request.Add the recipient first name to the order request.Immediately after correcting the order request.
400orderDetails.recipient.id.doesNotExistRecipient id must match an existing card holder.The recipient ID used to add more funds to a card doesn't exist.Verify the recipient ID.Wait until an orginal card order successfully submitted.
400orderDetails.recipient.id.invalidId is not valid.The recipient ID contains an invalid character.Verify the recipient ID.Immediately after correcting the order request.
400orderDetails.recipient.id.lengthId must be 30 characters or less.The recipient ID must be 30 characters or less.Reduce the length of the recipient ID.Immediately after correcting the order request.
400orderDetails.recipient.id.not.foundRecipient id is not foundThe recipient ID used in the request was not found.Verify the recipient ID.Immediately with a valid recipient ID.
400orderDetails.recipient.id.requiredId is required.The recipient ID was not included in the order request.Add the recipient ID to the order request.Immediately after correcting the order request.
400orderDetails.recipient.id.uniqueRecipient id must be unique.A previous order submitted by the client contained the same recipient ID.Generate a unique recipient ID and resubmit the order.Immediately after generating an unique recipient ID.
400orderDetails.recipient.id.unique.sameOrderRecipient id must be unique.Same recipient ID was used on two order line items.Generate a unique recipient ID on each order line item and resubmit the order.Immediately after generating an unique recipient ID on each order line item.
400orderDetails.recipient.id.unique.sameOrderRecipient id must be unique.Two or more line items contain the same recipient ID.Verify the recipient IDs used and resubmit the order.Immediately after generating an unqiue recipient ID / PID
400orderDetails.recipient.lastName.invalidLast name is not valid.The recipient last name contains an invalid character.Verify the recipient last name.Immediately after correcting the order request.
400orderDetails.recipient.lastName.lengthLast name must be 25 characters or less.Individual Personalized Prepaid / Individual Merchant Gift CardThe recipient last name must 25 characters or less.Reduce the length of the recipient last name.Immediately after correcting the order request.
400orderDetails.recipient.lastName.lengthLast name must be 50 characters or less.Individual eGift / Individual VirtualThe recipient last name must 50 characters or less.Reduce the length of the recipient last name.Immediately after correcting the order request.
400orderDetails.recipient.lastName.requiredLast name is required.The recipient last name was not included in the order request.Add the recipient last name to the order request.Immediately after correcting the order request.
400orderDetails.recipient.phonenumber.invalidRecipient phone number is not valid.The recipient phone number contains an invalid character.Verify the recipient phone number.Immediately after correcting the order request.
400orderDetails.recipient.phonenumber.lengthRecipient phone number must be 10 numbers or more.The recipient phone number must be 10 or more digits.Verify the recipient phone number.Immediately after correcting the order request.
400orderDetails.recipient.prefix.invalidPrefix must be 5 characters or less. Available options are: Mr, Mrs, Miss, Ms or blank.The recipient prefix was contains an invalid character or value.Either remove the prefix, or use one of the options in the error code.Immediately after correcting the order request.
400orderDetails.recipient.requiredRecipient is required.The recipient information was not included in the order request.Add the recipient information to the order request.Immediately after correcting the order request.
400orderDetails.recipient.suffix.lengthSuffix must be 5 characters or less.Data IssueThe recipient suffix must be 5 characters or less.Reduce the length of the recipient suffix.Immediately after correcting the order request.
400orderDetails.shippingMethod.invalidShipping Method is invalid for this order.The shipping method contains a value that is not valid for the program.Reach out to the Account Specialist for help with this issue.Immediately after correcting the order request.
400orderDetails.shippingMethod.uniqueShippingMethod must match for all order line items with a single delivery address.If there are multiple line items for a single order, the shipping method must be the same for each instance.Review the recipient's in the order and verify any repeats have the same shipping method. Or break the line items into separate ordersImmediately after correcting the order request.
400orderDetails.thirdPartyInfo.address.postalCode.requiredPostal code is required.End Client InformationThe third-party postalCode was not included in the order request.Add the third-party postal code to the order request.Immediately after correcting the order request.
400orderDetails.thirdPartyInfo.address.zip.invalidPostal or zip code is invalid.End Client InformationThe third-party postal code contains an invalid character.Verify the third-party postal code.Immediately after correcting the order request.
400orderDetails.thirdPartyInfo.invalidInvalid third party information.End Client InformationThe third-party information contains an invalid character or value.Verify the third-party information.Immediately after correcting the order request.
400orderDetails.thirdPartyInfo.requiredThird party is required for this order.End Client InformationThe third-party information was not included in the order request.If your program does not have third-party information automatically assigned, then it needs to be included with your post request. Contact the account manager to have it permanently added.Submit new order once the account manager has indicated it is ready.
400paymentTypePayment type is required for this order type.PaymentThe payment type was not included in the order request.Add the payment type to the order request.Immediately after correcting the order request.
400paymentType.invalidPayment type [PaymentType] does not support expedited orders.PaymentThe payment type does not support expedited shipping.Either choose a payment type that does support expedited orders, or change the shipping typeImmediately after correcting the order request.
400paymentType.invalidPayment type is not valid for the client program.PaymentThe payment type selected is valid but has not been added to the client program.Either try another payment type or contact the account manager and have the current payment type added to the program.Immediately after correcting the order request.
400requestId.uniqueRequest id must be unique and not more than 50 char.The requestId must be unique and not more than 50 characters.Verify that the request ID in the header is no more than 50 characters, and is incremented correctly.Immediately after correcting the order request.
400service.errorAn error has occurred and your order has not been submitted.  Please contact your Account Specialist.Many things can cause this error. Allow engineering to review your request information.Contact your account manager with the URL, request headers, and request body.Do not retry until given the go ahead from your account manager.
400service.errorItem Number : [Item Number]. An error has occurred and your order has not been submitted.  Please contact your Account Specialist.Many things can cause this error. Allow engineering to review your request information.Contact your account manager with the URL, request headers, and request body.Resubmit once the account manager has replied to you.
400SYNCHRONOUS_ONLYSynchronous only is invalid for this client program.The synchronous-only parameter was sent with an Open Loop Virtual product order. Open Loop Virtual does not support synchronous-only.Synchronous-only is only available for real-time APIs of the Closed Loop eGift product.Do not retry unless using a Closed Loop eGift product.
504timed.outOrder is cancelled due to failure to meet SLA for this SYNCHRONOUS_ONLY order.The synchronous-only order was not successfully completed within the provided millisecondsToWait time specified in the order request header.This error can happen because of a heavy system load or a delay with a downstream merchant or provider.Wait at least 15 seconds before retrying (if desired).
409transaction.processing.create.conflictThe transaction already exists.The request ID in the header is not unique.Make sure the request ID is incremented correctly with each order regardless of POST success.Immediately after correcting the order request.

Updated 2 months ago

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.