Chargement de vos clés API…

Obtenir un lien d'écriture

POSThttps://staging.mobupay.nc/api/v1/agency/dossiers/{obsId}/write-link

Ce que fait cet appel

Produit un lien d'écriture à usage unique : il ouvre notre parcours d'entrée en relation sur ce dossier, au nom du client, pour que vous le complétiez (identité avec la recherche au registre, personnes, pièces, coordonnées bancaires). Produire le lien, c'est prendre la main : le client n'écrit plus tant que vous ne la lui avez pas transmise.

Bornes : la session vit expiresInMinutes (15 par défaut, 60 au plus), dans la limite de la durée maximale d'une session d'assistance fixée par Mobupay, 30 minutes aujourd'hui : la réponse rend la durée retenue (expiresInMinutes) et l'échéance (expiresAt). Elle se ferme après quinze minutes d'inactivité ; un lien neuf ferme le précédent ; le motif est obligatoire et journalisé.

Refusé : 409 DOSSIER_WITHOUT_HOLDER, 409 HAND_HELD_BY_OTHER (une plateforme tient la main), 409 ENROLLMENT_COMPLETED ou ENROLLMENT_REFUSED (dossier clos), 409 SIMULATED_ENROLLMENT en test.

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.

Paramètres

1 en-tête

obsIdstringRequispath

Identifiant du dossier (`obs_*`).

Corps de la requête

application/json

reasonstringRequis

expiresInMinutesintegerOptionnel

Codes de retour

200

Le lien.

409

Écriture impossible, avec son motif.

Langage

Requête cURLpostExemple

1curl --request POST \

2 --url https://api.mobupay.nc/api/v1/agency/dossiers/{obsId}/write-link \

3 --header 'authorization: Bearer sk_test_XXXX' \

4 --header 'content-type: application/json' \

5 --data '{ "reason": "Saisie des pièces après appel du gérant", "expiresInMinutes": 15 }'

Réponse

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

application/json