ZapSign API
Español
Español
  • Información General
  • Antes de empezar
  • Entornos de ZapSign
  • Solicitudes listas para usar
  • Autenticación
    • Token estático
    • Autenticación JWT
      • Obtener el access token
      • Actualizar access token
  • Tipos de Tokens
  • Versiones de la API
  • Políticas de Rate Limit
  • Alertas de Incidentes
  • Cómo Funciona el Pago
  • Códigos de estado
  • Cuenta
    • Información del Plan
    • Listar usuarios de la cuenta
    • Crear usuarios en la cuenta
    • Eliminar usuario de la cuenta
  • Documentos
    • Crear documento via Upload
    • OneClick - Clickwrap
      • Crear documento (OneClick)
    • Crear documento via Plantilla
    • Adicionar documento (sobre)
    • Adicionar documento extra via Plantilla
    • Detalle del documento
    • Listar documentos
    • Eliminar documento
    • Histórico de eventos
    • Posicionar firma (opcional)
    • Rechazar documentos
  • Validación de firmas
  • Firmantes
    • Detalles del firmante
    • Actualizar firmante
    • Adicionar firmante
    • Eliminar firmante
    • Firma en lote via API
    • Rechazar documentos por el usuario
  • Plantillas
    • Crear plantilla DOCX
      • Configurar formulario de plantilla
    • Listar plantillas
    • Actualizar plantilla
    • Eliminar plantilla
  • Aliados / Re-sellers
    • Actualizar estado de pago
    • Crear cuenta
  • Antecedentes
    • Introducción
    • Entendiendo el resultado
  • Crear un consulta (check)
    • Consulta de persona
    • Consulta de empresa
  • Consultar check
  • Detalle del check
  • Webhooks
    • ¿Cómo funcionan los webhooks?
    • Probar webhooks en ZapSign
    • Crear Webhook
    • Registro de Webhooks
    • Eventos
      • De documento
        • Doc creado
        • Doc eliminado
        • Firmante creado
      • De firmantes
        • Solicitud de firma enviada
        • Doc visualizado
        • Confirmación lectura
        • Doc firmado
        • Doc rechazado
        • Email bounce
        • Validación Fallida
      • De antecedentes
        • Consulta completada
    • Reprocesando documentos y webhooks
    • Eliminar Webhook
  • Widget
    • iFrame: ¿cómo funciona?
Powered by GitBook
On this page

Was this helpful?

  1. Aliados / Re-sellers

Actualizar estado de pago

Esta API permite que los aliados / re-sellers gestionen el estado de pago de sus clientes de forma automatizada, brindando un mayor control sobre la morosidad y la continuidad de los servicios.

Ejemplo de uso

En el modelo de re-seller de ZapSign, puedes utilizar esta API para actualizar el estado de pago de tus clientes. Si un cliente se vuelve moroso, la API permite suspender automáticamente los beneficios del plan, garantizando que los servicios sean restringidos hasta que se regularice el pago.

De esta manera, si tu cliente está en mora, será posible suspender los beneficios del plan asignado.

Cómo configurar

Para utilizar esta funcionalidad, asegúrate de tener el API token del socio y el API token del cliente cuyo estado de pago deseas actualizar. Estos tokens son esenciales para realizar los cambios necesarios directamente a través de la API, manteniendo el control sobre la experiencia del cliente y la integridad de los servicios ofrecidos.

Funcionamiento del Endpoint

Al utilizar este endpoint, debes enviarnos el api_token de la cuenta del cliente, junto con el parámetro payment_status, que puede ser "inadimplente" (moroso) o "adimplente" (al día).

Nuestro sistema validará si el token utilizado para la autenticación en la API pertenece a la cuenta principal de la cuenta asociada al token enviado en el cuerpo de la solicitud (la cuenta del cliente). Si se cumple esta condición, la solicitud será aceptada.

  • Si el estado es "inadimplente" (moroso): El plan contratado por el cliente será bloqueado, restringiendo el acceso a los beneficios hasta que se regularice el pago.

  • Si el estado es "adimplente" (al día): El plan contratado será desbloqueado, restaurando el acceso completo a los servicios.

Actualizar estado de pago de un socio

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

Headers

Name
Type
Description

Authorization*

string

Token de API precedido por la palabra Bearer. Ejemplo: Bearer c7f35c84-7893-4087-b4fb-d1f06c23

Request Body

Name
Type
Description

client_api_token

string

Token de API del socio (revendedor)

payment_status

string

"adimplente" (al día) o "inadimplente" (moroso), define el estado deseado de la cuenta del cliente

{
    "client_api_token": "f44f44e-sve2-4d01-8753-9e8fdf825e44cfe41581-fc98-4f81-8f0f-b8a184046421",
    "payment_status": "inadimplente"
}
Status atualizado com sucesso.
PreviousEliminar plantillaNextCrear cuenta

Last updated 25 days ago

Was this helpful?