openapi: 3.1.0
info:
  title: FareMedium
  version: 2.0.0
  description: Schema definition for the FareMedium entity in the Beckn Mobility domain.
  license:
    name: CC-BY-NC-SA 4.0 International
    url: https://creativecommons.org/licenses/by-nc-sa/4.0/deed.en
  contact:
    name: Beckn Labs
    url: https://beckn.io
components:
  schemas:
    FareMedium:
      x-iri: https://schema.nfh.global/FareMedium/v2.0
      type: object
      title: FareMedium
      description: The physical or digital medium used to carry or present a fare
        product, such as a contactless card, mobile app, or paper ticket.
      x-tags:
        - mobility
        - ride-hailing
      properties:
        mediumType:
          description: Type of fare medium (e.g. CONTACTLESS_CARD, MOBILE_APP, PAPER_TICKET,
            QR_CODE)
          type: string
        mediumId:
          description: Unique identifier or number of the physical or digital medium
          type: string
        id:
          description: Unique identifier for the entitlement
          type: string
        descriptor:
          description: Human-readable information about the entitlement
          $ref: https://schema.nfh.global/Descriptor/v2.0/attributes.yaml#/components/schemas/Descriptor
        resource:
          description: The resource being accessed against this entitlement
          $ref: https://schema.nfh.global/ContractItem/v2.0/attributes.yaml#/components/schemas/ContractItem
        credentials:
          description: Credential descriptors for the entitlement
          $ref: https://schema.nfh.global/Descriptor/v2.0/attributes.yaml#/components/schemas/Descriptor
      additionalProperties: false