TUI Group Booking/payments API
The booking/payments API from TUI Group — 62 operation(s) for booking/payments.
TUI Group Booking/payments API is one of 113 APIs that TUI Group publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include booking/payments. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 67 operations across 62 paths, and defines 97 schemas. It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against 4 base URLs: https://prod.api.tui/flight/newskies/rest, https://playground.api.tui/flight/newskies/rest, https://prod.api.tui/flight/newskies/payment, https://playground.api.tui/flight/newskies/payment.
67 operations
62 paths
97 schemas
6 DELETE21 GET3 PATCH35 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
TUI Group Booking/payments API declares
2 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (jwt) (JWT).
An API key is passed in the header as x-apikey (ApiKeyAuth).
JWT— Paste your JWT token from the token endpoint.ApiKeyAuth— API key for authentication
Paths & Operations 67
Across 62 paths, the API surfaces 67 operations — 6 DELETE, 21 GET, 3 PATCH, 35 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
booking/payments 67
GET
/api/nsk/v1/booking/payments
Retrieves the booking payments on the booking in state
POST
/api/nsk/v5/booking/payments
Creates a new external payment or prepaid payment on the booking in state
GET
/api/nsk/v1/booking/payments/{paymentKey}
Gets a specific payment
DELETE
/api/nsk/v1/booking/payments/{paymentKey}
Deletes the payment
PATCH
/api/nsk/v2/booking/payments/{paymentKey}/authorize
Manually authorize a committed payment
PATCH
/api/nsk/v2/booking/payments/{paymentKey}/decline
Manually decline a committed payment
POST
/api/nsk/v1/booking/payments/{paymentMethod}/dcc
Gets the available direct currency codes offer.
GET
/api/nsk/v1/booking/payments/allocations
Gets the payment allocations for the booking in state.
GET
/api/nsk/v2/booking/payments/available
Retrieves the booking payment methods available for the booking in state
POST
/api/nsk/v1/booking/payments/blacklist
Adds the booking payment to the blacklist
GET
/api/nsk/v1/booking/payments/blacklist/{paymentKey}deprecated
Retrieves the specified blacklisted payment
PATCH
/api/nsk/v1/booking/payments/blacklist/{paymentKey}
Modifies the specified blacklisted payment
DELETE
/api/nsk/v1/booking/payments/blacklist/{paymentKey}
Removes the specified payment from the blacklist
GET
/api/nsk/v2/booking/payments/blacklist/{paymentKey}
Retrieves the specified blacklisted payment
GET
/api/nsk/v2/booking/payments/bookingCredit
Gets credit available from a past booking
POST
/api/nsk/v3/booking/payments/bookingCredit
Applies credit from a past booking
POST
/api/nsk/v3/booking/payments/credit
Applies credit by reference number and type
GET
/api/nsk/v2/booking/payments/credit
Gets credit available by reference number and type
POST
/api/nsk/v3/booking/payments/customerCredit
Applies credit from the logged in customer to the booking in state
GET
/api/nsk/v2/booking/payments/customerCredit
Gets credit available for the logged in user on the booking in state
POST
/api/nsk/v6/booking/payments/dcc/{dccKey}
Creates a new external payment with direct currency conversion.
POST
/api/nsk/v1/booking/payments/dcc/{dccPaymentTransactionKey}
Adds a dcc payment to the booking in state
POST
/api/nsk/v1/booking/payments/fees/{feeCode}
Retrieves the payment fee for the fee code by providing the account number and…
GET
/api/nsk/v1/booking/payments/fees/{feeCode}/storedPayment/{storedPaymentKey}
Retrieves the payment fee for the fee code by providing the stored payment key…
DELETE
/api/nsk/v1/booking/payments/inProcess
Cancels an in-process payment, if one exists, from the session state.
GET
/api/nsk/v3/booking/payments/mcc
Gets the available multi-currency codes available
POST
/api/nsk/v6/booking/payments/mcc/{currencyCode}
Creates a new MCC payment
POST
/api/nsk/v6/booking/payments/mcc/{currencyCode}/storedPayment/{storedPaymentKey}
Creates a new MCC payment from a stored payment
POST
/api/nsk/v3/booking/payments/organizationCredit
Applies credit to the logged-in or specified user's organization.
GET
/api/nsk/v2/booking/payments/organizationCredit
Gets credit available for the logged in users organization
GET
/api/nsk/v1/booking/payments/refunds
Retrieves the booking payment methods available for a refund on the booking in…
POST
/api/nsk/v5/booking/payments/refunds
Creates a refund for the booking in state.
POST
/api/nsk/v4/booking/payments/refundsdeprecated
Creates a refund for the booking in state
POST
/api/nsk/v1/booking/payments/refunds/creditShell
Creates a credit shell refund for the booking in state
POST
/api/nsk/v3/booking/payments/refunds/customerCredit
Creates a customer credit for a specified customer
POST
/api/nsk/v3/booking/payments/refunds/organizationCredit
Creates an organization account refund for a payment from the booking in state
POST
/api/nsk/v2/booking/payments/refunds/organizationCreditdeprecated
Creates an organization account refund for a payment from the booking in state
POST
/api/nsk/v1/booking/payments/reversalsdeprecated
Reverses a payment for the booking in state
POST
/api/nsk/v2/booking/payments/reversals
Reverses a payment for the booking in state
POST
/api/nsk/v7/booking/payments/storedPayment/{storedPaymentKey}
Creates a payment using the stored payment information for the booking in state
POST
/api/nsk/v6/booking/payments/threeDSecuredeprecated
Creates a new ThreeDSecure external payment or prepaid payment on the booking…
POST
/api/nsk/v7/booking/payments/threeDSecuredeprecated
Creates a new ThreeDSecure external payment or prepaid payment on the booking…
POST
/api/nsk/v1/booking/payments/threeDSecureRedirect
Creates a new ThreeDSecure Redirect external payment or prepaid payment on the…
POST
/api/nsk/v4/booking/payments/voucher
Creates a new voucher payment on the booking in state
GET
/api/nsk/v3/booking/payments/voucher
Gets information regarding a specific voucher code and validates whether the…
DELETE
/api/nsk/v2/booking/payments/voucher/{voucherPaymentReference}
Reverses a voucher payment on the booking in state.
POST
/api/nsk/v1/booking/payments/voucher/passenger/{passengerKey}
Creates a new voucher payment for a specified passenger
PUT
/api/nsk/v1/booking/payments/voucher/reassess
Reassess the voucher payments on the current booking in state.
GET
/rest/api/nsk/v1/booking/payments
Get booking payments
POST
/rest/api/nsk/v5/booking/payments
Create booking payment
GET
/rest/api/nsk/v1/booking/payments/{paymentKey}
Get specific payment
DELETE
/rest/api/nsk/v1/booking/payments/{paymentKey}
Delete payment
GET
/rest/api/nsk/v2/booking/payments/available
Get available payment methods
POST
/rest/api/nsk/v3/booking/payments/credit
Add credit payment
GET
/rest/api/nsk/v5/booking/payments/refunds
Get payment refunds
POST
/rest/api/nsk/v5/booking/payments/refunds
Create payment refund
POST
/rest/api/nsk/v1/booking/payments/{paymentMethod}/dcc
Get DCC offer
POST
/rest/api/nsk/v6/booking/payments/dcc/{dccKey}
Create DCC payment
GET
/rest/api/nsk/v3/booking/payments/mcc
Get MCC offers
POST
/rest/api/nsk/v6/booking/payments/mcc/{currencyCode}
Create MCC payment
POST
/rest/api/nsk/v1/booking/payments/fees/{feeCode}
Add payment fee
GET
/rest/api/nsk/v1/booking/payments/fees/{feeCode}/storedPayment/{storedPaymentKey}
Get fee for stored payment
GET
/rest/api/nsk/v3/booking/payments/voucher
Get voucher payment details
POST
/rest/api/nsk/v4/booking/payments/voucher
Add voucher payment
DELETE
/rest/api/nsk/v2/booking/payments/voucher/{voucherPaymentReference}
Delete voucher payment
POST
/rest/api/nsk/v1/booking/payments/voucher/passenger/{passengerKey}
Add voucher payment for passenger
PUT
/rest/api/nsk/v1/booking/payments/voucher/reassess
Reassess voucher payment
Schemas 97
The contract defines 97 schemas that model the data the API accepts and returns. The most detailed are Payment (28 properties), VoucherInformation (28 properties), ThreeDSecure (24 properties), PaymentMethod (22 properties). Each schema is shown below with its type and property counts.
PaymentReversalRequestv2
object
Defines information needed for reversing a payment in the state booking, v2.
6 properties
2 required
ApplyCreditAccountRequestv2
object
Defines a request to apply credit for an account.
7 properties
2 required
Exception
object
4 properties
MccCurrencyInformationv2
object
Model with the Mcc curency and rate information.
3 properties
ThreeDSecure
object
Defines three D secure.
24 properties
IJsonResponseOfBlacklistPaymentEntry
object
Defines the JSON response contract.
3 properties
RefundState
integer
Enumeration representing the refund ui state. 0 = Enabled 1 = Disabled 2 = Hidden
ChallengePreference
integer
Defines the challenge preference. 0 = NoPreference 1 = NoChallengeRequested 2 = ChallengeRequested 3 = ChallengeMandated
CustomerCreditRefundRequest
object
Defines information needed for a customer credit refund.
7 properties
3 required
BookingPaymentStatus
integer
Determines if the booking has been paid for or not. 0 = New 1 = Received 2 = Pending 3 = Approved 4 = Declined 5 = Unknown 6 = PendingCustomerAction
ChannelType
integer
Defines the available channel types doing invoking the communication with the server. 0 = Default 1 = Direct 2 = Web 3 = Gds 4 = Api 5 = DigitalApi 6 = Digital…
DirectCurrencyConversion
object
Defines a direct currency conversion.
7 properties
OrganizationRefundRequest
object
Defines information needed for an organization account refund.
7 properties
2 required
IJsonResponseOfVoucherInformation
object
Defines the JSON response contract.
3 properties
IJsonResponseOfPaymentAllocations
object
Defines the JSON response contract.
3 properties
PaymentRefundType
integer
Enum representing whether or not a payment can be refunded. 0 = NotAllowed 1 = LineItemLevel 2 = AccountLevel 3 = BookingLevel
VoucherPaymentRequest
object
Model to request a voucher payment.
5 properties
2 required
CollectType
integer
Used to identify the collect type of a service charge. 0 = SellerChargeable 1 = ExternalChargeable 2 = SellerNonChargeable 3 = ExternalNonChargeable 4 = Extern…
StoredPaymentRequest
object
Defines a request to apply person stored payment to the booking in state.
5 properties
1 required
VoucherTransaction
object
The voucher transaction model.
7 properties
MccPaymentMethodRequest
object
Defines information needed for a mcc payment requested to be added to the booking in state.
8 properties
2 required
PaymentAttachment
object
Defines a payment attachment.
3 properties
PassengerVoucherCustomerProgram
object
Defines the passenger voucher customer program.
2 properties
DccAvailabilityBaseRequest
object
Direct currency conversion request.
4 properties
3 required
IJsonResponseOfDirectCurrencyConversionAvailability
object
Defines the JSON response contract.
3 properties
AuthorizationStatus
integer
Defines the different possible payment authorization states. 0 = Unknown 1 = Acknowledged 2 = Pending 3 = InProcess 4 = Approved 5 = Declined 6 = Referral 7 =…
PassengerFee
object
Model representing passenger fee information.
16 properties
1 required
RefundCurrencyControl
integer
Enum representing the currency control on a refund. 0 = UseCollectedCurrency 1 = UseQuotedCurrency
IJsonResponseOfPayment
object
Defines the JSON response contract.
3 properties
PassengerVoucherUsageType
integer
Passenger voucher usage type specifies what parts of a booking this voucher can pay for. 0 = None 1 = Fares 2 = Taxes 3 = TravelFees 4 = ServiceFees 5 = Penalt…
Payment
object
Defines an applied payment on the booking.
28 properties
ManualPaymentFeeRequest
object
Defines information to be converted to the payment request v2 for a payment fee price request
5 properties
1 required
ExternalRate
object
External rate model.
4 properties
IJsonResponseOfIDictionaryOfStringAndMccCurrencyInformationv2
object
Defines the JSON response contract.
3 properties
VoucherStatus
integer
Defines the status of a voucher. 0 = Available 1 = Void 2 = Redeemed 3 = Expired
PaymentInformation
object
Defines the extra payment information.
2 properties
MccPaymentRequest
object
Defines information needed for a mcc stored payment requested to be added to the booking in state.
5 properties
1 required
ErrorResponse
object
Defines a unique error response.
8 properties
GetBlacklistPaymentEntryResponse
object
Defines the response for getting a blacklisted payment.
7 properties
1 required
IJsonResponseOfIListOfPayment
object
Defines the JSON response contract.
3 properties
PaymentReversalRequest
object
Defines information needed for reversing a payment in the state booking.
7 properties
2 required
DirectCurrencyConversionAvailability
object
Defines a direct currency conversion availability model.
4 properties
DccType
integer
Dynamic Currency Conversion (DCC) types. 0 = None 1 = ZeroRate 2 = FullAmount
FeeType
integer
Enumeration representing all the different fee types. 0 = All 1 = Tax 2 = TravelFee 3 = ServiceFee 4 = PaymentFee 5 = PenaltyFee 6 = SsrFee 7 = NonFlightServic…
IJsonResponseOfPaymentInformation
object
Defines the JSON response contract.
3 properties
MessageStatus
integer
Defines the message status. 0 = General 1 = Warning 2 = Critical
OrganizationRefundRequestv2
object
Defines information needed for an organization account refund, v2.
6 properties
2 required
ChargeType
integer
The type of a service charge. 0 = FarePrice 1 = Discount 2 = IncludedTravelFee 3 = IncludedTax 4 = TravelFee 5 = Tax 6 = ServiceCharge 7 = PromotionDiscount 8…
DirectCurrencyConversionStatus
integer
Enumeration that determines the status of a DCC authorization. 0 = DccNotOffered 1 = DccOfferRejected 2 = DccOfferAccepted 3 = DccInitialValue 4 = MccInUse
PaymentMethodType
integer
Defines the payment method types. 0 = ExternalAccount 1 = PrePaid 2 = AgencyAccount 3 = CustomerAccount 4 = Voucher 5 = Loyalty
DirectCurrencyConversionOffer
object
Defines the direct currency conversion offer.
4 properties
PaymentDetails
object
Defines the payment details.
9 properties
ThreeDSecureResponse
object
Defines three D secure response.
7 properties
ThreeDSecurePaymentMethodRequestv3
object
Defines information needed for a generic payment requested with ThreeDSecure validation.
3 properties
2 required
IJsonResponseOfCreditAccount
object
Defines the JSON response contract.
3 properties
IJsonResponseOfGetBlacklistPaymentEntryResponse
object
Defines the JSON response contract.
3 properties
CreditAccount
object
Defines a credit account information.
5 properties
Name
object
Defines a common name.
5 properties
PointOfSale
object
Model related to the point of sale. This is for read-only operations.
4 properties
PaymentAllocationDocument
object
Defines the payment allocation document.
6 properties
RetrieveBookingv2
object
Model representing the retrieve booking data.
7 properties
1 required
ApplyBookingCreditRequestv2
object
Defines a request to apply credit from state.
2 properties
2 required
BookingPaymentField
integer
This enum represents payment field categories. 0 = Miscellaneous 1 = AccountNumber 2 = Amount 3 = ExpirationDate 4 = CurrencyCode 5 = PaymentText 6 = PrepaidAp…
DeltaMapperOfBlacklistPaymentEntryEditRequest
object
Map delta changes of a specific type T to another object.
4 properties
PaymentMethod
object
The payment method model.
22 properties
2 required
RequiredType
integer
This enum represents the state of a payment field. 0 = Required 1 = Optional 2 = NotAllowed
BlacklistReasonCode
integer
Defines the reason for blacklisting a card used in an external payment. Defaults to None if no value is specified. 0 = None 1 = ChargedBack 2 = Lost 3 = Other…
PassengerVoucher
object
Defines a passenger voucher.
6 properties
IJsonResponseOfIDictionaryOfStringAndPaymentMethod
object
Defines the JSON response contract.
3 properties
ValueType
integer
This enum represents the value type of an input box. 0 = Unknown 1 = String 2 = UpperCaseString 3 = Numeric 4 = Alphanumeric 5 = Amount 6 = Date 7 = Mod10 8 =…
Currencyv2
object
The currency model.
7 properties
1 required
CreditShellRefundRequest
object
Defines information needed for a credit shell refund.
6 properties
4 required
PaymentRefundRequest
object
Defines information needed for a generic voucher payment requested to be added to the booking in state.
7 properties
2 required
CreditType
integer
Defines the different possible credit types. 0 = Customer 1 = Booking 2 = Organization
PaymentAmounts
object
Defines the different applied payment amounts for a single payment.
6 properties
VoucherTransactionType
integer
Defines voucher transaction type. 0 = Debit 1 = Credit 2 = Void 3 = Reinstate 4 = Adjustment 5 = ExpirationDateChange 6 = VoucherTypeChange 7 = VoucherOwnerCha…
ApplyCreditRequest
object
Defines a request to apply credit from state.
3 properties
1 required
PaymentRefundRequestv2
object
The payment refund request, v2.
6 properties
2 required
PaymentMethodField
object
The payment method field model.
13 properties
3 required
ServiceCharge
object
Model that represents the fare service charge information.
9 properties
IJsonResponseOfThreeDSecureResponse
object
Defines the JSON response contract.
3 properties
VoucherNameRestriction
integer
Defines how the name on the voucher will be validated. 0 = None 1 = MustBePassenger 2 = MustBePassengerOrContact
BlacklistPaymentEntry
object
Defines the request for a card used in an external payment to be blacklisted.
5 properties
1 required
Message
object
Defines a unique informational message.
5 properties
IJsonResponseOfPaymentFeeResponse
object
Defines the JSON response contract.
3 properties
ChallengePreferenceWindowSize
integer
Defines the challenge preference window size. 0 = SizeFullPage 1 = Size250X400 2 = Size390X400 3 = Size500X600 4 = Size600X400
PaymentAllocations
object
Defines the booking payment allocations.
4 properties
VoucherInformation
object
Voucher information. This model describes a voucher information after being queried by the voucher code.
28 properties
AuthenticationStatus
integer
Defines the different possible payment authentication statuses for 3DS. 0 = Unknown 1 = AuthenticationSuccessful 2 = AuthenticationFailed 3 = AuthenticationCou…
ApplyOrganizationCreditRequest
object
Defines a request to apply organization credit to the booking in state.
6 properties
1 required
DccRequestBasev2
object
Model representing the DCC request without a unique key.
4 properties
PaymentVoucherDetails
object
Payment voucher details. This describes a voucher applied to a payment.
5 properties
CreditShellAccountType
integer
Account types used for credit shell refunds. 0 = CustomerNumber 1 = ReservationCredit
VoucherType
integer
Defines the type of voucher. 0 = Credit 1 = SingleUseCredit 2 = Service 3 = SingleUse 4 = MultiUse 5 = SingleUseNegativeAdjustment 6 = PassengerSelect
PaymentFeeResponse
object
Defines information for the payment fee response.
3 properties
1 required
IJsonResponse
object
Defines the JSON response contract for a not content type response.
3 properties
PaymentMethodRequest
object
Defines a request to apply payment to the booking in state.
7 properties
2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from TUI Group 12
Other APIs TUI Group publishes across the network.
TUI Group Account API
TUI Group Airline Profile API
TUI Group APIS Message API
TUI Group Apo API
TUI Group Auth API
TUI Group Availability API
TUI Group Baggage API
TUI Group Bag Tag API
TUI Group Boarding API
TUI Group Boarding Devices API
TUI Group Booking/addons API
TUI Group Booking API
#booking/payments
Where this information came from
This is an independent, third-party profile of TUI Group Booking/payments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.