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 effectuée via l’API pour tous les utilisateurs et s’occupe de les refacturer ensuite.

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 :

• token : votre token
• id_user : l’identifiant utilisateur AR24 qui recevra le mail de demande d’ajout d’un moyen de paiement

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 dans l’onglet « Error » de la route concernée.

Un paramètre optionnel get_link vous permet de générer un lien à transmettre vous même à votre client plutôt que de faire envoyer un mail par AR24. Si ce paramètre est transmis, un lien vous est retourné que vous pouvez inclure dans votre workflow.

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 :

• token : votre token
• id_user : l’identifiant utilisateur AR24 qui doit être ajouté à l’équipe
• id_master : l’identifiant utilisateur AR24 qui est administrateur de l’équipe (doit posséder un moyen de paiement)

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 dans l’onglet « Error » de la route concernée.

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 sur l’API par ses utilisateurs.
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. Seules les consommations effectuées via l’API seront facturées au partenaire. Si l’utilisateur se connecte directement sur le site d’AR24, il devra utiliser son propre moyen de paiement.

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.