Skip to main content

IATA_PaymentClearanceRS

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

Returns the result of a payment-clearance request.

When to use​

Response to IATA_PaymentClearanceRQ.

Transport​

IATA_PaymentClearanceRS 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_PaymentClearanceRS xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceRS">
  <Error/>
</IATA_PaymentClearanceRS>

Key fields​

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

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

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