Encerrar

Encerra manualmente uma negociação informando o tipo de encerramento e as observações.

POSThttps://external-api.arbitralis.com.br/api/external/v1/extrajudicial/negotiations/{id}/encerrar

AutenticaçãoX-API-KEYSíncrono — a resposta já traz o resultado

Encerra manualmente uma negociação. O tipo de encerramento determina o status final e se o caso poderá ser reaberto.

Mensagens agendadas pendentes são canceladas automaticamente — a resposta informa quantas.

Parâmetros de rota

iduuidobrigatório

Identificador do caso de negociação.

Body

tipostringobrigatório

Tipo do encerramento. Define o status final.

valoresACORDO_MANUALACORDO_IADESISTENCIACANCELAMENTO

observacoesstringobrigatório

Motivo do encerramento, entre 1 e 2000 caracteres.

detalhesAcordoobjectopcional

Detalhes do acordo. Obrigatório quando tipo é ACORDO_MANUAL.

encerrarAtendimentoHumanobooleanopcionalpadrão true

Se true, encerra também o atendimento humano associado ao caso.

detalhesAcordo

valorAcordadonumberobrigatório

Valor final acordado, em reais. Deve ser positivo.

parcelasintegeropcional

Número de parcelas. Mínimo 1.

primeiroVencimentostringopcional

Data do primeiro vencimento.

Tipo e status final

`tipo`	Status final	Permite reabrir
`ACORDO_MANUAL`	`AGREEMENT_CLOSED`	Não
`ACORDO_IA`	`AGREEMENT_CLOSED`	Não
`DESISTENCIA`	`CLOSED`	Sim
`CANCELAMENTO`	`CLOSED`	Sim

Campos da resposta

Campo	Descrição
`status`	Status final aplicado
`tipoEncerramento`	Tipo informado na requisição
`dataEncerramento`	Momento do encerramento, em ISO 8601
`motivoEncerramento`	As observações registradas
`mensagensAgendadasCanceladas`	Quantas mensagens agendadas foram canceladas
`permiteReabrir`	Se o caso pode ser reaberto

Acordo fechado não reabre

ACORDO_MANUAL e ACORDO_IA levam a AGREEMENT_CLOSED, que é definitivo. Se houver chance de a tratativa voltar, prefira DESISTENCIA ou CANCELAMENTO — esses permitem reabertura.

Não é possível encerrar negociação agendada

Negociações em SCHEDULED ainda não começaram e não podem ser encerradas por este endpoint. O mesmo vale para casos já encerrados ou arquivados.

Erros

Código	Causa
`400`	`detalhesAcordo` ausente em acordo manual, `observacoes` vazio, ou status não permite encerramento
`401`	API key ausente, inválida ou inativa
`404`	Negociação não encontrada neste workspace
`429`	Limite de requisições excedido

Requisição

curl -X POST "https://external-api.arbitralis.com.br/api/external/v1/extrajudicial/negotiations/1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d/encerrar" \
  -H "Content-Type: application/json" \
  -H "X-API-KEY: arb_live_SUA_CHAVE" \
  -d '{
    "tipo": "ACORDO_MANUAL",
    "observacoes": "Acordo fechado por telefone com o setor financeiro",
    "detalhesAcordo": {
      "valorAcordado": 1200.00,
      "parcelas": 3,
      "primeiroVencimento": "2026-09-10"
    }
  }'

const negociacaoId = '1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d';

const response = await fetch(
  `https://external-api.arbitralis.com.br/api/external/v1/extrajudicial/negotiations/${negociacaoId}/encerrar`,
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'X-API-KEY': 'arb_live_SUA_CHAVE',
    },
    body: JSON.stringify({
      tipo: 'ACORDO_MANUAL',
      observacoes: 'Acordo fechado por telefone com o setor financeiro',
      detalhesAcordo: {
        valorAcordado: 1200.0,
        parcelas: 3,
        primeiroVencimento: '2026-09-10',
      },
    }),
  }
);

const { data } = await response.json();

Resposta

{
  "success": true,
  "data": {
    "negociacaoId": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "status": "AGREEMENT_CLOSED",
    "tipoEncerramento": "ACORDO_MANUAL",
    "dataEncerramento": "2026-08-07T17:12:03.000Z",
    "motivoEncerramento": "Acordo fechado por telefone com o setor financeiro",
    "mensagensAgendadasCanceladas": 2,
    "permiteReabrir": false
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Detalhes do acordo são obrigatórios para encerramento com acordo manual",
    "details": [
      {
        "code": "custom",
        "path": ["detalhesAcordo"],
        "message": "Detalhes do acordo são obrigatórios para encerramento com acordo manual"
      }
    ],
    "errorEventId": "b1f3c6d8-2a44-4d9e-9f10-7c5b8e2a1d33"
  }
}