Cancelar Contrato

Cancela um contrato de empréstimo que ainda não entrou em processo de assinatura, averbação ou formalização.

Identificação do contrato

O cancelamento aceita um único identificador — envie apenas um dos dois:

Parâmetro	Local	Tipo	Descrição
requestNumber	query	string	Número da requisição do contrato
contractNumber	query	string	Número do contrato (CCB)

Envie apenas um dos identificadores. Enviar ambos ou nenhum resulta em erro 400.

Regras de cancelamento

• O contrato é carregado com lock pessimista para garantir consistência

• O cancelamento só é permitido quando o contrato não entrou em assinatura/averbação/formalização

• Se o contrato já estiver em um estágio avançado, a API retorna 409 Conflict

Respostas

Código	Significado
200	Contrato cancelado com sucesso
400	Identificador ausente ou ambíguo
404	Contrato não encontrado
409	Contrato não pode ser cancelado (já em assinatura/averbação/formalização)

Cancelar Contrato

post

https://consignado.staging.giro.techhttps://consignado.giro.tech

/api/v1/originator/contracts/cancel

Cancela um contrato do originator usando um único identificador:

• requestNumber ou

• contractNumber

Regras de negócio:

• O contrato é carregado com lock pessimista antes da atualização.

• O cancelamento só é permitido quando o contrato ainda não entrou em assinatura/averbação/formalização.

• Após o lock, o backend valida o status do contrato e também os status de Endorsement e Formalization.

Autorizações

BearerAuth

AuthorizationstringObrigatório

JWT token fornecido pelo administrador

Parâmetros de consulta

requestNumberstringOpcional

Número da requisição do contrato (enviar apenas quando contractNumber não for informado)

contractNumberstringOpcional

Número do contrato (enviar apenas quando requestNumber não for informado)

Respostas

200

Contrato cancelado com sucesso

application/json

idinteger · int64Opcional

Identificador interno do contrato.

Example: 156

requestNumberstringOpcional

Número da requisição (GT + 10 alfanuméricos maiúsculos). Ex. GTAB12CD34EF

Example: GTAB12CD34EF

contractNumberstringOpcional

Número do contrato (8 dígitos com zero à esquerda). Ex. 00345678

Example: 345678

employeeIdinteger · int64Opcional

Identificador interno do trabalhador vinculado ao contrato.

Example: 15

proposalIdinteger · int64Opcional

Identificador da proposta que originou o contrato.

Example: 23

statusstring · enumOpcional

Ciclo de vida do contrato.

Valor	Significado
CREATED	Contrato criado, aguardando assinatura
SIGNED	Assinado pelo trabalhador
ENDORSED	Averbação consignada confirmada
FORMALIZED	Formalizado no sistema de pagamento
COMPLETED	Operação concluída (desembolsado)
CANCELLED	Cancelado

Example: CREATEDValores possíveis:

endorsementStatusstring · enumOpcional

Situação da averbação no convênio.

Valor	Significado
PENDING	Aguardando averbação
PROCESSING	Em processamento no convênio
ENDORSED	Averbação confirmada
FAILED	Falha na averbação
RETRYING	Nova tentativa em andamento

Example: PENDINGValores possíveis:

endorsementProtocolstringOpcional

Protocolo retornado pelo provedor de averbação, quando disponível.

contractAmountnumber · decimalOpcional

Valor principal do contrato em reais (decimal com 2 casas decimais).

Example: 5750

installmentsintegerOpcional

Quantidade de parcelas definida no contrato.

Example: 12

contractDatestring · date-timeOpcional

Data e hora de contratação registradas (UTC).

Example: 2024-02-01T10:00:00Z

firstInstallmentDueDatestring · dateOpcional

Data de vencimento da primeira parcela.

Example: 2024-04-25

lastInstallmentDueDatestring · dateOpcional

Data de vencimento da última parcela.

Example: 2025-03-25

signedAtstring · date-timeOpcional

Data e hora em que o contrato foi assinado (UTC).

formalizedAtstring · date-timeOpcional

Data e hora em que a formalização foi concluída (UTC).

paidAtstring · date-timeOpcional

Data e hora de liquidação/desembolso do contrato (UTC).

endorsedAtstring · date-timeOpcional

Data e hora de confirmação da averbação (UTC).

createdDatestring · date-timeOpcional

Data e hora de criação do contrato no sistema (UTC).

attendantNamestringOpcional

Nome do atendente/vendedor responsável.

attendantCpfstringOpcional

CPF do atendente/vendedor responsável.

400

Deve informar exatamente um identificador (requestNumber ou contractNumber)

401

Não autenticado

403

Permissão insuficiente

404

Contrato não encontrado

409

Contrato não pode ser cancelado porque já está em assinatura/averbação/formalização

application/json

post

/api/v1/originator/contracts/cancel

HTTPcURLJavaScriptPython

POST /api/v1/originator/contracts/cancel HTTP/1.1
Host: consignado.staging.giro.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 1,
  "requestNumber": "GTAB12CD34EF",
  "contractNumber": 345678,
  "status": "CANCELLED"
}

Central de Atendimento | Giro.TechGiro.Tech