Buscar Contrato por ID

Retorna os detalhes completos de um contrato a partir do identificador interno. Inclui dados financeiros, status, datas de vencimento e informações de desembolso.

Parâmetros

Parâmetro	Local	Tipo	Descrição
id	path	integer	ID interno do contrato

Buscar Contrato por ID

get

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

/api/v1/originator/contracts/{id}

Retorna os detalhes do contrato a partir do identificador interno.

Autorizações

BearerAuth

AuthorizationstringObrigatório

JWT token fornecido pelo administrador

Parâmetros de rota

idinteger · int64Obrigatório

ID do contrato

Respostas

200

Contrato retornado 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.

401

Não autenticado

403

Permissão insuficiente

404

Contrato não encontrado

get

/api/v1/originator/contracts/{id}

HTTPcURLJavaScriptPython

GET /api/v1/originator/contracts/{id} HTTP/1.1
Host: consignado.staging.giro.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 156,
  "requestNumber": "GTAB12CD34EF",
  "contractNumber": 345678,
  "employeeId": 15,
  "proposalId": 23,
  "status": "CREATED",
  "endorsementStatus": "PENDING",
  "contractAmount": 5000,
  "installments": 12,
  "contractDate": "2025-01-15T10:00:00Z",
  "firstInstallmentDueDate": "2025-04-25",
  "lastInstallmentDueDate": "2026-03-25",
  "attendantName": "Maria Atendente",
  "attendantCpf": "98765432100",
  "createdDate": "2025-01-15T10:00:00Z"
}

Central de Atendimento | Giro.TechGiro.Tech