Reload Value

Introduction

This API operation is used to reload an account with a given amount. In the case of a phone account, this transaction will be treated as a TOPUP.

Method

Service Name

Service Type

POST

accountProcessing/v1/reload

Synchronous

URI: https://api.blackhawknetwork.com/accountProcessing/v1/reload

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

The internal identifier of the account

amount

Big Decimal

Y

Amount to reload

currency

String

Y

Currency for transaction

productId

GUID

N

The internal identifier of the product

retrievalReferenceNumber

String

N

Retrieval reference number

storeNumber

String

N

Store number

terminalNumber

String

N

Terminal number

baseTransactionId

String

N

Transaction ID used to correlate multiple transactions

Response Elements

Name

Type

Descriptipon

accountTransaction

accountTransaction

Account transaction response object

Error Codes

HTTP Status Code

Error Code

Description

400

amount.null

Amount is null in the request

400

accountId.null

Account ID is null in the request

400

retrievalReferenceNumber.invalid

Retrieval reference number in the request is invalid

400

storeNumber.invalid

Store number in the request is invalid

400

terminalNumber.invalid

Terminal number in the request is invalid

400

account.transaction.offerDetails.offerDefinitionID.nuil

Offer definition ID is null in AccountTransactionOfferDetails

400

account.transaction.offerDetails.offerInstanceID.null

Offer Instance ID is null in AccountTransactionOfferDetails

400

account.transaction.offerDetails.offerAmount.null

Offer amount is null in AccountTransactionOfferDetails

400

account.transaction.offerDetails.offerCurrency.null

Offer currency is null in AccountTransactionOfferDetails

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

product.id.required

Product ID required for phone card reload

409

productLine.setup.not.complete

The product line passed in the request is not set up completely for a balance inquiry

409

account.does.not.exist

No account found for account ID

504

provider.transaction.timeout

Underlying systems not responding while refreshing the balance

*Sample Request and Response

Sample Request and Response

POST /accountProcessing/v1/reload HTTP/1.1
User-Agent: curl/7.23.1 (x86_64-pc-win32) libcurl/7.23.1
Accept: */*
requestorId: YKGVJGPTWC7TPWGPA3KJ2FX01R
Host: api.blackhawknetwork.com
Content-Type: application/json; charset=UTF-8
Content-Length: 117
  
{
   "accountId":"FAXF46GSGX3VTP34Y28YXRBWL4",
   "amount":"10.00",
   "currency":"USD"
}
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Date: Wed, 12 Sep 2012 22:33:16 GMT
Content-Type: application/json
Content-Length: 319
  
 {
   "entityId":"KZC4J0M2S4Q9AK2QGQSC58W4M4",
   "transactionId":"TQLM76HVKXT8KD60CPWDN7GPPW",
   "accountId":"https://api.blackhawknetwork.com/accountProcessing/v1/getAccount?accountId=ZHWFXC9C1408HQJ4SHL1949QXC",
   "productId": "https://api.blackhawknetwork.com/productManagement/v1/product/6JH5Q9KS2TQ2AWFS374AZLM5S0",
   "timestamp":"2012-09-12T22:33:11.132+0000",
   "requestedAmount":10.00,
   "approvedAmount":10,  
   "resultingBalance":20.00,
   "currency":"USD",  
   "authorizationCode":"000012",
   "transactionStatus":"APPROVED",
   "transactionType":"RELOAD"
}

Did this page help you?