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.
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.
POST https://api.zapsign.com.br/api/v1/partner/update-payment-status/
Headers
Authorization*
string
Token de API precedido por la palabra Bearer. Ejemplo: Bearer c7f35c84-7893-4087-b4fb-d1f06c23
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
Last updated
Was this helpful?
Was this helpful?
{
"client_api_token": "f44f44e-sve2-4d01-8753-9e8fdf825e44cfe41581-fc98-4f81-8f0f-b8a184046421",
"payment_status": "inadimplente"
}Status atualizado com sucesso.