Skip to content
Wink

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.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
groupIdentifier
required
string
""

Quote cancellation for this group identifier

Example 
a1f4c9e2-7b3d-4e8a-9c21-6f0b5d8e3a47

Query Parameters

Section titled “Query Parameters ”
hotelIdentifier
string
""

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

Example 
e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18

Header Parameters

Section titled “Header Parameters ”
Wink-Version
string
default: 2.0.0
Allowed values: 2.0

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Group cancellation refund preview

Media type application/json

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

object
groupIdentifier

The group code being quoted.

string
""
hotelIdentifier

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

string format: uuid
""
displayCurrency

The traveler’s display currency code.

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

Aggregate refund across all lines, in display currency.

number
""
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
bookingIdentifier

The booking’s internal identifier.

string format: uuid
""
bookingCode

The human-readable booking code.

string
""
hotelName

The property name for this booking.

string
""
startDate

Check-in date.

string format: date
""
endDate

Check-out date.

string format: date
""
refundable

Whether this booking refunds any money when cancelled.

boolean
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
cancellationPolicy

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

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

400

Section titled “400 ”

Bad Request — missing or invalid request parameter or body

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

401

Section titled “401 ”

Unauthorized — authentication is required or the session has expired

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

403

Section titled “403 ”

Forbidden — authenticated but lacking the required permission or scope

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

404

Section titled “404 ”

Not Found — the requested resource does not exist

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

405

Section titled “405 ”

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

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

415

Section titled “415 ”

Unsupported Media Type — use application/json

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

500

Section titled “500 ”

Internal Server Error — an unexpected failure occurred on the server

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

503

Section titled “503 ”

Service Unavailable — a downstream dependency is unreachable

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