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

Notification API

Download OpenAPI specification

Handle Event

post
/issuers/{issuerId}/wallets/{walletIndicator}/events/{eventType}/handleEvent

API used by Transit Issuer to trigger events:

  • notify transactions (purchase, rides...)

  • balance updates

  • count updates

  • fare products updates

  • update and retrieve bundle data

  • notify messages (alerts, promotions...)

Path parameters
eventTypestringRequired

Indicates the type of event to be handled.Value can be:

Value Description
transaction Used to notify a transaction.
message Used to notify a message.
update_balance Used to notify balance update.
update_count Used to notify count update of a count based fare product.
update_fare_products Used to update fare products (e.g. purchase of a new product, removal or renewal).
update_bundle_data Used to notify that a digital card bundle shall be updated.
retrieve_bundle_data Used to notify that digital card bundle data shall be retrieved.
issuerIdstring · max: 10Required

Issuer unique identifier. Assigned by Thales during onboarding.

walletIndicatornumberRequired

Indicates which digital wallet is involved in the use case.

Value Description
1 Apple
2 Google
3 Samsung
Body
digitalCardIdstring · max: 64Optional

Digital card unique identifier

Example: DGGLSW8D8AC610566D4EF09C22186B2A5ED756
cardAccountIdstring · max: 64Required

Card account unique identifier

Example: FAPLSW8D8AC610566D4EF09C22186B2A5ED793
eventTimestring · date-timeRequired

The event time

Responses
200Success
application/json
post/issuers/{issuerId}/wallets/{walletIndicator}/events/{eventType}/handleEvent

Last updated

Was this helpful?