Activate a Card

Introduction

The activate call will, given a proxy number and expiration date, activate an open loop prepaid card for use.

Method

Service

API

Type

POST

rewardsCardProcessing

activate → Explore

Hybrid synchronous/asynchronous based on millisecondToWait parameter.

URI: https://apipp.blackhawknetwork.com/rewardsCardProcessing/v1/activate

Activation Request

To send the request to activate the card we need to send the following values in the request header:

Parameter

Description

Type

Required

Default Value

merchantId

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

String

Yes

None

requestId

A unique identifier for each order provided by you (the caller).

String

Yes

None

millisecondsToWait

Provide a value between 0 - 30000 to indicate how long your application or service will wait for a response. Once this time is exceeded the request will become asynchronous.

Integer

No

2000

In our example we will be sending the following values in the header:

merchantId: 1234
requestId: 2019-08-19T13:50:01-0600
millisecondsToWait: 30000

In the body of the POST request we need to send all the information needed to complete the activation.

Parameter

Description

Type

Required

Example

proxyNumber

The proxy number corresponding to the card that needs to be activated.

String

Yes

1234567890123456789

expirationMonth

The expiration month on the card.

Integer

Yes

10

expirationYear

The four-digit expiration year on the card.

Integer

Yes

2018

In our example our JSON looks like this:

{
  "proxyNumber": "1234567890123456789",
  "expirationMonth": 12,
  "expirationYear": 2021
}

Activation Response

After submitting our request we will receive one of the following HTTP responses:

HTTP Status Code

Meaning

Notes

200, 201

Operation Complete

If isCompleted is not equal to "true" and percentComplete is not 100 the activation has not completed.

202

Operation is in Process

If isCompleted is not equal to "true" and percentComplete is not 100 the activation has not completed.

4XX

Invalid Request

Check the JSON error response provided. In most cases you will find the request had missing information or was formatted improperly.

5XX

System Error

Blackhawk Network encountered an internal error trying to process your order. Reach out to your Account Manager for more information.

Success

If the response was successful the following JSON will be returned:

{
"transactionID": "435LYTF8GAS6NCB3R9TLCXWY30",
"isCompleted": true,
"percentComplete": 100,
"success": true
}

Failure

If the response was not successful an error response object will be returned and the card has not been activated. Here are some examples:

{
  "errors": [
  {
    "errorCode": "card.expirationMonth.required",
    "message": "Expiration month is required"
  },
  {
    "errorCode": "card.expirationYear.required",
    "message": "Expiration year is required"
  }
  ]
}
{
  "errors": [{
  "errorCode": "card.activate.fail",
  "message": "Unable to activate card: Problem activating card id: 1234567890123456789_0217. UNKNOWN : The account is marked as lost or stolen"
  }]
}

Possible Error Codes

Here is a list of possible error codes that could be received in the error response:

Error Code

Description

card.proxyNumber.required

Proxy number must be supplied.

card.expirationMonth.required

Expiration month must be supplied.

card.expirationYear.required

Expiration year must be supplied.

card.expirationMonth.invalid

Expiration month must be value from 1 to 12
card.

card.activate.fail

Unable to activate the card. Typically the reason will be provided in the "message".


Did this page help you?