Facturation des consommations via l’API

Plusieurs actions sur l’API engendreront un coût et nécessitent que l’utilisateur possède un moyen de paiement (envoi d’un courrier, vérification de son identité, demandes de consentement)

Il existe 3 façons d’avoir un moyen de paiement :

  1. l’utilisateur possède son propre moyen de paiement enregistré sur son compte
  2. l’utilisateur fait parti d’une équipe et l’administrateur de l’équipe possède un moyen de paiement enregistré sur son compte
  3. la facturation globale est activée : le partenaire qui utilise l’API AR24 règle les consommations de tous les utilisateurs de l’API

1. Faire ajouter un moyen de paiement au compte de l’utilisateur

Si l’utilisateur ne possède pas de moyen de paiement (information que l’on retrouve en regardant les données d’un utilisateur via la route /user/info), vous pouvez lui envoyer un mail afin de lui demander d’en ajouter un sur son compte AR24.

Pour ce faire, utilisez la route /user/payment_request. Les paramètres attendus sont les suivants :

Vous obtenez alors un retour de notre API avec le statut SUCCESS et l’utilisateur recevra un mail de demande d’ajout d’un moyen de paiement sur le site d’AR24. Dans le cas d’une erreur, vous retrouverez dans le retour une explication et un slug. Vous retrouverez dans notre documentation la liste des erreurs : https://www.ar24.fr/documentation/api/#api-ErrorGroup-list

2. Ajouter l’utilisateur à une équipe

La fonctionnalité d’équipe permet à un utilisateur de bénéficier du moyen de paiement de l’administrateur de l’équipe. L’administrateur doit posséder un moyen de paiement enregistré sur son compte (voir le point [1]). Pour ajouter l’utilisateur à une équipe il faut appeler la route /user/join_team/. Les paramètres attendus sont les suivants :

Vous obtenez alors un retour de notre API avec le statut SUCCESS et l’utilisateur recevra un mail de demande d’ajout à l’équipe. Il devra cliquer dans le lien présent dans ce mail pour accepter l’invitation. Dans le cas d’une erreur, vous retrouverez dans le retour une explication et un slug. Vous retrouverez dans notre documentation la liste des erreurs : https://www.ar24.fr/documentation/api/#api-ErrorGroup-list

Une fois l’invitation acceptée, l’utilisateur est ajouté à l’équipe et bénéficie du moyen de paiement de l’administrateur de l’équipe. Il pourra alors effectuer toutes les actions nécessitant un moyen de paiement. L’administrateur de l’équipe sera prélevé pour les coûts des membres de son équipe.

3. Mettre en place la facturation globale sur l’API

AR24 propose aux partenaires utilisant l’API de prendre en charge tous les coûts générés par les utilisateurs rattachés à l’API.
Cette manipulation permet au partenaire de refacturer les services d’AR24 directement à leurs clients sans que ceux-ci aient besoin d’ajouter un moyen de paiement sur AR24.

Pour mettre en place cette fonctionnalité, vous devez créer un compte AR24 avec un moyen de paiement enregistré. Contactez ensuite l’équipe technique par mail avec l’identifiant de l’utilisateur créé et en demandant la mise en place de la facturation globale.

Vous ne trouvez pas votre réponse ? Contactez nous