Zum Hauptinhalt springen
POST
Zahlungsmethodenportal öffnen
Verwenden Sie diese Aktion von Console → Einstellungen → Abrechnung → Zahlungsmethoden oder Ihre Verbraucher-Abrechnungsseite. Dies erfordert eine angemeldete menschliche Sitzung. API-Schlüssel können nicht geöffnet werden ein Kundenportal. Geschäftliche Arbeitsbereiche erfordern einen aktiven Arbeitsbereichs-Administrator oder eine mandantenweite Rolle mit Berechtigung zur Abrechnungsverwaltung. Für einen nutzungsbasierten Arbeitsbereich ohne verknüpften Stripe-Kunden, das explizite Portal Anfrage initialisiert und verknüpft diesen Kunden mit der verifizierten Konto-E-Mail. Das Öffnen des Portals belastet keine Karte, erstellt kein Abonnement und ändert den Plan nicht.

Anfrage

Setzen Sie provider auf stripe (Standard). Flutterwave bietet derzeit keine Self-Service-Portal über diesen Endpunkt. Paystack wird hier nicht unterstützt. Setzen Sie return_url auf eine HTTPS-Adresse auf console.truthlocks.com für ein Unternehmen Sitzung oder verify.truthlocks.com für eine Verbrauchersitzung. Andere Hosts werden abgelehnt.

Antwort

portal_url ist ein kurzlebiger Stripe-Link. Öffnen Sie ihn, um Zahlungsdetails hinzuzufügen oder zu aktualisieren und verfügbare Stripe-Rechnungen anzeigen. Die Konfiguration des Truthlocks-Zahlungsmethodenportals ermöglicht keine Abonnementänderungen oder -kündigungen; verwenden Sie die entsprechende Abrechnung Seite für diese Aktionen. Behandeln Sie diesen Link als privat und fordern Sie jedes Mal einen neuen an.

Fehler

Fehler geben JSON mit code und error zurück. 403 bedeutet, dass die angemeldete Person nicht kann dieses Abrechnungskonto verwalten. 422 identifiziert einen nicht unterstützten Anbieter. 502 oder 503 zeigt einen Anbieter- oder Kontodienstfehler an; die Nachricht erklärt den nächster Schritt. Eine fehlgeschlagene Kontosuche erstellt keinen weiteren Anbieterkunden.

Autorisierungen

Authorization
string
header
erforderlich

JWT für benutzerinitiierte Operationen

Body

application/json
return_url
string<uri>
erforderlich

HTTPS-Adresse auf console.truthlocks.com für Geschäftssitzungen oder verify.truthlocks.com für Verbrauchersitzungen.

Beispiel:

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

provider
enum<string>
Standard:stripe

Stripe ist der unterstützte Self-Service-Portal-Anbieter.

Verfügbare Optionen:
stripe

Antwort

Kurzlebiger Link zum Zahlungsportal; bestätigt keine Zahlung.

portal_url
string<uri>
erforderlich