TUI Group Booking/payments API

openapi: 3.2.0
info:
  title: Tui Group Booking/payments API
  version: '1.0'
  description: 'Operations tagged booking/payments across 2 of this provider''s published API definitions: tui-group-tui-newskies-digital-api-openapi.yml, tui-group-tui-newskies-payment-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://prod.api.tui/flight/newskies/rest
  description: TUI Prod
- url: https://playground.api.tui/flight/newskies/rest
  description: TUI Playground
- url: https://prod.api.tui/flight/newskies/payment
  description: TUI Prod Payment Service
- url: https://playground.api.tui/flight/newskies/payment
  description: TUI Playground (Test) Payment Service
tags:
- name: booking/payments
paths:
  /api/nsk/v1/booking/payments:
    get:
      tags:
      - booking/payments
      summary: Retrieves the booking payments on the booking in state.
      description: Requires a booking in state.
      operationId: nsk_v1_booking_payments_get
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfIListOfPayment'
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
      security:
      - JWT: []
    servers:
    - url: https://prod.api.tui/flight/newskies/rest
      description: TUI Prod
    - url: https://playground.api.tui/flight/newskies/rest
      description: TUI Playground
  /api/nsk/v5/booking/payments:
    post:
      tags:
      - booking/payments
      summary: Creates a new external payment or prepaid payment on the booking in state.
      description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance

        problems.`

        The payment fields are dynamic to the criteria of your payment provider. Here is an example request for a

        credit card payment that does not require address, zip, etc.

        { "amount": 10, "currencyCode": "USD", "paymentFields": {"ACCTNO":"411111111111", "EXPDATE":"10/8/2017",

        "CC::AccountHolderName":"Bob Smith", "CC::VerificationCode":"111"}}

        A 202 (HTTP status code) response returns alternate data signifying that either Three D Secure was enabled for

        this payment and is required for this payment type or a direct currency conversion (Dcc) offer was given. The

        payment will need to be resent using the 3DS endpoint or the Dcc endpoint.

        Note that it is possible for a payment to return a dcc offer and also have three d secure enabled. In these

        cases the direct currency conversion offer will need to be handled first and then the three d secure payment

        can be

        handled.

        If you would like to make a Dcc offer and the system using this endpoint cannot display a dcc offer to the end

        user, the status should be updated to DccNotOffered. This indicates that the offer was not displayed to the end

        user

        and is to be accepted automatically.

        If you would like to make a ThreeDSecure payment, you will need to provide a valid term url.

        You will also need to have these headers populated:

        User Agent (USER-AGENT)

        Accept (ACCEPT)

        This endpoint can also only be used with the v6 three d secure endpoint, POST

        `api/nsk/v6/booking/payments/threeDSecure`.


        GraphQL endpoint: paymentAddv5'
      operationId: nsk_v5_booking_payments_post
      parameters:
      - name: termUrl
        in: query
        description: The term URL.
        schema:
          type:
          - string
          - 'null'
        x-position: 2
      requestBody:
        x-name: request
        description: Payment request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentMethodRequest'
        required: true
        x-position: 1
      responses:
        '201':
          description: The item was created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '202':
          description: The request was accepted successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfPaymentInformation'
              examples:
                Three D Secure 1 Redirect needed:
                  description: Example response for a Three D Secure 1 redirect is required.
                  value:
                    threeDSecureResponse:
                      redirectUrl: https://merchantacsstag.cardinalcommerce.com/MerchantACSWeb/pareq.jsp?vaa=b&gold=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
                      paReq: eNpdkl1PwjAUhu/7K4jxeu26gUoOTUAiHxGyyILgXe1OYMZ90G2A/952bKL26jyn57TnfVsI9xpxvEJVaRSwwKKQO+zE0eBGrTchn7JgVgSvz7v3XO3m7EZAMHzBg4Aj6iLOUuE6zOFAWyTmCK32Mi0FSHUYzZai2+16nge0QQIJ6tlYMLOAXmICqUxQLOUxLmWs0VFZArTOEVBZlZb6S9z7pr4FApX+FPuyzIs+pafTyfnXbLcJ0Os0QWWjwog8x5HYum/b9Xg+WzyN5sodbcJJFKvJMl19DAdAbQWBSJYoOOPcZczvuA997vd9F2idJyATO4u49bhjlTRIILcXDS/kcbv1O2P0VFpjqlpBLRHAc56laGqMnz+xGQMLJUIsSmbvtmB0XdU8Tq3TqjQ29liPu3e11TXXR8bGLe7Z3gZMt+2hzUPS5s1N9OcvfAMe8K4M
                      responseUrl: null
                      md: null
                      raw: <html><head></head><body><form id="redirectionPostForm" action="https://merchantacsstag.cardinalcommerce.com/MerchantACSWeb/pareq.jsp?vaa=b&gold=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA" method="POST"><input type="hidden" name="PaReq" value="eNpdkl1PwjAUhu/7K4jxeu26gUoOTUAiHxGyyILgXe1OYMZ90G2A/952bKL26jyn57TnfVsI9xpxvEJVaRSwwKKQO+zE0eBGrTchn7JgVgSvz7v3XO3m7EZAMHzBg4Aj6iLOUuE6zOFAWyTmCK32Mi0FSHUYzZai2+16nge0QQIJ6tlYMLOAXmICqUxQLOUxLmWs0VFZArTOEVBZlZb6S9z7pr4FApX+FPuyzIs+pafTyfnXbLcJ0Os0QWWjwog8x5HYum/b9Xg+WzyN5sodbcJJFKvJMl19DAdAbQWBSJYoOOPcZczvuA997vd9F2idJyATO4u49bhjlTRIILcXDS/kcbv1O2P0VFpjqlpBLRHAc56laGqMnz+xGQMLJUIsSmbvtmB0XdU8Tq3TqjQ29liPu3e11TXXR8bGLe7Z3gZMt+2hzUPS5s1N9OcvfAMe8K4M" /><input type="hidden" name="TermUrl" value="http://localhost/Navitaire.SkyPay.Test.TdsTestWebsite/Default.aspx" /><input type="hidden" name="MD" value="additional data you might need" /></form><script language="javascript" type="text/javascript">document.getElementById('redirectionPostForm').submit();</script></body></html>
                      paymentTransactionKey: Y1ZYVDJIMFBJc1BXTGdicGNnSjAhMSEtMSEtMSEtMSFYWFhYWFhYWFhYWFgwMDA3
                      threeDSecureVersion: '1.0'
                    directCurrencyConversionOffer: null
                DCC Offer:
                  description: Example response for when a DCC Offer is proposed.
                  value:
                    threeDSecureResponse: null
                    directCurrencyConversionOffer:
                      dccPaymentTransactionKey: MSFYWFhYWFhYWFhYWFg0NDQ0IUFVRCEyODA0LjAwITAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMA--
                      currencyCode: AUD
                      rateValue: 2.0
                      amount: 2804.0
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                Paying with a Blacklisted Card:
                  description: Example response when attempting to pay with a blacklisted card without a reason.
                  value:
                    errors:
                    - id: 23c0d2aa-9c93-9c37-f9e4-39276217cbb8
                      code: nsk-server:Payment:ValidationError:BlackListedCard
                      message: nsk-server:Payment:ValidationError:BlackListedCard
                      type: Validation
                      details:
                        blacklistErrorMessage: Blacklisted Card, the reason given is None.
                      rawMessage: Blacklisted Card, the reason given is None.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                    data: null
                Paying with a Lost Blacklisted Card:
                  description: Example response when attempting to pay with a blacklisted card tagged as lost.
                  value:
                    errors:
                    - id: 23c0d2aa-9c93-9c37-f9e4-39276217cbb8
                      code: nsk-server:Payment:ValidationError:BlackListedCard
                      message: nsk-server:Payment:ValidationError:BlackListedCard
                      type: Validation
                      details:
                        blacklistErrorMessage: Blacklisted Card, the reason given is Lost.
                      rawMessage: Blacklisted Card, the reason given is Lost.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                    data: null
                Paying with a Stolen Blacklisted Card:
                  description: Example response when attempting to pay with a blacklisted card tagged as stolen.
                  value:
                    errors:
                    - id: 23c0d2aa-9c93-9c37-f9e4-39276217cbb8
                      code: nsk-server:Payment:ValidationError:BlackListedCard
                      message: nsk-server:Payment:ValidationError:BlackListedCard
                      type: Validation
                      details:
                        blacklistErrorMessage: Blacklisted Card, the reason given is Stolen.
                      rawMessage: Blacklisted Card, the reason given is Stolen.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                    data: null
                Paying with a Chargedback Blacklisted Card:
                  description: Example response when attempting to pay with a blacklisted card tagged as chargedback.
                  value:
                    errors:
                    - id: 23c0d2aa-9c93-9c37-f9e4-39276217cbb8
                      code: nsk-server:Payment:ValidationError:BlackListedCard
                      message: nsk-server:Payment:ValidationError:BlackListedCard
                      type: Validation
                      details:
                        blacklistErrorMessage: Blacklisted Card, the reason given is ChargedBack.
                      rawMessage: Blacklisted Card, the reason given is ChargedBack.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                    data: null
                Inexistent or inactive payment method:
                  description: Example response when the payment method is inexistent or inactive. Please see /resources/PaymentMethods for valid codes.
                  value:
                    errors:
                    - id: null
                      code: nsk:Exceptions:OutOfRange
                      message: nsk:Exceptions:OutOfRange
                      type: Validation
                      details: null
                      rawMessage: '"The value ''DT'' is out of range for ''PaymentMethodRequest.PaymentMethodCode''.\nExpected values: (AC,AG,AP,AX,BD,BN,CA,CF,CK,DI,EA,EM,HP,IF,LP,LY,MC,OM,PP,PS,SO,SW,TA,TV,VI,VO)"'
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                    data: null
        '409':
          description: Concurrent changes were being made in the same session.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
      security:
      - JWT: []
    servers:
    - url: https://prod.api.tui/flight/newskies/rest
      description: TUI Prod
    - url: https://playground.api.tui/flight/newskies/rest
      description: TUI Playground
  /api/nsk/v1/booking/payments/{paymentKey}:
    get:
      tags:
      - booking/payments
      summary: Gets a specific payment.
      description: 'GraphQL endpoint: payments'
      operationId: nsk_v1_booking_payments_paymentKey_get
      parameters:
      - name: paymentKey
        in: path
        required: true
        description: Payment key.
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfPayment'
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
      security:
      - JWT: []
    delete:
      tags:
      - booking/payments
      summary: Deletes the payment.
      description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance

        problems.`


        GraphQL endpoint: paymentDelete'
      operationId: nsk_v1_booking_payments_paymentKey_delete
      parameters:
      - name: paymentKey
        in: path
        required: true
        description: Payment key.
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '409':
          description: Concurrent changes were being made in the same session.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
      security:
      - JWT: []
    servers:
    - url: https://prod.api.tui/flight/newskies/rest
      description: TUI Prod
    - url: https://playground.api.tui/flight/newskies/rest
      description: TUI Playground
  /api/nsk/v2/booking/payments/{paymentKey}/authorize:
    patch:
      tags:
      - booking/payments
      summary: Manually authorize a committed payment.
      description: 'NOTE: This endpoint takes a singular property for the request body and as such the request will need to be

        formatted differently than what it typically looks like. For more information, please see

        https://navitaire-developer-digital-api.azurewebsites.net/articles/Miscellaneous/UniqueInputSingleRequestBodiesREST

        and the Swagger request examples.

        This endpoint is to be used with caution and is only permissible to use under certain circumstances.

        IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance

        problems.


        GraphQL endpoint: paymentAuthorizev3'
      operationId: nsk_v2_booking_payments_paymentKey_authorize_patch
      parameters:
      - name: paymentKey
        in: path
        required: true
        description: The payment key.
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: authorizationCode
        description: The authorization code.
        content:
          application/json:
            schema:
              type: string
            examples:
              Manual Authorize JSON request body, with an authorization code:
                description: Example request for when you want to authorize a payment.
                value: ac89c98fdajldsfa
        required: true
        x-position: 2
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '409':
          description: Concurrent changes were being made in the same session.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
      security:
      - JWT: []
    servers:
    - url: https://prod.api.tui/flight/newskies/rest
      description: TUI Prod
    - url: https://playground.api.tui/flight/newskies/rest
      description: TUI Playground
  /api/nsk/v2/booking/payments/{paymentKey}/decline:
    patch:
      tags:
      - booking/payments
      summary: Manually decline a committed payment.
      description: 'This endpoint is to be used with caution and is only permissible to use under certain circumstances.

        IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance

        problems.


        GraphQL endpoint: paymentDeclinev3'
      operationId: nsk_v2_booking_payments_paymentKey_decline_patch
      parameters:
      - name: paymentKey
        in: path
        required: true
        description: The payment key.
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '409':
          description: Concurrent changes were being made in the same session.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
      security:
      - JWT: []
    servers:
    - url: https://prod.api.tui/flight/newskies/rest
      description: TUI Prod
    - url: https://playground.api.tui/flight/newskies/rest
      description: TUI Playground
  /api/nsk/v1/booking/payments/{paymentMethod}/dcc:
    post:
      tags:
      - booking/payments
      summary: 'Gets the available direct currency codes offer.

        This is for making an inline DCC payment.'
      description: 'This endpoint behaves like a GET but is masked as a POST.

        If a DCC offer is accepted the payment transaction will need to be completed before getting another

        DCC offer. For example, a user cannot get a DCC offer for a VISA, get a DCC offer for a MasterCard and then accept

        the VISA DCC offer and pay with the VISA. The only way to complete this would be to get a DCC offer on one card,

        accept, and then pay and then get the DCC offer for another card, accept, and pay.

        Regardless of whether the offer is accepted or not, the endpoint /api/nsk/v6/booking/payments/dcc/{dccKey} will

        need to be called.'
      operationId: nsk_v1_booking_payments_paymentMethod_dcc_post
      parameters:
      - name: paymentMethod
        in: path
        required: true
        description: The payment method code.
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: request
        description: The DCC availability request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DccAvailabilityBaseRequest'
        required: true
        x-position: 2
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfDirectCurrencyConversionAvailability'
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
      security:
      - JWT: []
    servers:
    - url: https://prod.api.tui/flight/newskies/rest
      description: TUI Prod
    - url: https://playground.api.tui/flight/newskies/rest
      description: TUI Playground
  /api/nsk/v1/booking/payments/allocations:
    get:
      tags:
      - booking/payments
      summary: 'Gets the payment allocations for the booking in state.

        Payment allocations are a collection of the payments assigned to each passenger

        on the booking.'
      description: 'GraphQL endpoint: paymentAllocations'
      operationId: nsk_v1_booking_payments_allocations_get
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfPaymentAllocations'
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
      security:
      - JWT: []
    servers:
    - url: https://prod.api.tui/flight/newskies/rest
      description: TUI Prod
    - url: https://playground.api.tui/flight/newskies/rest
      description: TUI Playground
  /api/nsk/v2/booking/payments/available:
    get:
      tags:
      - booking/payments
      summary: Retrieves the booking payment methods available for the booking in state.
      description: 'Requires a booking in state.


        GraphQL endpoint: paymentsAvailablev2'
      operationId: nsk_v2_booking_payments_available_get
      parameters:
      - name: currencyCode
        in: query
        description: The optional currency code. Defaults to the logged in users currency code.
        schema:
          type:
          - string
          - 'null'
        x-position: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfIDictionaryOfStringAndPaymentMethod'
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
      security:
      - JWT: []
    servers:
    - url: https://prod.api.tui/flight/newskies/rest
      description: TUI Prod
    - url: https://playground.api.tui/flight/newskies/rest
      description: TUI Playground
  /api/nsk/v1/booking/payments/blacklist:
    post:
      tags:
      - booking/payments
      summary: Adds the booking payment to the blacklist.
      description: 'GraphQL endpoint: paymentsBlacklistAdd'
      operationId: nsk_v1_booking_payments_blacklist_post
      requestBody:
        x-name: request
        description: The blacklist payment request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BlacklistPaymentEntry'
        required: true
        x-position: 1
      responses:
        '201':
          description: The item was created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
      security:
      - JWT: []
    servers:
    - url: https://prod.api.tui/flight/newskies/rest
      description: TUI Prod
    - url: https://playground.api.tui/flight/newskies/rest
      description: TUI Playground
  /api/nsk/v1/booking/payments/blacklist/{paymentKey}:
    get:
      tags:
      - booking/payments
      summary: Retrieves the specified blacklisted payment.
      description: 'GraphQL endpoint: paymentsBlacklistGet'
      operationId: nsk_v1_booking_payments_blacklist_paymentKey_get
      parameters:
      - name: paymentKey
        in: path
        required: true
        description: The unique identifier of the blacklisted payment to retrieve.
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfBlacklistPaymentEntry'
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
      deprecated: true
      security:
      - JWT: []
    patch:
      tags:
      - booking/payments
      summary: Modifies the specified blacklisted payment.
      description: 'GraphQL endpoint: paymentsBlacklistModify'
      operationId: nsk_v1_booking_payments_blacklist_paymentKey_patch
      parameters:
      - name: paymentKey
        in: path
        required: true
        description: The unique identifier of the blacklisted payment to modify.
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: request
        description: The modify blacklisted payment request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeltaMapperOfBlacklistPaymentEntryEditRequest'
        required: true
        x-position: 2
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
      security:
      - JWT: []
    delete:
      tags:
      - booking/payments
      summary: Removes the specified payment from the blacklist.
      description: 'GraphQL endpoint: paymentsBlacklistDelete'
      operationId: nsk_v1_booking_payments_blacklist_paymentKey_delete
      parameters:
      - name: paymentKey
        in: path
        required: true
        description: 'The unique identifier of the payment to be removed from the blacklist. '
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
      security:
      - JWT: []
    servers:
    - url: https://prod.api.tui/flight/newskies/rest
      description: TUI Prod
    - url: https://playground.api.tui/flight/newskies/rest
      description: TUI Playground
  /api/nsk/v2/booking/payments/blacklist/{paymentKey}:
    get:
      tags:
      - booking/payments
      summary: Retrieves the specified blacklisted payment.
      description: 'GraphQL endpoint: paymentsBlacklistGetv2'
      operationId: nsk_v2_booking_payments_blacklist_paymentKey_get
      parameters:
      - name: paymentKey
        in: path
        required: true
        description: The unique identifier of the blacklisted payment to retrieve.
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfGetBlacklistPaymentEntryResponse'
              examples:
                Retrieve Blacklisted Payment:
                  description: Successful retrieval of the blacklisted payment.
                  value:
                    data:
                      reason: 2
                      notes: The credit card was lost
                      startDate: '2026-07-10T05:55:13.7045443Z'
                      endDate: '2026-07-14T05:55:13.7045567Z'
                      paymentKey: MzU5NTcxITEhTUMhMzg1MjAy
                      createdDate: '2026-07-09T05:55:13.7045061Z'
                      modifiedDate: '2026-07-12T05:55:13.7045291Z'
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                Payment Not Found:
                  description: Payment key does not exist in the booking in state
                  value:
                    errors:
                    - code: nsk:Payment:PaymentKeyNotFoundOnBooking
                      message: The payment key FdZvq0FzTaNkJ8M6dKtU is not found on the booking in state.
                      type: Validation
                      number: null
                      details:
                        paymentKey: FdZvq0FzTaNkJ8M6dKtU
                No Booking in State:
                  description: No booking was put into state before retrieving a blacklisted payment.
                  value:
                    errors:
                    - code: nsk:Booking:NoBookingInState
                      message: No booking was found in session, cannot perform operation.
                      type: Validation
                      number: null
                      details: null
        '404':
          description: The item was not found.
          content:
            application/json:
            

# --- truncated at 32 KB (282 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/tui-group/refs/heads/main/openapi/tui-group-booking-payments-api-openapi.yml