ZapSign API
English
English
  • General Information
  • Getting Started
  • ZapSign Environments
  • Ready-to-use requests!
  • Authentication
    • Static token
    • JWT Authentication
      • Get access token
      • Refresh your access token
  • Types of Tokens
  • API versioning
  • Rate Limit Policies
  • Incident alerts
  • How Payment Works
  • Status Code
  • Account
    • Plan Information
    • List account users
    • Create account users
    • Delete account user
  • Documents
    • Create document via Upload
    • OneClick (ClickWrap)
      • Create document (OneClick)
    • Create document via Template
    • Add attachment (extra document)
    • Add attachment (extra document) via Template
    • Detail document
    • List documents
    • Delete document
    • Document Audit Trail
    • Optional: Place signatures
    • Reject Documents
  • Signature Validation
  • Signers
    • Detail signer
    • Update signer
    • Add signer
    • Delete signer
    • Batch sign via API
    • Reject Documents by User
  • Templates
    • Create template (DOCX)
      • Configure Template Form
    • List templates
    • Get template
    • Update template
    • Delete template
  • Partnerships
    • Update Payment Status
    • Create Account
  • TIMESTAMP
    • Add timestamp
  • Background Check
  • Introduction
  • Understanding the Result
  • Creating a Background Check
    • Person Check
    • Company check
  • Retrieve a Check
  • Check details
  • Webhooks
    • How webhooks works
    • Testing webhooks on ZapSign
    • Create Webhook
    • Webhooks logs
    • Events
      • Document
        • Doc created
        • Doc deleted
        • Created signer
      • Signer
        • Signature request send
        • Document viewed
        • Reading confirmation
        • Doc signed
        • Doc refused
        • Email bounce
        • Failed Validation
      • Background check
        • Background check completed
    • Reprocessing Documents and Webhooks
    • Delete Webhook
  • Widget
    • How widget works
Powered by GitBook
On this page

Was this helpful?

  1. Partnerships

Update Payment Status

This API allows Direct Reseller Partners to manage the payment status of their clients in an automated way, providing greater control over compliance and service continuity.

Usage Example

In ZapSign’s Direct Reseller Partnership model, you can use this API to update the payment status of your customers. If a customer is behind on payments or in default, the API allows you to automatically suspend the benefits of their plan, ensuring that services are restricted until the payment is resolved.

How to Configure

To use this feature, make sure you have both the partner’s API token and the client’s API token whose payment status you want to update. These tokens are essential to make the necessary changes directly through the API, maintaining control over the client experience and the integrity of the services provided.

How the Endpoint Works

When using this endpoint, you must send us the api_token of the client account, along with the payment_status parameter, which can be either "inadimplente" (if the customer hasn't paid) or "adimplente" (if the customer is up to date).

Our system will validate whether the token used for authentication in the API belongs to the parent account of the account associated with the token sent in the request body (the client account). If this condition is met, the request will be accepted.

  • If the status is "inadimplente" (if the customer hasn't paid): The client’s active plan will be blocked, restricting access to benefits until payment is settled.

  • If the status is "adimplente" (if the customer is up to date): The client’s plan will be unblocked, restoring full access to services.

Update a Partner’s Payment Status

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

Headers

Name
Type
Description

Authorization*

string

API token preceded by the API token preceded by the word Bearer.

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

Request Body

Name
Type
Description

client_api_token

string

API token of the partner

payment_status

string

payment_status: "adimplente" (active plan) or "inadimplente" (inactive plan) – defines the desired status of the client account.

{
    "client_api_token": "f44f44e-sve2-4d01-8753-9e8fdf825e44cfe41581-fc98-4f81-8f0f-b8a184046421",
    "payment_status": "inadimplente"
}
Status updated successfully
PreviousDelete templateNextCreate Account

Last updated 1 month ago

Was this helpful?