MobupayMobupay
Chargement de vos clés API…

Créer un lien d'enregistrement de carte

POSThttps://api.mobupay.nc/api/v1/customers/{id}/card-links

Ce que fait cet appel

Crée un lien d'enregistrement de carte à transmettre au client. Contrairement à une session, ce lien vit plusieurs jours : la session sécurisée n'est ouverte qu'au moment où le client l'ouvre. C'est ce qu'il faut pour envoyer une invitation par e-mail ou par message ; une session, elle, ne vaut que quatorze minutes et convient au mode intégré, où le composant est monté immédiatement. L'enregistrement lui-même ne débite rien : la carte fait l'objet d'une vérification au montant zéro. Avec abonnement, le client voit l'échéancier avant de valider, l'abonnement naît dès l'enregistrement de sa carte, et l'événement subscription.created vous en donne l'identifiant, avec cardLinkId. Au retour, le client atterrit sur la page d'issue Mobupay, qui lui dit ce qui vient de se passer.

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

2 en-têtes
idstringRequispath

Identifiant du client (`cus_*`), ou triple identification via `email` / `externalId` dans le corps.

Idempotency-KeystringOptionnelheader

Clé d'idempotence facultative (255 caractères au plus, UUID v4 recommandé). Un nouvel envoi de la même demande sous la même clé, dans les 24 heures, rend la réponse de la première exécution sans rien réexécuter. Cf. le guide Idempotence.

Corps de la requête

application/json
purposestringOptionnel

`register` : le client enregistre une carte. `manage` : il consulte et gère celles qu'il a déjà. Défaut `register`.

expiresInintegerOptionnel

Durée de vie du lien, en secondes. De 900 (15 min) à 7 776 000 (90 jours). Défaut 604 800 (7 jours).

emailstringOptionnel

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

externalIdstringOptionnel

Identifie le client par identifiant externe. Triple identification.

usagestringOptionnel

Ce que la carte servira. `one_click` : votre client repaiera lui-même. `unscheduled` : vous la débiterez sans lui, par exemple pour un abonnement. Défaut `one_click`.

sendByEmailbooleanOptionnel

Envoie le lien à votre client par e-mail. Défaut `false` : le lien vous est seulement rendu, à transmettre vous-même.

recipientEmailstringOptionnel

Destinataire de l'e-mail. Par défaut, l'adresse du client. Obligatoire avec `sendByEmail` si le client n'a pas d'adresse ; la confirmation d'enregistrement lui est alors envoyée aussi.

objectOptionnel

Fait naître un abonnement à l'enregistrement de la carte. Le client voit l'échéancier sur la page du lien et l'accepte en enregistrant sa carte. Mêmes champs et mêmes règles que `POST /api/v1/subscriptions`. Ne se combine pas avec `usage`, ni avec `purpose: "manage"`. `endsOn` et `maxOccurrences` s'excluent.

Codes de retour

201

Lien créé.

400

Corps invalide (ValidationError, le détail par champ dans fields), clé d'idempotence de plus de 255 caractères (IDEMPOTENCY_KEY_INVALID), ou sendByEmail demandé pour un client sans adresse e-mail et sans recipientEmail (RECIPIENT_REQUIRED).

404

Client introuvable.

409

IDEMPOTENCY_KEY_REUSED : la clé a déjà servi à une demande différente (autre client ou autre corps). IDEMPOTENCY_REQUEST_IN_PROGRESS : la première demande sous cette clé est encore en cours ; renvoyez-la à l'identique quelques secondes plus tard. Un nouvel envoi de la même demande dans les 24 heures rend le lien d'origine, avec l'en-tête Idempotent-Replayed: true, et aucun second e-mail n'est envoyé à votre client. Pour envoyer une nouvelle invitation, utilisez une nouvelle clé. IDEMPOTENCY_OUTCOME_UNKNOWN : la première demande sous cette clé a échoué après l'envoi de l'e-mail, qui a pu parvenir à votre client. Pour un nouveau lien, utilisez une nouvelle clé.

Langage

Requête cURLpostExemple
1curl --request POST \
2 --url https://api.mobupay.nc/api/v1/customers/{id}/card-links \
3 --header 'authorization: Bearer sk_test_XXXX' \
4 --header 'content-type: application/json' \
5 --data '{ "purpose": "register", "expiresIn": 604800, "usage": "unscheduled", "sendByEmail": true }'
Réponse

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

application/json