Chargement de vos clés API…

Créer une session de portefeuille

POSThttps://api.mobupay.nc/api/v1/customers/{id}/sessions

Ce que fait cet appel

Crée une session d'enregistrement de carte, immédiate et valable quatorze minutes : elle convient au mode intégré, où le composant est monté tout de suite. Pour envoyer une invitation au client, employer plutôt POST /api/v1/customers/{id}/card-links, dont le lien vit plusieurs jours. Aucun montant n'est débité : la carte fait l'objet d'une vérification au montant zéro (ACCOUNT_VERIFICATION), sans autorisation financière ni empreinte à rembourser. Redirigez le client vers redirectUrl ; au retour, il revient sur votre returnUrl avec ?status=success|failed|error et, en cas de succès, ?paymentMethodId=pm_*. La carte enregistrée devient un paymentMethod lié au 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.

Paramètres

1 en-tête

idstringRequispath

Identifiant du client (`cus_*`) ou utiliser la triple identification via `email`/`externalId` dans le body.

Corps de la requête

application/json

returnUrlstringRequis

URL HTTPS de redirection après l'enregistrement. Mobupay y ajoute `?status=success|failed|error`, et `&paymentMethodId=pm_*` en cas de succès.

localestringOptionnel

Code langue de la page d'enregistrement (`fr`, `en`...). 2 a 5 caractères.

emailstringOptionnel

Identifie le client par email si `:id` n'est pas précis. Triple identification.

externalIdstringOptionnel

Identifie le client par identifiant externe. Triple identification.

Codes de retour

201

Session wallet créée.

404

Client introuvable.

Langage

Requête cURLpostExemple

1curl --request POST \

2 --url https://api.mobupay.nc/api/v1/customers/{id}/sessions \

3 --header 'authorization: Bearer sk_test_XXXX' \

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

5 --data '{ "returnUrl": "https://example.com/wallet/return", "locale": "fr" }'

Réponse

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

application/json