Welcome to our new developer portal! Use the "Ask" button to chat with our AI Agent.
Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Document History

Release
Date (dd/mm/yyyy)
Modifications

1.0.0

20/09/2018

First release of the TES API

1.0.1

01/10/2018

  • add new error codes

    • declined provisionCard

    • account mismatch

    • invalid perso data

    • operation not allowed with current card state

  • add timestamp optional parameter for request/response headers

  • add 'unknown' value for card capture method

  • add keyIndex parameter for cardPersoData

  • updateCardState (TES to TSH) has new action PARK_AND_DELETE

  • updateCardState (TSH to TES) has new action BLACKLIST

  • updateCardState (TSH to TES) has new action BLACKLIST

  • states returned in getCards have been updated to CREATED, ACTIVE, SUSPENDED_ISSUER, SUSPENDED_WALLET, BLACKLISTED and DELETED

1.0.2

22/10/2018

  • add new deviceType "UNKNOWN"

  • add new error code "provisioning count exceeded"

  • fix typo on phoneNumerLastDigits, replaced by phoneNumberLastDigits

  • add optional parameter "displayCardNumber" in provisionCard response

  • remove PARK_AND_DELETE action from updateCardState (TES to TSH)

  • add new API sendMessage allowing TES to request message delivery to user

  • remove BLACKLISTED state from getCards and BLACKLIST action from updateCardState (TSH to TES)

  • add new API refundCardAccount allowing TES to notify TSH that a card account has been refunded

  • Fix issue in TES to TSH swagger for cardPersoData type

  • Replace PARK_CARD operation by BLOCK_AND_READ_CARD in initiateCardSession

  • update parameter operation to newState for updateCardState (TSH to TES) and values associated to reflect that this call is made to notify the change and not to request it.

1.0.3

05/11/2018

  • increase length of orderId and purchaseId to 64 instead of 48

  • add new parameters in paymentInstrument parameter (applicable for createCardAccound and topupCardAccount)

    • version

    • header

    • signature

  • add new output parameter "signature" to createCardAccount and topupCardAccount

  • statusCode in responseHeader is now mandatory

  • add new API getRequestStatus + new error code "unknow request"

  • add new LCM action "ERASE" for GDPR / RoI compliancy

  • add new API getRequestStatus + new error code "unknow request"

  • add customerData parameter in provisionCard

1.0.4

10/12/2018

  • remove obsolete APIs "getPurchaseStatus" and "updatePurchaseStatus"

  • New Device GW API getParkCardCommands for park card

  • add new error codes for createCardAccount and topupCardAccount

    • 419 PIN required

    • 420 PIN incorrect

    • 421 PIN locked

  • Error in updateCardState (TSH to TES), purchaseId removed from response

  • Add productId in createCardAccount request

  • Add cardLastDigits in provisionCard

  • Fix prefix URL for transit notifications API (from xxx/v1.0 to xxx/1/0)

1.0.5

07/01/2019

  • remove RECEIVED status from getRequestStatus API response

  • add new error code 166 for invalid card information

  • signature and paymentData in paymentInstrument are restricted to 8192 characters max

  • add new parameter wrappedKey in paymentInstrument (used for RSA algorithm) for createCardAccount and topupCardAccount

1.0.6

01/02/2019

  • add new method updateCardMetadata for commute plans management

  • add cardContents object parameter in getReaderModeCommands

1.0.7

08/02/2019

  • add support for localized title on commute plans

1.0.8

21/02/2019

  • align operation possible values between initiateCardSession and getCardCommands

1.0.9

18/03/2019

  • New state "UNLINKED" can be sent in updateCardState (TSH to TES)

  • Update getCards API for managing UNLINKED card state and it will now return the card account state

  • New optional parameter in provisionCard response "cardholderName"

1.0.10

02/04/2019

  • Add new error codes in device gateway API

    • 172 Invalid card, unsupported system code

    • 173 Invalid card, unsupported service

    • 177 Invalid card, invalid area data

    • 178 Invalid card, card status is in-station

1.0.11

16/04/2019

  • update getCards response

    • cardAccountId removed

    • walletAccountId, cardAccountState and walletCardAccountId are at top level

  • update provisionCard response for cardholder name localization management

  • update getParkCardCommands and getReaderModeCommands

    • add new parameter "cardData" in response

    • cardData contains "balanceAmount"

  • error code 221 added for TES to TSH api

1.0.12

24/04/2019

  • add error codes in device gateway for taking into account new client TSM spec 2.2

1.0.13

17/05/2019

  • rename operation value "RENEW_CARD" to "UPDATE_PLAN"

1.0.14

27/05/2019

  • update of notifyOperationResult

    • cardId is now optional

    • add optional parameter purchaseId

    • add optional parameter cardAccountId

    • add parameter isProvisioning

1.0.15

06/06/2019

  • walletAccountId is removed from createCardAccount (only sent in provisionCard)

1.0.16

23/07/2019

  • removal of retryCount from device gateway methods

  • removal of error 922

  • add error 432 for TSH to TES methods

  • increase card perso data length to 8192 instead of 500

1.0.17

11/12/2019

  • remove enum constraint on walletProviderId provided in checkCardAccount

  • add new HTTP header x-actor-id on device-gateway and transit-tsh-to-tes. This header indicates the wallet provider initiating the request. Its value corresponds to the walletProviderId as defined in checkCardAccount

1.0.18

26/10/2020

  • add new optional parameter "resultData" in notifyOperationResult to provide extra information to TES

  • add new parameter "purchaseId" that is given by TSH to TES in getCardCommands when it's related to topup initiated from wallet.

  • add new parameter "cardData" in provisionCard response.

  • add new optional parameter "opaqueServiceProviderData" in createCardAccount and topupCardAccount requests.

1.0.19

30/11/2021

  • add new function getCardAccountsMetadata

  • add new function getCardActions

  • add new optional parameter 'cardArtManifest' in checkCardAccount response and in updateCardMetadata request

  • add new function getAsset

1.0.20

28/02/2024

  • add new parameter (array of objects) "title" within cardActions object from getCardActions response in order to allow replacing predefined values statically provisioned

  • add Calypso truth on card data preparation section

1.0.21

14/1/2024

  • add new parameter 'mobileApplicationInfo' in 'checkCardAccount' response

1.0.22

11/12/2025

  • add new optional parameter 'cardArtManifest' in provisionCard response

PreviousTransit (Classic)NextAPI Overview

Last updated

Was this helpful?