Source: https://guides.developer.iata.org/docs/download-the-latest-standards

Clearance

A delivery of funds from one party - payer- to another party - the payee - to fulfill contractual obligations, i.e. commitment between the two parties.

Properties

Name Description Type Required Generic Enum Ignore
airlineRefIdentifier identifier provided by the carrier to support internal financial processes, for example reconciliation. string false false
carrier An organization which carries the passenger, baggage, or goods, and/or commits to delivering the carriage as well as any related services such as issuance of ticket, creation of Order, etc. Carrier true false
clearanceIdentifier this is an identifier generated by the party requesting the clearance that uniquely identifies the clearance transaction. It provides the necessary link for financial audit connecting the sale to the financial records. This field is required because no other existing data elements could be used by the financial systems or could provide unique identification. The identifier is globally unique for the settlement by design. string true false
clearancePayeeReconciliationIdentifier identifier provided by the Clearance Payee to support internal financial processes, for example reconciliation. If this identifier is included in the clearance request then it must be included in all messages thereafter where it is provided as an option. string false false
clearancePayerReconciliationIdentifier identifier provided by the Clearance Payer to support internal financial processes, for example reconciliation. If this identifier is included in the clearance request then it must be included in all messages thereafter where it is provided as an option. string false false
commitmentToPay A commitment to settle a transaction through monetary or other compensations. This is the trigger to request clearance and it refers to the commitment to make payment within the agreement. CommitmentToPay true false
failureReasonCode describe the reason why a request for clearance cannot be performed and effectively the clearance is rejected or the requested action, such as cancelling the clearance, failed. string false false
nonSettledAmount amount of the Net Clearance Amount in the individual clearance that remains to be cleared. The amount in the NonSettledAmount is defined by the value in the data element StatusCode. When the value of the StatusCode is Write off (WRTOF) then the value in the data element NonSettledAmount is the value that is being written off. For all other values of the data element StatusCode the value of the data element NonSettledAmount represents what is the remaining amount to be cleared. NonSettledAmount must be included in all messages where it is provided as an option when its value is neither 0 (zero) nor equal to NetClearanceAmount Amount false false
org An organized structure set up for a particular purpose, such as a business, government body, department, charity, or financial institution. Org true false
payee A private retailer or public service that provides travel and tourism related services to the public on behalf of suppliers such as activities, airlines, car rentals, cruise lines, hotels, railways, travel insurance, and package tours. TravelAgency true false
processingInstructions An Information related to the processing options ProcessingInstructions true false
processRuleCode defines under what governing rules, process and reporting standard the Settlement Manager processes the clearance. Example: IATAC00 or BLTRL00 or NDCLNK0 string true false
remainingAmount amount that remains to be settled from the individual clearance request. Amount true false
settlementDate the date when the Settlement Manager will settle the funds to the Clearance Payee. string true false
statusCode the progress of the individual transaction within the settlement process. Transaction is first acknowledged, then in process, then settled or could have status 'clawback', 'partially settled', 'final settlement' or 'write off'. ClearanceStatusCode true false
travelAgency A private retailer or public service that provides travel and tourism related services to the public on behalf of suppliers such as activities, airlines, car rentals, cruise lines, hotels, railways, travel insurance, and package tours. TravelAgency true false
{
  "airlineRefIdentifier" : "string",
  "carrier" : {
    "aircraftGroup" : [ { } ],
    "airlineAccountingCode" : "string",
    "airlineCabinType" : [ { } ],
    "airlineCriteria" : [ { } ],
    "airlineDesigCode" : { },
    "airlineLoadInfo" : [ { } ],
    "airlineProfile" : { },
    "alliance" : [ { } ],
    "baggageAllowance" : { },
    "baggageDisclosure" : { },
    "baggageStandardWeights" : [ { } ],
    "bagTag" : { },
    "bookingEntity" : { },
    "carrierAgent" : [ { } ],
    "carrierAircraftType" : [ { } ],
    "carrierFee" : { },
    "clearance" : { },
    "clearanceParty" : { },
    "contactInfo" : [ { } ],
    "contentOwner" : { },
    "coupon" : { },
    "crewBaggageStandardWeights" : [ { } ],
    "crewStandardWeights" : [ { } ],
    "datedMarketingSegment" : [ { } ],
    "datedOperatingFlight" : [ { } ],
    "datedOperatingSegment" : [ { } ],
    "duplicateDesigInd" : "boolean",
    "iataAircraftType" : [ { } ],
    "iataNumber" : "number",
    "loyaltyProgram" : { },
    "loyaltyProgramAccount" : { },
    "marketedOffer" : [ { } ],
    "merchantAccount" : { },
    "name" : "string",
    "order" : [ { } ],
    "orderItem" : [ { } ],
    "paxStandardWeights" : [ { } ],
    "programCriteria" : { },
    "promotionIssuer" : { },
    "service" : { },
    "serviceDefinition" : [ { } ],
    "shoppingResponse" : { },
    "ticketIssuanceInfo" : { },
    "uldType" : [ { } ],
    "validatedOffer" : [ { } ],
    "volumeUnitCode" : { },
    "weightUnitCode" : { }
  },
  "clearanceIdentifier" : "string",
  "clearancePayeeReconciliationIdentifier" : "string",
  "clearancePayerReconciliationIdentifier" : "string",
  "commitmentToPay" : {
    "agreement" : { },
    "clearance" : { },
    "commitmentIdentifier" : "string",
    "paymentCommitmentDateTime" : "string",
    "paymentMethod" : { },
    "typeCode" : { }
  },
  "failureReasonCode" : "string",
  "nonSettledAmount" : {
    "curCode" : "string",
    "value" : "number"
  },
  "org" : {
    "bookingEntity" : { },
    "bookingRef" : [ { } ],
    "clearance" : { },
    "clearanceParty" : { },
    "contactInfo" : [ { } ],
    "contentOwner" : { },
    "name" : "string",
    "orgIdentifier" : "string",
    "pax" : { },
    "programCriteria" : { },
    "promotionIssuer" : { },
    "salesTaxRegistration" : [ { } ],
    "taxDeductedAtSourceCapabilityInd" : "boolean"
  },
  "payee" : {
    "agencyIdentifier" : "string",
    "bookingAgencyTicketDocInfo" : [ { } ],
    "clearance" : { },
    "clearanceParty" : { },
    "contactInfo" : [ { } ],
    "iataNumber" : "number",
    "name" : "string",
    "promotionIssuer" : { },
    "pseudoCityIdentifier" : "string",
    "servicingAgencyTicketDocInfo" : [ { } ],
    "ticketIssuanceInfo" : { },
    "travelAgencyAccreditation" : [ { } ],
    "travelAgent" : [ { } ],
    "typeCode" : { }
  },
  "processingInstructions" : {
    "clearance" : { },
    "clearanceCount" : "integer",
    "rejectEveryClearanceInd" : "boolean"
  },
  "processRuleCode" : "string",
  "remainingAmount" : {
    "curCode" : "string",
    "value" : "number"
  },
  "settlementDate" : "string",
  "statusCode" : {
    "clearanceStatusCodeEnum" : { }
  },
  "travelAgency" : {
    "agencyIdentifier" : "string",
    "bookingAgencyTicketDocInfo" : [ { } ],
    "clearance" : { },
    "clearanceParty" : { },
    "contactInfo" : [ { } ],
    "iataNumber" : "number",
    "name" : "string",
    "promotionIssuer" : { },
    "pseudoCityIdentifier" : "string",
    "servicingAgencyTicketDocInfo" : [ { } ],
    "ticketIssuanceInfo" : { },
    "travelAgencyAccreditation" : [ { } ],
    "travelAgent" : [ { } ],
    "typeCode" : { }
  }
}