Skip to content

Quote group cancellation

GET
/api/booking/group/{groupIdentifier}/refund-preview
curl --request GET \
--url 'https://api.wink.travel/api/booking/group/a1f4c9e2-7b3d-4e8a-9c21-6f0b5d8e3a47/refund-preview?hotelIdentifier=e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18' \
--header 'Authorization: Bearer <token>' \
--header 'Wink-Version: 2.0'

Read-only preview of the refund for cancelling a group booking, optionally scoped to one hotel, reporting per-booking refundability and the aggregate. Nothing is cancelled.

groupIdentifier
required
string
""

Quote cancellation for this group identifier

Example
a1f4c9e2-7b3d-4e8a-9c21-6f0b5d8e3a47
hotelIdentifier
string
""

Optional. Restrict the quote to bookings for this property within the group.

Example
e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18
Wink-Version
string
default: 2.0.0
Allowed values: 2.0

Group cancellation refund preview

Media typeapplication/json

Read-only preview of what cancelling a booking group would refund, shown to the traveler before they confirm cancellation.

object
displayCurrency

The traveler’s display currency code.

string
"" /^[A-Z]{3}$/
groupIdentifier

The group code being quoted.

string
""
hotelIdentifier

Property the quote is scoped to, or null for the whole trip.

string format: uuid
""
lines

One entry per booking that would be cancelled.

Array<object>
""

A single booking’s line in a group refund preview, showing the refund amount and cancellation details for that booking.

object
bookingCode

The human-readable booking code.

string
""
bookingIdentifier

The booking’s internal identifier.

string format: uuid
""
cancellationPolicy

Human-readable cancellation policy text (may be long).

string
""
endDate

Check-out date.

string format: date
""
hotelName

The property name for this booking.

string
""
refundDisplayAmount

Refund amount in the traveler’s display currency (0 when non-refundable).

number
""
refundType

Whether the refund is FULL, PARTIAL, or NONE.

string
""
Allowed values: NONE PARTIAL FULL
refundable

Whether this booking refunds any money when cancelled.

boolean
startDate

Check-in date.

string format: date
""
totalRefundDisplayAmount

Aggregate refund across all lines, in display currency.

number
""
key
additional properties
""
Example
{
"displayCurrency": "USD",
"groupIdentifier": "G-UOCWALXX",
"hotelIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18",
"lines": [
{
"bookingCode": "MAVWBWMD",
"bookingIdentifier": "f4d1c8e5-2b9a-4f3d-9e7c-1b6a5d3f8c92",
"cancellationPolicy": "Full refund if cancelled before 48 hours of check-in.",
"endDate": "2026-06-10",
"hotelName": "The Siam Residences, Bangkok",
"refundDisplayAmount": 120,
"refundType": "FULL",
"refundable": true,
"startDate": "2026-06-09"
}
],
"totalRefundDisplayAmount": 240
}

Bad Request — missing or invalid request parameter or body

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

Unauthorized — authentication is required or the session has expired

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

Forbidden — authenticated but lacking the required permission or scope

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

Not Found — the requested resource does not exist

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

Method Not Allowed — the HTTP verb is not supported on this endpoint

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

Unsupported Media Type — use application/json

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

Internal Server Error — an unexpected failure occurred on the server

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

Service Unavailable — a downstream dependency is unreachable

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example