pi-spi-sdk 0.1.3 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +39 -0
- package/README.md +23 -1
- package/dist/chunk-7W56NW2S.mjs +2066 -0
- package/dist/generated-FM5EVVHH.mjs +84 -0
- package/dist/index.cjs +4754 -0
- package/dist/index.d.cts +4940 -0
- package/dist/index.d.ts +4937 -12
- package/dist/index.mjs +2359 -0
- package/dist/index.umd.js +2 -0
- package/dist/qrcode/index.cjs +757 -0
- package/dist/qrcode/index.d.cts +68 -0
- package/dist/qrcode/index.d.ts +20 -14
- package/dist/qrcode/index.mjs +712 -0
- package/package.json +24 -8
- package/dist/config.d.ts +0 -35
- package/dist/config.js +0 -5
- package/dist/error-handler.d.ts +0 -7
- package/dist/error-handler.js +0 -55
- package/dist/errors.d.ts +0 -25
- package/dist/errors.js +0 -48
- package/dist/examples.d.ts +0 -8
- package/dist/examples.js +0 -93
- package/dist/generated/core/ApiError.d.ts +0 -10
- package/dist/generated/core/ApiError.js +0 -15
- package/dist/generated/core/ApiRequestOptions.d.ts +0 -13
- package/dist/generated/core/ApiRequestOptions.js +0 -2
- package/dist/generated/core/ApiResult.d.ts +0 -7
- package/dist/generated/core/ApiResult.js +0 -2
- package/dist/generated/core/CancelablePromise.d.ts +0 -20
- package/dist/generated/core/CancelablePromise.js +0 -116
- package/dist/generated/core/OpenAPI.d.ts +0 -16
- package/dist/generated/core/OpenAPI.js +0 -14
- package/dist/generated/core/request.d.ts +0 -34
- package/dist/generated/core/request.js +0 -292
- package/dist/generated/index.d.ts +0 -78
- package/dist/generated/index.js +0 -86
- package/dist/generated/models/AliasCreationReponse.d.ts +0 -22
- package/dist/generated/models/AliasCreationReponse.js +0 -2
- package/dist/generated/models/AliasCreationRequest.d.ts +0 -11
- package/dist/generated/models/AliasCreationRequest.js +0 -2
- package/dist/generated/models/AliasReponseListe.d.ts +0 -26
- package/dist/generated/models/AliasReponseListe.js +0 -2
- package/dist/generated/models/AnnulationStatut.d.ts +0 -13
- package/dist/generated/models/AnnulationStatut.js +0 -21
- package/dist/generated/models/Champs.d.ts +0 -1
- package/dist/generated/models/Champs.js +0 -2
- package/dist/generated/models/CompteOperation.d.ts +0 -72
- package/dist/generated/models/CompteOperation.js +0 -27
- package/dist/generated/models/CompteOperationListe.d.ts +0 -18
- package/dist/generated/models/CompteOperationListe.js +0 -2
- package/dist/generated/models/CompteSolde.d.ts +0 -129
- package/dist/generated/models/CompteSolde.js +0 -74
- package/dist/generated/models/CompteTransfertIntraReponse.d.ts +0 -33
- package/dist/generated/models/CompteTransfertIntraReponse.js +0 -15
- package/dist/generated/models/CompteTransfertIntraRequest.d.ts +0 -9
- package/dist/generated/models/CompteTransfertIntraRequest.js +0 -2
- package/dist/generated/models/DemandePaiementConfirmationAnnulationRaison.d.ts +0 -14
- package/dist/generated/models/DemandePaiementConfirmationAnnulationRaison.js +0 -22
- package/dist/generated/models/DemandePaiementConfirmationReponse.d.ts +0 -41
- package/dist/generated/models/DemandePaiementConfirmationReponse.js +0 -16
- package/dist/generated/models/DemandePaiementConfirmationRequest.d.ts +0 -3
- package/dist/generated/models/DemandePaiementConfirmationRequest.js +0 -2
- package/dist/generated/models/DemandePaiementConfirmationRequestAccepter.d.ts +0 -9
- package/dist/generated/models/DemandePaiementConfirmationRequestAccepter.js +0 -2
- package/dist/generated/models/DemandePaiementConfirmationRequestRejeter.d.ts +0 -9
- package/dist/generated/models/DemandePaiementConfirmationRequestRejeter.js +0 -2
- package/dist/generated/models/DemandePaiementConsultationReponse.d.ts +0 -151
- package/dist/generated/models/DemandePaiementConsultationReponse.js +0 -30
- package/dist/generated/models/DemandePaiementEnMasseConfirmationRequest.d.ts +0 -3
- package/dist/generated/models/DemandePaiementEnMasseConfirmationRequest.js +0 -2
- package/dist/generated/models/DemandePaiementEnMasseConfirmationRequestAccepter.d.ts +0 -9
- package/dist/generated/models/DemandePaiementEnMasseConfirmationRequestAccepter.js +0 -2
- package/dist/generated/models/DemandePaiementEnMasseConfirmationRequestRejeter.d.ts +0 -9
- package/dist/generated/models/DemandePaiementEnMasseConfirmationRequestRejeter.js +0 -2
- package/dist/generated/models/DemandePaiementEnMasseRequest.d.ts +0 -74
- package/dist/generated/models/DemandePaiementEnMasseRequest.js +0 -2
- package/dist/generated/models/DemandePaiementEnMasseStatutReponse.d.ts +0 -98
- package/dist/generated/models/DemandePaiementEnMasseStatutReponse.js +0 -23
- package/dist/generated/models/DemandePaiementListe.d.ts +0 -26
- package/dist/generated/models/DemandePaiementListe.js +0 -2
- package/dist/generated/models/DemandePaiementListeItem.d.ts +0 -163
- package/dist/generated/models/DemandePaiementListeItem.js +0 -30
- package/dist/generated/models/DemandePaiementReponse.d.ts +0 -129
- package/dist/generated/models/DemandePaiementReponse.js +0 -2
- package/dist/generated/models/DemandePaiementReponseRequest.d.ts +0 -21
- package/dist/generated/models/DemandePaiementReponseRequest.js +0 -14
- package/dist/generated/models/DemandePaiementRequest.d.ts +0 -98
- package/dist/generated/models/DemandePaiementRequest.js +0 -10
- package/dist/generated/models/DemandePaiementRequestBase.d.ts +0 -42
- package/dist/generated/models/DemandePaiementRequestBase.js +0 -2
- package/dist/generated/models/DemandePaiementRequestCategorie.d.ts +0 -12
- package/dist/generated/models/DemandePaiementRequestCategorie.js +0 -20
- package/dist/generated/models/DemandePaiementStatut.d.ts +0 -13
- package/dist/generated/models/DemandePaiementStatut.js +0 -21
- package/dist/generated/models/DemandePaiementStatutRaison.d.ts +0 -46
- package/dist/generated/models/DemandePaiementStatutRaison.js +0 -54
- package/dist/generated/models/ListeMeta.d.ts +0 -14
- package/dist/generated/models/ListeMeta.js +0 -2
- package/dist/generated/models/Paiement.d.ts +0 -156
- package/dist/generated/models/Paiement.js +0 -31
- package/dist/generated/models/PaiementAnnulationMotif.d.ts +0 -17
- package/dist/generated/models/PaiementAnnulationMotif.js +0 -25
- package/dist/generated/models/PaiementAnnulationReponseRequest.d.ts +0 -11
- package/dist/generated/models/PaiementAnnulationReponseRequest.js +0 -2
- package/dist/generated/models/PaiementAnnulationReponseRequestAccepter.d.ts +0 -9
- package/dist/generated/models/PaiementAnnulationReponseRequestAccepter.js +0 -2
- package/dist/generated/models/PaiementAnnulationReponseRequestRejeter.d.ts +0 -9
- package/dist/generated/models/PaiementAnnulationReponseRequestRejeter.js +0 -2
- package/dist/generated/models/PaiementAnnulationRequest.d.ts +0 -4
- package/dist/generated/models/PaiementAnnulationRequest.js +0 -2
- package/dist/generated/models/PaiementAnnulationStatutRaison.d.ts +0 -21
- package/dist/generated/models/PaiementAnnulationStatutRaison.js +0 -29
- package/dist/generated/models/PaiementEnMasseConfirmationRequest.d.ts +0 -3
- package/dist/generated/models/PaiementEnMasseConfirmationRequest.js +0 -2
- package/dist/generated/models/PaiementEnMasseConfirmationRequestAccepter.d.ts +0 -9
- package/dist/generated/models/PaiementEnMasseConfirmationRequestAccepter.js +0 -2
- package/dist/generated/models/PaiementEnMasseConfirmationRequestRejeter.d.ts +0 -9
- package/dist/generated/models/PaiementEnMasseConfirmationRequestRejeter.js +0 -2
- package/dist/generated/models/PaiementEnMasseReponseStatut.d.ts +0 -97
- package/dist/generated/models/PaiementEnMasseReponseStatut.js +0 -23
- package/dist/generated/models/PaiementEnMasseRequest.d.ts +0 -54
- package/dist/generated/models/PaiementEnMasseRequest.js +0 -2
- package/dist/generated/models/PaiementImmediatConfirmationReponse.d.ts +0 -31
- package/dist/generated/models/PaiementImmediatConfirmationReponse.js +0 -10
- package/dist/generated/models/PaiementImmediatConfirmationRequest.d.ts +0 -3
- package/dist/generated/models/PaiementImmediatConfirmationRequest.js +0 -2
- package/dist/generated/models/PaiementImmediatConfirmationRequestAccepter.d.ts +0 -9
- package/dist/generated/models/PaiementImmediatConfirmationRequestAccepter.js +0 -2
- package/dist/generated/models/PaiementImmediatConfirmationRequestRejeter.d.ts +0 -9
- package/dist/generated/models/PaiementImmediatConfirmationRequestRejeter.js +0 -2
- package/dist/generated/models/PaiementImmediatReponse.d.ts +0 -98
- package/dist/generated/models/PaiementImmediatReponse.js +0 -10
- package/dist/generated/models/PaiementImmediatRequest.d.ts +0 -13
- package/dist/generated/models/PaiementImmediatRequest.js +0 -2
- package/dist/generated/models/PaiementListe.d.ts +0 -6
- package/dist/generated/models/PaiementListe.js +0 -2
- package/dist/generated/models/PaiementRequest.d.ts +0 -33
- package/dist/generated/models/PaiementRequest.js +0 -2
- package/dist/generated/models/PaiementStatut.d.ts +0 -13
- package/dist/generated/models/PaiementStatut.js +0 -21
- package/dist/generated/models/PaiementStatutRaison.d.ts +0 -56
- package/dist/generated/models/PaiementStatutRaison.js +0 -64
- package/dist/generated/models/Problem7807.d.ts +0 -31
- package/dist/generated/models/Problem7807.js +0 -2
- package/dist/generated/models/RefDocType.d.ts +0 -38
- package/dist/generated/models/RefDocType.js +0 -46
- package/dist/generated/models/RetourStatut.d.ts +0 -13
- package/dist/generated/models/RetourStatut.js +0 -21
- package/dist/generated/models/RetourStatutRaison.d.ts +0 -25
- package/dist/generated/models/RetourStatutRaison.js +0 -33
- package/dist/generated/models/WebhookCreationRequest.d.ts +0 -14
- package/dist/generated/models/WebhookCreationRequest.js +0 -2
- package/dist/generated/models/WebhookCreationResponse.d.ts +0 -12
- package/dist/generated/models/WebhookCreationResponse.js +0 -2
- package/dist/generated/models/WebhookData.d.ts +0 -8
- package/dist/generated/models/WebhookData.js +0 -2
- package/dist/generated/models/WebhookEvent.d.ts +0 -191
- package/dist/generated/models/WebhookEvent.js +0 -45
- package/dist/generated/models/WebhookEventsList.d.ts +0 -13
- package/dist/generated/models/WebhookEventsList.js +0 -2
- package/dist/generated/models/WebhookList.d.ts +0 -13
- package/dist/generated/models/WebhookList.js +0 -2
- package/dist/generated/models/WebhookModificationRequest.d.ts +0 -4
- package/dist/generated/models/WebhookModificationRequest.js +0 -2
- package/dist/generated/models/WebhooksEvents.d.ts +0 -12
- package/dist/generated/models/WebhooksEvents.js +0 -20
- package/dist/generated/services/AliasService.d.ts +0 -63
- package/dist/generated/services/AliasService.js +0 -88
- package/dist/generated/services/ComptesService.d.ts +0 -64
- package/dist/generated/services/ComptesService.js +0 -90
- package/dist/generated/services/DemandeAnnulationService.d.ts +0 -84
- package/dist/generated/services/DemandeAnnulationService.js +0 -103
- package/dist/generated/services/DemandesDePaiementEnMasseService.d.ts +0 -161
- package/dist/generated/services/DemandesDePaiementEnMasseService.js +0 -193
- package/dist/generated/services/DemandesDePaiementService.d.ts +0 -123
- package/dist/generated/services/DemandesDePaiementService.js +0 -165
- package/dist/generated/services/NotificationService.d.ts +0 -80
- package/dist/generated/services/NotificationService.js +0 -136
- package/dist/generated/services/PaiementEnMasseService.d.ts +0 -159
- package/dist/generated/services/PaiementEnMasseService.js +0 -191
- package/dist/generated/services/PaiementImmediatService.d.ts +0 -135
- package/dist/generated/services/PaiementImmediatService.js +0 -180
- package/dist/generated/services/RetoursdeFondsService.d.ts +0 -28
- package/dist/generated/services/RetoursdeFondsService.js +0 -41
- package/dist/index.js +0 -72
- package/dist/qrcode/index.js +0 -541
- package/dist/qrcode/logo.d.ts +0 -3
- package/dist/qrcode/logo.js +0 -142
- package/dist/query-builder.d.ts +0 -91
- package/dist/query-builder.js +0 -191
- package/dist/sdk.d.ts +0 -104
- package/dist/sdk.js +0 -147
- package/dist/services/alias.d.ts +0 -76
- package/dist/services/alias.js +0 -80
- package/dist/services/base.d.ts +0 -20
- package/dist/services/base.js +0 -67
- package/dist/services/comptes.d.ts +0 -149
- package/dist/services/comptes.js +0 -162
- package/dist/services/demandes-annulation.d.ts +0 -97
- package/dist/services/demandes-annulation.js +0 -108
- package/dist/services/demandes-paiement-en-masse.d.ts +0 -33
- package/dist/services/demandes-paiement-en-masse.js +0 -44
- package/dist/services/demandes-paiement.d.ts +0 -148
- package/dist/services/demandes-paiement.js +0 -153
- package/dist/services/paiements-en-masse.d.ts +0 -152
- package/dist/services/paiements-en-masse.js +0 -157
- package/dist/services/paiements.d.ts +0 -135
- package/dist/services/paiements.js +0 -139
- package/dist/services/retours-fonds.d.ts +0 -94
- package/dist/services/retours-fonds.js +0 -104
- package/dist/services/webhooks.d.ts +0 -131
- package/dist/services/webhooks.js +0 -146
- package/dist/types/alias.d.ts +0 -64
- package/dist/types/alias.js +0 -78
- package/dist/utils/constants.d.ts +0 -93
- package/dist/utils/constants.js +0 -96
- package/dist/utils/index.d.ts +0 -60
- package/dist/utils/index.js +0 -126
|
@@ -1,161 +0,0 @@
|
|
|
1
|
-
import type { DemandePaiementEnMasseConfirmationRequest } from '../models/DemandePaiementEnMasseConfirmationRequest';
|
|
2
|
-
import type { DemandePaiementEnMasseRequest } from '../models/DemandePaiementEnMasseRequest';
|
|
3
|
-
import type { DemandePaiementEnMasseStatutReponse } from '../models/DemandePaiementEnMasseStatutReponse';
|
|
4
|
-
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
5
|
-
export declare class DemandesDePaiementEnMasseService {
|
|
6
|
-
/**
|
|
7
|
-
* Envoyer une demande de paiement en masse
|
|
8
|
-
* Ce point de terminaison permet au client business d'envoyer plusieurs demandes de paiement à la fois.
|
|
9
|
-
*
|
|
10
|
-
* La catégorie des demandes de paiement en masse est toujours `401` (Autres demandes de paiement de facture).
|
|
11
|
-
*
|
|
12
|
-
* **Traitement asynchrone :** La création retourne immédiatement `202 Accepted`. Le traitement des transactions se fait de manière asynchrone.
|
|
13
|
-
*
|
|
14
|
-
* **Sans confirmation (`confirmation: false` ou non spécifié) :**
|
|
15
|
-
* - Les transactions sont créées et validées (unicité des txId)
|
|
16
|
-
* - Les demandes de paiement sont envoyées directement aux payeurs
|
|
17
|
-
* - Les transactions avec txId dupliqué sont automatiquement rejetées avec le code `DU03`
|
|
18
|
-
* - Les transactions avec alias de payeur invalide sont automatiquement rejetées avec le code `BE23`
|
|
19
|
-
*
|
|
20
|
-
* **Avec confirmation (`confirmation: true`) :**
|
|
21
|
-
* - Les transactions sont créées et validées (unicité des txId + recherche d'alias des payeurs)
|
|
22
|
-
* - Les transactions avec alias de payeur invalide sont rejetées avec le code `BE23`
|
|
23
|
-
* - Les transactions avec txId dupliqué sont rejetées avec le code `DU03`
|
|
24
|
-
* - Les transactions valides passent à l'état `INITIE` avec les noms et pays des payeurs
|
|
25
|
-
* - Le business dispose d'un **délai adaptatif** pour confirmer ou annuler via `PUT /demandes-paiements-groupes/{instructionId}/confirmations` :
|
|
26
|
-
* - **1 à 500 transactions** : 24 heures
|
|
27
|
-
* - **501 à 1000 transactions** : 48 heures
|
|
28
|
-
* - **Plus de 1000 transactions** : 72 heures
|
|
29
|
-
* - Lors de la confirmation, seules les transactions `INITIE` sont envoyées (les transactions `REJETE` sont automatiquement exclues)
|
|
30
|
-
* - Passé le délai, la demande expire automatiquement
|
|
31
|
-
*
|
|
32
|
-
* **Consultation des détails :**
|
|
33
|
-
* - Statut global du bulk : `GET /demandes-paiements-groupes/{instructionId}`
|
|
34
|
-
* - Liste de toutes les transactions : `GET /demandes-paiements?instructionId={instructionId}`
|
|
35
|
-
* - Seulement les rejetées (validation) : `GET /demandes-paiements?instructionId={instructionId}&statut=REJETE`
|
|
36
|
-
* - Seulement les valides (avec noms/pays des payeurs) : `GET /demandes-paiements?instructionId={instructionId}&statut=INITIE`
|
|
37
|
-
*
|
|
38
|
-
* **Convention de nommage des instructionId (important) :**
|
|
39
|
-
*
|
|
40
|
-
* L'`instructionId` doit être **unique** pour chaque création de bulk. Pour faciliter le suivi métier, nous recommandons la convention suivante :
|
|
41
|
-
*
|
|
42
|
-
* ```
|
|
43
|
-
* <IDENTIFIANT_METIER>-<NUMERO_TENTATIVE>
|
|
44
|
-
* ```
|
|
45
|
-
*
|
|
46
|
-
* **Exemples :**
|
|
47
|
-
* - Première tentative : `FACTURES-2025-01-1` (factures de janvier 2025, tentative 1)
|
|
48
|
-
* - Deuxième tentative : `FACTURES-2025-01-2` (corrections après échecs)
|
|
49
|
-
* - Troisième tentative : `FACTURES-2025-01-3` (nouvelles corrections)
|
|
50
|
-
*
|
|
51
|
-
* **Avantages :**
|
|
52
|
-
* - ✅ Chaque bulk a un statut indépendant (INITIE, CONFIRME, ANNULE)
|
|
53
|
-
* - ✅ Traçabilité claire des tentatives successives
|
|
54
|
-
* - ✅ Possibilité de filtrer par identifiant métier : `GET /demandes-paiements?instructionId[beginsWith]=FACTURES-2025-01`
|
|
55
|
-
* - ✅ Respect de l'unicité de l'instructionId
|
|
56
|
-
*
|
|
57
|
-
* @returns string La demande a été acceptée et est en cours de traitement.
|
|
58
|
-
*
|
|
59
|
-
* Consultez le statut via `GET /demandes-paiements-groupes/{instructionId}`.
|
|
60
|
-
*
|
|
61
|
-
* @throws ApiError
|
|
62
|
-
*/
|
|
63
|
-
static demandePaiementGroupeCreer({ requestBody, }: {
|
|
64
|
-
requestBody: DemandePaiementEnMasseRequest;
|
|
65
|
-
}): CancelablePromise<string>;
|
|
66
|
-
/**
|
|
67
|
-
* Détails d'une demande de paiement en masse
|
|
68
|
-
* Ce point de terminaison permet de consulter les détails d'une demande de paiement en masse.
|
|
69
|
-
*
|
|
70
|
-
* **Statut du bulk :**
|
|
71
|
-
* - `INITIE` : Créée avec confirmation demandée, en attente de confirmation
|
|
72
|
-
* - `CONFIRME` : Confirmée par le business (si confirmation demandée) ou en cours de traitement (si sans confirmation)
|
|
73
|
-
* - `ANNULE` : Annulée par le business avant confirmation (seulement si confirmation demandée)
|
|
74
|
-
*
|
|
75
|
-
* **Note :**
|
|
76
|
-
* - Si créée **avec confirmation** (`confirmation: true`) : Le statut évolue de `INITIE` → `CONFIRME` ou `ANNULE`
|
|
77
|
-
* - Si créée **sans confirmation** (`confirmation: false`) : Le statut est directement `CONFIRME` (aucune action requise du business)
|
|
78
|
-
*
|
|
79
|
-
* **Vérification de fin de validation (important pour confirmation) :**
|
|
80
|
-
*
|
|
81
|
-
* Lorsque `confirmation: true`, la validation des transactions se fait de manière asynchrone.
|
|
82
|
-
* Pour savoir si la validation est terminée et que vous pouvez confirmer, vérifiez que :
|
|
83
|
-
*
|
|
84
|
-
* ```
|
|
85
|
-
* transactionsInitiees + transactionsRejetees = transactionsTotal
|
|
86
|
-
* ```
|
|
87
|
-
*
|
|
88
|
-
* - Si égalité → Validation terminée, vous pouvez confirmer ✅
|
|
89
|
-
* - Si inégalité → Validation en cours, attendez encore (consultez à nouveau plus tard) ⏳
|
|
90
|
-
*
|
|
91
|
-
* Le détail de chaque transaction se consulte via `GET /demandes-paiements?txId={txId}`.
|
|
92
|
-
*
|
|
93
|
-
* **Consultation des transactions individuelles :**
|
|
94
|
-
* Pour obtenir la liste détaillée des transactions (avec noms des payeurs, codes d'erreur, etc.), utilisez :
|
|
95
|
-
* - Toutes les transactions : `GET /demandes-paiements?instructionId={instructionId}`
|
|
96
|
-
* - Seulement les rejetées : `GET /demandes-paiements?instructionId={instructionId}&statut=REJETE`
|
|
97
|
-
* - Seulement les réussies : `GET /demandes-paiements?instructionId={instructionId}&statut=IRREVOCABLE`
|
|
98
|
-
*
|
|
99
|
-
* @returns DemandePaiementEnMasseStatutReponse Opération effectuée avec succès
|
|
100
|
-
* @throws ApiError
|
|
101
|
-
*/
|
|
102
|
-
static demandePaiementGroupeConsulter({ instructionId, }: {
|
|
103
|
-
/**
|
|
104
|
-
* L'identifiant de la demande de paiement en masse dans le SI du client
|
|
105
|
-
*/
|
|
106
|
-
instructionId: string;
|
|
107
|
-
}): CancelablePromise<DemandePaiementEnMasseStatutReponse>;
|
|
108
|
-
/**
|
|
109
|
-
* Confirmer la demande de paiement en masse
|
|
110
|
-
* Ce point de terminaison permet de confirmer ou d'annuler une demande de paiement en masse créée avec `confirmation: true`.
|
|
111
|
-
*
|
|
112
|
-
* **Processus de vérification :**
|
|
113
|
-
* 1. Après la création (`POST /demandes-paiements-groupes`), le participant valide toutes les transactions (unicité des txId + recherche d'alias des payeurs)
|
|
114
|
-
* 2. Les transactions invalides sont automatiquement rejetées (`statut: REJETE`) avec codes `BE23` (alias invalide) ou `DU03` (txId dupliqué)
|
|
115
|
-
* 3. Les transactions valides passent à l'état `INITIE` avec les noms et pays des payeurs
|
|
116
|
-
* 4. Le business consulte via `GET /demandes-paiements-groupes/{instructionId}` pour vérifier la progression de la validation
|
|
117
|
-
* 5. **La validation (unicité des txId + recherche d'alias) est terminée quand** : `transactionsInitiees + transactionsRejetees = transactionsTotal`
|
|
118
|
-
* 6. Le business peut alors confirmer ou annuler l'envoi des demandes de paiement
|
|
119
|
-
*
|
|
120
|
-
* **Important :** La confirmation n'est possible que lorsque la validation de toutes les transactions est terminée.
|
|
121
|
-
* Si le business tente de confirmer pendant que la validation est en cours, une erreur 403 sera retournée avec la progression actuelle.
|
|
122
|
-
*
|
|
123
|
-
* **Comportement de la confirmation :**
|
|
124
|
-
* - `decision: true` → Le système envoie **automatiquement SEULEMENT** les demandes de paiement pour les transactions avec `statut: INITIE`
|
|
125
|
-
* - Les transactions `REJETE` (erreurs de validation) sont **automatiquement exclues** (pas besoin de les lister)
|
|
126
|
-
* - Le statut du bulk passe de `INITIE` à `CONFIRME`
|
|
127
|
-
*
|
|
128
|
-
* **Idempotence** : Cet endpoint est idempotent.
|
|
129
|
-
* - Premier appel avec `decision: true` → Envoie les demandes, retourne `200 OK {statut: "CONFIRME"}`
|
|
130
|
-
* - Appels suivants avec `decision: true` → Retourne `200 OK {statut: "CONFIRME"}` (idempotent, ne relance pas)
|
|
131
|
-
* - Premier appel avec `decision: false` → Annule, retourne `200 OK {statut: "ANNULE"}`
|
|
132
|
-
* - Appels suivants avec `decision: false` → Retourne `200 OK {statut: "ANNULE"}` (idempotent)
|
|
133
|
-
* - `decision: true` après `decision: false` → Retourne `403 Forbidden` (déjà annulé)
|
|
134
|
-
* - `decision: false` après `decision: true` → Retourne `403 Forbidden` (déjà confirmé)
|
|
135
|
-
*
|
|
136
|
-
* **Timeout adaptatif** : Le délai pour confirmer dépend automatiquement du nombre de transactions :
|
|
137
|
-
* - **1 à 500 transactions** : 24 heures
|
|
138
|
-
* - **501 à 1000 transactions** : 48 heures
|
|
139
|
-
* - **Plus de 1000 transactions** : 72 heures
|
|
140
|
-
*
|
|
141
|
-
* Passé ce délai, la demande expire automatiquement et ne peut plus être confirmée. Le délai exact est indiqué dans le champ `dateExpiration` retourné par `GET /demandes-paiements-groupes/{instructionId}`.
|
|
142
|
-
*
|
|
143
|
-
* **Changement de décision** : Une fois une décision prise, elle est définitive. Impossible de confirmer après avoir annulé, et vice-versa.
|
|
144
|
-
*
|
|
145
|
-
* @returns DemandePaiementEnMasseStatutReponse Confirmation enregistrée avec succès.
|
|
146
|
-
* - Si `decision: true`, le statut passe à `CONFIRME` et les demandes de paiement sont envoyées
|
|
147
|
-
* - Si `decision: false`, le statut passe à `ANNULE`
|
|
148
|
-
*
|
|
149
|
-
* @throws ApiError
|
|
150
|
-
*/
|
|
151
|
-
static demandePaiementGroupeConfirmer({ instructionId, requestBody, }: {
|
|
152
|
-
/**
|
|
153
|
-
* L'identifiant de la demande de paiement en masse dans le SI du client
|
|
154
|
-
*/
|
|
155
|
-
instructionId: string;
|
|
156
|
-
/**
|
|
157
|
-
* Le client envoie oui ou non s'il confirme l'envoi de la demande de paiement en masse.
|
|
158
|
-
*/
|
|
159
|
-
requestBody: DemandePaiementEnMasseConfirmationRequest;
|
|
160
|
-
}): CancelablePromise<DemandePaiementEnMasseStatutReponse>;
|
|
161
|
-
}
|
|
@@ -1,193 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.DemandesDePaiementEnMasseService = void 0;
|
|
4
|
-
const OpenAPI_1 = require("../core/OpenAPI");
|
|
5
|
-
const request_1 = require("../core/request");
|
|
6
|
-
class DemandesDePaiementEnMasseService {
|
|
7
|
-
/**
|
|
8
|
-
* Envoyer une demande de paiement en masse
|
|
9
|
-
* Ce point de terminaison permet au client business d'envoyer plusieurs demandes de paiement à la fois.
|
|
10
|
-
*
|
|
11
|
-
* La catégorie des demandes de paiement en masse est toujours `401` (Autres demandes de paiement de facture).
|
|
12
|
-
*
|
|
13
|
-
* **Traitement asynchrone :** La création retourne immédiatement `202 Accepted`. Le traitement des transactions se fait de manière asynchrone.
|
|
14
|
-
*
|
|
15
|
-
* **Sans confirmation (`confirmation: false` ou non spécifié) :**
|
|
16
|
-
* - Les transactions sont créées et validées (unicité des txId)
|
|
17
|
-
* - Les demandes de paiement sont envoyées directement aux payeurs
|
|
18
|
-
* - Les transactions avec txId dupliqué sont automatiquement rejetées avec le code `DU03`
|
|
19
|
-
* - Les transactions avec alias de payeur invalide sont automatiquement rejetées avec le code `BE23`
|
|
20
|
-
*
|
|
21
|
-
* **Avec confirmation (`confirmation: true`) :**
|
|
22
|
-
* - Les transactions sont créées et validées (unicité des txId + recherche d'alias des payeurs)
|
|
23
|
-
* - Les transactions avec alias de payeur invalide sont rejetées avec le code `BE23`
|
|
24
|
-
* - Les transactions avec txId dupliqué sont rejetées avec le code `DU03`
|
|
25
|
-
* - Les transactions valides passent à l'état `INITIE` avec les noms et pays des payeurs
|
|
26
|
-
* - Le business dispose d'un **délai adaptatif** pour confirmer ou annuler via `PUT /demandes-paiements-groupes/{instructionId}/confirmations` :
|
|
27
|
-
* - **1 à 500 transactions** : 24 heures
|
|
28
|
-
* - **501 à 1000 transactions** : 48 heures
|
|
29
|
-
* - **Plus de 1000 transactions** : 72 heures
|
|
30
|
-
* - Lors de la confirmation, seules les transactions `INITIE` sont envoyées (les transactions `REJETE` sont automatiquement exclues)
|
|
31
|
-
* - Passé le délai, la demande expire automatiquement
|
|
32
|
-
*
|
|
33
|
-
* **Consultation des détails :**
|
|
34
|
-
* - Statut global du bulk : `GET /demandes-paiements-groupes/{instructionId}`
|
|
35
|
-
* - Liste de toutes les transactions : `GET /demandes-paiements?instructionId={instructionId}`
|
|
36
|
-
* - Seulement les rejetées (validation) : `GET /demandes-paiements?instructionId={instructionId}&statut=REJETE`
|
|
37
|
-
* - Seulement les valides (avec noms/pays des payeurs) : `GET /demandes-paiements?instructionId={instructionId}&statut=INITIE`
|
|
38
|
-
*
|
|
39
|
-
* **Convention de nommage des instructionId (important) :**
|
|
40
|
-
*
|
|
41
|
-
* L'`instructionId` doit être **unique** pour chaque création de bulk. Pour faciliter le suivi métier, nous recommandons la convention suivante :
|
|
42
|
-
*
|
|
43
|
-
* ```
|
|
44
|
-
* <IDENTIFIANT_METIER>-<NUMERO_TENTATIVE>
|
|
45
|
-
* ```
|
|
46
|
-
*
|
|
47
|
-
* **Exemples :**
|
|
48
|
-
* - Première tentative : `FACTURES-2025-01-1` (factures de janvier 2025, tentative 1)
|
|
49
|
-
* - Deuxième tentative : `FACTURES-2025-01-2` (corrections après échecs)
|
|
50
|
-
* - Troisième tentative : `FACTURES-2025-01-3` (nouvelles corrections)
|
|
51
|
-
*
|
|
52
|
-
* **Avantages :**
|
|
53
|
-
* - ✅ Chaque bulk a un statut indépendant (INITIE, CONFIRME, ANNULE)
|
|
54
|
-
* - ✅ Traçabilité claire des tentatives successives
|
|
55
|
-
* - ✅ Possibilité de filtrer par identifiant métier : `GET /demandes-paiements?instructionId[beginsWith]=FACTURES-2025-01`
|
|
56
|
-
* - ✅ Respect de l'unicité de l'instructionId
|
|
57
|
-
*
|
|
58
|
-
* @returns string La demande a été acceptée et est en cours de traitement.
|
|
59
|
-
*
|
|
60
|
-
* Consultez le statut via `GET /demandes-paiements-groupes/{instructionId}`.
|
|
61
|
-
*
|
|
62
|
-
* @throws ApiError
|
|
63
|
-
*/
|
|
64
|
-
static demandePaiementGroupeCreer({ requestBody, }) {
|
|
65
|
-
return (0, request_1.request)(OpenAPI_1.OpenAPI, {
|
|
66
|
-
method: 'POST',
|
|
67
|
-
url: '/demandes-paiements-groupes',
|
|
68
|
-
body: requestBody,
|
|
69
|
-
mediaType: 'application/json',
|
|
70
|
-
responseHeader: 'Location',
|
|
71
|
-
errors: {
|
|
72
|
-
400: `La requête est malformée`,
|
|
73
|
-
401: `Autorisations manquantes`,
|
|
74
|
-
409: `Conflit - instructionId déjà utilisé`,
|
|
75
|
-
429: `Erreur inattendue`,
|
|
76
|
-
503: `Erreur inattendue du serveur`,
|
|
77
|
-
},
|
|
78
|
-
});
|
|
79
|
-
}
|
|
80
|
-
/**
|
|
81
|
-
* Détails d'une demande de paiement en masse
|
|
82
|
-
* Ce point de terminaison permet de consulter les détails d'une demande de paiement en masse.
|
|
83
|
-
*
|
|
84
|
-
* **Statut du bulk :**
|
|
85
|
-
* - `INITIE` : Créée avec confirmation demandée, en attente de confirmation
|
|
86
|
-
* - `CONFIRME` : Confirmée par le business (si confirmation demandée) ou en cours de traitement (si sans confirmation)
|
|
87
|
-
* - `ANNULE` : Annulée par le business avant confirmation (seulement si confirmation demandée)
|
|
88
|
-
*
|
|
89
|
-
* **Note :**
|
|
90
|
-
* - Si créée **avec confirmation** (`confirmation: true`) : Le statut évolue de `INITIE` → `CONFIRME` ou `ANNULE`
|
|
91
|
-
* - Si créée **sans confirmation** (`confirmation: false`) : Le statut est directement `CONFIRME` (aucune action requise du business)
|
|
92
|
-
*
|
|
93
|
-
* **Vérification de fin de validation (important pour confirmation) :**
|
|
94
|
-
*
|
|
95
|
-
* Lorsque `confirmation: true`, la validation des transactions se fait de manière asynchrone.
|
|
96
|
-
* Pour savoir si la validation est terminée et que vous pouvez confirmer, vérifiez que :
|
|
97
|
-
*
|
|
98
|
-
* ```
|
|
99
|
-
* transactionsInitiees + transactionsRejetees = transactionsTotal
|
|
100
|
-
* ```
|
|
101
|
-
*
|
|
102
|
-
* - Si égalité → Validation terminée, vous pouvez confirmer ✅
|
|
103
|
-
* - Si inégalité → Validation en cours, attendez encore (consultez à nouveau plus tard) ⏳
|
|
104
|
-
*
|
|
105
|
-
* Le détail de chaque transaction se consulte via `GET /demandes-paiements?txId={txId}`.
|
|
106
|
-
*
|
|
107
|
-
* **Consultation des transactions individuelles :**
|
|
108
|
-
* Pour obtenir la liste détaillée des transactions (avec noms des payeurs, codes d'erreur, etc.), utilisez :
|
|
109
|
-
* - Toutes les transactions : `GET /demandes-paiements?instructionId={instructionId}`
|
|
110
|
-
* - Seulement les rejetées : `GET /demandes-paiements?instructionId={instructionId}&statut=REJETE`
|
|
111
|
-
* - Seulement les réussies : `GET /demandes-paiements?instructionId={instructionId}&statut=IRREVOCABLE`
|
|
112
|
-
*
|
|
113
|
-
* @returns DemandePaiementEnMasseStatutReponse Opération effectuée avec succès
|
|
114
|
-
* @throws ApiError
|
|
115
|
-
*/
|
|
116
|
-
static demandePaiementGroupeConsulter({ instructionId, }) {
|
|
117
|
-
return (0, request_1.request)(OpenAPI_1.OpenAPI, {
|
|
118
|
-
method: 'GET',
|
|
119
|
-
url: '/demandes-paiements-groupes/{instructionId}',
|
|
120
|
-
path: {
|
|
121
|
-
'instructionId': instructionId,
|
|
122
|
-
},
|
|
123
|
-
errors: {
|
|
124
|
-
401: `Autorisations manquantes`,
|
|
125
|
-
404: `La ressource n'existe pas dans le système`,
|
|
126
|
-
429: `Erreur inattendue`,
|
|
127
|
-
503: `Erreur inattendue du serveur`,
|
|
128
|
-
},
|
|
129
|
-
});
|
|
130
|
-
}
|
|
131
|
-
/**
|
|
132
|
-
* Confirmer la demande de paiement en masse
|
|
133
|
-
* Ce point de terminaison permet de confirmer ou d'annuler une demande de paiement en masse créée avec `confirmation: true`.
|
|
134
|
-
*
|
|
135
|
-
* **Processus de vérification :**
|
|
136
|
-
* 1. Après la création (`POST /demandes-paiements-groupes`), le participant valide toutes les transactions (unicité des txId + recherche d'alias des payeurs)
|
|
137
|
-
* 2. Les transactions invalides sont automatiquement rejetées (`statut: REJETE`) avec codes `BE23` (alias invalide) ou `DU03` (txId dupliqué)
|
|
138
|
-
* 3. Les transactions valides passent à l'état `INITIE` avec les noms et pays des payeurs
|
|
139
|
-
* 4. Le business consulte via `GET /demandes-paiements-groupes/{instructionId}` pour vérifier la progression de la validation
|
|
140
|
-
* 5. **La validation (unicité des txId + recherche d'alias) est terminée quand** : `transactionsInitiees + transactionsRejetees = transactionsTotal`
|
|
141
|
-
* 6. Le business peut alors confirmer ou annuler l'envoi des demandes de paiement
|
|
142
|
-
*
|
|
143
|
-
* **Important :** La confirmation n'est possible que lorsque la validation de toutes les transactions est terminée.
|
|
144
|
-
* Si le business tente de confirmer pendant que la validation est en cours, une erreur 403 sera retournée avec la progression actuelle.
|
|
145
|
-
*
|
|
146
|
-
* **Comportement de la confirmation :**
|
|
147
|
-
* - `decision: true` → Le système envoie **automatiquement SEULEMENT** les demandes de paiement pour les transactions avec `statut: INITIE`
|
|
148
|
-
* - Les transactions `REJETE` (erreurs de validation) sont **automatiquement exclues** (pas besoin de les lister)
|
|
149
|
-
* - Le statut du bulk passe de `INITIE` à `CONFIRME`
|
|
150
|
-
*
|
|
151
|
-
* **Idempotence** : Cet endpoint est idempotent.
|
|
152
|
-
* - Premier appel avec `decision: true` → Envoie les demandes, retourne `200 OK {statut: "CONFIRME"}`
|
|
153
|
-
* - Appels suivants avec `decision: true` → Retourne `200 OK {statut: "CONFIRME"}` (idempotent, ne relance pas)
|
|
154
|
-
* - Premier appel avec `decision: false` → Annule, retourne `200 OK {statut: "ANNULE"}`
|
|
155
|
-
* - Appels suivants avec `decision: false` → Retourne `200 OK {statut: "ANNULE"}` (idempotent)
|
|
156
|
-
* - `decision: true` après `decision: false` → Retourne `403 Forbidden` (déjà annulé)
|
|
157
|
-
* - `decision: false` après `decision: true` → Retourne `403 Forbidden` (déjà confirmé)
|
|
158
|
-
*
|
|
159
|
-
* **Timeout adaptatif** : Le délai pour confirmer dépend automatiquement du nombre de transactions :
|
|
160
|
-
* - **1 à 500 transactions** : 24 heures
|
|
161
|
-
* - **501 à 1000 transactions** : 48 heures
|
|
162
|
-
* - **Plus de 1000 transactions** : 72 heures
|
|
163
|
-
*
|
|
164
|
-
* Passé ce délai, la demande expire automatiquement et ne peut plus être confirmée. Le délai exact est indiqué dans le champ `dateExpiration` retourné par `GET /demandes-paiements-groupes/{instructionId}`.
|
|
165
|
-
*
|
|
166
|
-
* **Changement de décision** : Une fois une décision prise, elle est définitive. Impossible de confirmer après avoir annulé, et vice-versa.
|
|
167
|
-
*
|
|
168
|
-
* @returns DemandePaiementEnMasseStatutReponse Confirmation enregistrée avec succès.
|
|
169
|
-
* - Si `decision: true`, le statut passe à `CONFIRME` et les demandes de paiement sont envoyées
|
|
170
|
-
* - Si `decision: false`, le statut passe à `ANNULE`
|
|
171
|
-
*
|
|
172
|
-
* @throws ApiError
|
|
173
|
-
*/
|
|
174
|
-
static demandePaiementGroupeConfirmer({ instructionId, requestBody, }) {
|
|
175
|
-
return (0, request_1.request)(OpenAPI_1.OpenAPI, {
|
|
176
|
-
method: 'PUT',
|
|
177
|
-
url: '/demandes-paiements-groupes/{instructionId}/confirmations',
|
|
178
|
-
path: {
|
|
179
|
-
'instructionId': instructionId,
|
|
180
|
-
},
|
|
181
|
-
body: requestBody,
|
|
182
|
-
mediaType: 'application/json',
|
|
183
|
-
errors: {
|
|
184
|
-
401: `Autorisations manquantes`,
|
|
185
|
-
403: `Opération interdite`,
|
|
186
|
-
404: `La ressource n'existe pas dans le système`,
|
|
187
|
-
429: `Erreur inattendue`,
|
|
188
|
-
503: `Erreur inattendue du serveur`,
|
|
189
|
-
},
|
|
190
|
-
});
|
|
191
|
-
}
|
|
192
|
-
}
|
|
193
|
-
exports.DemandesDePaiementEnMasseService = DemandesDePaiementEnMasseService;
|
|
@@ -1,123 +0,0 @@
|
|
|
1
|
-
import type { DemandePaiementConfirmationReponse } from '../models/DemandePaiementConfirmationReponse';
|
|
2
|
-
import type { DemandePaiementConfirmationRequest } from '../models/DemandePaiementConfirmationRequest';
|
|
3
|
-
import type { DemandePaiementConsultationReponse } from '../models/DemandePaiementConsultationReponse';
|
|
4
|
-
import type { DemandePaiementListe } from '../models/DemandePaiementListe';
|
|
5
|
-
import type { DemandePaiementReponse } from '../models/DemandePaiementReponse';
|
|
6
|
-
import type { DemandePaiementReponseRequest } from '../models/DemandePaiementReponseRequest';
|
|
7
|
-
import type { DemandePaiementRequest } from '../models/DemandePaiementRequest';
|
|
8
|
-
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
9
|
-
export declare class DemandesDePaiementService {
|
|
10
|
-
/**
|
|
11
|
-
* Envoyer une demande
|
|
12
|
-
* Ce point de terminaison permet d'envoyer une demande de paiement.
|
|
13
|
-
*
|
|
14
|
-
* Le business peut définir le champ `confirmation` à `true` pour demander une validation en deux étapes : le PSP retournera d'abord le résultat de la recherche d'alias (avec le nom et le pays du payeur), puis attendra une confirmation explicite avant d'envoyer la demande de paiement au payeur via l'endpoint `PUT /demandes-paiements/{txId}/confirmations`.
|
|
15
|
-
*
|
|
16
|
-
* Si le champ `confirmation` n'est pas défini ou est à `false`, le système envoie directement la demande de paiement au payeur.
|
|
17
|
-
*
|
|
18
|
-
* **Timeout de confirmation** : Si le business demande une validation en deux étapes , il dispose de **24 heures** pour confirmer ou annuler. Passé ce délai, la demande expire automatiquement.
|
|
19
|
-
*
|
|
20
|
-
* @returns DemandePaiementReponse Demande de paiement traitée. Le champ `statut` indique le résultat :
|
|
21
|
-
* - `INITIE` : En attente de confirmation (si `confirmation: true`)
|
|
22
|
-
* - `ENVOYE` : Demande envoyée au payeur avec succès (si `confirmation: false`)
|
|
23
|
-
* - `REJETE` : Demande rejetée. Le champ `statutRaison` contient le code d'erreur :
|
|
24
|
-
* - `DU03` : txId dupliqué (déjà utilisé)
|
|
25
|
-
* - `BE23` : Alias payeur invalide
|
|
26
|
-
* - Autres codes ISO 20022
|
|
27
|
-
*
|
|
28
|
-
* @throws ApiError
|
|
29
|
-
*/
|
|
30
|
-
static demandePaiementCreer({ requestBody, }: {
|
|
31
|
-
/**
|
|
32
|
-
* Données pour envoyer une demande de paiement.
|
|
33
|
-
*/
|
|
34
|
-
requestBody: DemandePaiementRequest;
|
|
35
|
-
}): CancelablePromise<DemandePaiementReponse>;
|
|
36
|
-
/**
|
|
37
|
-
* Lister les demandes
|
|
38
|
-
* Ce point de terminaison permet de lister les demandes de paiements effectuées par le client.
|
|
39
|
-
* @returns DemandePaiementListe Succès de l'opération
|
|
40
|
-
* @throws ApiError
|
|
41
|
-
*/
|
|
42
|
-
static demandePaiementLister({ payeAlias, payeCompte, dateEnvoi, dateLimitePaiement, statut, categorie, payeurAlias, payeurCompte, montantAchat, montantRetrait, debitDiffere, remise, motif, refDocType, instructionId, page, size, sort, fields, }: {
|
|
43
|
-
payeAlias?: string;
|
|
44
|
-
payeCompte?: string;
|
|
45
|
-
dateEnvoi?: string;
|
|
46
|
-
dateLimitePaiement?: string;
|
|
47
|
-
statut?: 'INITIE' | 'ENVOYE' | 'IRREVOCABLE' | 'REJETE';
|
|
48
|
-
categorie?: '631' | '500' | '521' | '401';
|
|
49
|
-
payeurAlias?: string;
|
|
50
|
-
payeurCompte?: string;
|
|
51
|
-
montantAchat?: number;
|
|
52
|
-
montantRetrait?: number;
|
|
53
|
-
debitDiffere?: boolean;
|
|
54
|
-
remise?: boolean;
|
|
55
|
-
motif?: string;
|
|
56
|
-
refDocType?: string;
|
|
57
|
-
instructionId?: string;
|
|
58
|
-
page?: string;
|
|
59
|
-
size?: number;
|
|
60
|
-
sort?: string;
|
|
61
|
-
fields?: any;
|
|
62
|
-
}): CancelablePromise<DemandePaiementListe>;
|
|
63
|
-
/**
|
|
64
|
-
* Consulter une demande
|
|
65
|
-
* Cet point de terminaison permet de consulter les details d'une demande de paiement.
|
|
66
|
-
*
|
|
67
|
-
* @returns DemandePaiementConsultationReponse Opération effectuée avec succès
|
|
68
|
-
* @throws ApiError
|
|
69
|
-
*/
|
|
70
|
-
static demandePaiementRecuperer({ txId, }: {
|
|
71
|
-
/**
|
|
72
|
-
* L'identifiant de la transaction dans le SI du client business
|
|
73
|
-
*/
|
|
74
|
-
txId: string;
|
|
75
|
-
}): CancelablePromise<DemandePaiementConsultationReponse>;
|
|
76
|
-
/**
|
|
77
|
-
* Confirmer la demande
|
|
78
|
-
* Ce point de terminaison permet d'envoyer la confirmation de l'envoi d'une demande de paiement.
|
|
79
|
-
*
|
|
80
|
-
* Le client business confirme oui ou non si le PSP peut envoyer la demande au payeur après vérification des informations d'identification (nom et pays du payeur).
|
|
81
|
-
*
|
|
82
|
-
* **Idempotence** : Cet endpoint est idempotent.
|
|
83
|
-
* - Premier appel avec `decision: true` → Envoie la demande, retourne `200 OK {statut: "ENVOYE"}`
|
|
84
|
-
* - Appels suivants avec `decision: true` → Retourne `200 OK` avec l'état actuel (ENVOYE, IRREVOCABLE, ou REJETE) - idempotent
|
|
85
|
-
* - Premier appel avec `decision: false` → Annule, retourne `200 OK {statut: "ANNULE"}`
|
|
86
|
-
* - Appels suivants avec `decision: false` → Retourne `200 OK {statut: "ANNULE"}` (idempotent)
|
|
87
|
-
* - `decision: true` après `decision: false` → Retourne `403 Forbidden` (déjà annulé)
|
|
88
|
-
* - `decision: false` après `decision: true` → Retourne `403 Forbidden` (déjà confirmé)
|
|
89
|
-
*
|
|
90
|
-
* **Timeout** : La confirmation doit être envoyée dans les **24 heures** suivant la création de la demande. Passé ce délai, la demande expire automatiquement et ne peut plus être confirmée.
|
|
91
|
-
*
|
|
92
|
-
* **Changement de décision** : Une fois une décision prise, elle est définitive. Impossible de confirmer après avoir annulé, et vice-versa.
|
|
93
|
-
*
|
|
94
|
-
* @returns DemandePaiementConfirmationReponse Opération effectuée avec succès
|
|
95
|
-
* @throws ApiError
|
|
96
|
-
*/
|
|
97
|
-
static demandePaiementConfirmer({ txId, requestBody, }: {
|
|
98
|
-
/**
|
|
99
|
-
* L'identifiant de la transaction dans le SI du payé
|
|
100
|
-
*/
|
|
101
|
-
txId: string;
|
|
102
|
-
/**
|
|
103
|
-
* Le client envoie oui ou non s'il confirme l'envoi de la demande
|
|
104
|
-
*/
|
|
105
|
-
requestBody: DemandePaiementConfirmationRequest;
|
|
106
|
-
}): CancelablePromise<DemandePaiementConfirmationReponse>;
|
|
107
|
-
/**
|
|
108
|
-
* Accepter ou rejeter la demande
|
|
109
|
-
* Ce point de terminaison permet au client d'accepter ou de rejeter une demande de paiement reçue.
|
|
110
|
-
* @returns any Opération effectuée avec succès
|
|
111
|
-
* @throws ApiError
|
|
112
|
-
*/
|
|
113
|
-
static demandePaiementRepondre({ txId, requestBody, }: {
|
|
114
|
-
/**
|
|
115
|
-
* L'identifiant de la transaction dans le SI du client
|
|
116
|
-
*/
|
|
117
|
-
txId: string;
|
|
118
|
-
/**
|
|
119
|
-
* Réponse à la demande de paiement.
|
|
120
|
-
*/
|
|
121
|
-
requestBody: DemandePaiementReponseRequest;
|
|
122
|
-
}): CancelablePromise<any>;
|
|
123
|
-
}
|
|
@@ -1,165 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.DemandesDePaiementService = void 0;
|
|
4
|
-
const OpenAPI_1 = require("../core/OpenAPI");
|
|
5
|
-
const request_1 = require("../core/request");
|
|
6
|
-
class DemandesDePaiementService {
|
|
7
|
-
/**
|
|
8
|
-
* Envoyer une demande
|
|
9
|
-
* Ce point de terminaison permet d'envoyer une demande de paiement.
|
|
10
|
-
*
|
|
11
|
-
* Le business peut définir le champ `confirmation` à `true` pour demander une validation en deux étapes : le PSP retournera d'abord le résultat de la recherche d'alias (avec le nom et le pays du payeur), puis attendra une confirmation explicite avant d'envoyer la demande de paiement au payeur via l'endpoint `PUT /demandes-paiements/{txId}/confirmations`.
|
|
12
|
-
*
|
|
13
|
-
* Si le champ `confirmation` n'est pas défini ou est à `false`, le système envoie directement la demande de paiement au payeur.
|
|
14
|
-
*
|
|
15
|
-
* **Timeout de confirmation** : Si le business demande une validation en deux étapes , il dispose de **24 heures** pour confirmer ou annuler. Passé ce délai, la demande expire automatiquement.
|
|
16
|
-
*
|
|
17
|
-
* @returns DemandePaiementReponse Demande de paiement traitée. Le champ `statut` indique le résultat :
|
|
18
|
-
* - `INITIE` : En attente de confirmation (si `confirmation: true`)
|
|
19
|
-
* - `ENVOYE` : Demande envoyée au payeur avec succès (si `confirmation: false`)
|
|
20
|
-
* - `REJETE` : Demande rejetée. Le champ `statutRaison` contient le code d'erreur :
|
|
21
|
-
* - `DU03` : txId dupliqué (déjà utilisé)
|
|
22
|
-
* - `BE23` : Alias payeur invalide
|
|
23
|
-
* - Autres codes ISO 20022
|
|
24
|
-
*
|
|
25
|
-
* @throws ApiError
|
|
26
|
-
*/
|
|
27
|
-
static demandePaiementCreer({ requestBody, }) {
|
|
28
|
-
return (0, request_1.request)(OpenAPI_1.OpenAPI, {
|
|
29
|
-
method: 'POST',
|
|
30
|
-
url: '/demandes-paiements',
|
|
31
|
-
body: requestBody,
|
|
32
|
-
mediaType: 'application/json',
|
|
33
|
-
errors: {
|
|
34
|
-
400: `La requête est malformée`,
|
|
35
|
-
401: `Autorisations manquantes`,
|
|
36
|
-
429: `Erreur inattendue`,
|
|
37
|
-
503: `Erreur inattendue du serveur`,
|
|
38
|
-
},
|
|
39
|
-
});
|
|
40
|
-
}
|
|
41
|
-
/**
|
|
42
|
-
* Lister les demandes
|
|
43
|
-
* Ce point de terminaison permet de lister les demandes de paiements effectuées par le client.
|
|
44
|
-
* @returns DemandePaiementListe Succès de l'opération
|
|
45
|
-
* @throws ApiError
|
|
46
|
-
*/
|
|
47
|
-
static demandePaiementLister({ payeAlias, payeCompte, dateEnvoi, dateLimitePaiement, statut, categorie, payeurAlias, payeurCompte, montantAchat, montantRetrait, debitDiffere, remise, motif, refDocType, instructionId, page, size, sort, fields, }) {
|
|
48
|
-
return (0, request_1.request)(OpenAPI_1.OpenAPI, {
|
|
49
|
-
method: 'GET',
|
|
50
|
-
url: '/demandes-paiements',
|
|
51
|
-
query: {
|
|
52
|
-
'payeAlias': payeAlias,
|
|
53
|
-
'payeCompte': payeCompte,
|
|
54
|
-
'dateEnvoi': dateEnvoi,
|
|
55
|
-
'dateLimitePaiement': dateLimitePaiement,
|
|
56
|
-
'statut': statut,
|
|
57
|
-
'categorie': categorie,
|
|
58
|
-
'payeurAlias': payeurAlias,
|
|
59
|
-
'payeurCompte': payeurCompte,
|
|
60
|
-
'montantAchat': montantAchat,
|
|
61
|
-
'montantRetrait': montantRetrait,
|
|
62
|
-
'debitDiffere': debitDiffere,
|
|
63
|
-
'remise': remise,
|
|
64
|
-
'motif': motif,
|
|
65
|
-
'refDocType': refDocType,
|
|
66
|
-
'instructionId': instructionId,
|
|
67
|
-
'page': page,
|
|
68
|
-
'size': size,
|
|
69
|
-
'sort': sort,
|
|
70
|
-
'fields': fields,
|
|
71
|
-
},
|
|
72
|
-
errors: {
|
|
73
|
-
401: `Autorisations manquantes`,
|
|
74
|
-
429: `Erreur inattendue`,
|
|
75
|
-
503: `Erreur inattendue du serveur`,
|
|
76
|
-
},
|
|
77
|
-
});
|
|
78
|
-
}
|
|
79
|
-
/**
|
|
80
|
-
* Consulter une demande
|
|
81
|
-
* Cet point de terminaison permet de consulter les details d'une demande de paiement.
|
|
82
|
-
*
|
|
83
|
-
* @returns DemandePaiementConsultationReponse Opération effectuée avec succès
|
|
84
|
-
* @throws ApiError
|
|
85
|
-
*/
|
|
86
|
-
static demandePaiementRecuperer({ txId, }) {
|
|
87
|
-
return (0, request_1.request)(OpenAPI_1.OpenAPI, {
|
|
88
|
-
method: 'GET',
|
|
89
|
-
url: '/demandes-paiements/{txId}',
|
|
90
|
-
path: {
|
|
91
|
-
'txId': txId,
|
|
92
|
-
},
|
|
93
|
-
errors: {
|
|
94
|
-
401: `Autorisations manquantes`,
|
|
95
|
-
404: `La ressource n'existe pas dans le système`,
|
|
96
|
-
429: `Erreur inattendue`,
|
|
97
|
-
503: `Erreur inattendue du serveur`,
|
|
98
|
-
},
|
|
99
|
-
});
|
|
100
|
-
}
|
|
101
|
-
/**
|
|
102
|
-
* Confirmer la demande
|
|
103
|
-
* Ce point de terminaison permet d'envoyer la confirmation de l'envoi d'une demande de paiement.
|
|
104
|
-
*
|
|
105
|
-
* Le client business confirme oui ou non si le PSP peut envoyer la demande au payeur après vérification des informations d'identification (nom et pays du payeur).
|
|
106
|
-
*
|
|
107
|
-
* **Idempotence** : Cet endpoint est idempotent.
|
|
108
|
-
* - Premier appel avec `decision: true` → Envoie la demande, retourne `200 OK {statut: "ENVOYE"}`
|
|
109
|
-
* - Appels suivants avec `decision: true` → Retourne `200 OK` avec l'état actuel (ENVOYE, IRREVOCABLE, ou REJETE) - idempotent
|
|
110
|
-
* - Premier appel avec `decision: false` → Annule, retourne `200 OK {statut: "ANNULE"}`
|
|
111
|
-
* - Appels suivants avec `decision: false` → Retourne `200 OK {statut: "ANNULE"}` (idempotent)
|
|
112
|
-
* - `decision: true` après `decision: false` → Retourne `403 Forbidden` (déjà annulé)
|
|
113
|
-
* - `decision: false` après `decision: true` → Retourne `403 Forbidden` (déjà confirmé)
|
|
114
|
-
*
|
|
115
|
-
* **Timeout** : La confirmation doit être envoyée dans les **24 heures** suivant la création de la demande. Passé ce délai, la demande expire automatiquement et ne peut plus être confirmée.
|
|
116
|
-
*
|
|
117
|
-
* **Changement de décision** : Une fois une décision prise, elle est définitive. Impossible de confirmer après avoir annulé, et vice-versa.
|
|
118
|
-
*
|
|
119
|
-
* @returns DemandePaiementConfirmationReponse Opération effectuée avec succès
|
|
120
|
-
* @throws ApiError
|
|
121
|
-
*/
|
|
122
|
-
static demandePaiementConfirmer({ txId, requestBody, }) {
|
|
123
|
-
return (0, request_1.request)(OpenAPI_1.OpenAPI, {
|
|
124
|
-
method: 'PUT',
|
|
125
|
-
url: '/demandes-paiements/{txId}/confirmations',
|
|
126
|
-
path: {
|
|
127
|
-
'txId': txId,
|
|
128
|
-
},
|
|
129
|
-
body: requestBody,
|
|
130
|
-
mediaType: 'application/json',
|
|
131
|
-
errors: {
|
|
132
|
-
401: `Autorisations manquantes`,
|
|
133
|
-
403: `Opération interdite`,
|
|
134
|
-
404: `La ressource n'existe pas dans le système`,
|
|
135
|
-
429: `Erreur inattendue`,
|
|
136
|
-
503: `Erreur inattendue du serveur`,
|
|
137
|
-
},
|
|
138
|
-
});
|
|
139
|
-
}
|
|
140
|
-
/**
|
|
141
|
-
* Accepter ou rejeter la demande
|
|
142
|
-
* Ce point de terminaison permet au client d'accepter ou de rejeter une demande de paiement reçue.
|
|
143
|
-
* @returns any Opération effectuée avec succès
|
|
144
|
-
* @throws ApiError
|
|
145
|
-
*/
|
|
146
|
-
static demandePaiementRepondre({ txId, requestBody, }) {
|
|
147
|
-
return (0, request_1.request)(OpenAPI_1.OpenAPI, {
|
|
148
|
-
method: 'POST',
|
|
149
|
-
url: '/demandes-paiements/{txId}/reponses',
|
|
150
|
-
path: {
|
|
151
|
-
'txId': txId,
|
|
152
|
-
},
|
|
153
|
-
body: requestBody,
|
|
154
|
-
mediaType: 'application/json',
|
|
155
|
-
errors: {
|
|
156
|
-
401: `Autorisations manquantes`,
|
|
157
|
-
403: `Interdiction d'effectuer le paiement`,
|
|
158
|
-
404: `La ressource n'existe pas dans le système`,
|
|
159
|
-
429: `Erreur inattendue`,
|
|
160
|
-
503: `Erreur inattendue du serveur`,
|
|
161
|
-
},
|
|
162
|
-
});
|
|
163
|
-
}
|
|
164
|
-
}
|
|
165
|
-
exports.DemandesDePaiementService = DemandesDePaiementService;
|