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/G-UOCWALXX/refund-preview?hotelIdentifier=hotel-1' \
  --header 'Wink-Version: 2.0'

Preview the refund for cancelling a group booking (optionally scoped to a hotel) without cancelling anything.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
groupIdentifier
required
string
""

Quote cancellation for this group identifier

Example 
G-UOCWALXX

Query Parameters

Section titled “Query Parameters ”
hotelIdentifier
string
""

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

Example 
hotel-1

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 ”

OK

Media type application/json
object
groupIdentifier

The group code being quoted.

string
""
hotelIdentifier

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

string
""
displayCurrency

The traveler’s display currency code.

string
""
totalRefundDisplayAmount

Aggregate refund across all lines, in display currency.

number
""
lines

One entry per booking that would be cancelled.

Array<object>
""
object
bookingIdentifier

The booking’s internal identifier.

string
""
bookingCode

The human-readable booking code.

string
""
hotelName

The hotel 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
""
Example 
{
  "groupIdentifier": "",
  "hotelIdentifier": "",
  "displayCurrency": "",
  "totalRefundDisplayAmount": "",
  "lines": ""
}

400

Section titled “400 ”

Bad Request

object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
Example generated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  }
}

401

Section titled “401 ”

Unauthorized

Media type */*
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties

403

Section titled “403 ”

Forbidden

Media type */*
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties

500

Section titled “500 ”

Internal Server Error

object
Example generated
{}