Consulta Status da Garantia da Operação

Visão Geral

Este endpoint permite que originadores consultem, em tempo real as atualizadas da garantia vinculada à operação, incluindo status atual, tipo de contrato, histórico de ações executadas e possíveis erros retornados pela averbadora. O objetivo é aumentar a visibilidade operacional do fluxo de garantia, trazendo transparência e e autonomia sobre as pendências, falhas ou confirmações de processamento.

Endpoint

/banking/originator/applications/{application_id}/guarantee

Parameters

Parâmetro	Tipo	Obrigatório	Descrição
`application_id`	UUID	Sim	ID da operação consultada

Exemplo de Request

/banking/originator/applications/89d6546d-3f74-42d4-a33b-6edbf2663175/guarantee
Authorization: Bearer {token}

Exemplo de Response

{
  "application_id": "89d6546d-3f74-42d4-a33b-6edbf2663175",
  "guarantee": {
    "status": "WAITING_ANNOTATION_REGISTRATION",
    "contract_type": "NORMAL",
    "operations": [
      {
        "status": "SUCCESS",
        "action_type": "START_ANNOTATION",
        "error": null
      },
      {
        "status": "ERROR",
        "action_type": "END_ANNOTATION",
        "error": {
          "code": "HR",
          "message": "Quantidade de contratos permitida excedida"
        }
      }
    ]
  }
}

Campos de Retorno

Campo	Tipo	Nullable	Descrição
application_id	String	Não	ID da operação consultada
guarantee	Object	Não	Dados da garantia vinculada à operação
guarantee.status	String	Não	Status atual da garantia no órgão consignatário
guarantee.contract_type	String	Sim	Tipo do contrato vinculado à operação
guarantee.operations	Array	Sim	Lista de ações executadas na garantia
guarantee.operations[].status	String	Não	Status da ação executada
guarantee.operations[].action_type	String	Não	Tipo da ação realizada
guarantee.operations[].error	Object	Sim	Dados do erro quando houver falha
guarantee.operations[].error.code	String	Não	Código do erro retornado pela garantia/averbadora
guarantee.operations[].error.message	String	Não	Mensagem descritiva do erro retornado pela garantia

Possíveis Tipos de Contrato

contract_type	Descrição
`NORMAL até 18/05 // NEW_CREDIT a partir de 19/05`	Novo crédito
`REFINANCING`	Refinanciamento
`PORTABILITY`	Portabilidade
`RENEWED_LINKED`	Renegociação

Possíveis Status da Garantia

Status	Descrição
`WAITING_ANNOTATION_REGISTRATION`	Averbação aguardando registro
`WAITING_CONFIRMATION`	Aguardando confirmação
`APPROVED`	Garantia aprovada
`ERROR`	Erro no processamento
`CANCELED`	Garantia cancelada

Possíveis Tipos de Ação

action_type	Descrição
`START_ANNOTATION`	Início da averbação
`END_ANNOTATION`	Desaverbação
`REACTIVATE_ANNOTATION`	Reativação
`SUSPEND_ANNOTATION`	Suspensão da averbação
`ALTER_ANNOTATION`	Alteração de uma annotation
`REVERT_ANNOTATION`	Reversão de um refinanciamento
`ADD_CONTRACT`	Adição de um contrato
`ALTER_EXTERNAL_ANNOTATION_ACTIVE`	Alteração de uma annotation externa ativa
`ALTER_EXTERNAL_ANNOTATION_DELETED`	Alteração de uma annotation externa deletada
`ALTER_EXTERNAL_ANNOTATION_CLOSED`	Alteração de uma annotation externa encerrada
`ALTER_EXTERNAL_ANNOTATION_START_NEXT_COMPETENCE`	Alteração de uma annotation externa inicio da próxima competência
`ALTER_EXTERNAL_ANNOTATION_DELETE_NEXT_COMPETENCE`	Alteração de uma annotation externa exclusão da próxima competência
`ALTER_EXTERNAL_ANNOTATION_SUSPENDED_ACP_APS`	Alteração de uma annotation externa suspensa ACP APS
`ALTER_EXTERNAL_ANNOTATION_SUSPENDED_LEGAL_ACTION`	Alteração de uma annotation externa suspensa acao legal
`ALTER_EXTERNAL_ANNOTATION_SUSPENDED_BANK`	Alteração de uma annotation externa suspensa banco

Possíveis Status das Operações

status	Descrição
`PROCESSING`	Operação em processamento
`SUCCESS`	Operação executada com sucesso
`ERROR`	Erro na operação
`CANCELED`	Operação cancelada

Erros

HTTP Status	Mensagem	Causa
`422`	`Guarantee status is only available after CCB signature.`	Operação ainda não possui assinatura da CCB
`400`	`entity not found for id {application_id}`	Operação inexistente, de outro originador ou não elegível
`404`	`Guarantee not found for applicationId: {id}`	Operação sem garantia registrada
`404`	`Anotação não encontrada`	Garantia não localizada no órgão consignatário
`500`	`Erro ao processar resposta da garantia`	Falha no processamento da resposta do órgão

Regras de Negócio

Produto Elegível: endpoint disponível exclusivamente para operações de Crédito do Trabalhador.
Consulta por Operação: a consulta deve ser realizada obrigatoriamente pelo application_id.
Consulta permitida apenas após assinatura da CCB: A consulta só estará disponível para operações em status posteriores à assinatura da CCB, que podem ser:
- PENDING_QUALIFICATION
- AWAITING_APPROVAL_DISBURSEMENT
- PENDING_GUARANTEE
- PENDING_DISBURSEMENT
- SCHEDULED_DISBURSEMENT
- DISBURSEMENT_ATTEMPT_FAILED
- CANCELED
- ISSUED

Updated about 1 hour ago