Card Holder Activation Request API

Introduction

This API allows the Client application to activate a single physical card fulfilled via BHN Core Online Fulfillment Platform, aka Order Central, using the card number and the activation code.

Method

Service Name

Service Type

GET

VolumeOrderProcessing/v1/card/transaction/cardHolderActivation

Synchronous

URI: https://api.blackhawknetwork.com/VolumeOrderProcessing/v1/card/transaction/cardHolderActivation

Request Header Attributes

All of these 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

cardNumber

Numeric string

19

Y

Card number from the physical card.

ActivationCode

Numeric string

4

Y

Activation code assigned to the card number

Sample Request

{
"cardNumber": "<full card number>",
"ActivationCode": "<card activation code>"
}

Response Elements

Name

Type

Description

status

String

Status of the Card Holder Activation

Request. Possible values are:

"ERROR","SUCCESS"

errors

Array of error information

errorCode

String

Corresponding error code about an error.

message

String

Detailed message about an error.

Sample Responses

{
"status": "SUCCESS"
}
{
"status": "ERROR"
"errors" : [
{
"errorCode": "",
"message": ""
}
]
}

Response Codes

HTTP response codes are used to indication the outcome of the request
This table shows the HTTP codes used to indicate the outcome of the request and their meanings

HTTP Status Code

Status Code Description

Comments

200

OK

The request has been validated and processed

404

Not found

The card identified in the request does not exist.

403

Forbidden

The request is not allowed. For example, the Card 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 Card Holder Order Activation Request can safely be repeated

504

Internal Timeout

A system failed to process the request within the allowed time.
The Card Holder Activation Request can safely be repeated.


Did this page help you?