THthalescloud

Request to provide the next list of commands to be executed on a device

This method is used by TSH to request the pending commands to be executed on a device.</br> It is used for reading/updating the content of a device (e.g. topup).</br> The TES has to return the list of commands that needs to be executed on the device after checking the previous commands responses.</br>

post/getCardCommands

Request

Headers

x-actor-idstring required

HTTP header identifying the actor initiating the request.

Request body

issuerIdstring required
cardIdstring required

Unique identifier of the card.

purchaseIdstring

The Purchase Identifier. Unique for each purchase.<br/> It is provided when the call is related to topup initiated from wallet.

deviceIdstring required

The Device Identifier. Unique for each device.

operation'READ_BALANCE' | 'UPDATE_BALANCE' | 'UPDATE_CONFIG' | 'UPDATE_PLAN' | 'ERASE_CARD' | 'PARK_CARD' | 'BLOCK_AND_READ_CARD'

The operation for which the commands are requested

responseTimeMsnumber double

Total time of all executed commands listed in responses array in milliseconds.

statusCodenumber

Status code to the request

Status codeDescription
0OK
111Missing mandatory parameter
112Bad parameter format
113Unknown issuer
117Unknown device
118Unknown session
119Unknown virtual card
159Card is blacklisted
160Card is deleted
162Card has unsufficient balance
163Card product not eligible
167Card is already provisioned
172Invalid card, unsupported system code
173Invalid card, unsupported service
177Invalid card, invalid area data
178Invalid card, card status is in-station
191Card is expired
192Reader mode attempt exceeded allowed threshold
221Device or wallet server not accessible
231Device unexpected error
232Device out of memory error
321Operation already on-going for this device
322Time to live of the operation expired
323Operation incomplete
911Operation failed
921Unexpected server error
statusMessagestring

Textual status message

Response

getCardCommands response payload

Changes

No recorded changes to this operation across all 1 revision of this API.