Entur Developer
Partner
REST
Refunds

CompensationElement

A element that wraps a sub operation on a given order. Typically when different
compensationAmount
​string · required

The amount of compensation desired for this order

orderLineIds
​string[]

Optional list of order line ids that are to be compensated. If left empty the whole order is assumed to be compensated

compensationReason
​string

Optional field describing the reason for the compensation

CompensationOperation

An entry describing a compensation operation
orderId
​string · required

The order id referencing the order to be compensated

​CompensationElement[] · required

A list of compensation elements

CompensationRequest

A request performing compensation operations in batch
​CompensationOperation[] · required

A required list of one or more compensation operations

CompensationDetails

The summary of a CompensationElement' outcome
feeId
​string · required

ID of the resulting REDUCTION fee for the compensation

involvedAuthorityIds
​string[] · required

A list of all the Authority ids associated with the compensated operation

orderLineIds
​string[]

Optional list of order line ids that have been compensated. If empty the whole order was compensated

CompensationResult

The response from performing one or more compensation operations
orderId
​string · required
​CompensationDetails[] · required

A collection of compensation details, corresponding to each CompensationElement in a CompensationOperation

​object · pattern: \\d+ · required

Map containing one or more payment ids, mapping to its transaction ids that have been affected by the credit operation

creditId
​integer · int64 · required

ID of the performed Credit

CompensationResponse

The response from performing one or more compensation operations
​CompensationResult[] · required

RefundError

title
​string · required
error
​string · required
exception
​string · required
message
​string · required
path
​string · required
status
​integer · int32 · required
timestamp
​string · date-time · required

TerminalRefundingData

Holder for data that needs to be provided when performing a refund on an external terminal
baxNumber
​string · required

When performing an offline refund to card terminal, the BAX-number is mandatory info

obfuscatedCardNumber
​string · required

The obfuscated value of the card number the refund was performed against

paymentType
​string · required

The type of payment method that is provided to the terminal for refunding

rrn
​string · required

Reconciliation reference number used to track an order (transaction) through different economy systems. Generated by a terminal

terminalId
​string · required

When performing an offline refund to card terminal, the terminal id is mandatory info

transactionConfirmedAt
​string · date-time · required

Datetime when credit transaction was completed externally by the client.

​object

Any extra transaction data which could be relevant can be specified as a key value map of strings. If there exists keys here that clash with specific types in this request, the fields in the request are prioritized

CompensationOperationRequest

A request performing an single compensation operation

A list of compensation elements

​TerminalRefundingData

Holder for data that needs to be provided when performing a refund on an external terminal

overrideReimbursementType
​string

Used to override the payment method that the refund operations will be registered as. All refund operations that will target a payment transaction that is imported, will be overridden. Available types: CASH

CompensationOperationResponse

The response from performing a single compensation operation
​CompensationResult · required

The response from performing one or more compensation operations

ProductLevel

string · enum
Enum values:
SALE_PACKAGE
FARE_PRODUCT
VALIDABLE_ELEMENT
FARESTRUCTURE_ELEMENT

The level the element resides

ProductElementIdentifier

A type for depicting where an element resides in a sales package tree
level
​ProductLevel · enum · required

The level the element resides

Enum values:
SALE_PACKAGE
FARE_PRODUCT
VALIDABLE_ELEMENT
FARESTRUCTURE_ELEMENT
fareStructureElementIndex
​integer · int32

The index of the element on the farestructure element level

fareproductIndex
​integer · int32

The index of the element on the fareproduct level

validableElementIndex
​integer · int32

The index of the element on the validable element level

AffectedPaymentTransaction

A composition of payment transaction data that is affected, including the amount that will be subtracted if used in a refund
amount
​string · required

The amount that will be subtracted from the transaction if used in a refund

generalType
​string · required

The general type of payment

import
​boolean · required
paymentId
​integer · int64 · required

The id of a payment

transactionId
​integer · int64 · required

The id of the payment transaction

rrn
​string

The Retrieval Reference Number for the affected transaction

specificType
​string

If available, a more specific payment type

OrderReference

Wrapper detailing a OrderReference to an instance
id
​string · required

The id of the instance

version
​integer · int32 · required

The version of the instance

ProductsElementWrapper

A data-wrapper for a product type
id
​string · required

The id of the product type

version
​string · required

The version of the product type

name
​string

The name of the product type

RefundOption

A representation of a complete refundable option
​AffectedPaymentTransaction[] · required

A summary list of which payment and its transactions that will be affected if this option is selected

expiresAt
​string · date-time · required

The datetime that this option will expire

fee
​string · required

The fee this option will entail. This needs to be subtracted from refundAmount to get the final amount that will be refunded

​OrderReference · required

Wrapper detailing a OrderReference to an instance

​ProductsElementWrapper · required

A data-wrapper for a product type

​ProductElementIdentifier · required

A type for depicting where an element resides in a sales package tree

refundAmount
​string · required

The refundable amount that this option permits

​ProductsElementWrapper · required

A data-wrapper for a product type

transientId
​string · uuid · required

An id for an option that is unique only in the context of a RefundOptionResponse

​ProductElementIdentifier[]

An optional list of additional elements on the same product level that this option also will consume

Default: []

RefundOptionResponse

A response detailing all refundable options for an order
optionIdsThatCanBePerformedTogether
​array[] · unique · required

A set of option ids that are possible to refund together. If only one option is returned, this will be empty. Ids are only valid inside the scope of a RefundOptionResponse

​RefundOption[] · required

All the refundable options for a given order, or options for requested order lines

Default: []
​OrderReference · required

Wrapper detailing a OrderReference to an instance

PerformRefundEntry

A refund 'operation' that describes which order line, and which elements in that order line product tree that is to be refunded
​OrderReference · required

Wrapper detailing a OrderReference to an instance

​ProductElementIdentifier[] · required

A list of identifiers for which element(s) in the order lines product tree that is to be refunded

The refund rule that is to be used with this entry.

RefundRequest

A request for performing a refund
​PerformRefundEntry[] · required

A list of refund operations which will specify order line, optionally where in the product tree the change occurs, and how much money should be refunded with this change

​TerminalRefundingData

Holder for data that needs to be provided when performing a refund on an external terminal

​object

Optional key value map of strings passed on to the credit as transaction data. Only applies when the refunded payment transaction is imported. Keys that clash with transaction data set by refund are ignored.

includesCancelledOrderLines
​boolean

Lets refund know that the request will include already cancelled order lines, and to handle them accordingly

RefundResponse

A summary about a performed refund.
orderId
​string · required

ID of the refunded order.

affectedOrderLineIds
​string[] · required

List containing the IDs of the affected order lines.

Default: []
creditId
​integer · int64 · required

ID of the performed Credit

​object · pattern: \\d+ · required

Map containing one or more payment ids, mapping to its transaction ids that have been affected by the credit operation

disabledTicketIds
​integer[] · required

List containing the IDs of the disabled tickets.

Default: []

DryRunRefundFee

​ProductsElementWrapper · required

A data-wrapper for a product type

amount
​string · required

The amount of the fee

type
​string · required

The type of a Fee that will be added. REFUNDING or MANUAL

DryRunRefundResponse

A representation of a complete refundable option
orderId
​string · required

The id of the order used

totalRefundAmount
​string · required

The total amount that will be refunded if refund is called with the provided input

​DryRunRefundFee[] · required

The fees that will be added to the order if refund is called with the provided input

​AffectedPaymentTransaction[] · required

A summary list of which payment and its transactions that will be affected if refund is run with the provided input

Did you find what you were looking for?