Chargement de vos clés API…

Annuler l'invitation d'un client

POSThttps://api.mobupay.nc/api/v1/integrator/clients/invitations/{invitationId}/cancel

Ce que fait cet appel

Annule une invitation dont le dossier n'est pas commencé, réelle ou simulée, et rend l'invitation annulée (enrollmentStatus: CANCELLED). L'événement integrator.invitation.cancelled part vers vos adresses de réception.

Une invitation dont votre client a ouvert le dossier ne s'annule plus : 409 INVITATION_NOT_CANCELLABLE, comme une simulation déjà à un état final.

Portée de clé requise : integrator.invitations.write (403 INTEGRATOR_SCOPE_REQUIRED sinon).

En-tête d'authentification

Authorization: Bearer sk_int_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_int_test_* ne traite aucun paiement réel, sk_int_live_* encaisse.

Paramètres

1 en-tête

invitationIdstringRequispath

Identifiant de l'invitation (`iiv_*`).

Codes de retour

200

L'invitation annulée.

409

INVITATION_NOT_CANCELLABLE.

Langage

Requête cURLpostExemple

1curl --request POST \

2 --url https://api.mobupay.nc/api/v1/integrator/clients/invitations/{invitationId}/cancel \

3 --header 'authorization: Bearer sk_int_test_XXXX'

Réponse

Cliquez sur Essayer pour lancer la requête et voir la réponse ici.