Skip to main content

IATA_PaymentClearanceListRS

Response · Payment Clearance · Implemented

Implemented

Delivers: STTSUM Payment clearance — summary.

Limits today:

  • STTSUM — The caller sees its own clearances, by ClearanceID, CommitmentID (the OrderID) or filter criteria; AgreementIDs are not recorded.

Rests on simulated supply (settlement) — flagged on every response; see Simulated supply.

Returns the list of matching clearances.

When to use​

Response to IATA_PaymentClearanceListRQ.

Transport​

IATA_PaymentClearanceListRS is a response body. It is returned by its paired request rather than POSTed directly.

Example​

note

✅ The example below validates against the original XSD.

<?xml version="1.0" encoding="UTF-8"?>
<IATA_PaymentClearanceListRS xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceListRS">
  <Clearance>
    <ClearanceID xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">0000000AAAAAAAA</ClearanceID>
    <ClearancePayeeData xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">
      <ClearancePayee>
        <Carrier>
          <AirlineAccountingCode>X</AirlineAccountingCode>
          <AirlineDesigCode>AA</AirlineDesigCode>
        </Carrier>
      </ClearancePayee>
    </ClearancePayeeData>
    <ClearancePayerData xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">
      <ClearancePayer>
        <Carrier>
          <AirlineAccountingCode>X</AirlineAccountingCode>
          <AirlineDesigCode>AA</AirlineDesigCode>
        </Carrier>
      </ClearancePayer>
    </ClearancePayerData>
    <NetClearanceAmount xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes" CurCode="X">1</NetClearanceAmount>
    <PaymentBrandCode xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">1</PaymentBrandCode>
    <PaymentCommitmentDateTime xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">2024-06-01T09:00:00Z</PaymentCommitmentDateTime>
    <ProcessRuleCode xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">IATACAA</ProcessRuleCode>
    <RemittanceDate xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">2024-06-01</RemittanceDate>
    <SettlementDate xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">2024-06-01</SettlementDate>
    <StatusCode xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">AAAAA</StatusCode>
  </Clearance>
</IATA_PaymentClearanceListRS>

Key fields​

Top-level content model of IATA_PaymentClearanceListRS (one level deep, including inherited content):

FieldTypeRequiredRepeatableNotes
ClearanceClearanceListResponseType✓✓choice — pick one
ErrorPC_ErrorType✓✓choice — pick one
PayloadStandardAttributesPC_IATA_PayloadStandardAttributesType——

Build it with the SDK​

The @oms/ndc-24-4 package is a reference SDK — build, serialize, parse, and validate this message in code:

import { IATA_PaymentClearanceListRS } from '@oms/ndc-24-4';

const obj = IATA_PaymentClearanceListRS.parseXML(xml);   // parse a received response
IATA_PaymentClearanceListRS.schema.parse(obj);            // strict Zod validation