Volume Card Activation Request API
Introduction
The Volume Card Activation Request API allows you to request the activation of all cards within a given Order fulfilled via BHN Core Online Fulfillment Platform, aka Order Central. This is an asynchronous call. The Volume Card order Activation Status Request API will provide the status of the Volume Card Activation Request
Method | Service Name | Service Type |
---|---|---|
POST | VolumeOrderProcessing/v1/card/order/activationRequest | Asynchronous |
URI: https://api.blackhawknetwork.com/VolumeOrderProcessing/v1/card/order/activationRequest
Request Header Attributes
All three of the header attributes are optional
Name | Type | Required | Description |
---|---|---|---|
requestorId | String | N | A value defined by the client application that can be used to uniquely identify that client application. If the client application does not specify a value, a globally unique identifier will be filled in automatically. |
requestId | String | N | A value defined by the client application that can be used to uniquely identify that specific request from the client. This value should be set if the client application wants to take advantage of an idempotent operation on a service. |
previousAttempts | Integer | N | The number of times this same request has been attempted unsuccessfully before. A value that is greater than zero will cause the service to view this request as a retry attempt and it will be treated idempotently. |
Request Elements
Name | Type | Max Length | Required | Description |
---|---|---|---|---|
customerOrderId | Numeric string | 50 | Y | Customer-assigned order number from Card Order request, Partner Order Number. |
bhnOrderId | Numeric string | 50 | Y | Blackhawk-assigned order number from Card Order request, BHN Order ID |
Sample Request
{
"customerOrderId": "<customer assigned order number from Volume Card Order>",
"bhnOrderId": "<Blackhawk assigned order from Volume Card Order Acknowledgement>"
}
Response Elements
Name | Type | Description |
---|---|---|
href | URI | HREF to the activation request status URL |
Sample Response
{
"href": "/v2/card/order/activationRequest/{activationRequestId}"
}
Response Codes
HTTP Status Code | Status Code Description | Explanation |
---|---|---|
202 | Accepted | The request has been validated and accepted for processing. |
404 | Not found | The Card Order Number identified in the request does not exist. |
409 | Conflict | The request for activation cannot be processed due to the state of the Card Order Request. The Card Order must be in the "shipped" state. |
500 | Internal Server Error | A system failure occurred while processing the request. The Volume Card Order Activation Request can safely be repeated. |
504 | Internal Timeout | A system failed to process the request within the allowed time. The Volume Card Order Activation Request can safely be repeated. |
Updated 10 months ago