Skip to content
Wink

Show Receipt

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

Show a receipt with the specified booking identifier.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
bookingIdentifier
required
string
""

Booking identifier

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

Booking identifier.

string format: uuid
"" >= 1 characters
bookingCode
required

Booking code

string
"" >= 1 characters
serverUrl
required

Where the booking occurred

string
"" >= 1 characters
hotelIdentifier
required

Hotel identifier

string format: uuid
"" >= 1 characters
hotelName
required

Hotel name

string
"" >= 1 characters
itemList
required

Line items in this receipt.

Array<object>
""
object
name
required

Room rate internal name.

string
"" >= 1 characters
description

Room description

string
""
internalCurrency
required

The internal currency

string
"" >= 1 characters
internalAmount
required

The total internal (capture) price.

number
""
stripePaymentIntentId

Stripe Payment Intent ID

string
""
cancelled

Whether the booking was cancelled.

boolean
cancelledOn

When the booking was cancelled.

string format: date-time
""
canceller

Who cancelled the booking.

string
""
Allowed values: HOTEL GUEST ADMIN AGENT ACQUIRER SALES_CHANNEL SYSTEM
cancellationType

Cancellation policy type.

string
""
Allowed values: DUPLICATE CANCELLATION NO_SHOW CC_INVALID CC_INSUFFICIENT DISCRETIONARY
cancelReason

Reason for cancellation.

string
""
refunds

List of refunds on this booking.

Array<object>
""
object
identifier
required

Refund identifier

string
"" >= 1 characters
stripeRefundId

Stripe refund identifier

string
""
internalAmount
required

Refund amount in internal currency

number
""
created
required

When the refund was created

string format: date-time
""
description
required

Description of the refund

string
"" >= 1 characters
reason
required

Reason for the refund

string
""
Allowed values: DUPLICATE FRAUDULENT REQUESTED_BY_CUSTOMER GUEST_COMPLAINT GUEST_BOOKED_INCORRECT_DATE GUEST_SICK OVERBOOKING EMERGENCY FLIGHT_CANCELLED DEATH_IN_FAMILY OTHER EXPIRED_UNCAPTURED_CHARGE AVAILABILITY_CHECK_FAILED
status
required

Status of the refund

string
""
Allowed values: PENDING SUCCEEDED CANCELED REQUIRES_ACTION FAILED
requestor
required

Who requested the refund

string
""
Allowed values: BY_SUPPLIER BY_ADMIN BY_STRIPE BY_SYSTEM BY_AGENT BY_GUEST
receiptUrl

Stripe receipt URL for the refund.

string
""
internalCurrency
required

The internal (capture) currency

string
"" >= 1 characters
internalAmount
required

The total internal (capture) price.

number
""
Example 
{
  "id": "",
  "bookingCode": "",
  "serverUrl": "",
  "hotelIdentifier": "",
  "hotelName": "",
  "itemList": "",
  "stripePaymentIntentId": "",
  "cancelled": false,
  "cancelledOn": "",
  "canceller": "HOTEL",
  "cancellationType": "DUPLICATE",
  "cancelReason": "",
  "refunds": "",
  "internalCurrency": "",
  "internalAmount": ""
}

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