Skip to main content

IATA_PaymentClearanceCancellationRQ

Request · Payment Clearance · Implemented

Implemented

Delivers: STTCAN Payment clearance — cancellation.

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

Request cancellation of a previously submitted clearance.

When to use​

To reverse or cancel a clearance.

Transport​

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

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_PaymentClearanceCancellationRQ xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCancellationRQ">
  <ClearanceID>0000000AAAAAAAA</ClearanceID>
</IATA_PaymentClearanceCancellationRQ>

Response example​

Paired response: IATA_PaymentClearanceCancellationRS.

<?xml version="1.0" encoding="UTF-8"?>
<IATA_PaymentClearanceCancellationRS xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCancellationRS">
  <Clearance>
    <ClearanceID xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">0000000AAAAAAAA</ClearanceID>
    <StatusCode xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">AAAAA</StatusCode>
  </Clearance>
</IATA_PaymentClearanceCancellationRS>

Key fields​

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

FieldTypeRequiredRepeatableNotes
ClearanceIDPC_ClearanceID_Type✓✓
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_PaymentClearanceCancellationRQ } from '@oms/ndc-24-4';

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