Volume Card Order Activation Status Request API

Introduction

The Volume Card Activation Status Request API allows you to review the activation of all cards within a given Order fulfilled via BHN Core Online Fulfillment Platform, aka Order Central. The Activation Request ID from the from the Volume Card Activation Request API call is required to provide the current status of the volume activation request

Method

Service Name

Service Type

GET

VolumeOrderProcessing/v1/card/order/activationRequest

Synchronous

URI: https://api.blackhawknetwork.com/VolumeOrderProcessing/v1/card/order/activationRequest/{activationRequestId}

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

activationRequestId

GUID

26

Y

activationRequestId received from activationRequest API

Request Format

/v2/card/order/activationRequest/{activationRequestId}

Response Elements

Name

Type

Description

activationRequestState

String

State of the Volume Card Order Activation Request. Possible values are:

PENDING,IN_PROGRESS, COMPLETED

progressMessage

String

Description of progress. Format is %n of %n processed.

progressDatetime

ISO 8601 date time string

Date time at which progress message was updated. Date time is in PDT.

errors

array of error information

errorCode

String

See table below.

message

String

Description of the error.

Sample Response

{
    "activationRequestState": "IN_PROGRESS",
    "progressMessage": "50 of 5,000 processed",
    "progressDatetime": "2014-05-08T22:16:05Z"
}
{
    "activationRequestState": "COMPLETE",
    "progressMessage": "5,000 of 5,000 processed",
    "progressDatetime": "2014-05-08T23:17:35Z",
    "errors" : [
    {
        "errorCode": "",
        "message": ""
    }
    ], [
    {
        "errorCode": "",
        "message": ""
    }
    ]
}
200 OK
{
    "activationRequestState" : "COMPLETE",
    "progressMessage" : "5,000 of 5,000 processed",
    "progressDatetime" : "2014-05-08T23:17:35Z",
    "errors" : [ 
        {
            "errorCode" : "card.activation.failed",
            "message" : "Attempt to activate card number XXXXXXXXXXXX1234 failed. Card is void."
        }
    ], [
        {
            "errorCode" : "card.activation.saf",
            "message" : "Activation for card number XXXXXXXXXXXX2345 will be performed within 24 hours."
        }
    ]
}

Response Codes

HTTP Status Code

Status Code Description

Explanation

200

Accepted

The response includes the state of the Volume Card Order Activation Status Request.

404

Not found

The Card Order Number identified in the request does not exist.

403

Forbidden

The request is not allowed. For example the Volume Card Order Activation Request identified was not created by the company that is requesting resource.

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.


Did this page help you?