Negocie icon

Negocie

Consume Negocie API
Join our community

Actions7

Overview

This node integrates with the Negocie API to perform various operations related to debt management, payment options, agreements, and authentication. Specifically, for the Dívida resource and the Buscar opções de pagamento operation, it fetches available payment options for specified contracts within a financial institution.

Typical use cases include:

  • Retrieving payment plans or installment options for outstanding debts.
  • Automating debt negotiation workflows by fetching payment alternatives programmatically.
  • Integrating with CRM systems to provide customers with tailored payment solutions based on contract data.

For example, a financial service provider can use this node to query payment options for multiple contracts of a customer, enabling dynamic display of feasible payment plans in their application.

Properties

Name Meaning
Ambiente Selects the environment to run the operation: "Homologação" (testing) or "Produção" (production).
Token Bearer token obtained from prior authentication, used for API authorization.
Financeira Name of the financial institution (e.g., BV, PAN, Casas Bahia).
CRM CRM code associated with the financial institution, required to identify the context.
Carteira Numeric identifier of the wallet or portfolio number.
Contratos List of contract numbers for which to fetch payment options.
Data de Vencimento Due date in ISO 8601 format, specifying the deadline for payment options.

Output

The node outputs an array of JSON objects representing the payment options retrieved from the Negocie API. Each item corresponds to one input item processed and contains the structured response data from the API.

If errors occur during processing, the output includes error objects with details such as error type, status code, message, and context information.

No binary data is produced by this operation.

Dependencies

  • Requires a valid Bearer token for authorization, typically obtained via a separate authentication operation.
  • Depends on access to the Negocie API endpoints, which differ based on the selected environment ("Homologação" or "Produção").
  • Network connectivity to the respective API URLs must be configured and allowed.
  • No additional external libraries beyond those bundled are required.

Troubleshooting

  • Common Issues:

    • Invalid or expired Bearer token leading to authentication failures.
    • Incorrect contract numbers or CRM codes causing empty or error responses.
    • Network or endpoint misconfiguration due to wrong environment selection.

  • Error Messages:

    • "Documento não encontrado na API Negocie. Verifique se o documento informado existe e está correto."
      Means the document/contract was not found; verify contract numbers.
    • "Falha na autenticação. Verifique as credenciais (appId, appPass, usuario) no ambiente X."
      Indicates authentication failure; check credentials and environment.
    • "Acesso negado. O usuário não tem permissão para acessar este recurso."
      Permission denied; ensure user has correct API access rights.
    • "Erro interno do servidor da API Negocie. Tente novamente mais tarde."
      Server-side error; retry after some time.

  • When errors occur, if the node is set to continue on fail, it returns detailed error info per item without stopping the entire workflow.

Links and References

Discussion