cardType

November 12, 2025 · View on GitHub

A generic description of a CARD

Type: object

semantics [{'transmodel': 'TYPE OF PAYMENT METHOD, MEDIUM ACCESS DEVICE'}]


Properties overview

PropertyTypeRequiredDescription
idcardTypeReferenceexternal reference to address the card used.
typestring
cardCategoryenum (DISCOUNT, TRAVEL, BANK, CREDIT, ID, ...)The broad category of card
DISCOUNT - discount card, can be applied in th...
subTypeshortStringFor use in case of OTHER. Can be used in bilateral agreements.
modesarray[mode]modes for which this card can be used, when empty, all modes are allowed
relatedProductproductReferencedefault string, full names etc (length 0-200)
transportOrganisationsarray[organisationReference]references to accepting parties, only if applicable
customFieldscustomPropertiesdictionary for extra fields (bilatural agreements)

Detailed Properties

  • id (cardTypeReference) - required
    external reference to address the card used.

  • type (string) - required
    value: "cardType"

  • cardCategory (enum (DISCOUNT, TRAVEL, BANK, CREDIT, ID, ...)) - optional
    The broad category of card
    DISCOUNT - discount card, can be applied in the purchase process to get rebate
    TRAVEL - (external) travel card, possibly paid for in other context, but also monthly, weekly or day-cards
    BANK - bank card
    CREDIT - credit card
    ID - identification card, like an ID card
    PASSPORT - passport to identify yourself
    OTHER - unspecified

  • subType (shortString) - optional
    For use in case of OTHER. Can be used in bilateral agreements.

  • modes (array[mode]) - optional
    modes for which this card can be used, when empty, all modes are allowed

  • relatedProduct (productReference) - optional
    default string, full names etc (length 0-200)

  • transportOrganisations (array[organisationReference]) - optional
    references to accepting parties, only if applicable

  • customFields (customProperties) - optional
    dictionary for extra fields (bilatural agreements)

Example

{
  "type": "cardType",
  "id": "identifier",
  "cardCategory": "DISCOUNT",
  "subType": "example-string",
  "modes": [
    "AIR",
    "AIR"
  ]
}