Cette page spécifie les évènements émis par le moteur de workflow vers le puit de données de l'EP.
Format
Ces évènements sont au format JSON, avec la structure générique ci-dessous:
{
"source": "B.EP.BPM",
"uid": "string",
"correlationId": "string",
"timestamp": "string",
"type": "string",
"params": [
{
"type": "string",
"name": "string",
"value": [] ou {} ou "string"
}
]
}
En détail:| Champ | Description | Exemple |
|---|---|---|
| source | La source de l'évènement : B.EP.BPM, pour serveur Back de Business Process Management de l'EP | "B.EP.BPM" |
| uid | Identifiant unique | "I190925T161713698S00000301" |
| correlationId | Identifiant de corrélation, qui permet de corréler l'ensemble des évènements d'une vacation | "d6e15128-dfa1-11e9-9fab-7c2a3123212b" |
| timestamp | Horodatage au format yyyy-MM-dd'T'HH:mm:ss.SSSZ | "2019-09-25T16:36:21.656+0200" |
| type | Type d'évènement.
Pour un démarrage de vacation, il est valorisé en concaténant le préfixe "start-" + l’identifiant du type de vacation. Pour une fin de vacation, il est valorisé en concaténant le préfixe "end-" + l’identifiant du type de vacation. Pour une fin de vacation en erreur, il est valorisé en concaténant le préfixe "end-with-error-" + l’identifiant du type de vacation. Les identifiants de vacation : "vacation-reglement-virements" | "vacation-reglement-transactions" | "vacation-reglement-impayes" | "vacation-creances" | "vacation-financiere" | "vacation-technique"
Consultation de solde: "get-account-balance" Création de transaction: "create-account-transaction"
"create-transfer"
"validate-cashout"
"register-debt" | "start-vacation-financiere" "end-vacation-financiere" "get-account-balance" "create-account-transaction" "create-transfer" "validate-cashout" "register-debt" "start-vacation-technique" "end-vacation-technique" |
| params | Tableaux des éventuels paramètres. | |
| params[*].type | Type du paramètre : "input" | "output" selon entrée | sortie | |
| params[*].name | Nom du paramètre | |
| params[*].value | Valeur du paramètre. Cela peut être un tableau, un objet json, ou une string | "Fichier.CRE.EP.TI.UEP.txt" |
Focus fonctionnels
Démarrage de vacation de règlement ("type":"start-vacation-reglement-...")
Ces vacations ont 2 paramètres valorisés:
- "globalTransaction": détail du mouvement sur le compte de Règlement
- "file": nom du fichier CRE des transactions CB2C à traiter
Trame JSON
{"source":"B.EP.BPM","uid":"I190925T161713327S00000201","correlationId":"d98a782f-dfa1-11e9-9fab-7c2a3123212b","timestamp":"2019-09-25T16:36:24.580+0200","type":"start-vacation-reglement-transactions","params":[{"type":"input","name":"globalTransaction","value":{"id":"dHJhbnNhY3Rpb240NTQyNDQ4","label":"REM E 100 00000120190725UEP","amount":{"currency":"EUR","value":1675264.66},"bookedDate":"2017-06-27T13:21:15.125Z","transactionDate":"2017-06-27T13:21:15.125Z","valueDate":"2017-06-27T13:21:15.125Z","type":"transfer","status":"booked","vacation":"TRANSACTION","reference":"00000120190725UEP","operationType":"100"}},{"type":"input","name":"file","value":"Fichier.CRE.EP.TI.UEP.txt"}]}
Les données à exploiter:
Ajout de transaction sur un compte de Paiement ("type":"create-account-transaction")
2 paramètres valorisés:
- "accountId": identifiant du compte de paiement, en provenance du fichier d'actu commerçants
- "transaction": la transaction ajoutée au compte de Paiement
Trame JSON
{"source":"B.EP.BPM","uid":"I190925T161717175S00000501","correlationId":"7806ac5e-dfa2-11e9-81fa-7c2a3123212b","timestamp":"2019-09-25T16:40:53.626+0200","type":"create-account-transaction","params":[{"type":"input","name":"accountId","value":"1A17660007"},{"type":"input","name":"transaction","value":{"label":"RBCRR CB10:25:55C1234567121119","amount":{"currency":"EUR","value":10.11},"transactionDate":"2019-09-25T16:40:53.571+0200","valueDate":"2019-09-25T16:40:53.571+0200"}}]}
Les données à exploiter:
Consultation du solde d'un compte ("type":"get-account-balance")
2 paramètres valorisés:
- "accountId": identifiant du compte, en provenance du fichier d'actu commerçants si compte de paiement, sinon l'un des 3 trois comptes ABI (règlement/cantonnement/fonctionnement)
- "balance": le solde du compte
Trame JSON
{"source":"B.EP.BPM","uid":"I190925T161717175S00000601","correlationId":"7806ac5e-dfa2-11e9-81fa-7c2a3123212b","timestamp":"2019-09-25T16:50:53.626+0200","type":"get-account-balance","params":[{"type":"input","name":"accountId","value":"1A17660007"},{"type":"output","name":"balance","value":"101.50"}]}
Les données à exploiter:
Demande de virement(s) ("type":"create-transfer")
1 paramètre valorisé:
- "orders": un tableau des ordres de virement à effectuer
Trame JSON
{"source":"B.EP.BPM","uid":"I200107T142714994S00000601","correlationId":"af0dd152-3159-11ea-b6f8-7c2a3123212b","timestamp":"2020-01-07T15:27:14.994+0100","type":"create-transfer","params":[{"type":"input","name":"orders","value":[{"refExterne":"af0dd152-3159-11ea-b6f8-7c2a3123212b-1578407231973","orderType":"V","creditorName":"MONEXT","creditorBic":"CMBRFR2BARK","creditorIban":"FR7615589297530028192724052","debtorName":"MONEXT","debtorBic":"CMBRFR2BARK","debtorIban":"FR7615589297530028192724246","amount":7.31,"deviseId":"EUR","ccy":"EUR","bankId":"999999","orderFormat":"PAIN.001.001.03","echeance":"2017-06-27T13:21:15.125Z","info":"COMCO CB15:27:11","bulkId":"cb511424-3159-11ea-b6f8-7c2a3123212b"}]}]}
Les données à exploiter:
Enregistrement de créance ("type":"register-debt")
1 paramètre valorisé:
- "merchant-debt": la créance d'un commerçant à créer ou mettre à jour
Trame JSON
{"source":"B.EP.BPM","uid":"I190925T161717175S00000701","correlationId":"7806ac5e-dfa2-11e9-81fa-7c2a3123212b","timestamp":"2019-09-25T16:50:53.626+0200","type":"register-debt","params":[{"type":"input","name":"merchant-debt","value":{"siret":"05009403605518","initialAmount":1000.5,"remainingAmount":1000.5,"creationDate":"2019-09-25T16:50:53.626+0200","modificationDate":null}}]}
Les données à exploiter:
Demande de récupération de transaction ("type":"get-account-transactions")
1 paramètre valorisé :
- "accountId": identifiant du compte, en provenance du fichier d'actu commerçants si compte de paiement, sinon l'un des 3 trois comptes ABI (règlement/cantonnement/fonctionnement)
Trame JSON
{"source":"B.EP.BPM","uid":"I190925T161717175S00000601","correlationId":"f6a8384d-faf2-11e9-992d-484d7edf4a17","timestamp":"2019-10-30T10:50:53.626+0200","type":"get-account-transactions","params":[{"type":"input","name":"accountId","params":[{"type":"input","name":"accountId","value":"1A18350001"},{"type":"output","name":"transactions","value":[{"id":"idTest1", "label":"LOT REJ VIR 192837544970 02","amount":{"currency":"EUR","value":2},"bookedDate":"2019-10-23T12:00:00Z","transactionDate":"2019-09-25T16:40:53.571+0200","valueDate":"2019-09-25T16:40:53.571+0200"} ,{"id":"idTest2", "label":"REM VIR MONEXTEUR20191009002","amount":{"currency":"EUR","value":-21},"bookedDate":"2019-10-23T12:00:00Z","transactionDate":"2019-09-25T16:40:53.571+0200","valueDate":"2019-09-25T16:40:53.571+0200"},{"id":"idTest3", "label":"REM VIR MONEXTEUR20191009001","amount":{"currency":"EUR","value":-52},"bookedDate":"2019-10-09T12:00:00Z","transactionDate":"2019-09-25T16:40:53.571+0200","valueDate":"2019-09-25T16:40:53.571+0200"}]}]}
Ajout d'une transaction rejetée de type mouvement Payline sur le compte de paiement ("type":"create-rejected-account-transaction")
5 paramètres valorisés :
- "accountId": identifiant du compte, en provenance du fichier d'actu commerçants si compte de paiement, sinon l'un des 3 trois comptes ABI (règlement/cantonnement/fonctionnement)
- "operationCode" : label comptable de l'opération
- "transaction" : le mouvement rejeté
- "rejectCode" : le motif du rejet sous forme de code (cf détail codes ici : Spécification technique versement manuel )
- "endToEndId" : identifiant provenant du fichier Payline
Trame JSON
{"source":"B.EP.BPM","uid":"R210809T100254324S00547301","correlationId":"f14e2458-f8f8-11eb-a917-0050569b2781","timestamp":"2021-08-09T12:02:54.324+0200","type":"create-rejected-account-transaction","params":[{"type":"input","name":"operationCode","value":"TRANS 12:02:54"},{"type":"input","name":"accountId","value":"DC09255102"},{"type":"input","name":"transaction","value":{"label":"Transfert de fonds CP Ã CP","amount":{"currency":"EUR","value":250.00},"transactionDate":"2021-08-09T12:02:54Z","valueDate":"2021-08-09T12:02:54Z"}},{"type":"input","name":"rejectCode","value":"AM02"},{"type":"input","name":"endToEndId","value":"2103150015038794"}]}
Ajout d'une transaction de type virement Payline ("type":"create-validated-order")
3 paramètres sont valorisés ;
- "accountId": identifiant du compte, en provenance du fichier d'actu commerçants si compte de paiement, sinon l'un des 3 trois comptes ABI (règlement/cantonnement/fonctionnement)
- "endToEndId" : identifiant provenant du fichier Payline
- "orders": un tableau des ordres de virement à effectuer
Trame JSON
{"source":"B.EP.BPM","uid":"R210602T102351144S00004501","correlationId":"8d661f6b-c38c-11eb-badc-0050569b2781","timestamp":"2021-06-02T12:23:51.144+0200","type":"create-validated-order","params":[{"type":"input","name":"orders","value":[{"refExterne":"9fe1b965-c38c-11eb-badc-0050569b2781-1622629431131","orderType":"V","creditorName":"ext","creditorBic":"SOGEFRPPXXX","creditorIban":"FR892193300001PNM1I3223UV55","debtorName":"Commercant_3_bis_CM","debtorBic":"CMBRFR2BARK","debtorIban":"FR7617028922821276386284526","amount":1.5E+2,"deviseId":"EUR","ccy":"EUR","bankId":"999999","orderFormat":"PAIN.001.001.03","echeance":"2021-06-02","info":"PAYOUT202105190021"}]},{"type":"input","name":"endToEndId","value":"2103150015038811"},{"type":"input","name":"accountId","value":"DC09255105"}]}
Ajout d'une transaction rejetée de type virement Payline ("type":"create-rejected-order")
4 paramètres sont valorisés ;
- "accountId": identifiant du compte, en provenance du fichier d'actu commerçants si compte de paiement, sinon l'un des 3 trois comptes ABI (règlement/cantonnement/fonctionnement)
- "endToEndId" : identifiant provenant du fichier Payline
- "orders": un tableau des ordres de virement à effectuer
- "rejectCode" : le motif du rejet sous forme de code (cf détail codes ici : Spécification technique versement manuel )
Trame JSON
{"source":"B.EP.BPM","uid":"R210809T100257536S00548501","correlationId":"f14e2458-f8f8-11eb-a917-0050569b2781","timestamp":"2021-08-09T12:02:57.536+0200","type":"create-rejected-order","params":[{"type":"input","name":"orders","value":[{"refExterne":"f8bcc303-f8f8-11eb-a917-0050569b2781-1628503377528","orderType":"V","creditorName":"Ext","creditorBic":"SOGEFRPPXXX","creditorIban":"FR0730003000305224397445A56","debtorName":"UNKNOWN","debtorBic":"CMBRFR2BARK","debtorIban":"FR7617028922820289045644093","amount":2E+2,"deviseId":"EUR","ccy":"EUR","bankId":"999999","orderFormat":"PAIN.001.001.03","echeance":"2021-08-09","info":"PAYOUT202105190013"}]},{"type":"input","name":"rejectCode","value":"AG01"},{"type":"input","name":"endToEndId","value":"2103150015038796"},{"type":"input","name":"accountId","value":"DC99999999"}]}
Ajouter un commentaire