Entur Developer
Products
Products

refunding-possibilities

Server
Download schema

Retrieves refunding rules for given elements

POST
https://api.entur.io/products
/refunding-possibilities

Retrieves refunding rules for given elements › Headers

ET-Client-Name
​string · style: simple

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>.

X-Correlation-Id
​string · style: simple

Correlation id

Accept-Language
​string · style: simple

The language code for the name and description fields.

Entur-Distribution-Channel
​string · style: simple

The id of the distribution channel.

Retrieves refunding rules for given elements › Request Body

Request for retrieving refunding alternatives for elements.
ParameterPossibilitiesRequest
​IdAndVersion[]

Fare structure elements the user wants to retrieve the parameter alternatives for.

​IdAndVersion[]

Preassigned products the user wants to retrieve the parameter alternatives for.

​IdAndVersion[]

Sales packages the user wants to retrieve the parameter alternatives for.

​IdAndVersion[]

Validable elements the user wants to retrieve the parameter alternatives for.

Retrieves refunding rules for given elements › Responses

Returns the resource.

Refunding alternatives for an element.
RefundingAlternatives
​IdAndVersion · required

Describes the ID and version of an element.

​Refunding[] · required

Refunding alternatives for this element.

Retrieves refunding rules for given elements

GET
https://api.entur.io/products
/refunding-possibilities/preassigned-product/{id}/{version}

Retrieves refunding rules for given elements › path Parameters

id
​string · pattern: ^([A-Z]{3}):([A-Za-z… · required · style: simple

The unique id to identify a product.

version
​string · pattern: ^([A-Z]{3}):([A-Za-z… · required · style: simple

The version of the element.

Retrieves refunding rules for given elements › Headers

ET-Client-Name
​string · style: simple

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>.

X-Correlation-Id
​string · style: simple

Correlation id

Accept-Language
​string · style: simple

The language code for the name and description fields.

Entur-Distribution-Channel
​string · style: simple

The id of the distribution channel.

If-None-Match
​string · style: simple

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.

Retrieves refunding rules for given elements › Responses

Returns the resource.

No data returned

Retrieves refunding rules for given elements

GET
https://api.entur.io/products
/refunding-possibilities/sales-package/{id}/{version}

Retrieves refunding rules for given elements › path Parameters

id
​string · pattern: ^([A-Z]{3}):([A-Za-z… · required · style: simple

The unique id to identify a product.

version
​string · pattern: ^([A-Z]{3}):([A-Za-z… · required · style: simple

The version of the element.

Retrieves refunding rules for given elements › Headers

ET-Client-Name
​string · style: simple

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>.

X-Correlation-Id
​string · style: simple

Correlation id

Accept-Language
​string · style: simple

The language code for the name and description fields.

Entur-Distribution-Channel
​string · style: simple

The id of the distribution channel.

If-None-Match
​string · style: simple

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.

Retrieves refunding rules for given elements › Responses

Returns the resource.

​Refunding[]
Refunding
Refunding
allowed
​string · enum · required

Allowed.

Enum values:
NONE
PARTIAL
FULL
Example: FULL
changed
​string · required

Changed datetime.

created
​string · required

Created datetime.

​VersionOfObjectRef · required

Fare frame ref.

​VersionOfObjectRef[] · required

References for associated fare tables.

id
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:Refunding:FullRefundUntilLimit
modification
​string · enum · required

Modification status.

Enum values:
NEW
REVISE
DELETE
Example: NEW
nameOfClass
​string · required

Name of class.

Example: Refunding
status
​string · enum · required

Refunding status.

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
version
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Refunding version.

Example: NSB:Version:V1
canChangeClass
​boolean

Whether user can change class.

compatibleWithVersionRef
​string

Compatible with version.

derivedFromVersionRef
​string

Derived from version.

​TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

exchangeableFromAnyTime
​boolean

Can be exchanged or refunded from any point after purchase.

exchangeableFromDuration
​string

Exchangeable from duration.

Example: PT24H
exchangeableUntilAnyTime
​boolean

Can be exchanged or refunded until any point after purchase.

exchangeableUntilDuration
​string

Exchangeable until duration.

hasFee
​boolean

Has fee.

limitingRule
​string

Pricing rule.

​VersionOfObjectRef

Fare frame ref.

​TextInLanguage[]

Name represented in different languages. Language codes are ISO-639.

onlyAtCertainDistributionPoints
​boolean

Whether distribution is restricted to certain points.

​FarePrice[]

Prices in different currencies for the refunding rule.

refundBasis
​string · enum

Basis on which refund is made. See allowed values below.

Enum values:
PER_OFFER
PER_PERSON
Example: PER_OFFER
refundType
​string · enum

Refund type.

Enum values:
UNUSED
DELAY
CANCELLATION
PARTIAL_JOURNEY
OTHER
Example: UNUSED
resellWhen
​string · enum

Event marking when the refundable status of the ticket changes.

Enum values:
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
Example: NEVER
unusedTicketsOnly
​boolean

Unused tickets only.

Retrieves refunding rules for given elements

GET
https://api.entur.io/products
/refunding-possibilities/validable-element/{id}/{version}

Retrieves refunding rules for given elements › path Parameters

id
​string · pattern: ^([A-Z]{3}):([A-Za-z… · required · style: simple

The unique id to identify a product.

version
​string · pattern: ^([A-Z]{3}):([A-Za-z… · required · style: simple

The version of the element.

Retrieves refunding rules for given elements › Headers

ET-Client-Name
​string · style: simple

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>.

X-Correlation-Id
​string · style: simple

Correlation id

Accept-Language
​string · style: simple

The language code for the name and description fields.

Entur-Distribution-Channel
​string · style: simple

The id of the distribution channel.

If-None-Match
​string · style: simple

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.

Retrieves refunding rules for given elements › Responses

Returns the resource.

​Refunding[]
Refunding
Refunding
allowed
​string · enum · required

Allowed.

Enum values:
NONE
PARTIAL
FULL
Example: FULL
changed
​string · required

Changed datetime.

created
​string · required

Created datetime.

​VersionOfObjectRef · required

Fare frame ref.

​VersionOfObjectRef[] · required

References for associated fare tables.

id
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Id.

Example: NSB:Refunding:FullRefundUntilLimit
modification
​string · enum · required

Modification status.

Enum values:
NEW
REVISE
DELETE
Example: NEW
nameOfClass
​string · required

Name of class.

Example: Refunding
status
​string · enum · required

Refunding status.

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
version
​string · minLength: 1 · pattern: ^([A-Z]{3}):([A-Za-z… · required

Refunding version.

Example: NSB:Version:V1
canChangeClass
​boolean

Whether user can change class.

compatibleWithVersionRef
​string

Compatible with version.

derivedFromVersionRef
​string

Derived from version.

​TextInLanguage[]

Description represented in different languages. Language codes are ISO-639.

exchangeableFromAnyTime
​boolean

Can be exchanged or refunded from any point after purchase.

exchangeableFromDuration
​string

Exchangeable from duration.

Example: PT24H
exchangeableUntilAnyTime
​boolean

Can be exchanged or refunded until any point after purchase.

exchangeableUntilDuration
​string

Exchangeable until duration.

hasFee
​boolean

Has fee.

limitingRule
​string

Pricing rule.

​VersionOfObjectRef

Fare frame ref.

​TextInLanguage[]

Name represented in different languages. Language codes are ISO-639.

onlyAtCertainDistributionPoints
​boolean

Whether distribution is restricted to certain points.

​FarePrice[]

Prices in different currencies for the refunding rule.

refundBasis
​string · enum

Basis on which refund is made. See allowed values below.

Enum values:
PER_OFFER
PER_PERSON
Example: PER_OFFER
refundType
​string · enum

Refund type.

Enum values:
UNUSED
DELAY
CANCELLATION
PARTIAL_JOURNEY
OTHER
Example: UNUSED
resellWhen
​string · enum

Event marking when the refundable status of the ticket changes.

Enum values:
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
Example: NEVER
unusedTicketsOnly
​boolean

Unused tickets only.

refundingreplacing
Did you find what you were looking for?