Schemas
RefundError
patherrortitlestatusmessageexceptiontimestampProductLevel
The level the element resides
RefundOption
feeThe fee this option will entail. This needs to be subtracted from refundAmount to get the final amount that will be refunded
A data-wrapper for a product type
expiresAtThe datetime that this option will expire
A data-wrapper for a product type
transientIdAn id for an option that is unique only in the context of a RefundOptionResponse
Wrapper detailing a OrderReference to an instance
refundAmountThe refundable amount that this option permits
A type for depicting where an element resides in a sales package tree
A summary list of which payment and its transactions that will be affected if this option is selected
An optional list of additional elements on the same product level that this option also will consume
RefundRequest
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
Holder for data that needs to be provided when performing a refund on an external terminal
includesCancelledOrderLinesLets refund know that the request will include already cancelled order lines, and to handle them accordingly
OrderReference
idThe id of the instance
versionThe version of the instance
RefundResponse
orderIdID of the refunded order.
creditIdID of the performed Credit
disabledTicketIdsList containing the IDs of the disabled tickets.
affectedOrderLineIdsList containing the IDs of the affected order lines.
\\d+ · requiredMap containing one or more payment ids, mapping to its transaction ids that have been affected by the credit operation
DryRunRefundFee
typeThe type of a Fee that will be added. REFUNDING or MANUAL
amountThe amount of the fee
A data-wrapper for a product type
CompensationResult
A collection of compensation details, corresponding to each CompensationElement in a CompensationOperation
orderIdcreditIdID of the performed Credit
\\d+ · requiredMap containing one or more payment ids, mapping to its transaction ids that have been affected by the credit operation
PerformRefundEntry
Wrapper detailing a OrderReference to an instance
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.
CompensationDetails
feeIdID of the resulting REDUCTION fee for the compensation
involvedAuthorityIdsA list of all the Authority ids associated with the compensated operation
orderLineIdsOptional list of order line ids that have been compensated. If empty the whole order was compensated
CompensationElement
compensationAmountThe amount of compensation desired for this order
orderLineIdsOptional list of order line ids that are to be compensated. If left empty the whole order is assumed to be compensated
compensationReasonOptional field describing the reason for the compensation
CompensationRequest
A required list of one or more compensation operations
CompensationResponse
DryRunRefundResponse
The fees that will be added to the order if refund is called with the provided input
orderIdThe id of the order used
totalRefundAmountThe total amount that will be refunded if refund is called with the provided input
A summary list of which payment and its transactions that will be affected if refund is run with the provided input
RefundOptionResponse
All the refundable options for a given order, or options for requested order lines
Wrapper detailing a OrderReference to an instance
optionIdsThatCanBePerformedTogetherA 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
CompensationOperation
orderIdThe order id referencing the order to be compensated
A list of compensation elements
TerminalRefundingData
rrnReconciliation reference number used to track an order (transaction) through different economy systems. Generated by a terminal
baxNumberWhen performing an offline refund to card terminal, the BAX-number is mandatory info
terminalIdWhen performing an offline refund to card terminal, the terminal id is mandatory info
paymentTypeThe type of payment method that is provided to the terminal for refunding
obfuscatedCardNumberThe obfuscated value of the card number the refund was performed against
transactionConfirmedAtDatetime when credit transaction was completed externally by the client.
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
ProductsElementWrapper
idThe id of the product type
versionThe version of the product type
nameThe name of the product type
ProductElementIdentifier
levelThe level the element resides
fareproductIndexThe index of the element on the fareproduct level
validableElementIndexThe index of the element on the validable element level
fareStructureElementIndexThe index of the element on the farestructure element level
AffectedPaymentTransaction
amountThe amount that will be subtracted from the transaction if used in a refund
importpaymentIdThe id of a payment
generalTypeThe general type of payment
transactionIdThe id of the payment transaction
rrnThe Retrieval Reference Number for the affected transaction
specificTypeIf available, a more specific payment type
CompensationOperationRequest
A list of compensation elements
Holder for data that needs to be provided when performing a refund on an external terminal
overrideReimbursementTypeUsed 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 one or more compensation operations