MobupayMobupay
Chargement de vos clés API…

Ouvrir le dossier d'un client

POSThttps://staging.mobupay.nc/api/v1/agency/dossiers

Ce que fait cet appel

Ouvre le dossier d'un client en nommant son courriel, et vous en donne la main : vous le constituez pour lui, puis vous le lui transmettez.

Adresse sans compte Mobupay : un compte sans mot de passe est préparé pour le client (il choisira le sien, vous ne le connaîtrez jamais), le dossier est ouvert et prérempli, hand: agency.

Adresse qui a déjà un compte : aucun dossier n'est ouvert sans son accord. Une invitation lui est envoyée, consentRequired: true et hand: pending_consent ; le dossier naît quand il l'accepte, et vous pouvez alors en prendre la main.

Le motif (dix caractères au moins) est obligatoire et journalisé. En test, le dossier est simulé : il naît à DRAFT, main à l'agence.

`prefill.registrationNumber` (Nouvelle-Calédonie) : le RIDET de l'établissement (10 chiffres) ou de l'entreprise (7 chiffres). Mobupay le cherche dans l'annuaire de l'ISEE à l'appel et rend ce qu'il a trouvé dans registry : found (l'établissement est identifié, le dossier le présente présélectionné à l'étape d'identité, et le valider remplit l'identité et récupère l'avis RIDET), not_listed (absent de l'annuaire public, le cas des entrepreneurs individuels : l'étape d'identité le recherche auprès de l'ISEE) ou unavailable (annuaire injoignable à l'appel, même suite). Refusé : 422 ESTABLISHMENT_AMBIGUOUS quand un RID à 7 chiffres compte plusieurs établissements (précisez les 10 chiffres), 409 ESTABLISHMENT_ALREADY_LINKED quand l'établissement fait déjà l'objet d'un dossier ou d'un compte Mobupay.

Le choix de l'établissement reste un geste du parcours : par votre lien d'écriture, ou par votre client.

En-tête d'authentification
Authorization: Bearer sk_test_XXXX

Le pool est déduit du préfixe de la clé

Il n'y a pas d'interrupteur test et production sur cette page. sk_test_* ne traite aucun paiement réel, sk_live_* encaisse.

Corps de la requête

application/json
objectRequis
objectOptionnel
reasonstringRequis
externalRefstringOptionnel
metadataobjectOptionnel
requestedScopearray[string]Optionnel

Codes de retour

201

Dossier ouvert, ou accord attendu.

400

Motif absent ou trop court, IBAN invalide, RIDET qui n'a ni 7 ni 10 chiffres.

409

ESTABLISHMENT_ALREADY_LINKED : l'établissement fait déjà l'objet d'un dossier ou d'un compte Mobupay.

422

ESTABLISHMENT_AMBIGUOUS : le RID à 7 chiffres compte plusieurs établissements ; envoyez le RIDET à 10 chiffres.

Langage

Requête cURLpostExemple
1curl --request POST \
2 --url https://api.mobupay.nc/api/v1/agency/dossiers \
3 --header 'authorization: Bearer sk_test_XXXX' \
4 --header 'content-type: application/json' \
5 --data '{ "holder": { "email": "gerant@snacklagon.nc", "firstName": "Léa" }, "prefill": { "brandName": "Snack du Lagon", "registrationNumber": "1234567001", "iban": "FR7630006000011234567890189" }, "reason": "Le gérant nous a confié la constitution de son dossier", "externalRef": "rest_00412" }'
Réponse

Cliquez sur Essayer pour lancer la requête et voir la réponse ici. Ou choisissez un exemple :

application/json