📌 Reabertura de Cobrança

Endpoint

POST /integration/reopen-installment/{billing_number}

🎯 Objetivo

Este endpoint permite reabrir uma cobrança já existente no sistema.

A reabertura é processada de forma assíncrona, sendo utilizada quando uma cobrança foi encerrada/baixada indevidamente ou precisa voltar ao estado anterior para correção de fluxo financeiro.

🔐 Autenticação

Requer autenticação válida.

A cobrança será localizada exclusivamente dentro do contexto da empresa autenticada.

📥 Parâmetros de Entrada

Path Parameters

Parâmetro	Tipo	Obrigatório	Descrição
`billing_number`	string	Sim	Identificador da cobrança. Pode ser o número da cobrança ou o identificador de integração.

📦 Body da Requisição

Este endpoint não requer body.

🔎 Comportamento de Busca

A API tenta localizar a cobrança seguindo a ordem abaixo:

Busca pelo billing_number vinculado à empresa.

Caso não encontre, busca pelo integration_identifier vinculado à empresa.

Se nenhuma cobrança for encontrada, a operação é interrompida.

⚙️ Processamento

Após localizar a cobrança:

A cobrança associada é identificada.

Um evento de reabertura da cobrança é enviado para processamento assíncrono.

A reabertura não ocorre de forma imediata na resposta da API.

📤 Respostas

✅ Sucesso

{
  "message": "Request accepted for billing reopening."
}

Status Code: 200 OK

❌ Cobrança não encontrada

{
  "message": "Billing not found."
}

Status Code: 404 Not Found

❌ Erro interno

{
  "message": "Problems reopening billing. Try again in a few moments."
}

Status Code: 500 Internal Server Error

⚠️ Observações Importantes

Este endpoint não garante reabertura imediata da cobrança.

O processamento ocorre de forma assíncrona.

Reenvios da mesma requisição podem gerar múltiplas tentativas de reabertura se não houver controle no fluxo de origem.

Recomenda-se utilizar este endpoint apenas em cenários controlados, como:

Correções operacionais

Reprocessamento financeiro

Ajustes de integração

🧪 Exemplo de Requisição

📞 Suporte

Em caso de dúvidas sobre quando ou como utilizar este endpoint, entre em contato com o time técnico responsável pela integração.

Como reabrir uma cobrança cancelada

📌 Reabertura de Cobrança#

Endpoint#

🎯 Objetivo#

🔐 Autenticação#

📥 Parâmetros de Entrada#

Path Parameters#

📦 Body da Requisição#

🔎 Comportamento de Busca#

⚙️ Processamento#

📤 Respostas#

✅ Sucesso#

❌ Cobrança não encontrada#

❌ Erro interno#

⚠️ Observações Importantes#

🧪 Exemplo de Requisição#

📞 Suporte#