# Cancel Air Pnr

Cancel the air pnr and issues applicable refunds

Endpoint: POST /v2/air/cancel-pnr
Version: v2
Security: Bearer

## Security:

  - `Bearer` (unknown)
    http bearer

## Request fields (application/json):

  - `pnrId` (string, required)
    The spotnana assigned unique PNR id of the booking.
    Example: 1234567819

  - `optionId` (string, required)
    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

  - `cancellationOverride` (object)
    Cancellation info override details, like cancellation penalty, waiver code, etc.

  - `cancellationOverride.waiverCode` (string)
    A waiver code to be applied to the refund. Typically a waiver code will be supplied by 
the airline for the agent to use to override a cancellation fee.
    Example: WAV123

  - `cancellationOverride.tourCode` (string)
    A tourcode to be applied to the refund. Input of a tourcode will override any tourcode 
on the original ticket.
    Example: TRAC345

  - `cancellationOverride.newCancellationPenalty` (object)
    Money object containing details such as the amount, the currency code, and the converted amount.

  - `cancellationOverride.newCancellationPenalty.amount` (number, required)
    The numeric value for the amount of money.
    Example: 510

  - `cancellationOverride.newCancellationPenalty.currencyCode` (string, required)
    The 3-letter currency code for the money amount (defined using ISO 4217 standard).
    Example: GBP

  - `cancellationOverride.newCancellationPenalty.convertedAmount` (number)
    The converted currency and amount that has been converted (if a currency conversion has been requested).
For example, if the call requests that money be sent in a specified currency (because the frontend requested
the backend to send money in the user's preferred currency).
    Example: 715.42

  - `cancellationOverride.newCancellationPenalty.convertedCurrency` (string)
    The 3-letter currency code for the converted currency (defined using ISO 4217 standard).
    Example: USD

  - `cancellationOverride.newCancellationPenalty.otherCoinage` (array)
    List of the dollar amount in other coinage systems like reward points, cryptocurrency etc.

  - `cancellationOverride.newCancellationPenalty.otherCoinage.coinageCode` (string)
    Payment method
    Enum: "PAYMENT_METHOD_UNKNOWN", "CREDIT_CARD", "BREX_POINTS", "CASH", "QANTAS_POINTS", "VENDOR_PROGRAM_PAYMENT", "DELAYED_INVOICING", "FLIGHT_CREDITS", "QANTAS_TRAVEL_FUND", "CUSTOM_VIRTUAL_PAYMENT", "FLIGHT_PASS", "MISCELLANEOUS_CREDIT_ORDER", "NO_PREPAYMENT", "DELAYED_PAYMENT"

  - `cancellationOverride.newCancellationPenalty.otherCoinage.amount` (number)
    Example: 1000

  - `cancellationOverride.newCancellationPenalty.otherCoinage.conversionRate` (number)
    1 coin in this system equals to how many currency value
    Example: 0.01

  - `cancellationOverride.newCancellationPenalty.otherCoinage.preferredCurrencyConversionRate` (number)
    1 coin in this system equals to how many currency value
    Example: 0.01

  - `cancellationOverride.newCancellationPenalty.otherCoinage.otherCoinageMetadata` (any)
    Metadata to store additional information related to the payment method

  - `cancellationOverride.newCancellationPenalty.otherCoinage.otherCoinageMetadata.metadataType` (string)
    Discriminator field for polymorphic deserialization
    Enum: "FlightPassPaymentMetadata"

  - `cancellationOverride.newCancellationPenalty.otherCoinage.otherCoinageMetadata.flightPassMetadata` (object, required)
    Metadata specific to Flight Pass payment method in OtherCoinage.

  - `cancellationOverride.newCancellationPenalty.otherCoinage.otherCoinageMetadata.flightPassMetadata.flightPassNumber` (string)
    Flight pass number
    Example: FP123456789

  - `cancellationOverride.newCancellationPenalty.otherCoinage.otherCoinageMetadata.flightPassMetadata.flightPassAmounts` (object)
    Fare breakdown for the flight pass booking.

  - `cancellationOverride.newCancellationPenalty.otherCoinage.otherCoinageMetadata.flightPassMetadata.flightPassAmounts.taxBreakdown` (array)
    Breakdown of taxes by code (e.g. GST_HST, QST, OTHER).

  - `cancellationOverride.newCancellationPenalty.otherCoinage.otherCoinageMetadata.flightPassMetadata.flightPassAmounts.taxBreakdown.code` (string)
    Tax code identifier (e.g. GST_HST, QST, OTHER).
    Example: GST_HST

  - `customFieldV3Responses` (array)
    Custom field responses for the booking.

  - `customFieldV3Responses.fieldId` (string, required)
    Custom field id

  - `customFieldV3Responses.fieldName` (string)
    Name of the custom field

  - `customFieldV3Responses.armId` (string, required)
    Arm id which is applicable

  - `customFieldV3Responses.includeLocations` (array)

  - `customFieldV3Responses.selectedOptions` (array, required)
    The list of options that are selected by user or auto populated.

  - `customFieldV3Responses.selectedOptions.name` (string, required)
    Value of the selection

  - `customFieldV3Responses.selectedOptions.translatedName` (string)
    Translated value of the selection

  - `customFieldV3Responses.selectedOptions.description` (string)
    Description of the selection

  - `customFieldV3Responses.selectedOptions.translatedDescription` (string)
    Translated description of the selection

  - `customFieldV3Responses.selectedOptions.additionalUserInput` (string)
    Additional user input

  - `customFieldV3Responses.selectedOptions.additionalInfos` (array)
    Actual values of the additional infos

  - `customFieldV3Responses.selectedOptions.additionalInfoConfigs` (array)
    Additional info configs for the selected option

  - `customFieldV3Responses.selectedOptions.additionalInfoConfigs.type` (string, required)
    Enum: "VARIABLE", "EXPRESSION"

  - `customFieldV3Responses.selectedOptions.additionalInfoConfigs.name` (string, required)
    Name of the variable.
    Enum: "PUBLISHED_FARE", "LLF", "ADD_COLLECT_AMOUNT", "SELECTED_FARE", "SPLIT_PAYMENT_FARE"

  - `customFieldV3Responses.selectedOptions.additionalInfoConfigs.formatExpression` (string, required)
    The expression must be of format : `<any_text> ${expression} <any_text>`.The expression
can consist of a combination of variables and mathematical operations.
Variable names must be same as VariableName Enum.
To define mathematical operations, the operation name should follow the format
`math.<math_op>(arg1, arg2)`. Both `arg1` and `arg2` can be variables or constants.
The supported math operations (math_op) include: `add, mul, div, sub, min, and max`. All keywords, such as `<math_op>, math, and var` must be written in lowercase.
    Example: Result:  ${math.mul(LLF,5)}  ${ADD_COLLECT_AMOUNT}

  - `customFieldV3Responses.selectedOptions.additionalInfoConfigs.variables` (array)
    Reference names of the variables present in the expression.

  - `customFieldV3Responses.selectedOptions.optionId` (string)
    Id of the selected option; sent by clients, never returned

  - `postPaymentVerificationInfo` (object)
    Payment information sent after the verification of payment method.

  - `postPaymentVerificationInfo.paymentKey` (string)
    Serialized key to identify the payment executed on payment gateway that will be used for post payment verification.

  - `postPaymentVerificationInfo.postStripeVerificationInfo` (object)
    Object to indicate successful stripe verification and provide payment information for next steps.

  - `postPaymentVerificationInfo.postStripeVerificationInfo.paymentMethodId` (string)
    Stripe's payment method id for which the verification was performed.
    Example: pm_1HzKDPI3bT9GUjvoUkRQooN3

  - `postPaymentVerificationInfo.postUrlBasedVerificationInfo` (object)

  - `postPaymentVerificationInfo.postUrlBasedVerificationInfo.pnrId` (string)
    Pnr Id, to continue with the booking flow/check the status of the pnr.

  - `postPaymentVerificationInfo.amadeusCheckoutVerificationInfo` (object)

  - `postPaymentVerificationInfo.amadeusCheckoutVerificationInfo.paymentActionTokens` (array, required)

  - `postPaymentVerificationInfo.amadeusCheckoutVerificationInfo.paymentActionTokens.paymentRequestId` (string, required)
    Initial payment id generated by checkout SDK to initiate payment

  - `postPaymentVerificationInfo.amadeusCheckoutVerificationInfo.paymentActionTokens.actionToken` (string, required)
    Token returned by checkout SDK to create/validate FOP in PSS order

  - `postPaymentVerificationInfo.amadeusCheckoutVerificationInfo.paymentRequestId` (string)
    Initial payment id generated by checkout SDK to initiate payment

  - `postPaymentVerificationInfo.amadeusCheckoutVerificationInfo.actionToken` (string)
    Token returned by checkout SDK to create/validate FOP in PSS order

  - `postPaymentVerificationInfo.amadeusCheckoutVerificationInfo.confirmPayment` (boolean)
    Flag which indicates that the payment confirmation is now required (after 3ds or redirection)

  - `postPaymentVerificationInfo.amadeusCheckoutVerificationInfo.saveCardForFutureUse` (boolean)
    Flag to indicate that card can be saved for future use.

  - `postPaymentVerificationInfo.threeDSecure2PostVerificationInfo` (object)
    Result of 3DS2 verification.

  - `postPaymentVerificationInfo.threeDSecure2PostVerificationInfo.results` (array, required)
    List of 3DS2 verification results.

  - `postPaymentVerificationInfo.threeDSecure2PostVerificationInfo.results.cardId` (string, required)
    Card id for which the verification was performed.
    Example: 550e8400-e29b-41d4-a716-446655440000

  - `postPaymentVerificationInfo.threeDSecure2PostVerificationInfo.results.sessionId` (string, required)
    session id of the payment service provider.
    Example: sid_7q3lpqopuwmuxct3l3rkz225ae

  - `postPaymentVerificationInfo.threeDSecure2PostVerificationInfo.results.success` (boolean, required)
    Whether the 3DSecure2 authentication was successful.
    Example: true

  - `postPaymentVerificationInfo.postRazorpayVerificationInfo` (object)
    Object to indicate successful stripe verification and provide payment information for next steps.

  - `postPaymentVerificationInfo.postRazorpayVerificationInfo.paymentId` (string, required)
    Razorpay payment id for which the verification was performed.
    Example: pay_Ot3t93Xwmh2hOg

  - `postPaymentVerificationInfo.postRazorpayVerificationInfo.orderId` (string)
    Razorpay order id in which the payment was added.
    Example: order_OshJ61KRRSzb2Q

  - `postPaymentVerificationInfo.postRazorpayVerificationInfo.signature` (string)
    Razorpay signature to validate the payment.
    Example: f2c0494b77cb067a0ac76973d65cdce8c9de593a55ef2f81969cbabbe7ce493d

  - `bookingPaymentDetails` (object)
    Payment details used for booking.

  - `bookingPaymentDetails.bookingTravelerPaymentDetails` (array, required)

  - `bookingPaymentDetails.bookingTravelerPaymentDetails.selectedFormOfPayments` (array, required)

  - `bookingPaymentDetails.bookingTravelerPaymentDetails.selectedFormOfPayments.paymentItems` (array, required)

  - `bookingPaymentDetails.bookingTravelerPaymentDetails.selectedFormOfPayments.paymentItems.itemType` (string)
    Type of payment item eligible for this fop rule
    Enum: "SERVICE_FEE", "TRAVEL_TICKET", "SEAT", "BAGGAGE", "EARLY_BIRD"

  - `bookingPaymentDetails.bookingTravelerPaymentDetails.selectedFormOfPayments.paymentItems.fareComponent` (array)

  - `bookingPaymentDetails.bookingTravelerPaymentDetails.selectedFormOfPayments.selectedPaymentSources` (array, required)

  - `bookingPaymentDetails.bookingTravelerPaymentDetails.selectedFormOfPayments.selectedPaymentSources.paymentSourceId` (string)
    Unique identifier identifying this payment source.
    Example: f49d00fe-1eda-4304-ba79-a980f565281d

  - `bookingPaymentDetails.bookingTravelerPaymentDetails.selectedFormOfPayments.selectedPaymentSources.rawPaymentSource` (object)
    Raw Details of the Payment Source

  - `bookingPaymentDetails.bookingTravelerPaymentDetails.selectedFormOfPayments.selectedPaymentSources.rawPaymentSource.type` (string, required)
    Payment source type. Should be set to DPAN for card details.
    Enum: "DPAN"

  - `bookingPaymentDetails.bookingTravelerPaymentDetails.selectedFormOfPayments.selectedPaymentSources.rawPaymentSource.cardDetails` (object, required)
    Card Details

  - `bookingPaymentDetails.bookingTravelerPaymentDetails.selectedFormOfPayments.selectedPaymentSources.rawPaymentSource.cardDetails.company` (string, required)
    The issuing company of card
    Enum: "NONE", "VISA", "MASTERCARD", "AMEX", "DISCOVER", "AIR_TRAVEL_UATP", "CARTE_BLANCHE", "DINERS_CLUB", "JCB", "BREX", "UNION_PAY", "EURO_CARD", "ACCESS_CARD", "ELO_CARD"

  - `bookingPaymentDetails.bookingTravelerPaymentDetails.selectedFormOfPayments.selectedPaymentSources.rawPaymentSource.cardDetails.token` (string, required)
    Tokenized Card Number
    Example: 4111111111111111

  - `bookingPaymentDetails.bookingTravelerPaymentDetails.selectedFormOfPayments.selectedPaymentSources.rawPaymentSource.cardDetails.expiry` (object, required)
    Contains the expiry of a Card.

  - `bookingPaymentDetails.bookingTravelerPaymentDetails.selectedFormOfPayments.selectedPaymentSources.rawPaymentSource.type` (string, required)
    Payment source type. Should be set to CREDIT for unused credit details.
    Enum: "CREDIT"

  - `bookingPaymentDetails.bookingTravelerPaymentDetails.selectedFormOfPayments.selectedPaymentSources.rawPaymentSource.pnrOwningPcc` (string, required)
    PCC the PNR was created on.

  - `bookingPaymentDetails.bookingTravelerPaymentDetails.selectedFormOfPayments.selectedPaymentSources.rawPaymentSource.unusedCreditPcc` (string, required)
    PCC the credit was issued on.

  - `bookingPaymentDetails.bookingTravelerPaymentDetails.selectedFormOfPayments.selectedPaymentSources.rawPaymentSource.departureCountry` (string)
    3 letter country code of the departure country associated with the original ticket.
    Example: USA

  - `bookingPaymentDetails.bookingTravelerPaymentDetails.selectedFormOfPayments.selectedPaymentSources.rawPaymentSource.arrivalCountry` (string)
    3 letter country code of the arrival country associated with the original ticket.
    Example: USA

  - `bookingPaymentDetails.bookingTravelerPaymentDetails.selectedFormOfPayments.selectedPaymentSources.rawPaymentSource.ticketType` (string, required)
    Type of credit.
    Enum: "TICKET_TYPE_UNKNOWN", "ETICKET", "MCO"

  - `bookingPaymentDetails.bookingTravelerPaymentDetails.selectedFormOfPayments.selectedPaymentSources.rawPaymentSource.departureDate` (object)
    ISO8601 UTC Date Time

  - `bookingPaymentDetails.bookingTravelerPaymentDetails.selectedFormOfPayments.selectedPaymentSources.rawPaymentSource.departureDate.iso8601` (string, required)
    Example: 2017-07-21T17:32Z

  - `bookingPaymentDetails.bookingTravelerPaymentDetails.selectedFormOfPayments.selectedPaymentSources.rawPaymentSource.segmentsAvailable` (string)
    Whether all segments are unused or some have already been used.
    Enum: "UNKNOWN", "ALL_OPEN", "PARTIAL", "OTHER"

  - `bookingPaymentDetails.bookingTravelerPaymentDetails.selectedFormOfPayments.selectedPaymentSources.rawPaymentSource.traveler` (object)
    The traveler identifiers. These can be either the Spotnana user IDs of the travelers or information regarding
the adhoc travelers.

  - `bookingPaymentDetails.bookingTravelerPaymentDetails.selectedFormOfPayments.selectedPaymentSources.rawPaymentSource.passengerName` (object)
    Full name containing first, middle, last (family) names, and suffix.

  - `bookingPaymentDetails.bookingTravelerPaymentDetails.selectedFormOfPayments.selectedPaymentSources.rawPaymentSource.passengerName.family1` (string, required)
    Last (family) name.
    Example: Gandas

  - `bookingPaymentDetails.bookingTravelerPaymentDetails.selectedFormOfPayments.selectedPaymentSources.rawPaymentSource.passengerName.family2` (string)
    Example: FamilyTwo

  - `bookingPaymentDetails.bookingTravelerPaymentDetails.selectedFormOfPayments.selectedPaymentSources.rawPaymentSource.passengerName.given` (string, required)
    First (given) name.
    Example: Vichitr

  - `bookingPaymentDetails.bookingTravelerPaymentDetails.selectedFormOfPayments.selectedPaymentSources.rawPaymentSource.passengerName.middle` (string)
    Middle name.
    Example: Kumar

  - `bookingPaymentDetails.bookingTravelerPaymentDetails.selectedFormOfPayments.selectedPaymentSources.rawPaymentSource.passengerName.suffix` (string)
    Suffix for name
    Enum: "NAME_SUFFIX_UNKNOWN", "SR", "JR", "MD", "PHD", "II", "III", "IV", "DO", "ATTY", "V", "VI", "ESQ", "DC", "DDS", "VM", "JD", "SECOND", "THIRD"

  - `bookingPaymentDetails.bookingTravelerPaymentDetails.selectedFormOfPayments.selectedPaymentSources.rawPaymentSource.passengerName.preferred` (string)
    Informal preferred name added by traveler. This is not used on any PNR or tickets
    Example: Don

  - `bookingPaymentDetails.bookingTravelerPaymentDetails.selectedFormOfPayments.selectedPaymentSources.rawPaymentSource.airlineInfo` (object, required)
    Detailed information about the airline.

  - `bookingPaymentDetails.bookingTravelerPaymentDetails.selectedFormOfPayments.selectedPaymentSources.rawPaymentSource.airlineInfo.airlineCode` (string, required)
    IATA code for airline.
    Example: AA

  - `bookingPaymentDetails.bookingTravelerPaymentDetails.selectedFormOfPayments.selectedPaymentSources.rawPaymentSource.airlineInfo.airlineName` (string)
    Airline name
    Example: American Airlines

  - `bookingPaymentDetails.bookingTravelerPaymentDetails.selectedFormOfPayments.selectedPaymentSources.rawPaymentSource.source` (string, required)
    Enum: "UNKNOWN_SOURCE", "SABRE", "TRAVEL_FUSION", "AVIA", "NDC", "TRAINLINE", "ATPCO_NDC", "FARELOGIX_NDC", "OFFLINE", "CONNEXUS", "ROUTEHAPPY", "AMADEUS", "GIATA", "QBR", "BCD", "QANTAS_HOTELS", "SOUTHWEST", "EXPEDIA", "HOTEL_HUB", "MARRIOTT", "CLEARTRIP", "KYTE", "GROUNDSPAN", "SABRE_NDC", "BOOKING_COM", "CARTRAWLER", "PREMIER_INN", "TRAVELODGE", "ENTERPRISE", "HYATT", "HILTON", "EUROSTAR", "NATIONAL", "ALAMO", "AVIS", "BUDGET", "HERTZ", "DOLLAR", "THRIFTY", "FIREFLY", "AMADEUS_NDC", "SIXT"

  - `bookingPaymentDetails.bookingTravelerPaymentDetails.selectedFormOfPayments.selectedPaymentSources.rawPaymentSource.sourcePnr` (string, required)
    PNR number corresponding to third party through which booking was made.
    Example: MC5ONS

  - `bookingPaymentDetails.bookingTravelerPaymentDetails.selectedFormOfPayments.selectedPaymentSources.rawPaymentSource.flightIds` (array)
    ID of the flights on which this credit applies.

  - `bookingPaymentDetails.bookingTravelerPaymentDetails.selectedFormOfPayments.selectedPaymentSources.rawPaymentSource.ticketNumber` (string, required)
    Ticket number for the ticket that was converted into an unused credit.
    Example: 5267779139217

  - `bookingPaymentDetails.bookingTravelerPaymentDetails.selectedFormOfPayments.selectedPaymentSources.rawPaymentSource.travelerIndex` (integer)
    credit associated to the traveler having this index in the air search request. If not passed, credit will be associated in order of the travelers
    Example: 2

  - `bookingPaymentDetails.bookingTravelerPaymentDetails.selectedFormOfPayments.selectedPaymentSources.postPaymentRedirectionUrl` (string)
    Url for post payment redirection if payment source navigates user to a third party url
    Example: https://mycompany.com/checkout?paymentSourceId=f49d00fe-1eda-4304-ba79-a980f565281d

  - `bookingPaymentDetails.bookingTravelerPaymentDetails.selectedFormOfPayments.selectedPaymentSources.cvv` (string)
    CVV associated with associated payment source, if any.

  - `manualRemarks` (array)
    Remarks from the frontend to be added to the PNR during creation.

  - `manualRemarks.sabre` (object)
    Sabre Remark

  - `manualRemarks.sabre.type` (string)
    Type of remark, for eg, General, Invoice, etc.
    Enum: "ALPHA_CODED", "CLIENT_ADDRESS", "CORPORATE", "DELIVERY_ADDRESS", "GENERAL", "GROUP_NAME", "HIDDEN", "HISTORICAL", "INVOICE", "ITINERARY", "OSI"

  - `manualRemarks.sabre.text` (string)
    ThirdPartyPnrRemark
    Example: PREF ALLIANCES 1-ONE WORLD/AA

  - `manualRemarks.sabre.legIndex` (integer)
    Index referencing the flight leg for which the remark should be added. Currently required only for OSI Remarks. Should be used in conjunction with the flight Index.
    Example: 1

  - `manualRemarks.sabre.flightIndex` (integer)
    Index referencing the flight for which the remark should be added. Currently required only for OSI Remarks. Should be used in conjunction with the leg Index.
    Example: 0

  - `unusedCreditTicketNumbers` (array)
    Ticket numbers to be left open to convert to unused credit.
    Example: ["0161234567890"]

  - `refundDetails` (array)
    Per-ticket refund details including refund amount and cancel type.

  - `refundDetails.ticketNumber` (string)
    Ticket number corresponding to the refund details.
    Example: 0161234567890

  - `refundDetails.refundAmount` (object)
    Fare amount including base fare and tax.

  - `refundDetails.refundAmount.taxBreakdown` (array)

  - `refundDetails.refundAmount.taxBreakdown.taxCode` (string)
    Tax code
    Example: VAT

  - `refundDetails.refundAmount.taxBreakdown.percentage` (number)
    Tax amount to total amount
    Example: 9

  - `refundDetails.refundAmount.taxBreakdown.description` (string)
    Tax name or Tax Description
    Example: AIR TRAVELLERS SECURITY CHARGE

  - `refundDetails.cancelType` (string)
    Type of cancellation for a ticket.
    Enum: "UNKNOWN_CANCEL_TYPE", "VOID", "REFUND", "UNUSED_CREDIT"

  - `waiveOffInfo` (object)
    Waive off info.

  - `waiveOffInfo.waiveOffInfoPerModules` (array)
    Waive off info per module.

  - `waiveOffInfo.waiveOffInfoPerModules.moduleId` (string)
    Module id
    Enum: "BOOKING", "AGENT"

  - `waiveOffInfo.waiveOffInfoPerModules.waiveOffFeeReason` (object)
    Fee waive off reason info.

  - `waiveOffInfo.waiveOffInfoPerModules.waiveOffFeeReason.reasonCode` (string)
    Fee waive off reason code.
    Example: WA05

  - `waiveOffInfo.waiveOffInfoPerModules.waiveOffFeeReason.reason` (string)
    Fee waive off reason description.
    Example: Customer goodwill

## Response 200:

  - `200` (unknown)
    OK

## Response 200 fields (application/json):

  - `sourcePnrId` (string)
    Source pnr id of the cancellation.
    Example: ABCDEF

  - `status` (string)
    - CANCELLED: PNR is cancelled.
- AGENT_TASK_CREATED: Agent task is created for the cancellation.
    Enum: "CANCELLED", "AGENT_TASK_CREATED"

  - `automaticCancellationInfo` (object)
    Information about automatic processing that was performed during cancellation

  - `automaticCancellationInfo.segmentsCancelled` (boolean)
    Whether segments were successfully cancelled
    Example: true

  - `automaticCancellationInfo.automaticRefundSuccessful` (boolean)
    Whether automatic refund was attempted and successful
    Example: true

  - `automaticCancellationInfo.refundedTicketNumbers` (array)
    List of ticket numbers that were automatically refunded
    Example: ["1234567890123"]

  - `automaticCancellationInfo.automaticProcessingMessage` (string)
    Human-readable message describing what was automatically processed
    Example: Refunded tickets: 1234567890123

  - `processingWarning` (string)
    Optional warning message if processing is taking longer than expected
    Example: Cancellation is successful but update is taking longer than expected

  - `paymentVerificationInfo` (object)
    VerificationInfo required for the payment operation.

  - `paymentVerificationInfo.gatewayIdentifier` (object)

  - `paymentVerificationInfo.gatewayIdentifier.gatewayId` (string)
    Gateway Id for which the payment method should be verified.

  - `paymentVerificationInfo.gatewayIdentifier.gatewayType` (string)
    Gateway Type for of the verification gateway.
    Enum: "PAYMENT_GATEWAY_UNKNOWN", "STRIPE", "BREX", "RAZORPAY"

  - `paymentVerificationInfo.paymentKey` (string)
    Serialized key to identify the payment executed on payment gateway that will be used for post payment verification.

  - `paymentVerificationInfo.stripeVerificationInfo` (object)
    Verification information required for card stripe verification.

  - `paymentVerificationInfo.stripeVerificationInfo.stripeCardTokens` (object)
    Stripe card tokens used by clients in authorizing newly added cards.

  - `paymentVerificationInfo.stripeVerificationInfo.stripeCardTokens.paymentProcessor` (string, required)
    Payment processor involved.
    Example: STRIPE

  - `paymentVerificationInfo.stripeVerificationInfo.stripeCardTokens.paymentMethodId` (string, required)
    Stripe's payment-method-id for the card.
    Example: pm_1HzKDPI3bT9GUjvoUkRQooN3

  - `paymentVerificationInfo.stripeVerificationInfo.stripeCardTokens.setupIntentClientSecret` (string, required)
    Stripe client secret for attaching the card to the setup-intent.
    Example: seti_1IBwEiKXFM6BpWYhfdCGZ7sg_secret_InXJDifWGBcVqekJvhAxidON6vHAvfS

  - `paymentVerificationInfo.stripeVerificationInfo.stripeCardTokens.connectedAccountId` (string)
    Account Id of the connected account in which above payment-method and setup-intent exist. This is populated only when a connected account is used.
    Example: acct_1NT8oyCZnFgI0lFY

  - `paymentVerificationInfo.stripeVerificationInfo.stripeCardTokens.publishableKey` (string)
    Publishable key of the Stripe platform account.
    Example: pk_test_51Hx7XyI3bT9GUjvoUkRQooN3

  - `paymentVerificationInfo.urlVerificationInfo` (object)
    Verification information required for url based payment verification.

  - `paymentVerificationInfo.urlVerificationInfo.ccVerificationUrl` (string)
    Verification url for the payment source.

  - `paymentVerificationInfo.threeDSecure2VerificationInfo` (object)
    Verification information required for 3DS2 authentication.

  - `paymentVerificationInfo.threeDSecure2VerificationInfo.verificationInfoList` (array, required)
    List of 3DS2 verification info.

  - `paymentVerificationInfo.threeDSecure2VerificationInfo.verificationInfoList.cardId` (string, required)
    Card id for which the verification was performed.
    Example: 550e8400-e29b-41d4-a716-446655440000

  - `paymentVerificationInfo.threeDSecure2VerificationInfo.verificationInfoList.sessionId` (string, required)
    session id of the payment service provider.
    Example: sid_7q3lpqopuwmuxct3l3rkz225ae

  - `paymentVerificationInfo.threeDSecure2VerificationInfo.verificationInfoList.redirectUrl` (string, required)
    3DS2 verification redirect url.
    Example: https://api.checkout.com/sessions-interceptor/sid_7q3lpqopuwmuxct3l3rkz225ae

  - `paymentVerificationInfo.razorPayVerificationInfo` (object)
    Verification information required when card is tokenized via Razorpay for Indian markets.

  - `paymentVerificationInfo.razorPayVerificationInfo.paymentProcessor` (string, required)
    Payment processor involved.
    Example: RAZORPAY

  - `paymentVerificationInfo.razorPayVerificationInfo.paymentAuthUrl` (string)
    URL for authorizing the payment on the card.

## Response 401:

  - `401` (unknown)
    Unauthorized

## Response 401 fields (application/json):

  - `debugIdentifier` (string)
    Link to debug the error internally.

  - `errorMessages` (array)

  - `errorMessages.errorCode` (string)
    Error code to identify the specific errors.

  - `errorMessages.message` (string)
    Message containing details of error.

  - `errorMessages.errorParameters` (array)
    Error message parameters.

  - `errorMessages.errorParameters.name` (string)
    Parameter name

  - `errorMessages.errorParameters.value` (string)
    Parameter value

  - `errorMessages.errorDetail` (string)
    More details about the error.

## Response 403:

  - `403` (unknown)
    Forbidden

## Response 403 fields (application/json):

  - `debugIdentifier` (string)
    Link to debug the error internally.

  - `errorMessages` (array)

  - `errorMessages.errorCode` (string)
    Error code to identify the specific errors.

  - `errorMessages.message` (string)
    Message containing details of error.

  - `errorMessages.errorParameters` (array)
    Error message parameters.

  - `errorMessages.errorParameters.name` (string)
    Parameter name

  - `errorMessages.errorParameters.value` (string)
    Parameter value

  - `errorMessages.errorDetail` (string)
    More details about the error.

## Response 404:

  - `404` (unknown)
    The specified resource was not found.

## Response 404 fields (application/json):

  - `debugIdentifier` (string)
    Link to debug the error internally.

  - `errorMessages` (array)

  - `errorMessages.errorCode` (string)
    Error code to identify the specific errors.

  - `errorMessages.message` (string)
    Message containing details of error.

  - `errorMessages.errorParameters` (array)
    Error message parameters.

  - `errorMessages.errorParameters.name` (string)
    Parameter name

  - `errorMessages.errorParameters.value` (string)
    Parameter value

  - `errorMessages.errorDetail` (string)
    More details about the error.