Skip to content
Wink

Quote Booking Cancellation

GET
/api/booking/{bookingIdentifier}/refund-preview
 
curl --request GET \
  --url https://api.wink.travel/api/booking/booking-1/refund-preview \
  --header 'Wink-Version: 2.0'

Preview the refund for cancelling a single booking without cancelling anything.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
bookingIdentifier
required
string
""

Quote cancellation for this booking identifier

Example 
booking-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
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
""
displayCurrency

The traveler’s display currency code.

string
""
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 
{
  "bookingIdentifier": "",
  "bookingCode": "",
  "hotelName": "",
  "startDate": "",
  "endDate": "",
  "displayCurrency": "",
  "refundable": false,
  "refundDisplayAmount": "",
  "refundType": "NONE",
  "cancellationPolicy": ""
}

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