Atualizar status de pagamento

Essa API permite que Parceiros de Revenda Direta gerenciem o status de pagamento dos clientes de forma automatizada, proporcionando maior controle sobre a adimplência e continuidade dos serviços

Exemplo de uso

No modelo de Parceria de Revenda Direta da ZapSign, você pode usar esta API para atualizar o status de pagamento dos seus clientes. Se um cliente se tornar inadimplente, a API permite suspender automaticamente os benefícios do plano, garantindo que os serviços sejam restritos até a regularização. Desta forma, caso seu cliente esteja inadimplente, será possível suspender os benefícios do plano atribuido a ele.

Como configurar

Para utilizar essa funcionalidade, certifique-se de ter em mãos o API Token do parceiro e do cliente cujo status de pagamento você deseja atualizar. Esses tokens são essenciais para realizar as alterações necessárias diretamente via API, mantendo o controle sobre a experiência do cliente e a integridade dos serviços prestados.

Funcionamento do Endpoint

Ao utilizar esse endpoint, você nos envia o api_token da conta do cliente junto com o parâmetro payment_status, que pode ser "inadimplente" ou "adimplente".

Nosso sistema irá validar se o token usado para autenticação na API pertence à conta mãe da conta associada ao token enviado no corpo da requisição (a conta do cliente). Se essa condição for atendida, a requisição será aceita.

  • Se o status for "inadimplente": O plano contratado pelo cliente será bloqueado, restringindo o acesso aos benefícios até que o pagamento seja regularizado.

  • Se o status for "adimplente": O plano contratado será desbloqueado, restaurando o acesso completo aos serviços.

Alterar status de pagamento de um parceiro

POST https://api.zapsign.com.br/api/v1/partner/update-payment-status/

Headers

Name
Type
Description

Authorization*

string

Api token a frente do texto "Bearer".

Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23

Request Body

Name
Type
Description

client_api_token

string

Token de API do parceiro

payment_status

string

"adimplente" | "inadimplente" 

{
    "client_api_token": "f44f44e-sve2-4d01-8753-9e8fdf825e44cfe41581-fc98-4f81-8f0f-b8a184046421",
    "payment_status": "inadimplente"
}
Status atualizado com sucesso.
PreviousAssinar em lote via APINextListar modelos

Last updated