Constantes et énumérations

Toutes les valeurs fixes que l'API envoie ou accepte. Comparez toujours sur la valeur (payee), jamais sur un libellé.

Environnements

Valeur	Clé	Signification
`test`	`cvr_test_...`	Sandbox : données fictives, paiements simulés, documents de test.
`live`	`cvr_live_...`	Production : vrais contrats, vrais paiements, documents officiels.

Préfixes des identifiants

Préfixe	Objet	Exemple
`dev_`	Devis	`dev_854bb48d2bdd0fc42a33cf06`
`sou_`	Souscription	`sou_bd4094da89da4a2e0e6078de`
`pay_`	Paiement Mobile Money (mode B)	`pay_a89dc8bc9bf46c794a82987e`
`evt_`	Événement (notification)	`evt_5f1c2a9be04d77a3c1d2e8f0`
`req_`	Référence d'un appel (requete_id)	`req_a1d70f59921bbf78c038f1db`
`CVR-API-`	Contrat de production	`CVR-API-MW25XEIG-A2D52BC9C7`
`TEST-CVR-API-`	Contrat de sandbox	`TEST-CVR-API-MW25XEIG-A2D52BC9C7`

Statut d'une souscription

Valeur	Signification	Suite possible
`en_attente_paiement`	Demande enregistrée, paiement attendu.	Payer (mode A ou B).
`payee`	Paiement confirmé, contrat émis (contrat.numero).	Consulter le contrat et ses documents.
`expiree`	Le devis a expiré (15 jours) avant le paiement.	Demander un nouveau devis.

Statut d'un paiement Mobile Money

Valeur	Signification
`en_attente`	Demande envoyée, le client doit valider sur son téléphone (ou sur lien_paiement).
`reussi`	Le client a payé. Le contrat est émis.
`echoue`	Paiement non abouti (voir motif_echec). La souscription reste payable : relancez un paiement.

Motifs d'échec d'un paiement

motif_echec	Signification	En sandbox
`solde_insuffisant`	Le solde du client ne suffit pas.	`0700000002`
`non_valide_par_le_client`	Le client n'a pas validé le paiement à temps, ou l'a refusé.	`0700000003`
`erreur_operateur`	L'opérateur a rencontré une erreur.	`0700000004`
`refuse_par_operateur`	L'opérateur a refusé le paiement (production).	-
`demande_refusee`	La demande n'a pas pu être transmise à l'opérateur (l'appel a renvoyé service_indisponible).	-

Statut d'un contrat

Valeur	Signification
`actif`	En cours de validité. Statut à son émission.
`expire`	Arrivé à échéance (date_echeance passée).
`suspendu`	Suspendu par COVERAF.
`annule`	Annulé.

Modes de paiement

mode_paiement	Qui encaisse	Appel
`encaissement_partenaire`	Vous (mode A)	POST /v1/souscriptions/{id}/confirmer-paiement
`jeko`	COVERAF, en Mobile Money (mode B)	POST /v1/souscriptions/{id}/paiement

Le mode est fixé pour votre compte par COVERAF et rappelé dans chaque souscription.

Opérateurs

operateur	Libellé	Mode A	Mode B
`orange`	Orange Money	oui	oui
`mtn`	MTN Mobile Money	oui	oui
`moov`	Moov Money	oui	oui
`wave`	Wave	oui	oui
`djamo`	Djamo	oui	oui
`autre`	Autre moyen (banque, carte...)	oui	non

Types de documents

type	Document	Disponible
`conditions_generales`	Conditions Générales	Toujours, et avant paiement (GET /v1/produits/{code}/conditions-generales).
`conditions_particulieres`	Conditions Particulières	Après paiement, tant que le contrat est actif.
`attestation`	Attestation (voyage, une par voyageur)	Après paiement, tant que le contrat est actif.

Types d'événements

type	Envoyé quand
`paiement.reussi`	Mode B : le client a payé.
`paiement.echoue`	Mode B : le paiement a échoué.
`contrat.emis`	Un contrat est émis (modes A et B).
`test.ping`	Vous appelez POST /v1/webhooks/test.

Produits et offres

produit	Offres (offre)
`sante`	`relaxsantecoups_durs`
`habitation`	`securhome_plus`
`commerce`	`securpro`
`vie`	`securvie_500ksecurvie_1m`
`voyage`	`voyage_zone1voyage_zone2`
`accidents`	`accidents_particulieraccidents_vtcaccidents_livreur_moto`

Valeurs des champs de tarification

Champ	Produit	Valeurs
`assures[].role`	Santé	`adherent` `conjoint` `enfant` `autre_adulte`
`assures[].sexe`	Santé	`M` `F`
`statut_occupant`	Habitation, Commerce	`proprietaire` `locataire`
`prevention`	Habitation, Commerce	`aucun` `un_seul` `gardien_et_extincteurs`
`classe`	Commerce	`1` bureau, pharmacie · `2` boutique, épicerie · `3` restaurant, maquis · `4` entrepôt, dépôt
`emplacement`	Commerce	`hors_marche` `marche`
`duree`	Voyage	`7_jours15_jours1_mois2_mois3_mois6_mois1_an_multi_voyages`
`duree_mois`	Accidents	`1` `12`

Numéros de la sandbox

telephone_payeur	Résultat simulé
`0700000001`	Paiement réussi
`0700000002`	Échec : solde_insuffisant
`0700000003`	Échec : non_valide_par_le_client
`0700000004`	Échec : erreur_operateur
tout autre numéro	Paiement réussi

Le résultat arrive 3 secondes après la demande. Voir Sandbox.

Valeurs futures

De nouvelles valeurs peuvent s'ajouter (un opérateur, un motif d'échec, un type d'événement). Prévoyez un cas par défaut dans votre code plutôt qu'une erreur.