Compensation

Server

Reduce the price of one or more orders to compensate customers without performing a full refund. Used when a price adjustment is sufficient instead of cancelling or refunding order lines.

Reduce one or multiple orders' price and thus provide compensation for the paying customer

POST

https://api.entur.io/sales

/v1/compensations

Leverages the possibility to compensate one or more orders in a batch operation

Reduce one or multiple orders' price and thus provide compensation for the paying customer › Headers

Authorization

string · required · style: simple

Authorization header

Entur-Distribution-Channel

string · required · style: simple

Distribution channel identifier.

Entur-Pos

string · required · style: simple

Point-of-sale identifier.

Entur-Settlement-Id

string · style: simple

An id for connecting a credit to a settlement

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

Reduce one or multiple orders' price and thus provide compensation for the paying customer › Request Body

A request performing compensation operations in batch

CompensationRequest

CompensationOperation[] · required

A required list of one or more compensation operations

Reduce one or multiple orders' price and thus provide compensation for the paying customer › Responses

The response from performing one or more compensation operations

CompensationResponse

CompensationResult[] · required

POST/v1/compensations

curl https://api.entur.io/sales/v1/compensations \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: <string>' \
  --header 'Entur-Distribution-Channel: <string>' \
  --header 'Entur-Pos: <string>' \
  --data '{
  "compensationOperations": [
    {
      "orderId": "NTA2JGR7",
      "elements": [
        {
          "orderLineIds": [
            "a3d7bfeb-c76c-4ded-8253-dbd04da15c13",
            "26b02145-7dbf-4be9-8600-ff4a570d83d5"
          ],
          "compensationAmount": "123.45",
          "compensationReason": "The bus was late"
        }
      ]
    }
  ]
}'

Example Request Body

{
  "compensationOperations": [
    {
      "orderId": "NTA2JGR7",
      "elements": [
        {
          "orderLineIds": [
            "a3d7bfeb-c76c-4ded-8253-dbd04da15c13",
            "26b02145-7dbf-4be9-8600-ff4a570d83d5"
          ],
          "compensationAmount": "123.45",
          "compensationReason": "The bus was late"
        }
      ]
    }
  ]
}

json

Example Responses

{
  "operationResults": [
    {
      "orderId": "NTA2JGR7",
      "details": [
        {
          "orderLineIds": [
            "a3d7bfeb-c76c-4ded-8253-dbd04da15c13",
            "26b02145-7dbf-4be9-8600-ff4a570d83d5"
          ],
          "feeId": "fd894a04-bfa5-4e04-92e5-fd235449ea7d",
          "involvedAuthorityIds": [
            "ENT:Authority:Test"
          ]
        }
      ],
      "affectedPaymentAndPaymentTransactionIds": {
        "286535": [
          6784139,
          6784140
        ]
      },
      "creditId": 123456
    }
  ]
}

json

application/json

Reduce an single order price and thus provide compensation for the paying customer

PUT

https://api.entur.io/sales

/v1/compensations/{orderId}

Leverages the possibility to compensate one order

Reduce an single order price and thus provide compensation for the paying customer › path Parameters

orderId

string · required · style: simple

The id of the order that one would like to get or perform refund operations on

Reduce an single order price and thus provide compensation for the paying customer › Headers

Authorization

string · required · style: simple

Authorization header

Entur-Distribution-Channel

string · required · style: simple

Distribution channel identifier.

Entur-Pos

string · required · style: simple

Point-of-sale identifier.

Entur-Settlement-Id

string · style: simple

An id for connecting a credit to a settlement

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Reduce an single order price and thus provide compensation for the paying customer › Request Body

A request performing an single compensation operation

CompensationOperationRequest

CompensationElement[]

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

Reduce an single order price and thus provide compensation for the paying customer › Responses

The response from performing a single compensation operation

CompensationOperationResponse

CompensationResult · required

The response from performing one or more compensation operations

PUT/v1/compensations/{orderId}

curl https://api.entur.io/sales/v1/compensations/:orderId \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: <string>' \
  --header 'Entur-Distribution-Channel: <string>' \
  --header 'Entur-Pos: <string>' \
  --data '{
  "elements": [
    {
      "orderLineIds": [
        "a3d7bfeb-c76c-4ded-8253-dbd04da15c13",
        "26b02145-7dbf-4be9-8600-ff4a570d83d5"
      ],
      "compensationAmount": "123.45",
      "compensationReason": "The bus was late"
    }
  ],
  "additionalTerminalData": {
    "additionalData": {
      "key": "string"
    },
    "baxNumber": "123456",
    "obfuscatedCardNumber": "************1234",
    "paymentType": "MASTERCARD",
    "rrn": "000000016575",
    "terminalId": "84565479",
    "transactionConfirmedAt": "2018-03-07T12:20:46Z"
  },
  "overrideReimbursementType": "CASH"
}'

Example Request Body

{
  "elements": [
    {
      "orderLineIds": [
        "a3d7bfeb-c76c-4ded-8253-dbd04da15c13",
        "26b02145-7dbf-4be9-8600-ff4a570d83d5"
      ],
      "compensationAmount": "123.45",
      "compensationReason": "The bus was late"
    }
  ],
  "additionalTerminalData": {
    "additionalData": {
      "key": "string"
    },
    "baxNumber": "123456",
    "obfuscatedCardNumber": "************1234",
    "paymentType": "MASTERCARD",
    "rrn": "000000016575",
    "terminalId": "84565479",
    "transactionConfirmedAt": "2018-03-07T12:20:46Z"
  },
  "overrideReimbursementType": "CASH"
}

json

Example Responses

{
  "operationResult": {
    "orderId": "NTA2JGR7",
    "details": [
      {
        "orderLineIds": [
          "a3d7bfeb-c76c-4ded-8253-dbd04da15c13",
          "26b02145-7dbf-4be9-8600-ff4a570d83d5"
        ],
        "feeId": "fd894a04-bfa5-4e04-92e5-fd235449ea7d",
        "involvedAuthorityIds": [
          "ENT:Authority:Test"
        ]
      }
    ],
    "affectedPaymentAndPaymentTransactionIds": {
      "286535": [
        6784139,
        6784140
      ]
    },
    "creditId": 123456
  }
}

json

application/json

Refund

Did you find what you were looking for?

Compensation

Reduce one or multiple orders' price and thus provide compensation for the paying customer

Reduce one or multiple orders' price and thus provide compensation for the paying customer › Headers

Reduce one or multiple orders' price and thus provide compensation for the paying customer › Request Body

Reduce one or multiple orders' price and thus provide compensation for the paying customer › Responses

Reduce an single order price and thus provide compensation for the paying customer

Reduce an single order price and thus provide compensation for the paying customer › path Parameters

Reduce an single order price and thus provide compensation for the paying customer › Headers

Reduce an single order price and thus provide compensation for the paying customer › Request Body

Reduce an single order price and thus provide compensation for the paying customer › Responses

Build with Entur

Contribute

Terms & Policies