Creates a full refund for a refundable completed order base

This endpoint can only be used for completed standard order entities.

A refundable completed order base can only be fully refunded when order refund availability AvailableMethods includes order refund method Full

Booking fees may or may not be refunded, as indicated by order refund availability IsBookingFeeRefundable

Licenses Required

  • Vista.Ocapi
Request
path Parameters
orderId
required
string

The unique identifier of the refundable completed order base

header Parameters
Connect-Region-Code
string

Region Code

Request Body schema:
required

The properties required to create the full refund

reason
string or null

Gets the reason for the refund

Responses
200

Success

400

Order cannot be fully refunded.

404

Order does not exist.

post/ocapi/v1/orders/completed/{orderId}/refunds/full
Request samples
{
  • "reason": "string"
}
Response samples
application/json
{
  • "id": "string",
  • "type": "Standard",
  • "status": "InProgress",
  • "totalPrice": {
    },
  • "originalPrice": {
    },
  • "booking": {
    },
  • "transaction": {
    },
  • "vouchers": [
    ],
  • "deals": [
    ],
  • "payments": [
    ],
  • "showtimes": [
    ],
  • "items": [
    ],
  • "itemDeliveries": [
    ],
  • "ticketRedemptionCards": [
    ],
  • "siteId": "string",
  • "preparation": {
    },
  • "amountSaved": {
    },
  • "journeyReference": "string",
  • "tip": {
    },
  • "refundAvailability": {
    },
  • "totalRefunded": {
    },
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "parentOrderId": "string"
}