Skip to content

Refund ​

Returns the amounts actually refunded per ticket for an order that has already been cancelled/returned. Identical shape to Cancel Conditions, but the amounts reflect the realised refund rather than a preview.

This is a safe, idempotent read.

Endpoint ​

Method: GET

URL: /v1/order/{order_id}/refund

Request Headers ​

ParameterTypeRequiredDescription
AuthorizationStringYesBearer <token> from Login

Path Parameters ​

ParameterTypeRequiredDescription
order_idStringYesProvider order id (Order.id returned by Create Order)

Query Parameters ​

ParameterTypeRequiredDescription
localeStringNoLocalises the human-readable refund notes, refer to Locale List

Response Parameters ​

The response is identical in shape to Cancel Conditions: a conditions object with per-ticket RefundTicket lines reflecting the realised refund.

Response Example ​

json
{
  "conditions": {
    "can_be_canceled": false,
    "currency": "UAH",
    "tickets": [
      {
        "ticket_code": "BK-9931",
        "currency": "UAH",
        "refund_amount": 585.0,
        "refund_fee_amount": 65.0,
        "full_refund": false
      }
    ]
  }
}

Error Code List ​

codemessageDescription
UNAUTHORIZEDInvalid tokenThe bearer token is missing, invalid, or expired (401).
NOT_FOUNDNo refund for orderThe order has no refund (never cancelled, or unknown order_id).

TTN Octo API documentation