pi-spi-sdk 0.1.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.
Files changed (208) hide show
  1. package/CHANGELOG.md +33 -0
  2. package/LICENSE +22 -0
  3. package/README.md +300 -0
  4. package/dist/config.d.ts +35 -0
  5. package/dist/config.js +4 -0
  6. package/dist/error-handler.d.ts +7 -0
  7. package/dist/error-handler.js +52 -0
  8. package/dist/errors.d.ts +25 -0
  9. package/dist/errors.js +40 -0
  10. package/dist/examples.d.ts +8 -0
  11. package/dist/examples.js +91 -0
  12. package/dist/generated/core/ApiError.d.ts +10 -0
  13. package/dist/generated/core/ApiError.js +11 -0
  14. package/dist/generated/core/ApiRequestOptions.d.ts +13 -0
  15. package/dist/generated/core/ApiRequestOptions.js +1 -0
  16. package/dist/generated/core/ApiResult.d.ts +7 -0
  17. package/dist/generated/core/ApiResult.js +1 -0
  18. package/dist/generated/core/CancelablePromise.d.ts +20 -0
  19. package/dist/generated/core/CancelablePromise.js +111 -0
  20. package/dist/generated/core/OpenAPI.d.ts +16 -0
  21. package/dist/generated/core/OpenAPI.js +11 -0
  22. package/dist/generated/core/request.d.ts +34 -0
  23. package/dist/generated/core/request.js +269 -0
  24. package/dist/generated/index.d.ts +78 -0
  25. package/dist/generated/index.js +43 -0
  26. package/dist/generated/models/AliasCreationReponse.d.ts +22 -0
  27. package/dist/generated/models/AliasCreationReponse.js +1 -0
  28. package/dist/generated/models/AliasCreationRequest.d.ts +11 -0
  29. package/dist/generated/models/AliasCreationRequest.js +1 -0
  30. package/dist/generated/models/AliasReponseListe.d.ts +26 -0
  31. package/dist/generated/models/AliasReponseListe.js +1 -0
  32. package/dist/generated/models/AnnulationStatut.d.ts +13 -0
  33. package/dist/generated/models/AnnulationStatut.js +18 -0
  34. package/dist/generated/models/Champs.d.ts +1 -0
  35. package/dist/generated/models/Champs.js +1 -0
  36. package/dist/generated/models/CompteOperation.d.ts +72 -0
  37. package/dist/generated/models/CompteOperation.js +24 -0
  38. package/dist/generated/models/CompteOperationListe.d.ts +18 -0
  39. package/dist/generated/models/CompteOperationListe.js +1 -0
  40. package/dist/generated/models/CompteSolde.d.ts +129 -0
  41. package/dist/generated/models/CompteSolde.js +71 -0
  42. package/dist/generated/models/CompteTransfertIntraReponse.d.ts +33 -0
  43. package/dist/generated/models/CompteTransfertIntraReponse.js +12 -0
  44. package/dist/generated/models/CompteTransfertIntraRequest.d.ts +9 -0
  45. package/dist/generated/models/CompteTransfertIntraRequest.js +1 -0
  46. package/dist/generated/models/DemandePaiementConfirmationAnnulationRaison.d.ts +14 -0
  47. package/dist/generated/models/DemandePaiementConfirmationAnnulationRaison.js +19 -0
  48. package/dist/generated/models/DemandePaiementConfirmationReponse.d.ts +41 -0
  49. package/dist/generated/models/DemandePaiementConfirmationReponse.js +13 -0
  50. package/dist/generated/models/DemandePaiementConfirmationRequest.d.ts +3 -0
  51. package/dist/generated/models/DemandePaiementConfirmationRequest.js +1 -0
  52. package/dist/generated/models/DemandePaiementConfirmationRequestAccepter.d.ts +9 -0
  53. package/dist/generated/models/DemandePaiementConfirmationRequestAccepter.js +1 -0
  54. package/dist/generated/models/DemandePaiementConfirmationRequestRejeter.d.ts +9 -0
  55. package/dist/generated/models/DemandePaiementConfirmationRequestRejeter.js +1 -0
  56. package/dist/generated/models/DemandePaiementConsultationReponse.d.ts +151 -0
  57. package/dist/generated/models/DemandePaiementConsultationReponse.js +27 -0
  58. package/dist/generated/models/DemandePaiementEnMasseConfirmationRequest.d.ts +3 -0
  59. package/dist/generated/models/DemandePaiementEnMasseConfirmationRequest.js +1 -0
  60. package/dist/generated/models/DemandePaiementEnMasseConfirmationRequestAccepter.d.ts +9 -0
  61. package/dist/generated/models/DemandePaiementEnMasseConfirmationRequestAccepter.js +1 -0
  62. package/dist/generated/models/DemandePaiementEnMasseConfirmationRequestRejeter.d.ts +9 -0
  63. package/dist/generated/models/DemandePaiementEnMasseConfirmationRequestRejeter.js +1 -0
  64. package/dist/generated/models/DemandePaiementEnMasseRequest.d.ts +74 -0
  65. package/dist/generated/models/DemandePaiementEnMasseRequest.js +1 -0
  66. package/dist/generated/models/DemandePaiementEnMasseStatutReponse.d.ts +98 -0
  67. package/dist/generated/models/DemandePaiementEnMasseStatutReponse.js +20 -0
  68. package/dist/generated/models/DemandePaiementListe.d.ts +26 -0
  69. package/dist/generated/models/DemandePaiementListe.js +1 -0
  70. package/dist/generated/models/DemandePaiementListeItem.d.ts +163 -0
  71. package/dist/generated/models/DemandePaiementListeItem.js +27 -0
  72. package/dist/generated/models/DemandePaiementReponse.d.ts +129 -0
  73. package/dist/generated/models/DemandePaiementReponse.js +1 -0
  74. package/dist/generated/models/DemandePaiementReponseRequest.d.ts +21 -0
  75. package/dist/generated/models/DemandePaiementReponseRequest.js +11 -0
  76. package/dist/generated/models/DemandePaiementRequest.d.ts +98 -0
  77. package/dist/generated/models/DemandePaiementRequest.js +7 -0
  78. package/dist/generated/models/DemandePaiementRequestBase.d.ts +42 -0
  79. package/dist/generated/models/DemandePaiementRequestBase.js +1 -0
  80. package/dist/generated/models/DemandePaiementRequestCategorie.d.ts +12 -0
  81. package/dist/generated/models/DemandePaiementRequestCategorie.js +17 -0
  82. package/dist/generated/models/DemandePaiementStatut.d.ts +13 -0
  83. package/dist/generated/models/DemandePaiementStatut.js +18 -0
  84. package/dist/generated/models/DemandePaiementStatutRaison.d.ts +46 -0
  85. package/dist/generated/models/DemandePaiementStatutRaison.js +51 -0
  86. package/dist/generated/models/ListeMeta.d.ts +14 -0
  87. package/dist/generated/models/ListeMeta.js +1 -0
  88. package/dist/generated/models/Paiement.d.ts +156 -0
  89. package/dist/generated/models/Paiement.js +28 -0
  90. package/dist/generated/models/PaiementAnnulationMotif.d.ts +17 -0
  91. package/dist/generated/models/PaiementAnnulationMotif.js +22 -0
  92. package/dist/generated/models/PaiementAnnulationReponseRequest.d.ts +11 -0
  93. package/dist/generated/models/PaiementAnnulationReponseRequest.js +1 -0
  94. package/dist/generated/models/PaiementAnnulationReponseRequestAccepter.d.ts +9 -0
  95. package/dist/generated/models/PaiementAnnulationReponseRequestAccepter.js +1 -0
  96. package/dist/generated/models/PaiementAnnulationReponseRequestRejeter.d.ts +9 -0
  97. package/dist/generated/models/PaiementAnnulationReponseRequestRejeter.js +1 -0
  98. package/dist/generated/models/PaiementAnnulationRequest.d.ts +4 -0
  99. package/dist/generated/models/PaiementAnnulationRequest.js +1 -0
  100. package/dist/generated/models/PaiementAnnulationStatutRaison.d.ts +21 -0
  101. package/dist/generated/models/PaiementAnnulationStatutRaison.js +26 -0
  102. package/dist/generated/models/PaiementEnMasseConfirmationRequest.d.ts +3 -0
  103. package/dist/generated/models/PaiementEnMasseConfirmationRequest.js +1 -0
  104. package/dist/generated/models/PaiementEnMasseConfirmationRequestAccepter.d.ts +9 -0
  105. package/dist/generated/models/PaiementEnMasseConfirmationRequestAccepter.js +1 -0
  106. package/dist/generated/models/PaiementEnMasseConfirmationRequestRejeter.d.ts +9 -0
  107. package/dist/generated/models/PaiementEnMasseConfirmationRequestRejeter.js +1 -0
  108. package/dist/generated/models/PaiementEnMasseReponseStatut.d.ts +97 -0
  109. package/dist/generated/models/PaiementEnMasseReponseStatut.js +20 -0
  110. package/dist/generated/models/PaiementEnMasseRequest.d.ts +54 -0
  111. package/dist/generated/models/PaiementEnMasseRequest.js +1 -0
  112. package/dist/generated/models/PaiementImmediatConfirmationReponse.d.ts +31 -0
  113. package/dist/generated/models/PaiementImmediatConfirmationReponse.js +7 -0
  114. package/dist/generated/models/PaiementImmediatConfirmationRequest.d.ts +3 -0
  115. package/dist/generated/models/PaiementImmediatConfirmationRequest.js +1 -0
  116. package/dist/generated/models/PaiementImmediatConfirmationRequestAccepter.d.ts +9 -0
  117. package/dist/generated/models/PaiementImmediatConfirmationRequestAccepter.js +1 -0
  118. package/dist/generated/models/PaiementImmediatConfirmationRequestRejeter.d.ts +9 -0
  119. package/dist/generated/models/PaiementImmediatConfirmationRequestRejeter.js +1 -0
  120. package/dist/generated/models/PaiementImmediatReponse.d.ts +98 -0
  121. package/dist/generated/models/PaiementImmediatReponse.js +7 -0
  122. package/dist/generated/models/PaiementImmediatRequest.d.ts +13 -0
  123. package/dist/generated/models/PaiementImmediatRequest.js +1 -0
  124. package/dist/generated/models/PaiementListe.d.ts +6 -0
  125. package/dist/generated/models/PaiementListe.js +1 -0
  126. package/dist/generated/models/PaiementRequest.d.ts +33 -0
  127. package/dist/generated/models/PaiementRequest.js +1 -0
  128. package/dist/generated/models/PaiementStatut.d.ts +13 -0
  129. package/dist/generated/models/PaiementStatut.js +18 -0
  130. package/dist/generated/models/PaiementStatutRaison.d.ts +56 -0
  131. package/dist/generated/models/PaiementStatutRaison.js +61 -0
  132. package/dist/generated/models/Problem7807.d.ts +31 -0
  133. package/dist/generated/models/Problem7807.js +1 -0
  134. package/dist/generated/models/RefDocType.d.ts +38 -0
  135. package/dist/generated/models/RefDocType.js +43 -0
  136. package/dist/generated/models/RetourStatut.d.ts +13 -0
  137. package/dist/generated/models/RetourStatut.js +18 -0
  138. package/dist/generated/models/RetourStatutRaison.d.ts +25 -0
  139. package/dist/generated/models/RetourStatutRaison.js +30 -0
  140. package/dist/generated/models/WebhookCreationRequest.d.ts +14 -0
  141. package/dist/generated/models/WebhookCreationRequest.js +1 -0
  142. package/dist/generated/models/WebhookCreationResponse.d.ts +12 -0
  143. package/dist/generated/models/WebhookCreationResponse.js +1 -0
  144. package/dist/generated/models/WebhookData.d.ts +8 -0
  145. package/dist/generated/models/WebhookData.js +1 -0
  146. package/dist/generated/models/WebhookEvent.d.ts +191 -0
  147. package/dist/generated/models/WebhookEvent.js +42 -0
  148. package/dist/generated/models/WebhookEventsList.d.ts +13 -0
  149. package/dist/generated/models/WebhookEventsList.js +1 -0
  150. package/dist/generated/models/WebhookList.d.ts +13 -0
  151. package/dist/generated/models/WebhookList.js +1 -0
  152. package/dist/generated/models/WebhookModificationRequest.d.ts +4 -0
  153. package/dist/generated/models/WebhookModificationRequest.js +1 -0
  154. package/dist/generated/models/WebhooksEvents.d.ts +12 -0
  155. package/dist/generated/models/WebhooksEvents.js +17 -0
  156. package/dist/generated/services/AliasService.d.ts +63 -0
  157. package/dist/generated/services/AliasService.js +84 -0
  158. package/dist/generated/services/ComptesService.d.ts +64 -0
  159. package/dist/generated/services/ComptesService.js +86 -0
  160. package/dist/generated/services/DemandeAnnulationService.d.ts +84 -0
  161. package/dist/generated/services/DemandeAnnulationService.js +99 -0
  162. package/dist/generated/services/DemandesDePaiementEnMasseService.d.ts +161 -0
  163. package/dist/generated/services/DemandesDePaiementEnMasseService.js +189 -0
  164. package/dist/generated/services/DemandesDePaiementService.d.ts +123 -0
  165. package/dist/generated/services/DemandesDePaiementService.js +161 -0
  166. package/dist/generated/services/NotificationService.d.ts +80 -0
  167. package/dist/generated/services/NotificationService.js +132 -0
  168. package/dist/generated/services/PaiementEnMasseService.d.ts +159 -0
  169. package/dist/generated/services/PaiementEnMasseService.js +187 -0
  170. package/dist/generated/services/PaiementImmediatService.d.ts +135 -0
  171. package/dist/generated/services/PaiementImmediatService.js +176 -0
  172. package/dist/generated/services/RetoursdeFondsService.d.ts +28 -0
  173. package/dist/generated/services/RetoursdeFondsService.js +37 -0
  174. package/dist/index.d.ts +14 -0
  175. package/dist/index.js +23 -0
  176. package/dist/query-builder.d.ts +91 -0
  177. package/dist/query-builder.js +187 -0
  178. package/dist/sdk.d.ts +88 -0
  179. package/dist/sdk.js +107 -0
  180. package/dist/services/alias.d.ts +72 -0
  181. package/dist/services/alias.js +82 -0
  182. package/dist/services/base.d.ts +9 -0
  183. package/dist/services/base.js +17 -0
  184. package/dist/services/comptes.d.ts +149 -0
  185. package/dist/services/comptes.js +158 -0
  186. package/dist/services/demandes-annulation.d.ts +97 -0
  187. package/dist/services/demandes-annulation.js +104 -0
  188. package/dist/services/demandes-paiement-en-masse.d.ts +139 -0
  189. package/dist/services/demandes-paiement-en-masse.js +139 -0
  190. package/dist/services/demandes-paiement.d.ts +144 -0
  191. package/dist/services/demandes-paiement.js +151 -0
  192. package/dist/services/paiements-en-masse.d.ts +152 -0
  193. package/dist/services/paiements-en-masse.js +153 -0
  194. package/dist/services/paiements.d.ts +135 -0
  195. package/dist/services/paiements.js +135 -0
  196. package/dist/services/retours-fonds.d.ts +94 -0
  197. package/dist/services/retours-fonds.js +100 -0
  198. package/dist/services/webhooks.d.ts +131 -0
  199. package/dist/services/webhooks.js +142 -0
  200. package/dist/types/alias.d.ts +64 -0
  201. package/dist/types/alias.js +73 -0
  202. package/dist/utils/constants.d.ts +93 -0
  203. package/dist/utils/constants.js +93 -0
  204. package/dist/utils/index.d.ts +60 -0
  205. package/dist/utils/index.js +115 -0
  206. package/package.json +81 -0
  207. package/scripts/post-generate.js +129 -0
  208. package/scripts/pre-generate.js +106 -0
@@ -0,0 +1,129 @@
1
+ import type { DemandePaiementRequestCategorie } from './DemandePaiementRequestCategorie';
2
+ import type { DemandePaiementStatut } from './DemandePaiementStatut';
3
+ import type { DemandePaiementStatutRaison } from './DemandePaiementStatutRaison';
4
+ import type { RefDocType } from './RefDocType';
5
+ export type DemandePaiementReponse = {
6
+ /**
7
+ * Identifiant de la demande de paiement dans le SI du client
8
+ */
9
+ txId?: string;
10
+ /**
11
+ * Alias de compte du client payeur à qui est adressé la demande
12
+ */
13
+ payeurAlias?: string;
14
+ /**
15
+ * L'alias de compte dans lequel le client payé souhaite recevoir les paiements
16
+ */
17
+ payeAlias?: string;
18
+ /**
19
+ * Lorsque le PSP recoit la demande, il effectue une recherche d'alias en vue d'obtenir les informations de compte du client payeur.
20
+ *
21
+ * L'attribut `confirmation` permet au client d'indiquer à son PSP si celui-ci doit lui retourner les resultats de la recherche d'alias pour confirmation:
22
+ *
23
+ * * La valeur `true` de la confirmation indique au PSP qu'il doit retourner le resultat de la recherche d'alias au client et attendre une confirmation
24
+ * * La valeur `false` indique qu'une confirmation n'est pas requise pour la demande, de ce fait le PSP transmet directement la demande à PI
25
+ *
26
+ */
27
+ confirmation?: boolean;
28
+ categorie?: DemandePaiementRequestCategorie;
29
+ /**
30
+ * La date limite à laquelle le payeur doit avoir effectuer le paiement.
31
+ * 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 "A payer avant".
32
+ *
33
+ */
34
+ dateLimitePaiement?: string;
35
+ /**
36
+ * C'est la date limite avant laquelle une réponse doit être fournie par le payeur.
37
+ * La demande de paiement expire à cette date. Le client payé ne peut ni accepter ni refuser après cette date.
38
+ * Par défaut, la date limite de réponse est la date de la demande + 92 jours (3 mois).
39
+ *
40
+ */
41
+ dateLimiteReponse?: string;
42
+ /**
43
+ * Le montant du paiement à effectué
44
+ */
45
+ montant?: number;
46
+ /**
47
+ * Le montant de l'achat dans le cadre d'une demande de paiement PICO
48
+ */
49
+ montantAchat?: number;
50
+ /**
51
+ * Le montant du retrait dans le cadre d'une demande de paiement PICO ou PICASH
52
+ */
53
+ montantRetrait?: number;
54
+ /**
55
+ * Les frais de retrait dans le cadre d'une demande de paiement PICO
56
+ */
57
+ montantFrais?: number;
58
+ /**
59
+ * Remise appliquée pour un paiement immédiat dés réception de la demande
60
+ *
61
+ */
62
+ remise?: {
63
+ /**
64
+ * Le montant de la remise
65
+ */
66
+ montant?: number;
67
+ /**
68
+ * Le taux de la remise
69
+ */
70
+ taux?: number;
71
+ };
72
+ /**
73
+ * Indique si le payeur peut acheter maintenant et payer plus tard.
74
+ *
75
+ * La valeur est true pour un paiement immédiat avec débit différé (Acheter maintenant, payer plus tard).
76
+ * Dans le cas du débit différé, le participant du client payeur paye le montant demandé prenant en compte la remise.
77
+ *
78
+ */
79
+ debitDiffere?: boolean;
80
+ /**
81
+ * Le motif de la demande de paiement
82
+ */
83
+ motif?: string;
84
+ /**
85
+ * Le numéro / la reference du document justificatif
86
+ */
87
+ refDocNumero?: string;
88
+ refDocType?: RefDocType;
89
+ statut?: DemandePaiementStatut;
90
+ statutRaison?: DemandePaiementStatutRaison;
91
+ /**
92
+ * Le nom du payeur.
93
+ *
94
+ * **Présence selon le statut :**
95
+ * - `INITIE` (avec confirmation) : Présent ✅
96
+ * - `ENVOYE` (sans confirmation) : Présent ✅
97
+ * - `REJETE` avec BE23 ou DU03 : Absent ❌
98
+ *
99
+ */
100
+ payeurNom?: string;
101
+ /**
102
+ * Le pays de résidence du payeur.
103
+ *
104
+ * **Présence selon le statut :**
105
+ * - `INITIE` (avec confirmation) : Présent ✅
106
+ * - `ENVOYE` (sans confirmation) : Présent ✅
107
+ * - `REJETE` avec BE23 ou DU03 : Absent ❌
108
+ *
109
+ */
110
+ payeurPays?: string;
111
+ /**
112
+ * Identifiant unique de bout en bout de la transaction
113
+ */
114
+ end2endId?: string;
115
+ /**
116
+ * Date d'envoi de la demande de paiement par le business
117
+ */
118
+ dateDemande?: string;
119
+ /**
120
+ * Date d'envoi de la demande de paiement par le participant
121
+ */
122
+ dateEnvoi?: string;
123
+ /**
124
+ * Date de confirmation de la demande si le client avait requis la confirmation de la demande de paiement.
125
+ * Il s'agit de la date et heure à laquelle le client a confirmé la demande.
126
+ *
127
+ */
128
+ dateConfirmation?: string;
129
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,21 @@
1
+ export type DemandePaiementReponseRequest = ({
2
+ /**
3
+ * La décision à `true` indique l'acception de la demande de paiement.
4
+ */
5
+ decision: boolean;
6
+ } | {
7
+ /**
8
+ * La décision à `false` indique le rejet de la demande de paiement.
9
+ */
10
+ decision: boolean;
11
+ raison: DemandePaiementReponseRequest.raison;
12
+ });
13
+ export declare namespace DemandePaiementReponseRequest {
14
+ enum raison {
15
+ BE05 = "BE05",
16
+ AM09 = "AM09",
17
+ APAR = "APAR",
18
+ RR07 = "RR07",
19
+ FR01 = "FR01"
20
+ }
21
+ }
@@ -0,0 +1,11 @@
1
+ export var DemandePaiementReponseRequest;
2
+ (function (DemandePaiementReponseRequest) {
3
+ let raison;
4
+ (function (raison) {
5
+ raison["BE05"] = "BE05";
6
+ raison["AM09"] = "AM09";
7
+ raison["APAR"] = "APAR";
8
+ raison["RR07"] = "RR07";
9
+ raison["FR01"] = "FR01";
10
+ })(raison = DemandePaiementReponseRequest.raison || (DemandePaiementReponseRequest.raison = {}));
11
+ })(DemandePaiementReponseRequest || (DemandePaiementReponseRequest = {}));
@@ -0,0 +1,98 @@
1
+ import type { DemandePaiementRequestBase } from './DemandePaiementRequestBase';
2
+ export type DemandePaiementRequest = (({
3
+ categorie: DemandePaiementRequest.categorie;
4
+ } & DemandePaiementRequestBase) | ({
5
+ categorie: DemandePaiementRequest.categorie;
6
+ /**
7
+ * Montant de l'achat
8
+ */
9
+ montantAchat: number;
10
+ /**
11
+ * Montant du retrait d'espèces (Inclus le montant des frais)
12
+ */
13
+ montantRetrait: number;
14
+ /**
15
+ * Frais de retrait
16
+ */
17
+ montantFrais: number;
18
+ } & DemandePaiementRequestBase) | ({
19
+ categorie: DemandePaiementRequest.categorie;
20
+ /**
21
+ * Montant du retrait d'espèces
22
+ */
23
+ montantRetrait: number;
24
+ /**
25
+ * Frais de retrait
26
+ */
27
+ montantFrais: number;
28
+ } & DemandePaiementRequestBase) | ({
29
+ categorie: DemandePaiementRequest.categorie;
30
+ /**
31
+ * Indique que le paiement est différé (Acheter maintenant, payer plus tard)
32
+ */
33
+ debitDiffere: boolean;
34
+ /**
35
+ * Remise appliquée sur la facture
36
+ */
37
+ remise?: {
38
+ montant?: number;
39
+ taux?: number;
40
+ };
41
+ } & DemandePaiementRequestBase) | ({
42
+ categorie: DemandePaiementRequest.categorie;
43
+ /**
44
+ * Date limite de paiement (2 minutes après création)
45
+ */
46
+ dateLimitePaiement: string;
47
+ } & DemandePaiementRequestBase) | ({
48
+ categorie: DemandePaiementRequest.categorie;
49
+ /**
50
+ * Indique que le paiement est différé
51
+ */
52
+ debitDiffere: boolean;
53
+ /**
54
+ * Remise appliquée
55
+ */
56
+ remise: {
57
+ /**
58
+ * Montant de la remise
59
+ */
60
+ montant?: number;
61
+ /**
62
+ * Taux de remise
63
+ */
64
+ taux?: number;
65
+ };
66
+ } & DemandePaiementRequestBase) | ({
67
+ categorie: DemandePaiementRequest.categorie;
68
+ /**
69
+ * Date limite de paiement de la facture (ex "A payer avant")
70
+ */
71
+ dateLimitePaiement: string;
72
+ /**
73
+ * Date limite de réponse
74
+ */
75
+ dateLimiteReponse?: string;
76
+ } & DemandePaiementRequestBase) | ({
77
+ categorie: DemandePaiementRequest.categorie;
78
+ /**
79
+ * Date limite de paiement
80
+ */
81
+ dateLimitePaiement: string;
82
+ /**
83
+ * Date limite de réponse
84
+ */
85
+ dateLimiteReponse: string;
86
+ /**
87
+ * Remise appliquée sur la facture - la remise n'est pas appliquée après la date limite de paiement
88
+ */
89
+ remise?: {
90
+ montant?: number;
91
+ taux?: number;
92
+ };
93
+ } & DemandePaiementRequestBase));
94
+ export declare namespace DemandePaiementRequest {
95
+ enum categorie {
96
+ _500 = "500"
97
+ }
98
+ }
@@ -0,0 +1,7 @@
1
+ export var DemandePaiementRequest;
2
+ (function (DemandePaiementRequest) {
3
+ let categorie;
4
+ (function (categorie) {
5
+ categorie["_500"] = "500";
6
+ })(categorie = DemandePaiementRequest.categorie || (DemandePaiementRequest.categorie = {}));
7
+ })(DemandePaiementRequest || (DemandePaiementRequest = {}));
@@ -0,0 +1,42 @@
1
+ import type { RefDocType } from './RefDocType';
2
+ export type DemandePaiementRequestBase = {
3
+ /**
4
+ * Identifiant de la demande de paiement dans le SI du client
5
+ */
6
+ txId: string;
7
+ /**
8
+ * Alias de compte du client payeur à qui est adressée la demande
9
+ */
10
+ payeurAlias: string;
11
+ /**
12
+ * L'alias de compte dans lequel le client payé souhaite recevoir les paiements
13
+ */
14
+ payeAlias: string;
15
+ /**
16
+ * L'URL du logo du business ou d'un produit du business qui sera affiché au client payeur
17
+ */
18
+ logoUrl?: string;
19
+ /**
20
+ * Lorsque le PSP reçoit la demande, il effectue une recherche d'alias en vue d'obtenir les informations de compte du client payeur.
21
+ *
22
+ * 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:
23
+ *
24
+ * * 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
25
+ * * La valeur `false` indique qu'une confirmation n'est pas requise pour la demande, de ce fait le PSP transmet directement la demande à PI
26
+ *
27
+ */
28
+ confirmation: boolean;
29
+ /**
30
+ * Le montant total du paiement à effectuer
31
+ */
32
+ montant: number;
33
+ /**
34
+ * Le motif de la demande de paiement
35
+ */
36
+ motif?: string;
37
+ /**
38
+ * Le numéro / la référence du document justificatif
39
+ */
40
+ refDocNumero?: string;
41
+ refDocType?: RefDocType;
42
+ };
@@ -0,0 +1,12 @@
1
+ /**
2
+ * Catégorie de la demande de paiement
3
+ * - `500` Demande de Paiement marchand sur site
4
+ * - `521` Demande de Paiement e-commerce immédiat
5
+ * - `401` Autres demandes de paiement de facture
6
+ *
7
+ */
8
+ export declare enum DemandePaiementRequestCategorie {
9
+ _500 = "500",
10
+ _521 = "521",
11
+ _401 = "401"
12
+ }
@@ -0,0 +1,17 @@
1
+ /* generated using openapi-typescript-codegen -- do not edit */
2
+ /* istanbul ignore file */
3
+ /* tslint:disable */
4
+ /* eslint-disable */
5
+ /**
6
+ * Catégorie de la demande de paiement
7
+ * - `500` Demande de Paiement marchand sur site
8
+ * - `521` Demande de Paiement e-commerce immédiat
9
+ * - `401` Autres demandes de paiement de facture
10
+ *
11
+ */
12
+ export var DemandePaiementRequestCategorie;
13
+ (function (DemandePaiementRequestCategorie) {
14
+ DemandePaiementRequestCategorie["_500"] = "500";
15
+ DemandePaiementRequestCategorie["_521"] = "521";
16
+ DemandePaiementRequestCategorie["_401"] = "401";
17
+ })(DemandePaiementRequestCategorie || (DemandePaiementRequestCategorie = {}));
@@ -0,0 +1,13 @@
1
+ /**
2
+ * - `INITIE` si la confirmation du client est attendue suite à la recherche d'alias
3
+ * - `ENVOYE` si les validations sont concluantes et que le PSP a envoyé la demande
4
+ * - `IRREVOCABLE` si le payeur a accepté la demande
5
+ * - `REJETE` si le payeur rejette la demande
6
+ *
7
+ */
8
+ export declare enum DemandePaiementStatut {
9
+ INITIE = "INITIE",
10
+ ENVOYE = "ENVOYE",
11
+ IRREVOCABLE = "IRREVOCABLE",
12
+ REJETE = "REJETE"
13
+ }
@@ -0,0 +1,18 @@
1
+ /* generated using openapi-typescript-codegen -- do not edit */
2
+ /* istanbul ignore file */
3
+ /* tslint:disable */
4
+ /* eslint-disable */
5
+ /**
6
+ * - `INITIE` si la confirmation du client est attendue suite à la recherche d'alias
7
+ * - `ENVOYE` si les validations sont concluantes et que le PSP a envoyé la demande
8
+ * - `IRREVOCABLE` si le payeur a accepté la demande
9
+ * - `REJETE` si le payeur rejette la demande
10
+ *
11
+ */
12
+ export var DemandePaiementStatut;
13
+ (function (DemandePaiementStatut) {
14
+ DemandePaiementStatut["INITIE"] = "INITIE";
15
+ DemandePaiementStatut["ENVOYE"] = "ENVOYE";
16
+ DemandePaiementStatut["IRREVOCABLE"] = "IRREVOCABLE";
17
+ DemandePaiementStatut["REJETE"] = "REJETE";
18
+ })(DemandePaiementStatut || (DemandePaiementStatut = {}));
@@ -0,0 +1,46 @@
1
+ /**
2
+ *
3
+ * **Raisons de rejet ou d'echec des demandes de paiement :**
4
+ * - **BE23** (Alias invalid) : L'alias du payeur n'existe pas ou est invalide.
5
+ * - **DU03** (Duplicate Transaction) : Le txId n'est pas unique
6
+ *
7
+ * - **AC04** (Closed Account Number) : Le compte du client payeur est clôturé.
8
+ * - **AC06** (Blocked Account) : Le compte du client payeur est bloqué.
9
+ * - **AEXR** (Already Expired RTP) : La demande de paiement a déjà expiré.
10
+ * - **AG03** (Transaction Not Supported) : Le client n'est pas autorisé à payer en mode débit différé.
11
+ * - **AG10** (Agent Suspended) : Le participant payeur est suspendu.
12
+ * - **AG11** (Creditor Agent Suspended) : Le participant payé est désactivé.
13
+ * - **ALAC** (Already Accepted RTP) : La demande de paiement a déjà été acceptée.
14
+ * - **AM02** (Not Allowed Amount) : Le montant spécifique de la transaction dépasse le montant maximum autorisé.
15
+ * - **AM09** (Wrong Amount) : Le montant reçu ne correspond pas au montant convenu ou attendu.
16
+ * - **AM14** (Amount Exceeds Agreed Limit) : Le montant de la transaction fait dépasser le plafond de débit différé du client.
17
+ * - **APAR** (Already Paid RTP) : Le paiement demandé a déjà été effectué par le payeur.
18
+ * - **ARFR** (Already Refused RTP) : La demande de paiement a déjà été refusée.
19
+ * - **ARJR** (Already Rejected RTP) : La demande de paiement a déjà été rejetée.
20
+ * - **BE01** (Inconsistent With End Customer) : L'identification du client final n'est pas liée au numéro de compte associé.
21
+ * - **BE05** (Unrecognised Initiating Party) : La partie qui a initié le message n'est pas reconnue par le client final.
22
+ * - **FR01** (Fraud) : Rejeté pour suspicion de fraude.
23
+ * - **RR07** (Remittance Information Invalid) : Le justificatif de la demande de paiement est invalide (par exemple, le numéro de facture est invalide).
24
+ *
25
+ */
26
+ export declare enum DemandePaiementStatutRaison {
27
+ BE23 = "BE23",
28
+ DU03 = "DU03",
29
+ AC04 = "AC04",
30
+ AC06 = "AC06",
31
+ AEXR = "AEXR",
32
+ AG03 = "AG03",
33
+ AG10 = "AG10",
34
+ AG11 = "AG11",
35
+ ALAC = "ALAC",
36
+ AM02 = "AM02",
37
+ AM09 = "AM09",
38
+ AM14 = "AM14",
39
+ APAR = "APAR",
40
+ ARFR = "ARFR",
41
+ ARJR = "ARJR",
42
+ BE01 = "BE01",
43
+ BE05 = "BE05",
44
+ FR01 = "FR01",
45
+ RR07 = "RR07"
46
+ }
@@ -0,0 +1,51 @@
1
+ /* generated using openapi-typescript-codegen -- do not edit */
2
+ /* istanbul ignore file */
3
+ /* tslint:disable */
4
+ /* eslint-disable */
5
+ /**
6
+ *
7
+ * **Raisons de rejet ou d'echec des demandes de paiement :**
8
+ * - **BE23** (Alias invalid) : L'alias du payeur n'existe pas ou est invalide.
9
+ * - **DU03** (Duplicate Transaction) : Le txId n'est pas unique
10
+ *
11
+ * - **AC04** (Closed Account Number) : Le compte du client payeur est clôturé.
12
+ * - **AC06** (Blocked Account) : Le compte du client payeur est bloqué.
13
+ * - **AEXR** (Already Expired RTP) : La demande de paiement a déjà expiré.
14
+ * - **AG03** (Transaction Not Supported) : Le client n'est pas autorisé à payer en mode débit différé.
15
+ * - **AG10** (Agent Suspended) : Le participant payeur est suspendu.
16
+ * - **AG11** (Creditor Agent Suspended) : Le participant payé est désactivé.
17
+ * - **ALAC** (Already Accepted RTP) : La demande de paiement a déjà été acceptée.
18
+ * - **AM02** (Not Allowed Amount) : Le montant spécifique de la transaction dépasse le montant maximum autorisé.
19
+ * - **AM09** (Wrong Amount) : Le montant reçu ne correspond pas au montant convenu ou attendu.
20
+ * - **AM14** (Amount Exceeds Agreed Limit) : Le montant de la transaction fait dépasser le plafond de débit différé du client.
21
+ * - **APAR** (Already Paid RTP) : Le paiement demandé a déjà été effectué par le payeur.
22
+ * - **ARFR** (Already Refused RTP) : La demande de paiement a déjà été refusée.
23
+ * - **ARJR** (Already Rejected RTP) : La demande de paiement a déjà été rejetée.
24
+ * - **BE01** (Inconsistent With End Customer) : L'identification du client final n'est pas liée au numéro de compte associé.
25
+ * - **BE05** (Unrecognised Initiating Party) : La partie qui a initié le message n'est pas reconnue par le client final.
26
+ * - **FR01** (Fraud) : Rejeté pour suspicion de fraude.
27
+ * - **RR07** (Remittance Information Invalid) : Le justificatif de la demande de paiement est invalide (par exemple, le numéro de facture est invalide).
28
+ *
29
+ */
30
+ export var DemandePaiementStatutRaison;
31
+ (function (DemandePaiementStatutRaison) {
32
+ DemandePaiementStatutRaison["BE23"] = "BE23";
33
+ DemandePaiementStatutRaison["DU03"] = "DU03";
34
+ DemandePaiementStatutRaison["AC04"] = "AC04";
35
+ DemandePaiementStatutRaison["AC06"] = "AC06";
36
+ DemandePaiementStatutRaison["AEXR"] = "AEXR";
37
+ DemandePaiementStatutRaison["AG03"] = "AG03";
38
+ DemandePaiementStatutRaison["AG10"] = "AG10";
39
+ DemandePaiementStatutRaison["AG11"] = "AG11";
40
+ DemandePaiementStatutRaison["ALAC"] = "ALAC";
41
+ DemandePaiementStatutRaison["AM02"] = "AM02";
42
+ DemandePaiementStatutRaison["AM09"] = "AM09";
43
+ DemandePaiementStatutRaison["AM14"] = "AM14";
44
+ DemandePaiementStatutRaison["APAR"] = "APAR";
45
+ DemandePaiementStatutRaison["ARFR"] = "ARFR";
46
+ DemandePaiementStatutRaison["ARJR"] = "ARJR";
47
+ DemandePaiementStatutRaison["BE01"] = "BE01";
48
+ DemandePaiementStatutRaison["BE05"] = "BE05";
49
+ DemandePaiementStatutRaison["FR01"] = "FR01";
50
+ DemandePaiementStatutRaison["RR07"] = "RR07";
51
+ })(DemandePaiementStatutRaison || (DemandePaiementStatutRaison = {}));
@@ -0,0 +1,14 @@
1
+ export type ListeMeta = {
2
+ /**
3
+ * total d'éléments correspondants à la recherche
4
+ */
5
+ length?: number;
6
+ /**
7
+ * numéro ou identifiant de la page suivante
8
+ */
9
+ page?: number;
10
+ /**
11
+ * nombre d'éléments retournés
12
+ */
13
+ limit?: number;
14
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,156 @@
1
+ import type { AnnulationStatut } from './AnnulationStatut';
2
+ import type { PaiementAnnulationMotif } from './PaiementAnnulationMotif';
3
+ import type { PaiementAnnulationStatutRaison } from './PaiementAnnulationStatutRaison';
4
+ import type { PaiementRequest } from './PaiementRequest';
5
+ import type { PaiementStatut } from './PaiementStatut';
6
+ import type { PaiementStatutRaison } from './PaiementStatutRaison';
7
+ import type { RetourStatut } from './RetourStatut';
8
+ import type { RetourStatutRaison } from './RetourStatutRaison';
9
+ export type Paiement = (PaiementRequest & {
10
+ /**
11
+ * Lorsque le PSP recoit la demande, il effectue une recherche d'alias en vue d'obtenir les informations de compte du client payé.
12
+ *
13
+ * L'attribut `confirmation` permet au client d'indiquer à son PSP si celui-ci doit lui retourner les resultats de la recherche d'alias pour confirmation:
14
+ *
15
+ * - La valeur `true` de la validation indique au PSP qu'il doit retourner le resultat de la recherche d'alias au client et attendre une validation avant d'effectuer le paiement.
16
+ * - La valeur `false` indique qu'une validation n'est pas requise pour la demande, de ce fait, le PSP transmet la demande à PI sans attendre la validation du client business.
17
+ *
18
+ */
19
+ confirmation?: boolean;
20
+ /**
21
+ * Le nom du payé (Retourné dans le cas d'un paiement envoyé)
22
+ */
23
+ payeNom?: string;
24
+ /**
25
+ * Le pays de residence du payé (Retourné dans le cas d'un paiement envoyé)
26
+ */
27
+ payePays?: string;
28
+ /**
29
+ * Le nom du payeur (Retourné dans le cas d'un paiement reçu)
30
+ */
31
+ payeurNom?: string;
32
+ /**
33
+ * Le pays de residence du payeur (Retourné dans le cas d'un paiement reçu)
34
+ */
35
+ payeurPays?: string;
36
+ /**
37
+ * Le numéro de compte du payeur
38
+ */
39
+ payeurCompte?: string;
40
+ /**
41
+ * Le numéro de compte du payé
42
+ */
43
+ payeCompte?: string;
44
+ /**
45
+ * La catégorie du paiement / Canal de paiement
46
+ * - `631` Demande de paiement provenant d'un particulier
47
+ * - `000` Paiement par QR Code Statique
48
+ * - `400` Paiement par QR Code Dynamique
49
+ * - `733` Ordre de paiement via l'API Business
50
+ * - `300` Via le canal USSD
51
+ * - `999` Ordre de transfert bancaire
52
+ * - `500` Demande de Paiement sur site
53
+ * - `521` Demande de Paiement e-commerce
54
+ * - `401` Autres demandes de paiement de facture
55
+ *
56
+ */
57
+ categorie?: Paiement.categorie;
58
+ statut?: PaiementStatut;
59
+ statutRaison?: PaiementStatutRaison;
60
+ /**
61
+ * Identifiant unique de bout en bout de la transaction
62
+ */
63
+ end2endId?: string;
64
+ /**
65
+ * Identifiant du paiement en masse dans le SI du client
66
+ */
67
+ instructionId?: string;
68
+ /**
69
+ * Les frais appliqués par le participant (Optionnel - dépend du modèle de facturation utilisé par le participant)
70
+ */
71
+ montantFrais?: number;
72
+ /**
73
+ * Date de création du paiement: date et heure à laquelle le paiement a été initié par le client business.
74
+ *
75
+ */
76
+ dateDemande?: string;
77
+ /**
78
+ * Date de confirmation de la demande si le client payé avait requis la confirmation du paiement.
79
+ * Il s'agit de la date et heure à laquelle le client a confirmé la transaction.
80
+ *
81
+ * Pour un paiement reçu, cette date correspond à la date de confirmation du paiement par le payeur.
82
+ *
83
+ */
84
+ dateConfirmation?: string;
85
+ /**
86
+ * Date d'envoi de la demande: date et heure à laquelle le paiement est envoyé par le participant (PSP)
87
+ *
88
+ */
89
+ dateEnvoi?: string;
90
+ /**
91
+ * Date à laquelle le paiement est irrévocable
92
+ *
93
+ */
94
+ dateIrrevocabilite?: string;
95
+ /**
96
+ * Date à laquelle la réponse du paiement a été reçue
97
+ *
98
+ */
99
+ dateReponse?: string;
100
+ retourStatut?: RetourStatut;
101
+ retourStatutRaison?: RetourStatutRaison;
102
+ /**
103
+ * Date de création du paiement: date et heure à laquelle le retour de fonds a été initié par le client business.
104
+ *
105
+ */
106
+ retourDateDemande?: string;
107
+ /**
108
+ * Date à laquelle le retour de fonds est irrévocable
109
+ *
110
+ */
111
+ retourDateIrrevocabilite?: string;
112
+ /**
113
+ * Date à laquelle la réponse au retour de fonds a été reçue
114
+ *
115
+ */
116
+ retourDateReponse?: string;
117
+ annulationStatut?: AnnulationStatut;
118
+ annulationMotif?: PaiementAnnulationMotif;
119
+ annulationStatutRaison?: PaiementAnnulationStatutRaison;
120
+ /**
121
+ * Date de reception de la demande d'annulation par le participant
122
+ *
123
+ */
124
+ annulationDateDemande?: string;
125
+ /**
126
+ * Date à laquelle la réponse à la demande d'annulation a été reçue (Date de rejet de la demande)
127
+ *
128
+ */
129
+ annulationDateReponse?: string;
130
+ });
131
+ export declare namespace Paiement {
132
+ /**
133
+ * La catégorie du paiement / Canal de paiement
134
+ * - `631` Demande de paiement provenant d'un particulier
135
+ * - `000` Paiement par QR Code Statique
136
+ * - `400` Paiement par QR Code Dynamique
137
+ * - `733` Ordre de paiement via l'API Business
138
+ * - `300` Via le canal USSD
139
+ * - `999` Ordre de transfert bancaire
140
+ * - `500` Demande de Paiement sur site
141
+ * - `521` Demande de Paiement e-commerce
142
+ * - `401` Autres demandes de paiement de facture
143
+ *
144
+ */
145
+ enum categorie {
146
+ _631 = "631",
147
+ _000 = "000",
148
+ _400 = "400",
149
+ _733 = "733",
150
+ _300 = "300",
151
+ _999 = "999",
152
+ _500 = "500",
153
+ _521 = "521",
154
+ _401 = "401"
155
+ }
156
+ }