Check refundable options and perform refunds on customer orders.
Refund order
By supplying a valid order id and refund-operations, this service will perform a refund on the provided entries.
path Parameters
orderIdThe id of the order that one would like to get or perform refund operations on
Headers
AuthorizationAuthorization header
Entur-Distribution-ChannelDistribution channel identifier.
Entur-PosPoint-of-sale identifier.
Entur-Settlement-IdAn id for connecting a credit to a settlement
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Refund order › Request Body
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
Refund order › Responses
OK
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
Check refundable
By supplying a valid order id (and optional order line ids), this service will provide all existing refundable options that can be performed on that order's (and order line's) latest version
path Parameters
orderIdThe id of the order that one would like to get or perform refund operations on
query Parameters
orderLineIdsAn optional list of comma separated order line ids
orderVersionGet refund options for a specific Order version. The Order in this version must be in status CONFIRMED
includeCancelledLets refund know that it can include already cancelled order lines when constructing refund options. Only usable from a Sørvis client
Headers
AuthorizationAuthorization header
Entur-Distribution-ChannelDistribution channel identifier.
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Check refundable › Responses
OK
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
Perform a 'dry-run' of a refund
By supplying a valid order id and refund-operations, this service will perform a 'dry-run' of a refund and return the total refund amount, possible fees and affected transactions
path Parameters
orderIdThe id of the order that one would like to get or perform refund operations on
Headers
AuthorizationAuthorization header
Entur-Distribution-ChannelDistribution channel identifier.
Entur-PosPoint-of-sale identifier.
Entur-Settlement-IdAn id for connecting a credit to a settlement
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Perform a 'dry-run' of a refund › Request Body
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
Perform a 'dry-run' of a refund › Responses
OK
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