openapi: 3.1.0
info:
  title: FareEstimate
  version: 2.0.0
  description: Schema definition for the FareEstimate entity in the Beckn Mobility
  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:
    FareEstimate:
      x-iri: https://schema.nfh.global/FareEstimate/v2.0
      type: object
      title: FareEstimate
      description: An estimated fare for a requested trip, typically returned in response
        to a search before the booking is confirmed.
      x-tags:
        - mobility
        - ride-hailing
      properties:
        estimatedAmount:
          description: Estimated total fare amount
          type: number
        currency:
          description: ISO 4217 currency code
          type: string
        minimumAmount:
          description: Minimum possible fare
          type: number
        maximumAmount:
          description: Maximum possible fare
          type: number
        fareBreakup:
          description: Itemised breakdown of the estimated fare
          $ref: https://schema.nfh.global/FareBreakup/v2.0/attributes.yaml#/components/schemas/FareBreakup
        id:
          description: Unique identifier for the offer
          type: string
        descriptor:
          description: Human-readable description of the offer
          $ref: https://schema.nfh.global/Descriptor/v2.0/attributes.yaml#/components/schemas/Descriptor
        price:
          description: Price specification for this offer
          $ref: https://schema.nfh.global/PriceSpecification/v2.1/attributes.yaml#/components/schemas/PriceSpecification
        validity:
          description: Validity period of the offer
          $ref: https://schema.nfh.global/TimePeriod/v2.0/attributes.yaml#/components/schemas/TimePeriod
        tags:
          description: Tags or labels associated with the offer
          type: string
      additionalProperties: false