Skip to content
API reference
/
Air
/
/
Cancel Air Pnr

Air API (v2)

Download OpenAPI description
AirApi.json
AirApi.yaml
Languages
Servers
Sandbox URL
https://api-ext-sboxmeta.partners.spotnana.com/
Spotnana mock server
https://developer.spotnana.com/_mock/openapi/airapi/

Air

APIs to perform search, checkout and book an air pnr

Operations

Create air pnr

Request

Creates a new air booking with the given itinerary

Security
Bearer
Bodyapplication/jsonrequired
bookingIdstring

The booking ID for which the PNR is being created. This is returned in the revalidate itinerary API response.

Example: "booking-id"
initiateBookingIdstring

Initiate booking id is returned in response to air-initiate-booking API call. This id is required if in case the booking id is not available due to third-party redirection.

Example: "eCfghty567jkHG56DFgh"
preSearchAnswersobject(PreSearchAnswers)
postPaymentVerificationInfoPostStripeVerificationInfoWrapper (object) or PostUrlBasedVerificationInfoWrapper (object) or AmadeusCheckoutVerificationInfoWrapper (object) or ThreeDSecure2PostVerificationInfoWrapper (object) or RazorpayPostVerificationInfoWrapper (object)(PostPaymentVerificationInfo)
One of:

Payment information sent after the verification of payment method.

isPreAuthApprovalRequiredboolean

Flag to check if the pre-authorization approval is enabled.

Example: false
customFieldV3ResponsesArray of objects(CustomFieldV3Response)

Custom field responses for the booking.

preBookAnswersobject(PreBookAnswers)Deprecated
curl -i -X POST \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/air/create-pnr \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "bookingId": "booking-id",
    "initiateBookingId": "eCfghty567jkHG56DFgh",
    "preBookAnswers": {
      "answers": [
        {
          "entityId": "string",
          "userInput": "string",
          "itemIds": [
            0
          ],
          "answers": [
            {
              "item": "string",
              "value": "string",
              "description": "string"
            }
          ],
          "customFieldType": "QUESTION",
          "questionDisplayText": "string",
          "question": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "name": "string",
            "questionFormat": "CHECKBOX",
            "optionInfo": {
              "source": "MANUAL",
              "sourceMetadata": {
                "companyConfig": {}
              },
              "totalNumOptions": 0,
              "options": [
                {}
              ]
            },
            "isRequired": true,
            "isDisabled": true,
            "includeInItinerary": true,
            "customFieldLocations": [
              "POLICY_APPROVAL_EMAIL"
            ],
            "matchConditions": {
              "travelerConditions": {
                "workerTypes": [
                  null
                ],
                "countries": [
                  null
                ],
                "legalEntities": [
                  null
                ],
                "departments": [
                  null
                ],
                "costCenters": [
                  null
                ],
                "offices": [
                  null
                ]
              },
              "travelTypes": [
                "AIR"
              ],
              "travelRegionTypes": [
                "DOMESTIC"
              ],
              "tripUsageTypes": [
                "STANDARD"
              ]
            },
            "questionType": {
              "preSearchQuestionType": "PURPOSE_OF_TRIP",
              "preCheckoutQuestionType": "OOP_REASON_CODE"
            }
          }
        }
      ],
      "preBookQuestionResponseId": "string"
    },
    "preSearchAnswers": {
      "answers": [
        {
          "entityId": "string",
          "userInput": "string",
          "itemIds": [
            0
          ],
          "answers": [
            {
              "item": "string",
              "value": "string",
              "description": "string"
            }
          ],
          "customFieldType": "QUESTION",
          "questionDisplayText": "string",
          "question": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "name": "string",
            "questionFormat": "CHECKBOX",
            "optionInfo": {
              "source": "MANUAL",
              "sourceMetadata": {
                "companyConfig": {}
              },
              "totalNumOptions": 0,
              "options": [
                {}
              ]
            },
            "isRequired": true,
            "isDisabled": true,
            "includeInItinerary": true,
            "customFieldLocations": [
              "POLICY_APPROVAL_EMAIL"
            ],
            "matchConditions": {
              "travelerConditions": {
                "workerTypes": [
                  null
                ],
                "countries": [
                  null
                ],
                "legalEntities": [
                  null
                ],
                "departments": [
                  null
                ],
                "costCenters": [
                  null
                ],
                "offices": [
                  null
                ]
              },
              "travelTypes": [
                "AIR"
              ],
              "travelRegionTypes": [
                "DOMESTIC"
              ],
              "tripUsageTypes": [
                "STANDARD"
              ]
            },
            "questionType": {
              "preSearchQuestionType": "PURPOSE_OF_TRIP",
              "preCheckoutQuestionType": "OOP_REASON_CODE"
            }
          }
        }
      ],
      "userEntitiesResponseId": "string"
    },
    "postPaymentVerificationInfo": {
      "paymentKey": "string",
      "postStripeVerificationInfo": {
        "paymentMethodId": "pm_1HzKDPI3bT9GUjvoUkRQooN3"
      }
    },
    "isPreAuthApprovalRequired": false,
    "customFieldV3Responses": [
      {
        "fieldId": "84922011-b03d-4966-bc95-c5b49bc2e342",
        "fieldName": "string",
        "armId": "0fd508db-63ff-4444-bfb1-b89c43061433",
        "includeLocations": [
          "APPROVAL_EMAILS"
        ],
        "selectedOptions": [
          {
            "name": "string",
            "description": "string",
            "additionalUserInput": "string",
            "additionalInfos": [
              "string"
            ],
            "additionalInfoConfigs": [
              {
                "type": "VARIABLE",
                "name": "LLF"
              }
            ]
          }
        ]
      }
    ]
  }'

Responses

OK

Bodyapplication/json
pnrIdstring

Spotnana PNR ID.

sourcePnrIdstring

Source PNR ID

pnrStatusstring

PNR status (for example success, approval pending)

Enum"SUCCESS""APPROVAL_PENDING""CC_VERIFICATION_REQUIRED""PAYMENT_PENDING""CONFIRMATION_PENDING""ERROR"
createPnrApplicationInfoobject

Create PNR application info, will return warning or error if present

Response
application/json
{
  "pnrId": "string",
  "sourcePnrId": "string",
  "pnrStatus": "SUCCESS",
  "createPnrApplicationInfo": {
    "applicationWarning": [ … ]
  }
}

Cancel Air Pnr

Request

Cancel the air pnr and issues applicable refunds

Security
Bearer
Bodyapplication/jsonrequired
pnrIdstringrequired

The spotnana assigned unique PNR id of the booking.

Example: "1234567819"
optionIdstringrequired

Cancellation option id chosen by the traveler prior to cancelling the booking. The trip->cancellation-details API returns a bunch of options like whether the traveler wants to keep the ticket as unused or get the refunds with applicable penalties.

Example: "OPTION123"
cancellationOverrideobject(CancellationOverride)

Cancellation info override details, like cancellation penalty, waiver code, etc.

customFieldV3ResponsesArray of objects(CustomFieldV3Response)

Custom field responses for the booking.

curl -i -X POST \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/air/cancel-pnr \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "pnrId": "1234567819",
    "optionId": "OPTION123",
    "cancellationOverride": {
      "waiverCode": "WAV123",
      "tourCode": "TRAC345",
      "newCancellationPenalty": {
        "amount": 510,
        "currencyCode": "GBP",
        "convertedAmount": 715.42,
        "convertedCurrency": "USD",
        "otherCoinage": [
          {
            "coinageCode": "BREX_POINTS",
            "amount": 1000,
            "conversionRate": 0.01,
            "preferredCurrencyConversionRate": 0.01
          }
        ]
      }
    },
    "customFieldV3Responses": [
      {
        "fieldId": "84922011-b03d-4966-bc95-c5b49bc2e342",
        "fieldName": "string",
        "armId": "0fd508db-63ff-4444-bfb1-b89c43061433",
        "includeLocations": [
          "APPROVAL_EMAILS"
        ],
        "selectedOptions": [
          {
            "name": "string",
            "description": "string",
            "additionalUserInput": "string",
            "additionalInfos": [
              "string"
            ],
            "additionalInfoConfigs": [
              {
                "type": "VARIABLE",
                "name": "LLF"
              }
            ]
          }
        ]
      }
    ]
  }'

Responses

OK

Bodyapplication/json
sourcePnrIdstring

Source pnr id of the cancellation.

Example: "ABCDEF"
statusstring(CancellationStatus)
  • CANCELLED: PNR is cancelled.
  • AGENT_TASK_CREATED: Agent task is created for the cancellation.
Enum"CANCELLED""AGENT_TASK_CREATED"
automaticCancellationInfoobject(AutomaticCancellationInfo)

Information about automatic processing that was performed during cancellation

Response
application/json
{
  "sourcePnrId": "ABCDEF",
  "status": "CANCELLED",
  "automaticCancellationInfo": {
    "segmentsCancelled": true,
    "automaticRefundSuccessful": true,
    "refundedTicketNumbers": [ … ],
    "automaticProcessingMessage": "Refunded tickets: 1234567890123"
  }
}

Get PNR exchange details

Request

This endpoint gets exchange details of all the tickets present in the given PNR ID of the given trip ID.

Security
Bearer
Path
pnrIdstringrequired

Spotnana PNR ID.

Example: 6926658168
curl -i -X GET \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/air/pnrs/6926658168/exchange-details \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
pnrIdstringrequired

PNR ID for the booking.

Example: "1234567890"
ticketToExchangeInfosArray of objects(TicketToExchangeInfo)

List of tickets and their exchange info.

Response
application/json
{
  "pnrId": "1234567890",
  "ticketToExchangeInfos": [
    { … }
  ]
}

Credits

Manage airline credits including company credit pools, credit transfers, and credit redemptions.

Operations

Autocomplete

Operations

Loyalty Programs

Operations
Copyright © 2025 Spotnana Technology, Inc.