Saltar al contenido principal
POST
Abrir portal de método de pago
Utilice esta acción desde Console → Configuración → Facturación → Métodos de pago o su página de facturación del consumidor. Requiere una sesión humana iniciada. Las claves API no pueden abrir un portal de clientes. Los espacios de trabajo empresariales requieren un administrador de espacio de trabajo activo o un rol a nivel de inquilino con permiso de gestión de facturación. Para un espacio de trabajo basado en el uso sin un cliente de Stripe vinculado, el portal explícito la solicitud inicializa y vincula a ese cliente utilizando el correo electrónico de la cuenta verificada. Abrir el portal no carga una tarjeta, no crea una suscripción ni cambia el plan.

Solicitud

Establezca provider en stripe (el valor predeterminado). Flutterwave no proporciona actualmente un portal de autoservicio a través de este endpoint. Paystack no es compatible aquí. Establezca return_url en una dirección HTTPS en console.truthlocks.com para una empresa sesión o verify.truthlocks.com para una sesión de consumidor. Otros hosts son rechazados.

Respuesta

portal_url es un enlace de Stripe de corta duración. Ábralo para agregar o actualizar los detalles de pago y ver las facturas de Stripe disponibles. La configuración del portal de métodos de pago de Truthlocks no permite cambios o cancelaciones de suscripción; use la página de facturación apropiada página para esas acciones. Trate este enlace como privado y solicite uno nuevo cada vez.

Errores

Los errores devuelven JSON con code y error. 403 significa que la persona que ha iniciado sesión no puede administrar esta cuenta de facturación. 422 identifica un proveedor no compatible. 502 o 503 indica una falla del proveedor o del servicio de cuenta; el mensaje explica el siguiente paso. Una búsqueda de cuenta fallida no crea otro cliente proveedor.

Autorizaciones

Authorization
string
header
requerido

JWT para operaciones iniciadas por el usuario

Cuerpo

application/json
return_url
string<uri>
requerido

Dirección HTTPS en console.truthlocks.com para sesiones de negocios o verify.truthlocks.com para sesiones de consumidores.

Ejemplo:

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

provider
enum<string>
predeterminado:stripe

Stripe es el proveedor de portal de autoservicio compatible.

Opciones disponibles:
stripe

Respuesta

Enlace de portal de método de pago de corta duración; no confirma un pago.

portal_url
string<uri>
requerido