openapi: 3.2.0
info:
  title: Pay@Pump Fueling API
  description: A micro service for Pay@Pump
  version: '1'
security:
- Bearer: []
tags:
- name: Fueling
paths:
  /fueling:
    post:
      tags:
      - Fueling
      parameters:
      - name: api-version
        in: header
        description: The requested API version
        schema:
          type: string
          default: '1'
      - name: X-APP-Client
        in: header
        description: Determines the calling client
        schema:
          type: string
      - name: X-Correlation-Id
        in: header
        description: A guid to track the request
        schema:
          type: string
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/pol_service_api.Request.Txo.InitiateFuelingRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/pol_service_api.Request.Txo.InitiateFuelingRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/pol_service_api.Request.Txo.InitiateFuelingRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/pol_service_api.Request.Txo.InitiateFuelingRequest'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/pol_service_api.Response.Txo.InitiateFuelingResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/pol_service_api.Response.Txo.InitiateFuelingResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/pol_service_api.Response.Txo.InitiateFuelingResponse'
        '500':
          description: Internal Server Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/pol_service_api.Models.Common.ErrorResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/pol_service_api.Models.Common.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/pol_service_api.Models.Common.ErrorResponse'
      summary: Create fueling
      x-summary-source: derived
      operationId: postFueling
      x-operation-id-source: derived
    get:
      tags:
      - Fueling
      parameters:
      - name: X-Transaction-Id
        in: header
        required: true
        schema:
          type: string
      - name: api-version
        in: header
        description: The requested API version
        schema:
          type: string
          default: '1'
      - name: X-APP-Client
        in: header
        description: Determines the calling client
        schema:
          type: string
      - name: X-Correlation-Id
        in: header
        description: A guid to track the request
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/pol_service_api.Response.Events.GetEventsResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/pol_service_api.Response.Events.GetEventsResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/pol_service_api.Response.Events.GetEventsResponse'
        '500':
          description: Internal Server Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/pol_service_api.Models.Common.ErrorResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/pol_service_api.Models.Common.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/pol_service_api.Models.Common.ErrorResponse'
      summary: Get fueling
      x-summary-source: derived
      operationId: getFueling
      x-operation-id-source: derived
  /fueling/cancel:
    put:
      tags:
      - Fueling
      parameters:
      - name: X-Transaction-Id
        in: header
        required: true
        schema:
          type: string
      - name: api-version
        in: header
        description: The requested API version
        schema:
          type: string
          default: '1'
      - name: X-APP-Client
        in: header
        description: Determines the calling client
        schema:
          type: string
      - name: X-Correlation-Id
        in: header
        description: A guid to track the request
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/System.Net.HttpStatusCode'
            application/json:
              schema:
                $ref: '#/components/schemas/System.Net.HttpStatusCode'
            text/json:
              schema:
                $ref: '#/components/schemas/System.Net.HttpStatusCode'
        '500':
          description: Internal Server Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/pol_service_api.Models.Common.ErrorResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/pol_service_api.Models.Common.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/pol_service_api.Models.Common.ErrorResponse'
      summary: Replace fueling cancel
      x-summary-source: derived
      operationId: putFuelingCancel
      x-operation-id-source: derived
components:
  schemas:
    System.Net.HttpStatusCode:
      enum:
      - 100
      - 101
      - 102
      - 103
      - 200
      - 201
      - 202
      - 203
      - 204
      - 205
      - 206
      - 207
      - 208
      - 226
      - 300
      - 301
      - 302
      - 303
      - 304
      - 305
      - 306
      - 307
      - 308
      - 400
      - 401
      - 402
      - 403
      - 404
      - 405
      - 406
      - 407
      - 408
      - 409
      - 410
      - 411
      - 412
      - 413
      - 414
      - 415
      - 416
      - 417
      - 421
      - 422
      - 423
      - 424
      - 426
      - 428
      - 429
      - 431
      - 451
      - 500
      - 501
      - 502
      - 503
      - 504
      - 505
      - 506
      - 507
      - 508
      - 510
      - 511
      type: integer
      format: int32
    pol_service_api.Response.Events.GetEventsResponse:
      type: object
      properties:
        status:
          type:
          - string
          - 'null'
        transactionReferenceId:
          type:
          - string
          - 'null'
        deliveryNote:
          $ref: '#/components/schemas/pol_service_api.Models.Events.Receipt'
        errorList:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/pol_service_api.Models.Common.PolError'
      additionalProperties: false
    pol_service_api.Models.Events.SiteAddress:
      type: object
      properties:
        siteName:
          type:
          - string
          - 'null'
        street1:
          type:
          - string
          - 'null'
        postalCode:
          type:
          - string
          - 'null'
        city:
          type:
          - string
          - 'null'
      additionalProperties: false
    pol_service_api.Models.Events.PriceDetails:
      type: object
      properties:
        subTotal:
          type:
          - string
          - 'null'
        totalTax:
          type:
          - string
          - 'null'
        totalAmount:
          type:
          - string
          - 'null'
      additionalProperties: false
    pol_service_api.Models.Events.ProductDetails:
      type: object
      properties:
        productPicked:
          type:
          - string
          - 'null'
        volumePicked:
          type: number
          format: double
        unitMeasure:
          type:
          - string
          - 'null'
        pricePerUnit:
          type:
          - number
          - 'null'
          format: double
      additionalProperties: false
    pol_service_api.Models.Common.ErrorResponse:
      type: object
      properties:
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/pol_service_api.Models.Common.PolError'
      additionalProperties: false
    pol_service_api.Models.Common.PolError:
      type: object
      properties:
        errorCode:
          type:
          - string
          - 'null'
        errorMessage:
          type:
          - string
          - 'null'
      additionalProperties: false
    pol_service_api.Models.Events.CardDetails:
      type: object
      properties:
        cardType:
          type:
          - string
          - 'null'
        cardNumber:
          type:
          - string
          - 'null'
      additionalProperties: false
    pol_service_api.Response.Txo.InitiateFuelingResponse:
      type: object
      properties:
        status:
          type:
          - string
          - 'null'
        pumpId:
          type: integer
          format: int32
        preAuthorizedAmount:
          type: number
          format: double
        allowedFuelTypes:
          type:
          - array
          - 'null'
          items:
            type: string
        transactionId:
          type:
          - string
          - 'null'
      additionalProperties: false
    pol_service_api.Models.Events.Receipt:
      type: object
      properties:
        siteId:
          type:
          - string
          - 'null'
        pumpId:
          type: integer
          format: int32
        transactionId:
          type:
          - string
          - 'null'
        transactionTime:
          type:
          - string
          - 'null'
        receiptNumber:
          type:
          - string
          - 'null'
        terminalId:
          type:
          - string
          - 'null'
        authCode:
          type:
          - string
          - 'null'
        odometer:
          type:
          - string
          - 'null'
        siteAddress:
          $ref: '#/components/schemas/pol_service_api.Models.Events.SiteAddress'
        productDetails:
          $ref: '#/components/schemas/pol_service_api.Models.Events.ProductDetails'
        priceDetails:
          $ref: '#/components/schemas/pol_service_api.Models.Events.PriceDetails'
        cardDetails:
          $ref: '#/components/schemas/pol_service_api.Models.Events.CardDetails'
      additionalProperties: false
    pol_service_api.Models.Txo.VehicleTxo:
      type: object
      properties:
        odometer:
          maximum: 999999
          minimum: 0
          type:
          - integer
          - 'null'
          format: int32
        additionalInfo:
          maxLength: 18
          minLength: 0
          pattern: ^[a-zA-Z0-9]*$
          type:
          - string
          - 'null'
        vehicleRegistration:
          type:
          - string
          - 'null'
        vehicleCode:
          maxLength: 4
          minLength: 1
          pattern: ^[0-9]*$
          type:
          - string
          - 'null'
      additionalProperties: false
    pol_service_api.Request.Txo.InitiateFuelingRequest:
      required:
      - entityId
      - locationInfo
      - printReciept
      - pumpId
      - siteId
      type: object
      properties:
        locationInfo:
          $ref: '#/components/schemas/pol_service_api.Models.Dsp.Location'
        vehicle:
          $ref: '#/components/schemas/pol_service_api.Models.Txo.VehicleTxo'
        siteId:
          minLength: 1
          type: string
        pumpId:
          type: integer
          format: int32
        amount:
          minimum: 5
          type:
          - number
          - 'null'
          format: double
        printReciept:
          type: boolean
        entityId:
          minLength: 1
          type: string
      additionalProperties: false
    pol_service_api.Models.Dsp.Location:
      required:
      - lat
      - lng
      type: object
      properties:
        lat:
          maximum: 90
          minimum: -90
          type: number
          format: double
        lng:
          maximum: 180
          minimum: -180
          type: number
          format: double
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: 'JWT Authorization header using the Bearer scheme (Example: ''Bearer 12345abcdef'')'
      name: Authorization
      in: header