Traveller-card-providers

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

Events

Action Event name Endpoint
Create a traveller card provider travellercardprovider.created POST /traveller-card-providers
Update a traveller card provider travellercardprovider.updated PUT /traveller-card-providers/:travellerCardProviderId

Payload example created

{
  "attemptId": "1c4cdeb3-d7fc-4a0c-b59b-7590e516e8a3",
  "created": 1733411106,
  "data": {
    "_id": "6751c10db534940506d40fae",
    "accountId": "52a377ec430c7d4e220001fc",
    "createdAt": {
      "offset": 0,
      "value": "2024-12-05T15:04:45.043Z"
    },
    "createdBy": "55fc2f318791db6e1a0000b6",
    "lexiconKeys": {
      "name": "lexicon-key-id"
    },
    "name": "My CAA Provider",
    "properties": {
      "clientId": "",
      "clientSecret": "",
      "partnerId": "",
      "scope": ""
    },
    "type": "caa",
    "updatedAt": {
      "offset": 0,
      "value": "2024-12-05T15:04:45.043Z"
    },
    "updatedBy": "55fc2f318791db6e1a0000b6"
  },
  "event": "travellercardprovider.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",
    "createdAt": {
      "offset": 0,
      "value": "2024-11-29T19:54:19.479Z"
    },
    "createdBy": "55fc2f318791db6e1a0000b6",
    "lexiconKeys": {
      "name": "lexicon-key-id"
    },
    "name": "Custom Provider",
    "properties": {},
    "type": "custom",
    "updatedAt": {
      "offset": 0,
      "value": "2024-12-05T15:01:53.493Z"
    },
    "updatedBy": "55fc2f318791db6e1a0000b6"
  },
  "event": "travellercardprovider.updated",
  "id": "dd335382-fb17-4e1f-b903-f613cd3bfd81",
  "livemode": true
}

Payload data fields

Field Type Description
_id string Traveller card provider id (24 hex characters).
accountId string Account id.
type string Provider type: "caa" or "custom".
name string Display name of the provider (from lexicon or stored value).
lexiconKeys object Lexicon keys; name is the key for the translated name of the provider.
properties object Type-specific config. For caa: partnerId, clientId, clientSecret, scope (strings). For custom: typically empty.
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.