Agence · Guides de recettes
Enrôler un client, de l'invitation au compte ouvert
Une clé sk_agy_* invite vos clients, ouvre leur dossier, et suit son instruction. Voici l'ordre des appels, et comment le recetter en simulation.
1. Déclarer votre adresse de réception
Les événements agency.* partent vers les adresses de votre agence, dans l'environnement de votre clé. Déclarez-en une en test avant tout le reste : la simulation vous enverra les mêmes notifications que la production.
{
"url": "https://app.votre-agence.nc/webhooks/mobupay",
"events": ["agency.client.onboarding.updated", "agency.client.opened", "agency.mandate.revoked"]
}2. Inviter le client
deliveryMode: email fait envoyer le courriel par Mobupay ; redirect vous rend le lien à transmettre. Le préremplissage porte la dénomination, l'enseigne, le RIDET et l'IBAN.
Le RIDET est cherché dans l'annuaire de l'ISEE à l'appel : registry.status vaut found quand l'établissement est identifié (votre client le trouve présélectionné), not_listed quand il est absent de l'annuaire public (l'étape d'identité le recherche auprès de l'ISEE).
Votre externalRef revient dans chaque événement : c'est elle qui rapproche, sans table de correspondance.
{
"email": "gerant@lebonplat.nc",
"deliveryMode": "email",
"prefill": { "brandName": "Le Bon Plat", "registrationNumber": "1234567001", "iban": "FR76…" },
"externalRef": "client_00412"
}En test, l'invitation est simulée
Avec une clé sk_agy_test_*, rien ne part et aucun dossier ne naît. Faites avancer l'enrôlement par POST /api/v1/agency/clients/invitations/{id}/simulation, transition par transition.
3. Ou ouvrir le dossier vous-même
POST /api/v1/agency/dossiers ouvre le dossier en nommant le courriel du client, avec un motif. Un lien d'écriture vous permet ensuite de le constituer ; la transmission le rend au client, qui le relit et le soumet.
Si l'adresse a déjà un compte, consentRequired: true : le dossier naît quand le client accepte l'invitation qui lui est envoyée.
{ "reason": "Saisie des pièces après appel du gérant", "expiresInMinutes": 15 }4. Suivre, et relancer qui doit agir
actionRequired dit qui doit agir : client (relancez-le), agency (à vous), mobupay (l'instruction suit son cours), none.
GET /api/v1/agency/dossiers/{obsId} rend ce qui manque au dossier, jamais le contenu d'une pièce.