Skip to main content

IATA_PaymentClearanceRQ

Request · Payment Clearance · Implemented

Implemented

Delivers: STTCAP Payment clearance — capture.

Limits today:

  • STTCAP — The platform is the ORA and a simulated Clearance Manager (no real Settlement Manager is connected): a captured settlement-plan payment is requested for clearance at capture, and PaymentClearanceRQ clears one that is not yet — one clearance per payment, of exactly its amount.

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

Request clearance of a payment between participants.

When to use​

Settlement layer — initiate clearance for a transaction.

Transport​

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

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_PaymentClearanceRQ xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceRQ">
  <Clearance>
    <ClearanceData xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">
      <ClearanceID>0000000AAAAAAAA</ClearanceID>
      <ClearancePayeeData>
        <ClearancePayee>
          <Carrier>
            <AirlineAccountingCode>X</AirlineAccountingCode>
            <AirlineDesigCode>AA</AirlineDesigCode>
          </Carrier>
        </ClearancePayee>
      </ClearancePayeeData>
      <ClearancePayerData>
        <ClearancePayer>
          <Carrier>
            <AirlineAccountingCode>X</AirlineAccountingCode>
            <AirlineDesigCode>AA</AirlineDesigCode>
          </Carrier>
        </ClearancePayer>
      </ClearancePayerData>
      <NetClearanceAmount CurCode="X">1</NetClearanceAmount>
      <PaymentCommitmentDateTime>2024-06-01T09:00:00Z</PaymentCommitmentDateTime>
      <ProcessRuleCode>IATACAA</ProcessRuleCode>
    </ClearanceData>
    <PaymentBrandCode xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">1</PaymentBrandCode>
  </Clearance>
  <ClearanceCount>1</ClearanceCount>
</IATA_PaymentClearanceRQ>

Response example​

Paired response: IATA_PaymentClearanceRS.

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

Key fields​

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

FieldTypeRequiredRepeatableNotes
ClearanceClearanceRequestType✓✓
ClearanceCountCountType✓—
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_PaymentClearanceRQ } from '@oms/ndc-24-4';

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