Saltar para o conteúdo principal
POST
Abrir portal de método de pagamento
Use esta ação em Console → Configurações → Cobrança → Métodos de pagamento ou seu página de faturamento do consumidor. Requer uma sessão humana autenticada. Chaves de API não podem abrir um portal do cliente. Espaços de trabalho empresariais exigem um administrador de espaço de trabalho ativo ou uma função em todo o locatário com permissão de gerenciamento de faturamento. Para um espaço de trabalho baseado em uso sem um cliente Stripe vinculado, o portal explícito solicitação inicializa e vincula esse cliente usando o e-mail da conta verificada. Abrir o portal não cobra um cartão, não cria uma subscrição, nem altera o plano.

Solicitação

Defina provider como stripe (o padrão). O Flutterwave atualmente não fornece um portal de autoatendimento através deste endpoint. Paystack não é suportado aqui. Defina return_url para um endereço HTTPS em console.truthlocks.com para uma empresa sessão ou verify.truthlocks.com para uma sessão de consumidor. Outros hosts são rejeitados.

Resposta

portal_url é um link Stripe de curta duração. Abra-o para adicionar ou atualizar detalhes de pagamento e visualize as faturas Stripe disponíveis. A configuração do portal de método de pagamento da Truthlocks não permite alterações ou cancelamento de assinatura; use a página de faturamento apropriada página para essas ações. Trate este link como privado e solicite um novo a cada vez.

Erros

Erros retornam JSON com code e error. 403 significa que a pessoa logada não pode gerenciar esta conta de faturamento. 422 identifica um provedor não suportado. 502 ou 503 indica uma falha do provedor ou do serviço de conta; a mensagem explica o próximo passo. Uma falha na pesquisa de conta não cria outro cliente provedor.

Autorizações

Authorization
string
header
obrigatório

JWT para operações iniciadas pelo usuário

Corpo

application/json
return_url
string<uri>
obrigatório

Endereço HTTPS em console.truthlocks.com para sessões de negócios ou verify.truthlocks.com para sessões de consumidor.

Exemplo:

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

provider
enum<string>
padrão:stripe

Stripe é o provedor de portal de autoatendimento suportado.

Opções disponíveis:
stripe

Resposta

Link de portal de método de pagamento de curta duração; não confirma um pagamento.

portal_url
string<uri>
obrigatório