Traveller-card-types

These events are emitted by the Inventory API (btrz-api-inventory) when traveller card types are created, updated, or deleted.

Events

Action Event name Endpoint
Create a traveller card type travellercardtype.created POST /traveller-card-types
Update a traveller card type travellercardtype.updated PUT /traveller-card-types/:travellerCardTypeId
Delete a traveller card type travellercardtype.deleted DELETE /traveller-card-types/:travellerCardTypeId

Payload example created

{
  "attemptId": "1c4cdeb3-d7fc-4a0c-b59b-7590e516e8a3",
  "created": 1733411106,
  "data": {
    "_id": "6751c10db534940506d40fae",
    "accountId": "52a377ec430c7d4e220001fc",
    "cardProviderId": "674a1beb1e21aa57dff37185",
    "createdAt": {
      "offset": 0,
      "value": "2024-12-05T15:04:45.043Z"
    },
    "createdBy": "55fc2f318791db6e1a0000b6",
    "fareId": "674a1beb1e21aa57dff37186",
    "hasExpireDate": false,
    "lexiconKeys": {
      "fareName": "lexicon-fare-key",
      "name": "lexicon-name-key",
      "productName": "lexicon-product-key"
    },
    "name": "Senior Card",
    "productId": "674a1beb1e21aa57dff37187",
    "updatedAt": {
      "offset": 0,
      "value": "2024-12-05T15:04:45.043Z"
    },
    "updatedBy": "55fc2f318791db6e1a0000b6"
  },
  "event": "travellercardtype.created",
  "id": "333c3e05-e89f-40df-ac6e-b049756571d5",
  "livemode": true
}

Payload example updated

{
  "attemptId": "21acd7b2-a74a-4bd4-8a99-40e056da76fc",
  "created": 1733410946,
  "data": {
    "_id": "674a1beb1e21aa57dff37185",
    "accountId": "52a377ec430c7d4e220001fc",
    "cardProviderId": "674a1beb1e21aa57dff37184",
    "createdAt": {
      "offset": 0,
      "value": "2024-11-29T19:54:19.479Z"
    },
    "createdBy": "55fc2f318791db6e1a0000b6",
    "fareId": "674a1beb1e21aa57dff37186",
    "hasExpireDate": true,
    "lexiconKeys": {
      "fareName": "lexicon-fare-key",
      "name": "lexicon-name-key",
      "productName": "lexicon-product-key"
    },
    "name": "Senior Card",
    "productId": "674a1beb1e21aa57dff37187",
    "updatedAt": {
      "offset": 0,
      "value": "2024-12-05T15:01:53.493Z"
    },
    "updatedBy": "55fc2f318791db6e1a0000b6"
  },
  "event": "travellercardtype.updated",
  "id": "dd335382-fb17-4e1f-b903-f613cd3bfd81",
  "livemode": true
}

Payload data fields (created / updated)

Field Type Description
_id string Traveller card type id (24 hex characters).
accountId string Account id.
name string Display name (from lexicon or stored value).
productId string Product id (24 hex).
fareId string Fare id (24 hex).
cardProviderId string Traveller card provider id (24 hex).
hasExpireDate boolean Whether the card type has an expiry date.
lexiconKeys object Lexicon keys for name, productName, fareName.
createdBy string User id that created this resource.
updatedBy string User id that last updated this resource.
createdAt object BzDate — when the object was created.
updatedAt object BzDate — when the object was last updated.

Payload example deleted

{
  "attemptId": "21acd7b2-a74a-4bd4-8a99-40e056da76fc",
  "created": 1733410946,
  "data": {
    "travellerCardTypeId": "674a1beb1e21aa57dff37185"
  },
  "event": "travellercardtype.deleted",
  "id": "dd335382-fb17-4e1f-b903-f613cd3bfd81",
  "livemode": true
}

Payload data fields (deleted)

Field Type Description
travellerCardTypeId string Id of the deleted traveller card type (24 hex).