pi-spi-sdk 0.1.0

package/dist/generated/models/DemandePaiementConsultationReponse.d.ts

@@ -0,0 +1,151 @@
+import type { DemandePaiementStatutRaison } from './DemandePaiementStatutRaison';
+import type { RefDocType } from './RefDocType';
+export type DemandePaiementConsultationReponse = {
+    /**
+     * Identifiant de la demande de paiement dans le SI du client
+     */
+    txId?: string;
+    /**
+     * Categorie de la demande de paiement
+     */
+    categorie?: DemandePaiementConsultationReponse.categorie;
+    /**
+     * L'alias de compte dans lequel le client payé souhaite recevoir les paiements
+     */
+    payeAlias?: string;
+    /**
+     * L'URL du logo du business ou d'un produit du business qui sera affiché au client payeur
+     */
+    logoUrl?: string;
+    /**
+     * Alias de compte du client payeur à qui est adressée la demande
+     */
+    payeurAlias?: string;
+    /**
+     * Lorsque le PSP reçoit la demande, il effectue une recherche d'alias en vue d'obtenir les informations de compte du client payeur.
+     *
+     * L'attribut `confirmation` permet au client d'indiquer à son PSP si celui-ci doit lui retourner les résultats de la recherche d'alias pour confirmation:
+     *
+     * * La valeur `true` de la confirmation indique au PSP qu'il doit retourner le résultat de la recherche d'alias au client et attendre une confirmation
+     * * La valeur `false` indique qu'une confirmation n'est pas requise pour la demande, de ce fait le PSP transmet directement la demande à PI
+     *
+     */
+    confirmation?: boolean;
+    /**
+     * Remise appliquée sur la demande de paiement
+     */
+    remise?: {
+        /**
+         * Le montant de la remise
+         */
+        montant?: number;
+        /**
+         * Le taux de la remise
+         */
+        taux?: number;
+    };
+    /**
+     * Indique si le client peut acheter maintenant et payer plus tard.
+     */
+    debitDiffere?: boolean;
+    /**
+     * Le montant total du paiement à effectuer
+     */
+    montant?: number;
+    /**
+     * Le montant de l'achat
+     */
+    montantAchat?: number;
+    /**
+     * Le montant du retrait
+     */
+    montantRetrait?: number;
+    /**
+     * Les frais de retrait
+     */
+    montantFrais?: number;
+    /**
+     * Le motif de la demande de paiement
+     */
+    motif?: string;
+    /**
+     * Le numéro / la référence du document justificatif
+     */
+    refDocNumero?: string;
+    refDocType?: RefDocType;
+    /**
+     * - `INITIE` si la confirmation du client est attendue suite à la recherche d'alias,
+     * - `ENVOYE` si les validations sont concluantes et que le PSP a envoyé la demande
+     * - `IRREVOCABLE` si le payeur a accepté la demande
+     * - `REJETE` si le payeur rejète la demande
+     *
+     */
+    statut?: DemandePaiementConsultationReponse.statut;
+    statutRaison?: DemandePaiementStatutRaison;
+    /**
+     * Le nom du payeur
+     */
+    payeurNom?: string;
+    /**
+     * Le pays de residence du payeur
+     */
+    payeurPays?: string;
+    /**
+     * Date limite de paiement
+     */
+    dateLimitePaiement?: string;
+    /**
+     * Date limite de réponse
+     */
+    dateLimiteReponse?: string;
+    /**
+     * Date de la demande de paiement
+     *
+     */
+    dateDemande?: string;
+    /**
+     * Date de confirmation de la demande si le client avait requis la confirmation de la demande de paiement.
+     * Il s'agit de la date et heure à laquelle le client a confirmé la demande.
+     *
+     */
+    dateConfirmation?: string;
+    /**
+     * Date d'envoi de la demande: date et heure à laquelle la demande de paiement est envoyée par le PSP
+     *
+     */
+    dateEnvoi?: string;
+    /**
+     * Date à laquelle le payeur à repondu à la demande de paiement
+     *
+     */
+    dateReponse?: string;
+    /**
+     * Date à laquelle le paiement accepté est irrévocable
+     *
+     */
+    dateIrrevocabilite?: string;
+};
+export declare namespace DemandePaiementConsultationReponse {
+    /**
+     * Categorie de la demande de paiement
+     */
+    enum categorie {
+        _631 = "631",
+        _500 = "500",
+        _521 = "521",
+        _401 = "401"
+    }
+    /**
+     * - `INITIE` si la confirmation du client est attendue suite à la recherche d'alias,
+     * - `ENVOYE` si les validations sont concluantes et que le PSP a envoyé la demande
+     * - `IRREVOCABLE` si le payeur a accepté la demande
+     * - `REJETE` si le payeur rejète la demande
+     *
+     */
+    enum statut {
+        INITIE = "INITIE",
+        ENVOYE = "ENVOYE",
+        IRREVOCABLE = "IRREVOCABLE",
+        REJETE = "REJETE"
+    }
+}

package/dist/generated/models/DemandePaiementConsultationReponse.js

@@ -0,0 +1,27 @@
+export var DemandePaiementConsultationReponse;
+(function (DemandePaiementConsultationReponse) {
+    /**
+     * Categorie de la demande de paiement
+     */
+    let categorie;
+    (function (categorie) {
+        categorie["_631"] = "631";
+        categorie["_500"] = "500";
+        categorie["_521"] = "521";
+        categorie["_401"] = "401";
+    })(categorie = DemandePaiementConsultationReponse.categorie || (DemandePaiementConsultationReponse.categorie = {}));
+    /**
+     * - `INITIE` si la confirmation du client est attendue suite à la recherche d'alias,
+     * - `ENVOYE` si les validations sont concluantes et que le PSP a envoyé la demande
+     * - `IRREVOCABLE` si le payeur a accepté la demande
+     * - `REJETE` si le payeur rejète la demande
+     *
+     */
+    let statut;
+    (function (statut) {
+        statut["INITIE"] = "INITIE";
+        statut["ENVOYE"] = "ENVOYE";
+        statut["IRREVOCABLE"] = "IRREVOCABLE";
+        statut["REJETE"] = "REJETE";
+    })(statut = DemandePaiementConsultationReponse.statut || (DemandePaiementConsultationReponse.statut = {}));
+})(DemandePaiementConsultationReponse || (DemandePaiementConsultationReponse = {}));

package/dist/generated/models/DemandePaiementEnMasseConfirmationRequest.d.ts

@@ -0,0 +1,3 @@
+import type { DemandePaiementEnMasseConfirmationRequestAccepter } from './DemandePaiementEnMasseConfirmationRequestAccepter';
+import type { DemandePaiementEnMasseConfirmationRequestRejeter } from './DemandePaiementEnMasseConfirmationRequestRejeter';
+export type DemandePaiementEnMasseConfirmationRequest = (DemandePaiementEnMasseConfirmationRequestAccepter | DemandePaiementEnMasseConfirmationRequestRejeter);

package/dist/generated/models/DemandePaiementEnMasseConfirmationRequest.js

@@ -0,0 +1 @@
+export {};

package/dist/generated/models/DemandePaiementEnMasseConfirmationRequestAccepter.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Confirmation de la demande de paiement en masse
+ */
+export type DemandePaiementEnMasseConfirmationRequestAccepter = {
+    /**
+     * La décision à `true` indique la confirmation de la demande de paiement en masse.
+     */
+    decision: boolean;
+};

package/dist/generated/models/DemandePaiementEnMasseConfirmationRequestAccepter.js

@@ -0,0 +1 @@
+export {};

package/dist/generated/models/DemandePaiementEnMasseConfirmationRequestRejeter.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Annulation de la demande de paiement en masse
+ */
+export type DemandePaiementEnMasseConfirmationRequestRejeter = {
+    /**
+     * La décision à `false` indique l'annulation de la demande de paiement en masse.
+     */
+    decision: boolean;
+};

package/dist/generated/models/DemandePaiementEnMasseConfirmationRequestRejeter.js

@@ -0,0 +1 @@
+export {};

package/dist/generated/models/DemandePaiementEnMasseRequest.d.ts

@@ -0,0 +1,74 @@
+import type { RefDocType } from './RefDocType';
+export type DemandePaiementEnMasseRequest = {
+    /**
+     * L'alias de compte dans lequel le client souhaite recevoir les paiements
+     *
+     */
+    payeAlias: string;
+    /**
+     * Indique si une confirmation du business est requise avant d'envoyer les demandes de paiement.
+     *
+     * - `true` : Le PSP effectue la recherche d'alias pour tous les payeurs, retourne leurs noms et pays, et attend la confirmation du business avant d'envoyer les demandes de paiement.
+     * - `false` : Le PSP envoie directement les demandes de paiement sans attendre de confirmation.
+     *
+     * **Note :** Si `true`, le business doit confirmer via `PUT /demandes-paiements-groupes/{instructionId}/confirmations` dans un délai adaptatif (24h, 48h ou 72h selon le nombre de transactions).
+     *
+     */
+    confirmation?: boolean;
+    /**
+     * Identifiant de la demande de paiement en masse dans le SI du client
+     */
+    instructionId: string;
+    /**
+     * Le motif commun à toutes les demandes de paiement du groupe.
+     * Si toutes les demandes de paiement du groupe ont le même motif, ce champ peut être utilisé pour optimiser la taille du lot.
+     * Dans le cas contraire, chaque demande de paiement doit avoir son propre motif.
+     *
+     */
+    motif?: string;
+    transactions: Array<{
+        /**
+         * Identifiant de la transaction dans le SI du client
+         */
+        txId: string;
+        /**
+         * L'alias du client payeur.
+         */
+        payeurAlias: string;
+        /**
+         * Le montant à payer
+         */
+        montant: number;
+        /**
+         * Remise appliquée sur la facture - la remise n'est pas appliquée après la date limite de paiement
+         */
+        remise?: {
+            montant?: number;
+            taux?: number;
+        };
+        /**
+         * La date limite à laquelle le payeur doit avoir effectué le paiement.
+         *
+         * Dans le cas d'une demande de paiement de facture, il s'agit en général de la date indiquée avec la mention "À payer avant".
+         *
+         */
+        dateLimitePaiement: string;
+        /**
+         * C'est la date limite avant laquelle une réponse doit être fournie par le payeur.
+         * La demande de paiement expire à cette date. Le client payé ne peut pas envoyer
+         *
+         */
+        dateLimiteReponse?: string;
+        /**
+         * Le motif de la demande de paiement.
+         * Si toutes les demandes de paiement du groupe ont le même motif, ce champ doit être omis, et le motif du groupe doit être utilisé.
+         *
+         */
+        motif?: string;
+        /**
+         * Le numéro / la référence du document justificatif
+         */
+        refDocNumero?: string;
+        refDocType?: RefDocType;
+    }>;
+};

package/dist/generated/models/DemandePaiementEnMasseRequest.js

@@ -0,0 +1 @@
+export {};

package/dist/generated/models/DemandePaiementEnMasseStatutReponse.d.ts

@@ -0,0 +1,98 @@
+export type DemandePaiementEnMasseStatutReponse = {
+    /**
+     * Identifiant de la demande de paiement en masse
+     */
+    instructionId?: string;
+    /**
+     * Statut global de la demande de paiement en masse:
+     * - `INITIE`: Créée avec confirmation demandée, en attente de confirmation
+     * - `CONFIRME`: Confirmée par le business ( pour savoir si le traitement est terminé, vérifiez que `transactionsIrrevocables + transactionsRejetees = transactionsTotal`)
+     * - `ANNULE`: Annulée par le business
+     *
+     * **Évolution selon le mode de création :**
+     * - Si créée **avec confirmation** (`confirmation: true`) : `INITIE` → `CONFIRME` (après PUT /confirmations) ou `ANNULE`
+     * - Si créée **sans confirmation** (`confirmation: false`) : Directement `CONFIRME` (aucune action requise du business)
+     *
+     */
+    statut?: DemandePaiementEnMasseStatutReponse.statut;
+    /**
+     * Date d'expiration de la confirmation (délai adaptatif selon nombre de transactions).
+     * Présent uniquement si statut = INITIE.
+     *
+     * Délais :
+     * - 1 à 500 transactions : 24 heures
+     * - 501 à 1000 transactions : 48 heures
+     * - Plus de 1000 transactions : 72 heures
+     *
+     */
+    dateExpiration?: string;
+    /**
+     * Nombre total de transactions dans la demande de paiement en masse
+     */
+    transactionsTotal?: number;
+    /**
+     * Nombre de transactions à l'état `INITIE` (validées avec succès, prêtes à être envoyées).
+     *
+     * Si créée avec `confirmation: true`, ces transactions ont passé toutes les validations :
+     * - txId unique (pas de duplication)
+     * - Alias du payeur valide (recherche d'alias réussie)
+     * - Nom et pays du payeur disponibles
+     *
+     * Ce sont ces transactions qui seront envoyées lors de la confirmation.
+     *
+     * **Vérification de fin de validation :** La validation est terminée quand `transactionsInitiees + transactionsRejetees = transactionsTotal`.
+     *
+     */
+    transactionsInitiees?: number;
+    /**
+     * Nombre de transactions à l'état `ENVOYE` (demandes envoyées au payeur)
+     */
+    transactionsEnvoyees?: number;
+    /**
+     * Nombre de transactions à l'état `IRREVOCABLE` (demandes acceptées et payées par le payeur)
+     */
+    transactionsIrrevocables?: number;
+    /**
+     * Nombre de transactions à l'état `REJETE` (échecs de validation ou refus du payeur).
+     *
+     * Comprend :
+     * - Rejets de validation (avant envoi) : BE23 (alias invalide), DU03 (txId dupliqué)
+     * - Rejets d'envoi (après confirmation) : Alias du payeur indisponible, etc.
+     * - Refus du payeur (le payeur a rejeté la demande)
+     *
+     * **Note :** Les transactions rejetées à la validation ne sont jamais envoyées, même si le bulk est confirmé.
+     *
+     */
+    transactionsRejetees?: number;
+    /**
+     * Date de création de la demande de paiement en masse (date de la demande)
+     */
+    dateDemande?: string;
+    /**
+     * Date de confirmation par le business (date d'acceptation de la demande).
+     * Présent uniquement si statut = CONFIRME.
+     *
+     * - Si créée avec confirmation: Date du PUT /confirmations avec decision: true
+     * - Si créée sans confirmation: Correspond à dateDemande (confirmation automatique)
+     *
+     */
+    dateConfirmation?: string;
+};
+export declare namespace DemandePaiementEnMasseStatutReponse {
+    /**
+     * Statut global de la demande de paiement en masse:
+     * - `INITIE`: Créée avec confirmation demandée, en attente de confirmation
+     * - `CONFIRME`: Confirmée par le business ( pour savoir si le traitement est terminé, vérifiez que `transactionsIrrevocables + transactionsRejetees = transactionsTotal`)
+     * - `ANNULE`: Annulée par le business
+     *
+     * **Évolution selon le mode de création :**
+     * - Si créée **avec confirmation** (`confirmation: true`) : `INITIE` → `CONFIRME` (après PUT /confirmations) ou `ANNULE`
+     * - Si créée **sans confirmation** (`confirmation: false`) : Directement `CONFIRME` (aucune action requise du business)
+     *
+     */
+    enum statut {
+        INITIE = "INITIE",
+        CONFIRME = "CONFIRME",
+        ANNULE = "ANNULE"
+    }
+}

package/dist/generated/models/DemandePaiementEnMasseStatutReponse.js

@@ -0,0 +1,20 @@
+export var DemandePaiementEnMasseStatutReponse;
+(function (DemandePaiementEnMasseStatutReponse) {
+    /**
+     * Statut global de la demande de paiement en masse:
+     * - `INITIE`: Créée avec confirmation demandée, en attente de confirmation
+     * - `CONFIRME`: Confirmée par le business ( pour savoir si le traitement est terminé, vérifiez que `transactionsIrrevocables + transactionsRejetees = transactionsTotal`)
+     * - `ANNULE`: Annulée par le business
+     *
+     * **Évolution selon le mode de création :**
+     * - Si créée **avec confirmation** (`confirmation: true`) : `INITIE` → `CONFIRME` (après PUT /confirmations) ou `ANNULE`
+     * - Si créée **sans confirmation** (`confirmation: false`) : Directement `CONFIRME` (aucune action requise du business)
+     *
+     */
+    let statut;
+    (function (statut) {
+        statut["INITIE"] = "INITIE";
+        statut["CONFIRME"] = "CONFIRME";
+        statut["ANNULE"] = "ANNULE";
+    })(statut = DemandePaiementEnMasseStatutReponse.statut || (DemandePaiementEnMasseStatutReponse.statut = {}));
+})(DemandePaiementEnMasseStatutReponse || (DemandePaiementEnMasseStatutReponse = {}));

package/dist/generated/models/DemandePaiementListe.d.ts

@@ -0,0 +1,26 @@
+import type { DemandePaiementListeItem } from './DemandePaiementListeItem';
+export type DemandePaiementListe = {
+    data: Array<DemandePaiementListeItem>;
+    meta: {
+        /**
+         * Nombre total de demandes de paiement correspondant aux critères
+         */
+        total?: number;
+        /**
+         * Nombre d'éléments par page
+         */
+        size?: number;
+        /**
+         * Identifiant de la page actuelle
+         */
+        page?: string;
+        /**
+         * Identifiant de la page suivante
+         */
+        next?: string;
+        /**
+         * Identifiant de la page précédente
+         */
+        prev?: string;
+    };
+};

package/dist/generated/models/DemandePaiementListe.js

@@ -0,0 +1 @@
+export {};

package/dist/generated/models/DemandePaiementListeItem.d.ts

@@ -0,0 +1,163 @@
+import type { DemandePaiementStatutRaison } from './DemandePaiementStatutRaison';
+import type { RefDocType } from './RefDocType';
+export type DemandePaiementListeItem = {
+    /**
+     * Identifiant de la demande de paiement dans le SI du client
+     */
+    txId?: string;
+    /**
+     * Categorie de la demande de paiement
+     */
+    categorie?: DemandePaiementListeItem.categorie;
+    /**
+     * L'alias de compte dans lequel le client payé souhaite recevoir les paiements
+     */
+    payeAlias?: string;
+    /**
+     * L'URL du logo du business ou d'un produit du business qui sera affiché au client payeur
+     */
+    logoUrl?: string;
+    /**
+     * Alias de compte du client payeur à qui est adressée la demande
+     */
+    payeurAlias?: string;
+    /**
+     * Lorsque le PSP reçoit la demande, il effectue une recherche d'alias en vue d'obtenir les informations de compte du client payeur.
+     *
+     * L'attribut `confirmation` permet au client d'indiquer à son PSP si celui-ci doit lui retourner les résultats de la recherche d'alias pour confirmation:
+     *
+     * * La valeur `true` de la confirmation indique au PSP qu'il doit retourner le résultat de la recherche d'alias au client et attendre une confirmation
+     * * La valeur `false` indique qu'une confirmation n'est pas requise pour la demande, de ce fait le PSP transmet directement la demande à PI
+     *
+     */
+    confirmation?: boolean;
+    /**
+     * Remise appliquée sur la demande de paiement
+     */
+    remise?: {
+        /**
+         * Le montant de la remise
+         */
+        montant?: number;
+        /**
+         * Le taux de la remise
+         */
+        taux?: number;
+    };
+    /**
+     * Indique si le client peut acheter maintenant et payer plus tard.
+     */
+    debitDiffere?: boolean;
+    /**
+     * Le montant total du paiement à effectuer
+     */
+    montant?: number;
+    /**
+     * Le montant de l'achat
+     */
+    montantAchat?: number;
+    /**
+     * Le montant du retrait
+     */
+    montantRetrait?: number;
+    /**
+     * Les frais de retrait
+     */
+    montantFrais?: number;
+    /**
+     * Le motif de la demande de paiement
+     */
+    motif?: string;
+    /**
+     * Le numéro / la référence du document justificatif
+     */
+    refDocNumero?: string;
+    refDocType?: RefDocType;
+    /**
+     * - `INITIE` si la confirmation du client est attendue suite à la recherche d'alias
+     * - `ENVOYE` si les validations sont concluantes et que le PSP a envoyé la demande
+     * - `IRREVOCABLE` si le payeur a accepté la demande
+     * - `REJETE` si le payeur rejette la demande
+     *
+     */
+    statut?: DemandePaiementListeItem.statut;
+    statutRaison?: DemandePaiementStatutRaison;
+    /**
+     * Identifiant unique de bout en bout de la transaction
+     */
+    end2endId?: string;
+    /**
+     * Le nom du payeur
+     */
+    payeurNom?: string;
+    /**
+     * Le pays de residence du payeur
+     */
+    payeurPays?: string;
+    /**
+     * Le nom du payé (Retourné dans le cas d'un RTP reçu)
+     */
+    payeNom?: string;
+    /**
+     * Le pays de residence du payé (Retourné dans le cas d'un RTP reçu)
+     */
+    payePays?: string;
+    /**
+     * Date limite de paiement
+     */
+    dateLimitePaiement?: string;
+    /**
+     * Date limite de réponse
+     */
+    dateLimiteReponse?: string;
+    /**
+     * Date de la demande de paiement
+     *
+     */
+    dateDemande?: string;
+    /**
+     * Date de confirmation de la demande si le client avait requis la confirmation de la demande de paiement.
+     * Il s'agit de la date et heure à laquelle le client a confirmé la demande.
+     *
+     */
+    dateConfirmation?: string;
+    /**
+     * Date d'envoi de la demande: date et heure à laquelle la demande de paiement est envoyée par le PSP
+     *
+     */
+    dateEnvoi?: string;
+    /**
+     * Date à laquelle le payeur à repondu à la demande de paiement
+     *
+     */
+    dateReponse?: string;
+    /**
+     * Date à laquelle le paiement accepté est irrévocable
+     *
+     */
+    dateIrrevocabilite?: string;
+};
+export declare namespace DemandePaiementListeItem {
+    /**
+     * Categorie de la demande de paiement
+     */
+    enum categorie {
+        _631 = "631",
+        _500 = "500",
+        _521 = "521",
+        _401 = "401"
+    }
+    /**
+     * - `INITIE` si la confirmation du client est attendue suite à la recherche d'alias
+     * - `ENVOYE` si les validations sont concluantes et que le PSP a envoyé la demande
+     * - `IRREVOCABLE` si le payeur a accepté la demande
+     * - `REJETE` si le payeur rejette la demande
+     *
+     */
+    enum statut {
+        INITIE = "INITIE",
+        ENVOYE = "ENVOYE",
+        IRREVOCABLE = "IRREVOCABLE",
+        REJETE = "REJETE"
+    }
+}

package/dist/generated/models/DemandePaiementListeItem.js

@@ -0,0 +1,27 @@
+export var DemandePaiementListeItem;
+(function (DemandePaiementListeItem) {
+    /**
+     * Categorie de la demande de paiement
+     */
+    let categorie;
+    (function (categorie) {
+        categorie["_631"] = "631";
+        categorie["_500"] = "500";
+        categorie["_521"] = "521";
+        categorie["_401"] = "401";
+    })(categorie = DemandePaiementListeItem.categorie || (DemandePaiementListeItem.categorie = {}));
+    /**
+     * - `INITIE` si la confirmation du client est attendue suite à la recherche d'alias
+     * - `ENVOYE` si les validations sont concluantes et que le PSP a envoyé la demande
+     * - `IRREVOCABLE` si le payeur a accepté la demande
+     * - `REJETE` si le payeur rejette la demande
+     *
+     */
+    let statut;
+    (function (statut) {
+        statut["INITIE"] = "INITIE";
+        statut["ENVOYE"] = "ENVOYE";
+        statut["IRREVOCABLE"] = "IRREVOCABLE";
+        statut["REJETE"] = "REJETE";
+    })(statut = DemandePaiementListeItem.statut || (DemandePaiementListeItem.statut = {}));
+})(DemandePaiementListeItem || (DemandePaiementListeItem = {}));