Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Hopper Disruption Guarantee (DG) API

**What is Disruption Guarantee?**Disruption Guarantee (DG) offers a premium disruption assistance service to customers in case of flight disruption, including rebooking options on any airline or a refund option.******How it works**There are two distinct flows for DG:- The _purchase flow_, enabling customers to purchase the product within the airline’s booking flow.- The _exercise flow_, enabling customers to benefit from the premium disruption assistance service in case of a flight disruption.For the _purchase flow_, the first step is to [Create a Session](#operation/postSessions)Both the purchase and the exercise of DG should be tracked by the airline in the airline’s Passenger Name Record (PNR) according to the applicable industry standards.******Purchase flow**DG follows the industry standard of a two step purchase process.1. Once the user is landing on the page displaying the DG offer, the airline will call the [Create DG Offers](#operation/postDg_offers) endpoint. DG Offers can be created at multiple granular levels. The request must include a description of the Itinerary for which the offers are requested. The response will contain - the price for the product (`premium`), - the refundable amount (`coverage`), - the maximum price per passenger for a new flight (`service_cap`), - the delay threshold to trigger the policy (`min_minuted_delay`), - the start of the timeframe to trigger the policy (`max_hours_before_departure`) - and the description of the offer in the user’s language (`contents`).2. If a user is attaching DG to his booking, the airline will call the [Create DG Contract](#operation/postDg_contracts) endpoint. The request must include the selected offer\_id(s) and a description of the Itinerary for which the contract is requested, which must match the one of the Offer. At this stage, the DG Contract is only _created_. It will be confirmed once the customer has made the payment, which can be done in two ways: 1. If the airline is the Merchant of Records (MoR), it will capture the payment for the total amount of the booking, including the DG fee amount. Upon a successful payment, the airline will call the Update DG Contract Status endpoint to set the DG contract to _confirmed_. The airline will track this purchase in its PNR following the industry standards that apply to ticketing or ticketless carriers. 2. If HTS is the Merchant of Records (MoR), the airline will capture the payment for the amount of the booking excluding the DG fee, while HTS will capture the payment for the DG fee amount. Upon a successful payment of its portion, the airline will call the Process DG Payment endpoint for HTS to capture the payment for the DG fee amount. Once successful, the DG contract will be set to _confirmed_. The airline will track this purchase in its PNR. The details of a DG contract can be retrieved at any time through the [Get a DG Contract](#operation/getDg_contractsId) endpoint.******Exercise flow**In this version of the API, the DG exercise is powered by HTS as a standalone flow, without any endpoint publicly exposed.\In a future version of the API, the DG exercise will be initialized from the “Manage My Bookings” (MMB) page of the airline. New endpoints will be released to that purpose.

Hopper Disruption Guarantee (DG) API is one of 5 APIs that Hopper publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Disruption Guarantee (DG). The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 9 operations across 9 paths, and defines 72 schemas. It is described by OpenAPI 3.0.3, at version v1.1.

Requests are made against a single base URL, https://airlines-api.hopper.com/airline/v1.1.

9 operations 9 paths 72 schemas 3 GET4 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v1.1
Base URL
https://airlines-api.hopper.com/airline/v1.1
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Hopper Disruption Guarantee (DG) API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (PartnerAuth). An API key is passed in the header as HC-Session-ID (SessionAuth).

  • PartnerAuth — This API is authenticated with OAuth 2, Client Credentials grant.\ Clients should use their clientid and clientsecret to obtain an accesstoken.\ The accesstoke…
  • SessionAuth — Header Parameters | headerName | description | |-----------------|---------------------------------------------------------------------------------------------…

Paths & Operations 9

Across 9 paths, the API surfaces 9 operations — 3 GET, 4 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Disruption Guarantee (DG) 9

What is Disruption Guarantee? Disruption Guarantee (DG) offers a premium disruption assistance service to customers in case of flight disruption, including rebooking options on an…

POST
/dg_offers
Create DG Offers
postDg_offers 1 param body → 201400401403404422500
POST
/dg_contracts
Create a DG Contract
postDg_contracts body → 201204400401403404422500
GET
/dg_contracts/{id}
Get a DG contract
getDg_contractsId 1 param → 200400401403404422500
POST
/dg_contracts/{id}/payment
Process DG payment
postDg_contractsIdPayment 1 param body → 200400401403404422500
PUT
/dg_contracts/{id}/update_status
Update DG Contract Status
putDg_contractsIdUpdate_status 1 param body → 200204400401403404422500
PUT
/dg_contracts/{id}/itinerary_slices
Update DG Contract Itinerary Slices
putDg_contractsIdItinerary_slices 1 param body → 200204400401403404422500
POST
/dg_contract_exercises
Create DG Exercise
postDg_contract_exercises 1 param body → 201400401403404422500
GET
/customer/dg/payout/receipt
Get payout receipt PDF
getCustomerDgPayoutReceipt 1 param → 200400401403404422500
GET
/customer/dg_exercises/{id}/session
Get session ID by DG exercise ID
getCustomerDg_exercisesIdSession 1 param → 200400404422500

Schemas 72

The contract defines 72 schemas that model the data the API accepts and returns. The most detailed are create_dg_offer_item_response (23 properties), dg_offer (22 properties), dg_contract (19 properties), update_dg_contract_status_request (17 properties). Each schema is shown below with its type and property counts.

dg_passenger_pricing
object
3 properties 2 required
process_dg_payment_request
object
A process DG payment request
12 properties 4 required
passenger_type
string
dg_request_type
string
opera
object
2 properties 1 required
dg_ancillary
object
An object detailing the fare used to create a DG offer
4 properties 2 required
create_dg_contract_exercise_response
object
An object containing exercise information for a contract
2 properties 1 required
points
object
2 properties 2 required
dg_passenger_type
string
other_os
object
3 properties 2 required
operating_system
passenger_count
object
2 properties 2 required
create_dg_offer_item_response
object
A created Dg offer
23 properties 17 required
dg_contract
object
A DG contract
19 properties 16 required
browser
other_browser
object
3 properties 2 required
platform
desktop
object
5 properties 2 required
dg_exercise_itinerary_slice
object
An object containing the list of flight segments for a fare slice
4 properties 1 required
windows
object
2 properties 1 required
app
object
2 properties 1 required
create_dg_contract_exercise_request
object
A create DG contract exercise request
7 properties 3 required
dg_itinerary_slice_segment
object
An object detailing a segment of a fare slice
9 properties 7 required
dg_offer
object
A Dg offer
22 properties 16 required
edge
object
2 properties 1 required
dg_passenger
object
An object detailing the Passenger Information
11 properties 2 required
dg_exercise_itinerary_slice_segment
object
An object detailing a segment of a fare slice
15 properties 10 required
mac_os
object
2 properties 1 required
gender
string
The gender of the passenger
update_dg_contract_status_request
object
A update DG contract status request
17 properties 1 required
dg_contents
object
2 properties 2 required
tablet
object
5 properties 2 required
web
object
3 properties 1 required
device
The end-user's device
internet_explorer
object
2 properties 1 required
dg_itinerary
object
6 properties 3 required
android
object
2 properties 1 required
api
object
API channel — a programmatic integration
2 properties 2 required
dg_passenger_count
object
2 properties 2 required
unprocessable_entity
object
1 property 1 required
flight_status
string
The current flight status
bad_request
object
1 property 1 required
dg_passenger_tax
object
3 properties 3 required
dg_exercise_itinerary
object
Itinerary of the user when the contract exercise was initiated (only active segments should be provided)
3 properties 2 required
dg_ancillary_type
string
The type of ancillary
cabin
string
Service class of the segment
dg_payment
object
1 property 1 required
dg_itinerary_slice
object
An object containing the list of flight segments for a fare slice
3 properties 1 required
create_dg_offers_request
object
A create DG offers request
6 properties 3 required
dg_tax
object
4 properties 3 required
linux
object
2 properties 1 required
mobile
object
5 properties 2 required
chrome_os
object
2 properties 1 required
white_label
object
White-label channel — the partner sells under a different brand
2 properties 2 required
error
object
3 properties 1 required
create_dg_contract_request
object
A create DG contract request
4 properties 3 required
online_booking_tool
object
Online booking tool channel
3 properties 3 required
user_info
object
An object containing information related to the airline's user. Should be included if known, but not if the user is anonymous.
3 properties 1 required
safari
object
2 properties 1 required
direct
object
Direct channel — the partner sells directly to the end customer
1 property 1 required
channel
The partner's distribution channel
cash
object
3 properties 3 required
i_os
object
2 properties 1 required
firefox
object
2 properties 1 required
form_of_payment
payment_card
object
7 properties 3 required
get_dg_exercise_session_response
object
Response containing the session ID for a DG exercise
1 property 1 required
agent_reseller
object
Agent / reseller channel
3 properties 3 required
dg_status
string
chrome
object
2 properties 1 required
non_cash
object
3 properties 3 required
create_airline_dg_session_request
object
An object containing information related to the user's session
6 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hopper-com-disruption-guarantee-dg-api-openapi.yml Raw ↑

Other APIs Hopper publishes across the network.

Hopper Analytics API
Hopper Authentication API
Hopper Cancel For Any Reason (CFAR) API
Hopper Sessions API