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=e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18' \
  --header 'Authorization: Bearer <token>' \
  --header 'Wink-Version: 2.0'

• Endpoint

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

• oauth2ClientCredentials

Parameters

Path Parameters

groupIdentifier

required

string

""

Quote cancellation for this group identifier

Example

G-UOCWALXX

Query Parameters

hotelIdentifier

string

""

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

Example

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

Header Parameters

Wink-Version

string

default: 2.0.0

Allowed values: 2.0

Responses

200

OK

Media type application/json

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

""

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

""

Example

{
  "groupIdentifier": "",
  "hotelIdentifier": "",
  "displayCurrency": "",
  "totalRefundDisplayAmount": "",
  "lines": ""
}

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"
  }
}

object

type

string format: uri

title

string

status

integer format: int32

detail

string

instance

string format: uri

properties

object

key

additional properties

object

type

string format: uri

title

string

status

integer format: int32

detail

string

instance

string format: uri

properties

object

key

additional properties

object

type

string format: uri

title

string

status

integer format: int32

detail

string

instance

string format: uri

properties

object

key

additional properties

object

type

string format: uri

title

string

status

integer format: int32

detail

string

instance

string format: uri

properties

object

key

additional properties

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

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

Internal Server Error

object

Example ^generated

{}

object

object

object

object