Passer au contenu principal
POST
Ouvrir le portail de la méthode de paiement
Utilisez cette action depuis Console → Paramètres → Facturation → Méthodes de paiement ou votre page de facturation du consommateur. Elle nécessite une session humaine connectée. Les clés API ne peuvent pas ouvrir un portail client. Les espaces de travail professionnels nécessitent un administrateur d’espace de travail actif ou un rôle à l’échelle du locataire avec la permission de gestion de la facturation. Pour un espace de travail basé sur l’utilisation sans client Stripe lié, le portail explicite la demande initialise et lie ce client en utilisant l’e-mail du compte vérifié. L’ouverture du portail ne débite pas de carte, ne crée pas d’abonnement et ne modifie pas le plan.

Requête

Définissez provider sur stripe (la valeur par défaut). Flutterwave ne fournit pas actuellement de portail en libre-service via ce point de terminaison. Paystack n’est pas pris en charge ici. Définissez return_url sur une adresse HTTPS sur console.truthlocks.com pour une entreprise session ou verify.truthlocks.com pour une session consommateur. Les autres hôtes sont rejetés.

Réponse

portal_url est un lien Stripe de courte durée. Ouvrez-le pour ajouter ou mettre à jour les détails de paiement et consultez les factures Stripe disponibles. La configuration du portail de paiement de Truthlocks n’active pas les changements d’abonnement ou l’annulation ; utilisez la page de facturation appropriée page pour ces actions. Traitez ce lien comme privé et demandez-en un nouveau à chaque fois.

Erreurs

Les erreurs renvoient du JSON avec code et error. 403 signifie que la personne connectée ne peut pas gérer ce compte de facturation. 422 identifie un fournisseur non pris en charge. 502 ou 503 indique une défaillance du fournisseur ou du service de compte ; le message explique le étape suivante. Une recherche de compte échouée ne crée pas un autre client fournisseur.

Autorisations

Authorization
string
header
requis

JWT pour les opérations initiées par l'utilisateur

Corps

application/json
return_url
string<uri>
requis

Adresse HTTPS sur console.truthlocks.com pour les sessions professionnelles ou verify.truthlocks.com pour les sessions grand public.

Exemple:

"https://console.truthlocks.com/settings/billing"

provider
enum<string>
défaut:stripe

Stripe est le fournisseur de portail en libre-service pris en charge.

Options disponibles:
stripe

Réponse

Lien de portail de méthode de paiement de courte durée ; ne confirme pas un paiement.

portal_url
string<uri>
requis