poc-reports/es_elt/xsd/common/PaymentStatus.xsd

<?xml version="1.0" encoding="UTF-8"?>
<!--

    Copyright (C) Revenue Collection Systems France S.A.S. - 2018-2025 ALL RIGHTS RESERVED

-->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
           xmlns="http://www.thales.dc/PaymentStatus"
           targetNamespace="http://www.thales.dc/PaymentStatus"
           version="1.0.1">

    <!-- Annotate all modification of the xsd file according to version -->
    <xs:annotation>
        <xs:documentation>-----------------------------------------------------------------------------------------------------------------------</xs:documentation>
    </xs:annotation>
    <xs:annotation>
        <xs:documentation>Version List</xs:documentation>
    </xs:annotation>
    <xs:annotation>
        <xs:documentation>-----------------------------------------------------------------------------------------------------------------------</xs:documentation>
    </xs:annotation>
    <xs:annotation>
        <xs:documentation>sprint 186 - 23/08/2023 - Version 1.0.1</xs:documentation>
        <xs:documentation>
            change versioning and add documentation to respect XSD versioning format
        </xs:documentation>
    </xs:annotation>
    <xs:annotation>
        <xs:documentation>sprint 201 - 19/07/2024 - Version 1.0.2</xs:documentation>
        <xs:documentation>
            add not sent to payment status
        </xs:documentation>
    </xs:annotation>
    <xs:annotation>
        <xs:documentation>-----------------------------------------------------------------------------------------------------------------------</xs:documentation>
    </xs:annotation>

    <!-- Description of the PaymentStatus structure -->
    <xs:annotation>
        <xs:documentation>
            Note that the values of the enumeration are in their order of priority for aggregation.

            Note also that the value REPAID shall never appear as an aggregated status as the repaid debt compensation
            shall always be accompanied with an approved repayment compensation.
        </xs:documentation>
    </xs:annotation>
    <xs:element name="PaymentStatus" type="PaymentStatus"/>
    <xs:simpleType name="PaymentStatus">
        <xs:restriction base="xs:string">
            <xs:enumeration value="SUPERSEDED">
                <xs:annotation>
                    <xs:documentation>Payment amount has been aggregated</xs:documentation>
                </xs:annotation>
            </xs:enumeration>
            <xs:enumeration value="REPAID">
                <xs:annotation>
                    <xs:documentation>A debt has been eventually repaid.</xs:documentation>
                </xs:annotation>
            </xs:enumeration>
            <xs:enumeration value="NOT_APPLICABLE">
                <xs:annotation>
                    <xs:documentation>Payment is not applicable.</xs:documentation>
                </xs:annotation>
            </xs:enumeration>
            <xs:enumeration value="APPROVED">
                <xs:annotation>
                    <xs:documentation>Payment has been approved either directly or the bank acquirer</xs:documentation>
                </xs:annotation>
            </xs:enumeration>
            <xs:enumeration value="ISSUED">
                <xs:annotation>
                    <xs:documentation>Payment has been issued to the bank acquirer</xs:documentation>
                </xs:annotation>
            </xs:enumeration>
            <xs:enumeration value="PENDING">
                <xs:annotation>
                    <xs:documentation>Payment has not been sent to the bank acquirer</xs:documentation>
                </xs:annotation>
            </xs:enumeration>
            <xs:enumeration value="ERROR">
                <xs:annotation>
                    <xs:documentation>An error has occurred during the payment processing either transient or permanent (ex. time out, connection broken,
                        internal error...), and will be retried later according to the recovery policy. Meanwhile, the payment is considered 'declined' but the
                        card will NOT been denied.
                    </xs:documentation>
                </xs:annotation>
            </xs:enumeration>
            <xs:enumeration value="DECLINED">
                <xs:annotation>
                    <xs:documentation>Payment has been declined either directly by the PSP or by the bank acquirer (ex. insufficient credit/threshold), the card
                        will be denied and a recovery policy will retry further attempts.
                    </xs:documentation>
                </xs:annotation>
            </xs:enumeration>
            <xs:enumeration value="BLOCKED">
                <xs:annotation>
                    <xs:documentation>Payment has been declined because the card or account is definitely blocked (ex. card denied by bank or expired). No
                        automatic recovery will be attempted. The card will be denied.
                    </xs:documentation>
                </xs:annotation>
            </xs:enumeration>
            <xs:enumeration value="RESET">
                <xs:annotation>
                    <xs:documentation>Payment has been RESET because the card or account is blocked and have now way to be unblocked via traditionnel channel.
                    </xs:documentation>
                </xs:annotation>
            </xs:enumeration>
            <xs:enumeration value="NOT_SENT">
                <xs:annotation>
                    <xs:documentation>Payment has not been SENT to the PSP.
                    </xs:documentation>
                </xs:annotation>
            </xs:enumeration>
        </xs:restriction>
    </xs:simpleType>
</xs:schema>