Aller au contenu
Support

Mode A : vous encaissez

Pour les partenaires qui ont leur propre moyen de paiement (portefeuille Mobile Money, banque, carte). Vous encaissez la prime, puis vous la déclarez : le contrat est émis dans la réponse.

Paiement en mode AVotre clientVotre clientVotre serveurVotre serveurAPI COVERAFAPI COVERAFPOST /v1/souscriptions201 : montant_a_payerEncaisse exactement ce montantPaie (votre propre moyen de paiement)POST /v1/souscriptions/{id}/confirmer-paiement201 : statut payee, contrat.numeroNotification contrat.emis
Mode A : votre encaissement, puis votre déclaration.

Déclarer l'encaissement

POSThttps://api.coveraf.com/v1/souscriptions/{id}/confirmer-paiement
Requête
{
  "reference_transaction": "OM-13733933",
  "operateur": "orange",
  "montant": 12980
}
Réponse 201 : contrat émis
{
  "id": "sou_8a1ab1eb752f13c8f09bb0b6",
  "objet": "souscription",
  "environnement": "test",
  "statut": "payee",
  "devis_id": "dev_68e56446d4b5c6875911f178",
  "montant_a_payer": {
    "montant": 12980,
    "devise": "XOF"
  },
  "mode_paiement": "encaissement_partenaire",
  "date_effet_prevue": "2026-11-04",
  "souscripteur": {
    "nom": "KONE",
    "prenom": "Awa",
    "telephone": "+2250701020304"
  },
  "reference_partenaire": "CMD-2026-0042",
  "paiement": null,
  "contrat": {
    "numero": "TEST-CVR-API-MW2EDTG6-F92441FC41",
    "adresse": "/v1/contrats/TEST-CVR-API-MW2EDTG6-F92441FC41"
  },
  "expire_le": "2026-11-19T17:35:33.439+00:00",
  "payee_le": "2026-11-04T17:35:36.2+00:00",
  "cree_le": "2026-11-04T17:35:33.887733+00:00"
}

Détail des champs et des erreurs : Confirmer un paiement (mode A).

Les règles

  • le montant doit être exactement montant_a_payer.montant de la souscription, sinon montant_incorrect ;
  • chaque reference_transaction (votre référence de l'encaissement) ne sert qu'une fois, sinon reference_deja_utilisee ;
  • déclarez l'encaissement seulement quand l'argent est réellement reçu ;
  • la requête porte une Idempotency-Key : en cas de coupure, renvoyez-la à l'identique, sans risque de double contrat.
Cette déclaration vous engage

La prime déclarée est due à OPTIMUS AFRICA selon votre convention (relevé de reversement). Un plafond de primes non reversées peut s'appliquer à votre compte : au-delà, les nouvelles déclarations sont refusées (plafond_encours_atteint) jusqu'au reversement.

En sandbox

Aucun argent ne circule : vous déclarez le résultat de votre propre encaissement de test, avec une référence de votre choix.