Skip to main content

IATA_PaymentClearanceListRQ

Request · 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.

List payment clearances matching criteria.

When to use​

To query clearance records.

Transport​

PropertyValue
Method & pathPOST /24.4/PaymentClearanceListRQ
Content-Typeapplication/xml
AuthAuthorization: Bearer <token> (or X-API-Key: <key>)
Routing headerIATA-Message-Name: IATA_PaymentClearanceListRQ

See Authentication & connection for the full handshake.

Request example​

note

✅ The example below validates against the original XSD.

<?xml version="1.0" encoding="UTF-8"?>
<IATA_PaymentClearanceListRQ xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceListRQ">
  <ClearanceFilterCriteria/>
</IATA_PaymentClearanceListRQ>

Response example​

Paired response: IATA_PaymentClearanceListRS.

<?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_PaymentClearanceListRQ (one level deep, including inherited content):

FieldTypeRequiredRepeatableNotes
ClearanceFilterCriteriaClearanceFilterCriteriaType✓✓choice — pick one
ClearanceIDPC_ClearanceID_Type✓✓choice — pick one
OtherIDOtherID_Type✓✓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_PaymentClearanceListRQ } from '@oms/ndc-24-4';

const xml = IATA_PaymentClearanceListRQ.toXML(payload, { pretty: true });
const obj = IATA_PaymentClearanceListRQ.parseXML(xml);    // round-trips
IATA_PaymentClearanceListRQ.schema.parse(obj);            // strict Zod validation