Definition Type: ComplexType
Name: PaymentFormType
Containing Schema: OTA_CommonTypes.xsd
Abstract
Documentation:
Ways of providing funds and guarantees for travel by the individual.
Collapse XSD Schema Diagram:
Drilldown into Cash in schema ota_commontypes_xsd Drilldown into MiscChargeOrder in schema ota_commontypes_xsd Drilldown into LoyaltyRedemption in schema ota_commontypes_xsd Drilldown into Voucher in schema ota_commontypes_xsd Drilldown into DirectBill in schema ota_commontypes_xsd Drilldown into BankAcct in schema ota_commontypes_xsd Drilldown into PaymentCard in schema ota_commontypes_xsd Drilldown into Remark in schema ota_commontypes_xsd1 Drilldown into GuaranteeID in schema ota_commontypes_xsd1 Drilldown into GuaranteeTypeCode in schema ota_commontypes_xsd1 Drilldown into GuaranteeIndicator in schema ota_commontypes_xsd1 Drilldown into PaymentTransactionTypeCode in schema ota_commontypes_xsd1 Drilldown into RPH in schema ota_commontypes_xsd1 Drilldown into CostCenterID in schema ota_commontypes_xsd1 Drilldown into ShareMarketInd in schema ota_commontypes_xsd1 Drilldown into ShareSynchInd in schema ota_commontypes_xsd1 Drilldown into PrivacyGroup in schema ota_commontypes_xsdXSD Diagram of PaymentFormType in schema ota_commontypes_xsd (Open Travel (OTA))
Collapse XSD Schema Code:
<xs:complexType name="PaymentFormType">
    <xs:annotation>
        <xs:documentation xml:lang="en">Ways of providing funds and guarantees for travel by the individual.</xs:documentation>
    </xs:annotation>
    <xs:choice minOccurs="0">
        <xs:element name="PaymentCard" type="PaymentCardType">
            <xs:annotation>
                <xs:documentation xml:lang="en">Details of a debit or credit card.</xs:documentation>
            </xs:annotation>
        </xs:element>
        <xs:element name="BankAcct" type="BankAcctType">
            <xs:annotation>
                <xs:documentation xml:lang="en">Details of a bank account. </xs:documentation>
            </xs:annotation>
        </xs:element>
        <xs:element name="DirectBill" type="DirectBillType">
            <xs:annotation>
                <xs:documentation xml:lang="en">Details of a direct billing arrangement.</xs:documentation>
            </xs:annotation>
        </xs:element>
        <xs:element name="Voucher">
            <xs:annotation>
                <xs:documentation xml:lang="en">Details of a paper or electronic document indicating prepayment.</xs:documentation>
            </xs:annotation>
            <xs:complexType>
                <xs:attributeGroup ref="VoucherGroup">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">The effective date, expiry date and series code of the voucher.</xs:documentation>
                    </xs:annotation>
                </xs:attributeGroup>
                <xs:attribute name="BillingNumber" type="StringLength1to64" use="optional">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">Reference of the billing account which handles the payment transaction.</xs:documentation>
                    </xs:annotation>
                </xs:attribute>
                <xs:attribute name="SupplierIdentifier" type="StringLength1to64" use="optional">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">Unique identifier of the electronic voucher, created by the supplier.</xs:documentation>
                    </xs:annotation>
                </xs:attribute>
                <xs:attribute name="Identifier" type="StringLength1to64" use="optional">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">Unique identifier of the electronic voucher.</xs:documentation>
                    </xs:annotation>
                </xs:attribute>
                <xs:attribute name="ValueType" type="StringLength1to32" use="optional">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">Defines the type of voucher (e.g., full credit or partial credit).</xs:documentation>
                    </xs:annotation>
                </xs:attribute>
                <xs:attribute name="ElectronicIndicator" type="xs:boolean" use="optional">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">When true, indicates the voucher is electronic.  An E-voucher is a value document issued by the Travel Agent for the customer. The e-voucher can be used as a proof of reservation, but more normally, as a full-payment or partial payment. </xs:documentation>
                    </xs:annotation>
                </xs:attribute>
            </xs:complexType>
        </xs:element>
        <xs:element name="LoyaltyRedemption">
            <xs:annotation>
                <xs:documentation xml:lang="en">Details of a loyalty redemption arrangement. This is normally miles or points. </xs:documentation>
            </xs:annotation>
            <xs:complexType>
                <xs:sequence>
                    <xs:element name="LoyaltyCertificate" minOccurs="0" maxOccurs="9">
                        <xs:annotation>
                            <xs:documentation xml:lang="en">A certificate may be needed in order to redeem miles or points. Certificates may be used in combination with each other as part of a reservation.</xs:documentation>
                        </xs:annotation>
                        <xs:complexType>
                            <xs:attributeGroup ref="LoyaltyCertificateGroup">
                                <xs:annotation>
                                    <xs:documentation xml:lang="en">Identifies the loyalty scheme, programs and promotions within the scheme, membership reference, format of the certificate, the number of nights it can be used and its current status.</xs:documentation>
                                </xs:annotation>
                            </xs:attributeGroup>
                        </xs:complexType>
                    </xs:element>
                </xs:sequence>
                <xs:attributeGroup ref="LoyaltyCertificateNumberGroup">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">Identifies the Loyalty scheme,  programs and promotions within the scheme, membership reference, form factor used by the certificate, the number of nights it can be used for and its current status.</xs:documentation>
                    </xs:annotation>
                </xs:attributeGroup>
                <xs:attributeGroup ref="PromotionCodeGroup">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">Used to provide a promotion code of the loyalty redemption.</xs:documentation>
                    </xs:annotation>
                </xs:attributeGroup>
                <xs:attribute name="RedemptionQuantity" type="xs:positiveInteger" use="optional">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">The quantity of loyalty units being redeemed.</xs:documentation>
                    </xs:annotation>
                </xs:attribute>
            </xs:complexType>
        </xs:element>
        <xs:element name="MiscChargeOrder">
            <xs:annotation>
                <xs:documentation xml:lang="en">Details of a miscellaneous charge order (MCO).</xs:documentation>
            </xs:annotation>
            <xs:complexType>
                <xs:attribute name="TicketNumber" type="StringLength1to32">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">The ticket number of the miscellaneous charge order (MCO).</xs:documentation>
                    </xs:annotation>
                </xs:attribute>
            </xs:complexType>
        </xs:element>
        <xs:element name="Cash">
            <xs:annotation>
                <xs:documentation xml:lang="en">Used to indicate payment in cash.</xs:documentation>
            </xs:annotation>
            <xs:complexType>
                <xs:attribute name="CashIndicator" type="xs:boolean" use="optional" default="true">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">If true, this indicates cash is being used.</xs:documentation>
                    </xs:annotation>
                </xs:attribute>
            </xs:complexType>
        </xs:element>
    </xs:choice>
    <xs:attributeGroup ref="PrivacyGroup">
        <xs:annotation>
            <xs:documentation xml:lang="en">Allows for control of the sharing of payment form data between parties.</xs:documentation>
        </xs:annotation>
    </xs:attributeGroup>
    <xs:attribute name="CostCenterID" type="StringLength1to32" use="optional">
        <xs:annotation>
            <xs:documentation xml:lang="en">A reference to identify the billing department for allocating cost of travel to company account.</xs:documentation>
        </xs:annotation>
    </xs:attribute>
    <xs:attribute name="RPH" type="RPH_Type" use="optional">
        <xs:annotation>
            <xs:documentation xml:lang="en">Provides a reference to a specific form of payment.</xs:documentation>
        </xs:annotation>
    </xs:attribute>
    <xs:attribute name="PaymentTransactionTypeCode" use="optional">
        <xs:annotation>
            <xs:documentation xml:lang="en">This is used to indicate either a charge, reserve (deposit) or refund.</xs:documentation>
        </xs:annotation>
        <xs:simpleType>
            <xs:restriction base="xs:NMTOKEN">
                <xs:enumeration value="charge">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">This indicates that an actual payment has been made.</xs:documentation>
                    </xs:annotation>
                </xs:enumeration>
                <xs:enumeration value="reserve">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">This indicates that a hold for the indicated amount has been placed on a credit card or that a cash amount has been taken from the customer to guarantee final payment.</xs:documentation>
                    </xs:annotation>
                </xs:enumeration>
                <xs:enumeration value="refund">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">This indicates that the payment amount of this PaymentDetail element is for a refund.</xs:documentation>
                    </xs:annotation>
                </xs:enumeration>
            </xs:restriction>
        </xs:simpleType>
    </xs:attribute>
    <xs:attribute name="GuaranteeIndicator" type="xs:boolean" use="optional">
        <xs:annotation>
            <xs:documentation xml:lang="en">When true, indicates this represents a guarantee rather than a payment form.</xs:documentation>
        </xs:annotation>
    </xs:attribute>
    <xs:attribute name="GuaranteeTypeCode" type="OTA_CodeType" use="optional">
        <xs:annotation>
            <xs:documentation xml:lang="en">Used to specify the method of guarantee. Refer to OTA Code List Payment Type (PMT).</xs:documentation>
        </xs:annotation>
    </xs:attribute>
    <xs:attribute name="GuaranteeID" type="StringLength1to64" use="optional">
        <xs:annotation>
            <xs:documentation xml:lang="en">Provides the identifier as specified by the GuaranteeTypeCode (e.g., Corporate ID or IATA number).</xs:documentation>
        </xs:annotation>
    </xs:attribute>
    <xs:attribute name="Remark" type="StringLength1to128" use="optional">
        <xs:annotation>
            <xs:documentation xml:lang="en">A remark associated with the payment form.</xs:documentation>
        </xs:annotation>
    </xs:attribute>
</xs:complexType>
Collapse Child Elements:
Name Type Min Occurs Max Occurs
PaymentCard PaymentCard (1) (1)
BankAcct BankAcct (1) (1)
DirectBill DirectBill (1) (1)
Voucher Voucher (1) (1)
LoyaltyRedemption LoyaltyRedemption (1) (1)
MiscChargeOrder MiscChargeOrder (1) (1)
Cash Cash (1) (1)
Collapse Child Attributes:
Name Type Default Value Use
ShareSynchInd ShareSynchInd Optional
ShareMarketInd ShareMarketInd Optional
CostCenterID CostCenterID Optional
RPH RPH Optional
PaymentTransactionTypeCode PaymentTransactionTypeCode Optional
GuaranteeIndicator GuaranteeIndicator Optional
GuaranteeTypeCode GuaranteeTypeCode Optional
GuaranteeID GuaranteeID Optional
Remark Remark Optional
Collapse Derivation Tree:
Collapse References:
AcceptedPayment, PaymentDetailType, PaymentForm, Unresolved link to paymentform2, Unresolved link to paymentform4