v1.0.0OpenAPI 3.1.1

Demo: Orbit Travel API

Search destinations, flights and seat maps, book and pay, manage saved passengers and Orbit Miles, and receive booking and payment events by webhook or from the Events API.

Every request needs an API key in the x-api-key header, or an OAuth access token from Create an access token in Authorization: Bearer …. Each credential can make 60 requests a minute.

Server

Local

Authentication Required

Your API key. The sample server accepts `otk_test_4f9a2c1b8e7d6a5f`.

x-api-key:

Client Libraries

Shell

Node.js

Python

Java

Shell

Authentication

Operations

POST/v1/oauth/token

Create an access token

POST/v1/oauth/token

Destinations

Operations

List destinations

GET/v1/destinations

Get a destination

GET/v1/destinations/{id}

Flights

Operations

Seats

Operations

Get a seat map

GET/v1/flights/{id}/seats

Hold seats

POST/v1/flights/{id}/seat-holds

Bookings

Operations

Create a booking

POST/v1/bookings

List bookings

GET/v1/bookings

Get a booking

GET/v1/bookings/{id}

Update a booking

PATCH/v1/bookings/{id}

Cancel a booking

POST/v1/bookings/{id}/cancel

Upload a travel documentbeta

POST/v1/bookings/{id}/documents

List travel documents

GET/v1/bookings/{id}/documents

Download a boarding pass

GET/v1/bookings/{id}/boarding-pass

Passengers

Operations

Create a passenger

POST/v1/passengers

List passengers

GET/v1/passengers

Get a passenger

GET/v1/passengers/{id}

Update a passenger

PATCH/v1/passengers/{id}

Delete a passenger

DELETE/v1/passengers/{id}

Payments

Operations

Pay for a booking

POST/v1/bookings/{id}/payments

Get a payment

GET/v1/payments/{id}

Refund a payment

POST/v1/payments/{id}/refunds

Loyalty

Operations

Get the loyalty account

GET/v1/loyalty/account

List loyalty transactions

GET/v1/loyalty/transactions

Redeem points

POST/v1/loyalty/redemptions

Events

Operations

List events

GET/v1/events

Get an event

GET/v1/events/{id}

Webhooks

Operations

Create a webhook endpoint

Auth Required

Registers a URL to receive booking and payment events. Deliveries are signed with the returned secret; verify the Orbit-Signature header before trusting them.

Bodyrequiredapplication/json

eventsstring[]required

Events to send.

Enum values:booking.confirmedbooking.changedbooking.cancelledpayment.succeededpayment.failed

Example: ["booking.confirmed"]

urlstring · urirequired

HTTPS URL that receives events.

Example: https://example.com/webhooks/orbit

Responses

201Created

application/json

eventsstring[]required

Events sent.

Enum values:booking.confirmedbooking.changedbooking.cancelledpayment.succeededpayment.failed

Example: ["booking.confirmed"]

idstringrequired

Endpoint id.

Example: whe_91ka2

urlstringrequired

Receiving URL.

Example: https://example.com/webhooks/orbit

secretstringrequired

Secret used to sign deliveries (Orbit-Signature header, HMAC-SHA256). Shown once.

Example: whsec_3b1f9e0c

Headers

X-RateLimit-Limitinteger

Requests allowed per minute for this credential.

Example: 60

X-RateLimit-Remaininginteger

Requests left in the current window.

Example: 59

X-RateLimit-Resetinteger

When the window resets, in Unix seconds.

Example: 1949398800

400The request is invalid: a parameter or body field failed validation.

application/json

statusCodeintegerrequired

HTTP status code, repeated in the body.

Example: 404

messagestring | string[]required

What went wrong, for people. Validation failures list one entry per problem. Do not branch on this text.

Example: Booking not found

errorstring

Short name of the status.

Example: Not Found

401Authentication is missing or invalid.

application/json

statusCodeintegerrequired

HTTP status code, repeated in the body.

Example: 404

messagestring | string[]required

What went wrong, for people. Validation failures list one entry per problem. Do not branch on this text.

Example: Booking not found

errorstring

Short name of the status.

Example: Not Found

403Authenticated, but not allowed to do this.

application/json

statusCodeintegerrequired

HTTP status code, repeated in the body.

Example: 404

messagestring | string[]required

What went wrong, for people. Validation failures list one entry per problem. Do not branch on this text.

Example: Booking not found

errorstring

Short name of the status.

Example: Not Found

429Too many requests: more than 60 a minute. Wait `Retry-After` seconds, then retry.

application/json

statusCodeintegerrequired

HTTP status code, repeated in the body.

Example: 404

messagestring | string[]required

What went wrong, for people. Validation failures list one entry per problem. Do not branch on this text.

Example: Booking not found

errorstring

Short name of the status.

Example: Not Found

Headers

Retry-Afterinteger

Seconds to wait before retrying.

Example: 42

X-RateLimit-Limitinteger

Requests allowed per minute for this credential.

Example: 60

X-RateLimit-Remaininginteger

Requests left in the current window.

Example: 59

X-RateLimit-Resetinteger

When the window resets, in Unix seconds.

Example: 1949398800

500Something failed on the server. Retry with backoff.

application/json

statusCodeintegerrequired

HTTP status code, repeated in the body.

Example: 404

messagestring | string[]required

What went wrong, for people. Validation failures list one entry per problem. Do not branch on this text.

Example: Booking not found

errorstring

Short name of the status.

Example: Not Found

POST/v1/webhook-endpoints

curl http://localhost:3010/v1/webhook-endpoints \
  --request POST \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "events": [
    "booking.confirmed"
  ],
  "url": "https://example.com/webhooks/orbit"
}'

201

400

401

403

429

500

Show Schema

{
  "events": [
    "booking.confirmed"
  ],
  "id": "whe_91ka2",
  "url": "https://example.com/webhooks/orbit",
  "secret": "whsec_3b1f9e0c"
}

Created

List webhook endpoints

GET/v1/webhook-endpoints

Delete a webhook endpoint

DELETE/v1/webhook-endpoints/{id}

Send a test event

POST/v1/webhook-endpoints/{id}/test

Models

BankTransferInstructionsDto

BankTransferPaymentRequestDto

BoardingGroup Boarding group, called in order.

BoardingPassDto

BoardingPassFormat

BoardingPassPassengerDto

BookingDto

BookingListDto

BookingStatus Where the booking is in its life.

CabinClass Cabin.

CabinSeatMapDto

CancelBookingDto

CardBrand Card network.

CardDetailsDto

CardPaymentRequestDto

Climate

CreateBookingDto

CreatePassengerDto

CreateRedemptionDto

CreateRefundDto

CreateSeatHoldDto

CreateWebhookEndpointDto

DestinationDto

DestinationListDto

DocumentKind What the document is, detected from the scan.

DocumentStatus Review status. Boarding needs a verified passport.

EventDataDto

EventDto

EventListDto

FareDto

FlightDto

FlightListDto

GrantType Always `client_credentials`.

LegacyFlightSearchDto

LoyaltyAccountDto

LoyaltyTier Current tier, from lifetime points.

LoyaltyTransactionDto

LoyaltyTransactionListDto

LoyaltyTransactionType

MealPreference Meal served on board.

OAuthErrorCode Machine-readable error code.

OAuthErrorDto

PageInfoDto

PassengerDto

PassengerListDto

PassengerProfileDto

PassportDto

PaymentDto

PaymentMethodDetailsDto

PaymentMethodType How the payment was made. Exactly one of the objects below is set.

PaymentStatus Where the payment is in its life.

RedemptionDto

RedemptionStatus Redemptions complete immediately.

RefundDto

RefundReason Why the money went back.

RefundStatus Bank transfer refunds stay `pending` for a few days.

RewardType Reward to buy. Costs: `cabin_upgrade` 40,000, `booking_credit` 10,000 ($100 off), `extra_baggage` 8,000, `lounge_access` 5,000.

SeatDto

SeatFeature What makes this seat different.

SeatHoldDto

SeatHoldStatus Active until it is used on a booking or expires.

SeatMapDto

SeatPreference Preferred seat, used when seats are auto-assigned.

SeatPriceDto

SeatRowDto

SeatStatus Whether the seat can be held.

TestWebhookEndpointDto

TierProgressDto

TokenRequestDto

TokenResponseDto

TravelDocumentDto

TravelDocumentListDto

TravelPreferencesDto

UpdateBookingDto

UpdatePassengerDto

UpdateTravelPreferencesDto

UploadDocumentDto

WalletPaymentRequestDto

WalletType Wallet the token comes from.

WebhookDeliveryDto

WebhookDeliveryStatus `succeeded` when your endpoint answered with a 2xx status.

WebhookEndpointDto

WebhookEndpointListDto

WebhookEvent

Demo: Orbit Travel API

Authentication

Create an access token

Destinations

List destinations

Get a destination

Flights

Search flights

Get a flight

Legacy flight searchDeprecated

Seats

Get a seat map

Hold seats

Bookings

Create a booking

List bookings

Get a booking

Update a booking

Cancel a booking

Upload a travel documentbeta

List travel documents

Download a boarding pass

Passengers

Create a passenger

List passengers

Get a passenger

Update a passenger

Delete a passenger

Payments

Pay for a booking

Get a payment

Refund a payment

Loyalty

Get the loyalty account

List loyalty transactions

Redeem points

Events

List events

Get an event

Webhooks

Create a webhook endpoint

Bodyrequiredapplication/json

Responses

List webhook endpoints

Delete a webhook endpoint

Send a test event

Models