Eventos e Payloads

Lista completa de eventos disponíveis e seus respectivos payloads.

---

Eventos disponíveis

Margem

Evento	Source	Descrição
MARGIN_QUERY_COMPLETED	EMPLOYEE	Consulta de margem concluída

Autorização Dataprev

Evento	Source	Descrição
AUTHORIZATION_COMPLETED	EMPLOYEE	Autorização Dataprev concluída (assinatura do termo)

Averbação

Evento	Source	Descrição
ENDORSEMENT_ENDORSED	CONTRACT	Contrato averbado com sucesso
ENDORSEMENT_FAILED	CONTRACT	Averbação falhou
ENDORSEMENT_RETRYING	CONTRACT	Averbação em retry (tentando novamente)
ENDORSEMENT_PROCESSING	CONTRACT	Averbação em processamento
ENDORSEMENT_PENDING	CONTRACT	Averbação pendente

Pagamento (GTBanker)

Evento	Source	Descrição
PAYMENT_SUCCESS	GTBANKER	Pagamento/desembolso realizado com sucesso
PAYMENT_REVISION	GTBANKER	Pagamento em revisão
PAYMENT_FAILURE	GTBANKER	Falha no pagamento/desembolso
CCB_RECEIVED	GTBANKER	CCB (Cédula de Crédito Bancário) recebida

Assinatura

Evento	Source	Descrição
SIGNATURE_LINK_RESEND	CONTRACT	Link de assinatura reenviado

---

Payloads por evento

MARGIN_QUERY_COMPLETED

Enviado quando a consulta de margem de um colaborador é concluída.

{
  "cpf": "12345678901",
  "publicId": "Kj8mP2xQ9nR4sT6v",
  "status": "MARGIN_UPDATED"
}

Campo	Tipo	Descrição
cpf	string	CPF do colaborador
publicId	string	Identificador público do colaborador
status	string	Status da consulta de margem (MARGIN_UPDATED quando concluída)

Referência: os campos cpf e publicId correspondem ao Employee. O status da margem pode ser consultado via:

Consultar Margem

get

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

/api/v1/originator/employees/{cpf}/margin

Consulta margem consignável de um employee

Autorizações

BearerAuth

AuthorizationstringObrigatório

JWT token fornecido pelo administrador

Parâmetros de rota

cpfstringObrigatório

CPF do employee (11 dígitos)

Pattern: ^\d{11}$

Respostas

200

Margem retornada com sucesso

application/json

statusstring · enumOpcional

Status da consulta de margem no convênio.

Valor	Significado
OK	Margem disponível e elegível
PENDING	Consulta em análise
PROCESSING	Processando dados no convênio
EXPIRED	Margem expirada (prazo Dataprev)
TERM_EXPIRED	Prazo do contrato expirado
NO_BONDS	Sem vínculos ativos
NOT_ELIGIBLE	Não elegível às regras do produto
NO_MARGIN	Sem margem disponível
ERROR	Erro na consulta

Valores possíveis:

reasonstringOpcional

202

Consulta em processamento

application/json

401

Não autenticado

403

Permissão insuficiente

404

Employee não encontrado

get

/api/v1/originator/employees/{cpf}/margin

HTTPcURLJavaScriptPython

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

{
  "status": "OK",
  "reason": null,
  "employmentRelationships": [
    {
      "id": 7,
      "registrationNumber": "12345678901",
      "employerTaxId": "12345678000199",
      "employerName": "Empresa Exemplo Ltda",
      "admissionDate": "2020-03-15",
      "status": "ACTIVE",
      "totalEarnings": 4850.73,
      "marginBase": 4850.73,
      "availableMargin": 1697.76,
      "usableMargin": 1697.76,
      "isEligible": true
    }
  ]
}

---

AUTHORIZATION_COMPLETED

Enviado quando a autorização Dataprev é concluída (após assinatura do termo).

{
  "cpf": "12345678901",
  "publicId": "Kj8mP2xQ9nR4sT6v",
  "status": "AUTHORIZED",
  "termExpiresAt": "2026-03-28T23:59:59Z",
  "tokenExpiresAt": "2026-03-01T12:00:00Z"
}

Campo	Tipo	Descrição
cpf	string	CPF do colaborador
publicId	string	Identificador público do colaborador
status	string	Status da autorização (AUTHORIZED quando concluída)
termExpiresAt	string (ISO 8601)	Data de expiração do termo de autorização
tokenExpiresAt	string (ISO 8601)	Data de expiração do token de autorização

Referência: o status da autorização pode ser consultado via:

Status de Autorização

get

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

/api/v1/originator/employees/{cpf}/authorization/status

Consulta status de autorização Dataprev de um employee

Autorizações

BearerAuth

AuthorizationstringObrigatório

JWT token fornecido pelo administrador

Parâmetros de rota

cpfstringObrigatório

CPF do employee (11 dígitos)

Pattern: ^\d{11}$

Respostas

200

Status retornado com sucesso

application/json

statusstring · enumOpcional

Status da autorização Dataprev.

Valor	Significado
NOT_STARTED	Processo não iniciado
PENDING_SIGNATURE	Aguardando assinatura do termo
PENDING_SUBMISSION	Aguardando envio ao Dataprev
AUTHORIZED	Autorização concluída (termo assinado)
EXPIRED	Prazo de assinatura expirado

Valores possíveis:

messagestringOpcional

signUrlstringOpcional

nsustringOpcional

expiresAtstring · date-timeOpcional

daysRemainingintegerOpcional

401

Não autenticado

403

Permissão insuficiente

404

Employee não encontrado

get

/api/v1/originator/employees/{cpf}/authorization/status

HTTPcURLJavaScriptPython

GET /api/v1/originator/employees/{cpf}/authorization/status HTTP/1.1
Host: consignado.staging.giro.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "PENDING_SIGNATURE",
  "message": "Aguardando assinatura do trabalhador.",
  "signUrl": "https://sign.example.com/auth/abc123",
  "nsu": "20250115000001",
  "expiresAt": "2025-01-22T23:59:59Z",
  "daysRemaining": 7
}

---

ENDORSEMENT_* (Averbação)

Enviado em cada mudança de status da averbação. O campo status indica o evento específico.

{
  "contractNumber": "00345678",
  "status": "ENDORSED",
  "protocol": "20260226143000",
  "failureReason": null
}

Campo	Tipo	Descrição
contractNumber	string	Número do contrato (8 dígitos)
status	string	Status da averbação (ENDORSED, FAILED, RETRYING, PROCESSING, PENDING)
protocol	string	Protocolo da averbação retornado pelo Dataprev
failureReason	string | null	Motivo da falha (apenas quando status = FAILED)

Referência: os campos correspondem a ContractResponse. O contrato pode ser consultado via:

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"
}

---

PAYMENT_SUCCESS / PAYMENT_REVISION / PAYMENT_FAILURE / CCB_RECEIVED

Enviado quando há atualização no status do pagamento/desembolso.

Os eventos de pagamento utilizam o payload original do GTBanker. A estrutura pode variar conforme o tipo de evento. Consulte a equipe de integração para detalhes do payload de cada evento.

---

SIGNATURE_LINK_RESEND (Autorização)

Enviado quando o link de assinatura da autorização Dataprev é reenviado.

{
  "cpf": "12345678901",
  "publicId": "Kj8mP2xQ9nR4sT6v",
  "nsu": "NSU-123456",
  "signUrl": "https://assinatura.giro.tech/sign/abc123"
}

Campo	Tipo	Descrição
cpf	string	CPF do colaborador
publicId	string	Identificador público do colaborador
nsu	string	NSU da operação
signUrl	string	URL de assinatura reenviada

Referência: o reenvio pode ser feito via:

Reenviar Link de Autorização

post

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

/api/v1/originator/employees/{cpf}/authorization/resend

Reenvia link de assinatura de autorização

Autorizações

BearerAuth

AuthorizationstringObrigatório

JWT token fornecido pelo administrador

Parâmetros de rota

cpfstringObrigatório

CPF do employee (11 dígitos)

Pattern: ^\d{11}$

Corpo

application/json

nsustringObrigatório

NSU do documento

Respostas

200

Link reenviado com sucesso

application/json

statusstring · enumOpcional

Resultado do reenvio do link de assinatura.

Valor	Significado
SENT	Link reenviado com sucesso
FAILED	Falha no reenvio
DOCUMENT_NOT_FOUND	Documento não encontrado
INVALID_STATUS	Status inválido para reenvio

Valores possíveis:

messagestringOpcional

nsustringOpcional

signUrlstringOpcional

400

Dados inválidos

401

Não autenticado

403

Permissão insuficiente

post

/api/v1/originator/employees/{cpf}/authorization/resend

HTTPcURLJavaScriptPython

POST /api/v1/originator/employees/{cpf}/authorization/resend HTTP/1.1
Host: consignado.staging.giro.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "nsu": "NSU123456"
}

{
  "status": "SENT",
  "message": "Link de assinatura reenviado com sucesso.",
  "nsu": "20250115000001",
  "signUrl": "https://sign.example.com/auth/abc123"
}

---

SIGNATURE_LINK_RESEND (Contrato)

Enviado quando o link de assinatura do contrato é reenviado.

{
  "cpf": "12345678901",
  "publicId": "Kj8mP2xQ9nR4sT6v",
  "requestNumber": "GTAB12CD34EF",
  "nsu": "NSU-789012",
  "signUrl": "https://assinatura.giro.tech/sign/def456"
}

Campo	Tipo	Descrição
cpf	string	CPF do colaborador
publicId	string	Identificador público do colaborador
requestNumber	string	Número de requisição do contrato
nsu	string	NSU da operação
signUrl	string	URL de assinatura reenviada

Referência: o reenvio pode ser feito via:

Reenviar Link de Assinatura do Contrato

post

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

/api/v1/originator/contracts/{requestNumber}/resend

Solicita o reenvio do link de assinatura para continuidade da formalização.

Autorizações

BearerAuth

AuthorizationstringObrigatório

JWT token fornecido pelo administrador

Parâmetros de rota

requestNumberstringObrigatório

Número da requisição do contrato

Respostas

200

Link reenviado com sucesso

application/json

statusstring · enumOpcional

Resultado do reenvio do link de assinatura.

Valor	Significado
SENT	Link reenviado com sucesso
FAILED	Falha no reenvio
DOCUMENT_NOT_FOUND	Documento não encontrado
INVALID_STATUS	Status inválido para reenvio

Valores possíveis:

messagestringOpcional

Mensagem explicativa do resultado retornado pela operação.

requestNumberstringOpcional

Número da requisição do contrato processado.

signUrlstringOpcional

URL de assinatura retornada para continuidade do fluxo.

401

Não autenticado

403

Permissão insuficiente

404

Contrato não encontrado

post

/api/v1/originator/contracts/{requestNumber}/resend

HTTPcURLJavaScriptPython

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

{
  "status": "SENT",
  "message": "Link de assinatura reenviado com sucesso.",
  "requestNumber": "GTAB12CD34EF",
  "signUrl": "https://sign.example.com/contract/abc123"
}