Read Card Data (Read Account)

Introduction

This API Operation uses an accountId to retrieve account information. This API Operation can be used instead of getAccount if the current balance is not required.

Method

Service Name

Service Type

GET

accountProcessing/v1/readAccount

Synchronous

URI: https://api.blackhawknetwork.com/accountProcessing/v1/readAccount?accountId={accountIdValue}

Request Header Attributes

All three of these header attributes are optional; however, if a client wants idempotency support then they should specify all three on every request.

Name

Type

Required

Length

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

Required

Description

accountId

GUID

Y

Internal identifier of an account

Response Elements

Name

Type

Decription

account

AccountInformation

The requested account information

Error Codes

HTTP Status Code

Error Code

Description

400

accountId.null

Account ID is null in request

409

account.does.not.exist

No account found for account ID

Sample Request and Response

GET https://api.blackhawknetwork.com/accountProcessing/v1/readAccount?accountId=G3CV0ZFX68KDHRHYJD5D70NZDW
HTTP/1.1
Content-Type: application/json; charset=UTF-8
Accept: application/json; charset=UTF-8
Host: api.blackhawknetwork.com
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.2 (java 1.5)
HTTP/1.1 200 OK Server: Apache-Coyote/1.1
Date: Sat, 27 Jul 2013 20:20:56 GMT
Content-Type: application/json
Content-Length: 293
{   
    "entityId":https://api.blackhawknetwork.com/accountProcessing/v1/getAccount?accountId=G3CV0ZFX68KDHRHYJD5D70NZDW,
    "updatedTimestamp":"2013-07-27T19:28:53.648+0000",
    "type":"GIFT_CARD",
    "accountNumber":"12312312332123132",
    "productLineId":"AF4KPDDG5ML19PKC2090N3PAPH",
    "balance":10.00,
    "balanceAsOf":"2014-01-07",
    "isBalanceStale": true,
    "currency":"USD",
    "status": "ACTIVATED",
    "barCodeValue" : "6270672650222277"
 }

Did this page help you?