Get Account Information (Get Account)
This API Operation uses an accountId
to retrieve account information, including the current balance, in eGifts that do not require a PIN.
Updates are reflected in the current balance.
Method | Service Name | Service Type |
---|---|---|
GET | /accountProcessing/v1/getAccount | Synchronous |
- Post-Production URI:
https://api.certification.blackhawknetwork.com/accountProcessing/v1/getAccount?accountId={accountIdValue}
- Production URI:
https://api.blackhawknetwork.com/accountProcessing/v1/getAccount?accountId={accountIdValue}
Request
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 | 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 | String | 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, aka cardId |
Response
Response Header Attributes
Standard header attributes only
Response Elements
Name | Type | Description |
---|---|---|
account | AccountInformation | The requested account information |
Error Codes
HTTP Status Code | Error Code | Description |
---|---|---|
400 | bhn.com.service.request.missing.parameter | Account ID missing in request |
400 | com.bhn.general.invalid.argument | Illegal argument supplied in the request |
409 | account.does.not.exist | No account found for account ID |
409 | productline.not.found | Product line not found in the system |
409 | product.not.found | Product ID associated to the product line is not found in the system |
409 | productLine.setup.not.complete | The product line passed in the request is not set up completely for a balance inquiry |
Sample
GET /accountProcessing/v1/getAccount?accountId=RFAKLML8JL8MVK01N373YCWKYH HTTP/1.1
Accept-Encoding: gzip,deflate
Host: api.blackhawknetwork.com
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.5.5 (Java/16.0.1)
{
"entityId": "https://api.certification.blackhawknetwork.com/accountProcessing/v1/getAccount?accountId=RFAKLML8JL8MVK01N373YCWKYH",
"updatedTimestamp": "2022-12-07T18:08:18.000+0000",
"accountNumber": "9877894586899157",
"activationAccountNumber": "9877894586899157",
"productLineId": "https://api.certification.blackhawknetwork.com/productManagement/v1/productLine/7993LLJC3GJHS5LWWK3Q410M5C",
"productId": "https://api.certification.blackhawknetwork.com/productManagement/v1/product/YLMFFYX7BVJKQC6S0XBNS5KG50",
"upc": "07675050959",
"isBalanceStale": true,
"balanceResponse": "balance.inquiry.not.supported",
"currency": "USD",
"activationAmount": 25,
"status": "SHIPPED",
"activationCode": "6373",
"activationMerchantId": "60300005535",
"externalOrderId": "300366343",
"shipDate": "2022-12-07T18:08:18.000+0000",
"orderId": "4W53HSGLH6XRGVRN2L3QFA87KM",
"orderLineItemId": "7AXWLBSWNWDTHKQMRJHC5AQ3LC",
"externalOrderLineItemId": "2285601431"
}
GET /accountProcessing/v1/getAccount?accountId=RFAKLML8JL8MVK01N373YCWKYH&requestId=2023-03-14T09%3A51%3A27-0500 HTTP/1.1
Accept-Encoding: gzip,deflate
requestorId: RZ2JMRQW0SM680Q0MF2M8FBFMR
previousAttempts: 1
Host: api.blackhawknetwork.com
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.5.5 (Java/16.0.1)
{
"entityId": "https://api.certification.blackhawknetwork.com/accountProcessing/v1/getAccount?accountId=RFAKLML8JL8MVK01N373YCWKYH",
"updatedTimestamp": "2022-12-07T18:08:18.000+0000",
"accountNumber": "9877894586899157",
"activationAccountNumber": "9877894586899157",
"productLineId": "https://api.certification.blackhawknetwork.com/productManagement/v1/productLine/7993LLJC3GJHS5LWWK3Q410M5C",
"productId": "https://api.certification.blackhawknetwork.com/productManagement/v1/product/YLMFFYX7BVJKQC6S0XBNS5KG50",
"upc": "07675050959",
"isBalanceStale": true,
"balanceResponse": "balance.inquiry.not.supported",
"currency": "USD",
"activationAmount": 25,
"status": "SHIPPED",
"activationCode": "6373",
"activationMerchantId": "60300005535",
"externalOrderId": "300366343",
"shipDate": "2022-12-07T18:08:18.000+0000",
"orderId": "4W53HSGLH6XRGVRN2L3QFA87KM",
"orderLineItemId": "7AXWLBSWNWDTHKQMRJHC5AQ3LC",
"externalOrderLineItemId": "2285601431"
}
Updated 3 months ago