Entur Refunding Possibilities API

openapi: 3.2.0
info:
  title: Entur Refunding Possibilities API
  version: 2026.10.0
  description: 'Operations tagged refunding-possibilities across 2 of this provider''s published API definitions: entur-products-openapi.json, entur-products-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.entur.io/products
  description: Production environment
- url: https://api.staging.entur.io/products
  description: Staging environment
- url: https://api.dev.entur.io/products
  description: Development environment
security:
- jwt: []
tags:
- name: refunding-possibilities
paths:
  /refunding-possibilities:
    parameters:
    - $ref: '#/components/parameters/ET-Client-Name'
    - $ref: '#/components/parameters/X-Correlation-Id'
    post:
      tags:
      - refunding-possibilities
      summary: Retrieves refunding rules for given elements
      operationId: refunding-possibilities_getRefundingPossibilities
      parameters:
      - name: Accept-Language
        in: header
        description: The language code for the name and description fields.
        required: false
        style: simple
        explode: false
        schema:
          type: string
      - name: Entur-Distribution-Channel
        in: header
        description: The id of the distribution channel.
        required: false
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ParameterPossibilitiesRequest'
        required: true
      responses:
        '200':
          description: Returns the resource.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RefundingAlternatives'
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                type: string
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                type: string
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                type: string
        '404':
          description: Resource not found.
          content:
            application/problem+json:
              schema:
                type: string
        '409':
          description: Conflict
          content:
            application/problem+json:
              schema:
                type: string
        '500':
          description: Internal server error.
          content:
            application/problem+json:
              schema:
                type: string
      security:
      - basic_auth: []
      x-entur-permissions:
        value: product-api-access:les
    servers:
    - url: https://api.entur.io/products
      description: Production environment
    - url: https://api.staging.entur.io/products
      description: Staging environment
    - url: https://api.dev.entur.io/products
      description: Development environment
  /refunding-possibilities/preassigned-product/{id}/{version}:
    parameters:
    - $ref: '#/components/parameters/ET-Client-Name'
    - $ref: '#/components/parameters/X-Correlation-Id'
    get:
      tags:
      - refunding-possibilities
      summary: Retrieves refunding rules for given elements
      operationId: refunding-possibilities_getFPRefundingPossibilities
      parameters:
      - name: id
        in: path
        description: The unique id to identify a product.
        required: true
        style: simple
        explode: false
        schema:
          pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$
          type: string
      - name: version
        in: path
        description: The version of the element.
        required: true
        style: simple
        explode: false
        schema:
          pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$
          type: string
      - name: Accept-Language
        in: header
        description: The language code for the name and description fields.
        required: false
        style: simple
        explode: false
        schema:
          type: string
      - name: Entur-Distribution-Channel
        in: header
        description: The id of the distribution channel.
        required: false
        style: simple
        explode: false
        schema:
          type: string
      - name: If-None-Match
        in: header
        description: Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.
        required: false
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Returns the resource.
        '304':
          description: Not Modified
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                type: string
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                type: string
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                type: string
        '404':
          description: Resource not found.
          content:
            application/problem+json:
              schema:
                type: string
        '500':
          description: Internal server error.
          content:
            application/problem+json:
              schema:
                type: string
      security:
      - basic_auth: []
      x-entur-permissions:
        value: product-api-access:les
    servers:
    - url: https://api.entur.io/products
      description: Production environment
    - url: https://api.staging.entur.io/products
      description: Staging environment
    - url: https://api.dev.entur.io/products
      description: Development environment
  /refunding-possibilities/sales-package/{id}/{version}:
    parameters:
    - $ref: '#/components/parameters/ET-Client-Name'
    - $ref: '#/components/parameters/X-Correlation-Id'
    get:
      tags:
      - refunding-possibilities
      summary: Retrieves refunding rules for given elements
      operationId: refunding-possibilities_getSPRefundingPossibilities
      parameters:
      - name: id
        in: path
        description: The unique id to identify a product.
        required: true
        style: simple
        explode: false
        schema:
          pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$
          type: string
      - name: version
        in: path
        description: The version of the element.
        required: true
        style: simple
        explode: false
        schema:
          pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$
          type: string
      - name: Accept-Language
        in: header
        description: The language code for the name and description fields.
        required: false
        style: simple
        explode: false
        schema:
          type: string
      - name: Entur-Distribution-Channel
        in: header
        description: The id of the distribution channel.
        required: false
        style: simple
        explode: false
        schema:
          type: string
      - name: If-None-Match
        in: header
        description: Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.
        required: false
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Returns the resource.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Refunding'
        '304':
          description: Not Modified
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                type: string
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                type: string
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                type: string
        '404':
          description: Resource not found.
          content:
            application/problem+json:
              schema:
                type: string
        '500':
          description: Internal server error.
          content:
            application/problem+json:
              schema:
                type: string
      security:
      - basic_auth: []
      x-entur-permissions:
        value: product-api-access:les
    servers:
    - url: https://api.entur.io/products
      description: Production environment
    - url: https://api.staging.entur.io/products
      description: Staging environment
    - url: https://api.dev.entur.io/products
      description: Development environment
  /refunding-possibilities/validable-element/{id}/{version}:
    parameters:
    - $ref: '#/components/parameters/ET-Client-Name'
    - $ref: '#/components/parameters/X-Correlation-Id'
    get:
      tags:
      - refunding-possibilities
      summary: Retrieves refunding rules for given elements
      operationId: refunding-possibilities_getVERefundingPossibilities
      parameters:
      - name: id
        in: path
        description: The unique id to identify a product.
        required: true
        style: simple
        explode: false
        schema:
          pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$
          type: string
      - name: version
        in: path
        description: The version of the element.
        required: true
        style: simple
        explode: false
        schema:
          pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$
          type: string
      - name: Accept-Language
        in: header
        description: The language code for the name and description fields.
        required: false
        style: simple
        explode: false
        schema:
          type: string
      - name: Entur-Distribution-Channel
        in: header
        description: The id of the distribution channel.
        required: false
        style: simple
        explode: false
        schema:
          type: string
      - name: If-None-Match
        in: header
        description: Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.
        required: false
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Returns the resource.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Refunding'
        '304':
          description: Not Modified
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                type: string
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                type: string
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                type: string
        '404':
          description: Resource not found.
          content:
            application/problem+json:
              schema:
                type: string
        '500':
          description: Internal server error.
          content:
            application/problem+json:
              schema:
                type: string
      security:
      - basic_auth: []
      x-entur-permissions:
        value: product-api-access:les
    servers:
    - url: https://api.entur.io/products
      description: Production environment
    - url: https://api.staging.entur.io/products
      description: Staging environment
    - url: https://api.dev.entur.io/products
      description: Development environment
components:
  schemas:
    VersionOfObjectRef:
      required:
      - nameOfClass
      - ref
      - version
      type: object
      properties:
        nameOfClass:
          minLength: 1
          type: string
          description: Name of class.
        ref:
          minLength: 1
          pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$
          type: string
          description: The netex id reference to the object.
        version:
          type: string
          description: Version.
      description: Fare frame ref.
    IdAndVersion:
      required:
      - id
      - version
      type: object
      properties:
        id:
          minLength: 1
          pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$
          type: string
          description: ID of the element.
        version:
          minLength: 1
          pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$
          type: string
          description: Version of the element.
      description: Describes the ID and version of an element.
    Refunding:
      required:
      - allowed
      - changed
      - created
      - fareFrameRef
      - fareTableRefs
      - id
      - modification
      - nameOfClass
      - status
      - version
      type: object
      properties:
        allowed:
          type: string
          description: Allowed.
          enum:
          - NONE
          - PARTIAL
          - FULL
          examples:
          - FULL
        canChangeClass:
          type: boolean
          description: Whether user can change class.
        changed:
          type: string
          description: Changed datetime.
        compatibleWithVersionRef:
          type: string
          description: Compatible with version.
        created:
          type: string
          description: Created datetime.
        derivedFromVersionRef:
          type: string
          description: Derived from version.
        description:
          type: array
          description: Description represented in different languages. Language codes are ISO-639.
          items:
            $ref: '#/components/schemas/TextInLanguage'
        exchangeableFromAnyTime:
          type: boolean
          description: Can be exchanged or refunded from any point after purchase.
        exchangeableFromDuration:
          type: string
          description: Exchangeable from duration.
          examples:
          - PT24H
        exchangeableUntilAnyTime:
          type: boolean
          description: Can be exchanged or refunded until any point after purchase.
        exchangeableUntilDuration:
          type: string
          description: Exchangeable until duration.
        fareFrameRef:
          $ref: '#/components/schemas/VersionOfObjectRef'
        fareTableRefs:
          type: array
          description: References for associated fare tables.
          items:
            $ref: '#/components/schemas/VersionOfObjectRef'
        hasFee:
          type: boolean
          description: Has fee.
        id:
          minLength: 1
          pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$
          type: string
          description: Id.
          examples:
          - NSB:Refunding:FullRefundUntilLimit
        limitingRule:
          type: string
          description: Pricing rule.
        limitingRuleRef:
          $ref: '#/components/schemas/VersionOfObjectRef'
        modification:
          type: string
          description: Modification status.
          enum:
          - NEW
          - REVISE
          - DELETE
          examples:
          - NEW
        name:
          type: array
          description: Name represented in different languages. Language codes are ISO-639.
          items:
            $ref: '#/components/schemas/TextInLanguage'
        nameOfClass:
          type: string
          description: Name of class.
          examples:
          - Refunding
        onlyAtCertainDistributionPoints:
          type: boolean
          description: Whether distribution is restricted to certain points.
        prices:
          type: array
          description: Prices in different currencies for the refunding rule.
          items:
            $ref: '#/components/schemas/FarePrice'
        refundBasis:
          type: string
          description: Basis on which refund is made. See allowed values below.
          enum:
          - PER_OFFER
          - PER_PERSON
          examples:
          - PER_OFFER
        refundType:
          type: string
          description: Refund type.
          enum:
          - UNUSED
          - DELAY
          - CANCELLATION
          - PARTIAL_JOURNEY
          - OTHER
          examples:
          - UNUSED
        resellWhen:
          type: string
          description: Event marking when the refundable status of the ticket changes.
          enum:
          - NEVER
          - BEFORE_START_OF_VALIDITY_PERIOD
          - AFTER_START_OF_VALIDITY_PERIOD
          - AFTER_END_OF_VALIDITY_PERIOD
          - BEFORE_FIRST_USE
          - AFTER_FIRST_USE
          - BEFORE_VALIDATION
          - AFTER_VALIDATION
          - AFTER_PURCHASE
          examples:
          - NEVER
        status:
          type: string
          description: Refunding status.
          enum:
          - DRAFT
          - PROPOSED
          - VERSIONED
          - DEPRECATED
          examples:
          - DRAFT
        unusedTicketsOnly:
          type: boolean
          description: Unused tickets only.
        version:
          minLength: 1
          pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$
          type: string
          description: Refunding version.
          examples:
          - NSB:Version:V1
      description: Refunding
    RefundingAlternatives:
      required:
      - ref
      - refundingOptions
      type: object
      properties:
        ref:
          $ref: '#/components/schemas/IdAndVersion'
        refundingOptions:
          type: array
          description: Refunding alternatives for this element.
          items:
            $ref: '#/components/schemas/Refunding'
      description: Refunding alternatives for an element.
    FarePrice:
      required:
      - changed
      - created
      - fareFrameRef
      - id
      - modification
      - nameOfClass
      - status
      type: object
      properties:
        amount:
          type: string
          description: Amount
          examples:
          - '164.0'
        canBeCumulative:
          type: boolean
          description: canBeCumulative.
          examples:
          - true
        changed:
          type: string
          description: Changed datetime.
          readOnly: true
        compatibleWithVersionRef:
          type: string
          description: Compatible with version.
        created:
          type: string
          description: Created datetime.
          readOnly: true
        currency:
          type: string
          description: Currency.
          examples:
          - NOK
        derivedFromVersionRef:
          type: string
          description: Derived from version.
        discountPercentageUsed:
          maximum: 100
          minimum: -100
          type: integer
          description: discountPercentageUsed.
          format: int32
          examples:
          - 5
        fareFrameRef:
          $ref: '#/components/schemas/VersionOfObjectRef'
        id:
          minLength: 1
          type: string
          description: Id.
          examples:
          - NSB:FarePrice:1005TEN
        isAllowed:
          type: boolean
          description: isAllowed.
          examples:
          - true
        limitingRule:
          $ref: '#/components/schemas/LimitingRule'
        modification:
          type: string
          description: Modification status.
          readOnly: true
          enum:
          - NEW
          - REVISE
          - DELETE
          examples:
          - NEW
        name:
          type: array
          description: Name.
          items:
            $ref: '#/components/schemas/TextInLanguage'
        nameOfClass:
          type: string
          description: Name of class.
          readOnly: true
          examples:
          - FarePrice
        ranking:
          type: integer
          description: Ranking.
          format: int32
          examples:
          - 1
        rounding:
          $ref: '#/components/schemas/Rounding'
        roundingRef:
          $ref: '#/components/schemas/VersionOfObjectRef'
        status:
          type: string
          description: Status.
          readOnly: true
          enum:
          - DRAFT
          - PROPOSED
          - VERSIONED
          - DEPRECATED
          examples:
          - DRAFT
        vatRegisterGroup:
          type: string
          description: vatRegisterGroup.
          enum:
          - EXCEPTION_FROM_VAT
          - GENERAL_VAT
          - FOOD_VAT
          - TRANSPORT_AND_TICKETS_VAT
          examples:
          - TRANSPORT_AND_TICKETS_VAT
        version:
          type: string
          description: Version.
          readOnly: true
          examples:
          - NSB:Version:V1
      description: A description of the price and factor for a set fare
    ParameterPossibilitiesRequest:
      type: object
      properties:
        fareStructureElements:
          type: array
          description: Fare structure elements the user wants to retrieve the parameter alternatives for.
          items:
            $ref: '#/components/schemas/IdAndVersion'
        preassignedFareProducts:
          type: array
          description: Preassigned products the user wants to retrieve the parameter alternatives for.
          items:
            $ref: '#/components/schemas/IdAndVersion'
        salesPackages:
          type: array
          description: Sales packages the user wants to retrieve the parameter alternatives for.
          items:
            $ref: '#/components/schemas/IdAndVersion'
        validableElements:
          type: array
          description: Validable elements the user wants to retrieve the parameter alternatives for.
          items:
            $ref: '#/components/schemas/IdAndVersion'
      description: Request for retrieving refunding alternatives for elements.
    LimitingRule:
      required:
      - changed
      - created
      - fareFrameRef
      - id
      - modification
      - nameOfClass
      - status
      type: object
      properties:
        canBeCumulative:
          type: boolean
          description: CanBeCumulative.
        changed:
          type: string
          description: Changed datetime.
          readOnly: true
        compatibleWithVersionRef:
          type: string
          description: Compatible with version.
        created:
          type: string
          description: Created datetime.
          readOnly: true
        derivedFromVersionRef:
          type: string
          description: Derived from version.
        description:
          type: array
          description: Description.
          items:
            $ref: '#/components/schemas/TextInLanguage'
        discountAsPercentage:
          type: number
          description: DiscountAsPercentage.
          format: float
        discountAsValue:
          type: number
          description: DiscountAsValue.
          format: float
        fareFrameRef:
          $ref: '#/components/schemas/VersionOfObjectRef'
        id:
          minLength: 1
          pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$
          type: string
          description: Id.
        maximumPrice:
          type: string
          description: MaximumPrice.
          examples:
          - '164.0'
        maximumPriceAsPercentage:
          type: number
          description: MaximumPriceAsPercentage.
          format: double
        minimumLimitPrice:
          type: string
          description: MinimumLimitPrice.
          examples:
          - '164.0'
        minimumPrice:
          type: string
          description: MinimumPrice.
          examples:
          - '164.0'
        modification:
          type: string
          description: Modification status.
          readOnly: true
          enum:
          - NEW
          - REVISE
          - DELETE
          examples:
          - NEW
        name:
          type: array
          description: Name.
          items:
            $ref: '#/components/schemas/TextInLanguage'
        nameOfClass:
          type: string
          description: Name of class.
          readOnly: true
          examples:
          - LimitingRule
        status:
          type: string
          description: Status.
          readOnly: true
          enum:
          - DRAFT
          - PROPOSED
          - VERSIONED
          - DEPRECATED
          examples:
          - DRAFT
        version:
          minLength: 1
          pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$
          type: string
          description: Version.
          examples:
          - NSB:Version:V1
      description: A LimitingRule
    TextInLanguage:
      required:
      - lang
      - value
      type: object
      properties:
        lang:
          minLength: 1
          type: string
          description: Language code.
          examples:
          - nob
        value:
          minLength: 1
          type: string
          description: The text.
      description: Text in a specific language.
    Rounding:
      required:
      - changed
      - created
      - fareFrameRef
      - id
      - modification
      - nameOfClass
      - roundingMethod
      - status
      - version
      type: object
      properties:
        changed:
          type: string
          description: Changed datetime.
          readOnly: true
        compatibleWithVersionRef:
          type: string
          description: Compatible with version.
        created:
          type: string
          description: Created datetime.
          readOnly: true
        derivedFromVersionRef:
          type: string
          description: Derived from version.
        description:
          type: array
          description: Description.
          items:
            $ref: '#/components/schemas/TextInLanguage'
        fareFrameRef:
          $ref: '#/components/schemas/VersionOfObjectRef'
        id:
          minLength: 1
          pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$
          type: string
          description: Id.
          examples:
          - NSB:Rounding:Ordinary
        modification:
          type: string
          description: Modification status.
          readOnly: true
          enum:
          - NEW
          - REVISE
          - DELETE
          examples:
          - NEW
        name:
          type: array
          description: Name.
          items:
            $ref: '#/components/schemas/TextInLanguage'
        nameOfClass:
          type: string
          description: Name of class.
          readOnly: true
          examples:
          - Rounding
        roundingMethod:
          type: string
          description: Type of rounding.
          enum:
          - NONE
          - DOWN
          - UP
          - SPLIT
          - STEP_TABLE
          - FIVE
          - NINE
          - TEN
          - FORTY_NINE
        roundingModulus:
          type: number
          description: Amount by which rounding is to be quantised, i.e. results should be quantised to nearest whole multiple of this value.
          format: double
        status:
          type: string
          description: Rounding status.
          readOnly: true
          enum:
          - DRAFT
          - PROPOSED
          - VERSIONED
          - DEPRECATED
          examples:
          - DRAFT
        version:
          minLength: 1
          pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$
          type: string
          description: Rounding version.
          examples:
          - NSB:Version:V1
      description: A description of how prices are rounded post calculation
      deprecated: true
  parameters:
    X-Correlation-Id:
      name: X-Correlation-Id
      in: header
      description: Correlation id
      required: false
      style: simple
      explode: false
      schema:
        type: string
    ET-Client-Name:
      name: ET-Client-Name
      in: header
      description: 'Entur Client Header.

        It is required that all consumers identify themselves by using this header.

        Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers.

        The structure of ET-Client-Name should be: `<company>-<application>`.'
      required: false
      style: simple
      explode: false
      schema:
        type: string
  securitySchemes:
    jwt:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-refined-from:
- entur-products-openapi.json
- entur-products-openapi.yml