Skip to main content

IATA_PaymentClearingListRQ

Request · Payment Clearance · Implemented

Implemented

Delivers: STTHST Payment clearance — history.

Limits today:

  • STTHST — Clearing is a scheduled simulated batch: no bank moves anything.

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

List payment-clearing (settlement) records.

When to use​

To query clearing records.

Transport​

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

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_PaymentClearingListRQ xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearingListRQ">
  <ClearingDate>
    <FromDate xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">2024-06-01</FromDate>
    <ToDate xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">2024-06-01</ToDate>
  </ClearingDate>
</IATA_PaymentClearingListRQ>

Response example​

Paired response: IATA_PaymentClearingListRS.

<?xml version="1.0" encoding="UTF-8"?>
<IATA_PaymentClearingListRS xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearingListRS">
  <ClearingProcess>
    <ClearanceClearingNotif xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">
      <ClearanceID>0000000AAAAAAAA</ClearanceID>
      <NetClearanceAmount CurCode="X">1</NetClearanceAmount>
      <PaymentBrandCode>1</PaymentBrandCode>
      <PaymentCommitmentDateTime>2024-06-01T09:00:00Z</PaymentCommitmentDateTime>
      <ProcessRuleCode>IATACAA</ProcessRuleCode>
      <StatusCode>AAAAA</StatusCode>
    </ClearanceClearingNotif>
    <ClearingDate xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">2024-06-01</ClearingDate>
    <ClearingID xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">SWSAAAAAAA</ClearingID>
    <ClearingParty xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">
      <RemittancePayer>
        <Carrier>
          <AirlineAccountingCode>X</AirlineAccountingCode>
          <AirlineDesigCode>AA</AirlineDesigCode>
        </Carrier>
      </RemittancePayer>
    </ClearingParty>
    <FundsTransfer xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">
      <MethodCode>AAAAAAA</MethodCode>
      <TypeCode>AAA</TypeCode>
      <ValueDate>2024-06-01</ValueDate>
    </FundsTransfer>
    <TotalAmount xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes" CurCode="X">1</TotalAmount>
  </ClearingProcess>
</IATA_PaymentClearingListRS>

Key fields​

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

FieldTypeRequiredRepeatableNotes
ClearingDateClearingDateType✓✓choice — pick one
ClearingIDClearingID_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_PaymentClearingListRQ } from '@oms/ndc-24-4';

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