> For the complete documentation index, see [llms.txt](https://docs.giro.tech/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.giro.tech/desenvolvedores/api-gtfgts/api-reference/operacoes-fgts/submeter-operacoes/consultar-status-protocolo.md).

# Consultar Status por Protocolo

Admite uma consulta do status **atual** de um protocolo FGTS já emitido pela Caixa, de forma assíncrona com prioridade `NORMAL`. O protocolo é gerado pela Caixa após uma averbação ou manutenção de garantia concluída; use esta operação quando você tem o **número do protocolo** e quer saber a situação atual dele.

{% hint style="info" %}
Esta operação é **assíncrona**: a resposta `202` confirma apenas a admissão. O resultado chega depois via [webhook](https://docs.giro.tech/desenvolvedores/api-gtfgts/webhooks/payloads.md) ou por [polling](https://docs.giro.tech/desenvolvedores/api-gtfgts/api-reference/operacoes-fgts/acompanhar-resultado/consultar-status-operacao.md) do `requestId`.
{% endhint %}

{% hint style="info" %}
A consulta de status por protocolo passa pela **mesma fila priorizada** das demais operações FGTS. Antes era uma consulta síncrona (`GET`); mudou para o modelo assíncrono para garantir **priorização justa entre originadores** — nenhuma consulta de status pode furar a fila das demais operações. Para acompanhar o desfecho de uma operação que **você** submeteu, prefira o [polling por `requestId`](https://docs.giro.tech/desenvolvedores/api-gtfgts/api-reference/operacoes-fgts/acompanhar-resultado/consultar-status-operacao.md) da própria submissão; a diferença entre as duas consultas está em [Status da operação vs. status do protocolo](https://docs.giro.tech/desenvolvedores/api-gtfgts/guias/fluxo-assincrono-e-polling.md#protocolo-vs-operacao).
{% endhint %}

## Request

`POST /api/v1/fgts/protocol-status-queries`

Autenticado: `Authorization: Bearer {originatorToken}`.

### Parâmetros

| Parâmetro         | Local  | Tipo               | Obrigatório | Descrição                                                                                                                                                                                                     |
| ----------------- | ------ | ------------------ | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Idempotency-Key` | header | `string` (max 100) | Não         | Chave de idempotência de negócio. Reenviar a mesma chave retorna o `requestId` existente sem publicar novamente. Ver [Idempotência](https://docs.giro.tech/desenvolvedores/api-gtfgts/guias/idempotencia.md). |

### Corpo

| Campo            | Tipo                                            | Obrigatório | Descrição                                                                                                       |
| ---------------- | ----------------------------------------------- | ----------- | --------------------------------------------------------------------------------------------------------------- |
| `protocolNumber` | `string` (numérico, 1–18 dígitos, `^\d{1,18}$`) | Sim         | Número do protocolo gerado pela Caixa, somente dígitos. Apenas o originator dono do protocolo pode consultá-lo. |

## Response

| Campo       | Tipo            | Descrição                                                                                                                 |
| ----------- | --------------- | ------------------------------------------------------------------------------------------------------------------------- |
| `requestId` | `string` (uuid) | Identificador único da requisição admitida, gerado pela API. Use no polling em `GET /api/v1/fgts/operations/{requestId}`. |
| `status`    | `string`        | `QUEUED` — operação enfileirada para processamento assíncrono.                                                            |

* **202 Accepted** — consulta de status por protocolo admitida para processamento assíncrono. Quando concluída, o `result` do polling conterá o status atual do protocolo.

## Exemplo

```http
POST /api/v1/fgts/protocol-status-queries HTTP/1.1
Host: ingress.gtfgts.staging.giro.tech
Authorization: Bearer {originatorToken}
Content-Type: application/json

{
  "protocolNumber": "202400010000001"
}
```

```json
{
  "requestId": "f6a7b8c9-58cc-4372-a567-0e02b2c3d479",
  "status": "QUEUED"
}
```

## Próximo passo

Acompanhe o resultado em [Consultar Status da Operação](https://docs.giro.tech/desenvolvedores/api-gtfgts/api-reference/operacoes-fgts/acompanhar-resultado/consultar-status-operacao.md) usando o `requestId` retornado, ou aguarde o callback no [webhook](https://docs.giro.tech/desenvolvedores/api-gtfgts/webhooks/payloads.md) cadastrado.

## Erros

| Código | Situação                                                                                                                                                                                                                                                                              |
| ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 400    | Validação de payload (campo obrigatório ausente, `protocolNumber` fora do padrão `^\d{1,18}$`, etc.) — `errorCode = VALIDATION_ERROR`                                                                                                                                                 |
| 401    | Token ausente, inválido ou expirado — `errorCode = UNAUTHORIZED`                                                                                                                                                                                                                      |
| 422    | `Idempotency-Key` já usada nesta rota com outro corpo — `errorCode = IDEMPOTENCY_KEY_PAYLOAD_MISMATCH`. Nada é enfileirado; para uma operação nova, use uma chave nova. Ver [Idempotência](https://docs.giro.tech/desenvolvedores/api-gtfgts/guias/idempotencia.md#payload-diferente) |
| 429    | Hard ceiling de rate limit de ingresso excedido — `errorCode = INGRESS_RATE_LIMIT_EXCEEDED` (header `Retry-After: 1`, sem `X-RateLimit-*`). Ver [Prioridades e rate limit](https://docs.giro.tech/desenvolvedores/api-gtfgts/guias/prioridades-e-rate-limit.md)                       |
| 503    | Indisponibilidade momentânea; nada foi registrado — `errorCode = SUBMISSION_TEMPORARILY_UNAVAILABLE` (header `Retry-After: 5`). Repita com o mesmo corpo e a mesma `Idempotency-Key`                                                                                                  |
| 500    | Erro interno inesperado — `errorCode = INTERNAL_ERROR`                                                                                                                                                                                                                                |

Os erros seguem o formato `ProblemDetail` (RFC 7807), com o campo `errorCode`. Ver [Erros da API](https://docs.giro.tech/desenvolvedores/api-gtfgts/guias/erros.md).

Esses são os erros da **requisição**. O desfecho da operação chega depois, no `error.code` do polling e do webhook — ver [`error.code` de operação](https://docs.giro.tech/desenvolvedores/api-gtfgts/guias/erros.md#catalogo-operacao) e [Códigos da Caixa](https://docs.giro.tech/desenvolvedores/api-gtfgts/guias/erros.md#catalogo-caixa). Desfechos de falha: `PROVIDER_ERROR` com o código cru `29` quando o protocolo não existe, `PROVIDER_UNAVAILABLE` e `TRANSIENT_PROVIDER_EDGE_UNAVAILABLE`.

## Submete consulta de status de protocolo FGTS (assíncrona)

> Admite uma consulta de status de protocolo FGTS de forma assíncrona. O resultado é entregue via webhook cadastrado ou via polling em \`GET /api/v1/fgts/operations/{requestId}\`.\
> Esta operação \*\*não usa CPF\*\* — o campo \`cpf\` na mensagem SQS é sempre \`null\`. Identificação é feita pelo \`protocolNumber\` (numérico, 1–18 dígitos).\
> O header \`Idempotency-Key\` é aceito para deduplicação de negócio.

```json
{"openapi":"3.0.3","info":{"title":"gtfgts-ingress Public API","version":"0.0.1"},"tags":[{"name":"fgts-operations","description":"Submissão assíncrona de operações FGTS (balance-queries, endorsements, guarantee-maintenances, reserve-cancellations, reserve-value-queries, reserve-protocol-queries, protocol-status-queries), polling de status por `requestId` e cancelamento síncrono de operação. Todas protegidas por JWT do originator."}],"servers":[{"url":"https://ingress.gtfgts.staging.giro.tech","description":"Homologação (testes e validação da integração)"},{"url":"https://gtfgts.giro.tech","description":"Produção (operações reais)"},{"url":"http://localhost:8080","description":"Local (bootRun -Pprofiles=local)"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT de originator fornecido pela GTLab no cadastro do originator. Identifica e autoriza o originator em todos os endpoints `/api/v1/**`.\nInclua no header: `Authorization: Bearer <token>`."}}},"paths":{"/api/v1/fgts/protocol-status-queries":{"post":{"operationId":"submitProtocolStatusQuery","tags":["fgts-operations"],"summary":"Submete consulta de status de protocolo FGTS (assíncrona)","description":"Admite uma consulta de status de protocolo FGTS de forma assíncrona. O resultado é entregue via webhook cadastrado ou via polling em `GET /api/v1/fgts/operations/{requestId}`.\nEsta operação **não usa CPF** — o campo `cpf` na mensagem SQS é sempre `null`. Identificação é feita pelo `protocolNumber` (numérico, 1–18 dígitos).\nO header `Idempotency-Key` é aceito para deduplicação de negócio.","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"description":"Chave de idempotência de negócio. Reenviar a mesma chave retorna o `requestId` existente sem reprocessar.","schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["protocolNumber"],"properties":{"protocolNumber":{"type":"string","description":"Número do protocolo FGTS a ser consultado. Deve conter apenas dígitos (0-9), com 1 a 18 caracteres.","pattern":"^\\d{1,18}$","minLength":1,"maxLength":18}}}}}},"responses":{"202":{"description":"Consulta de status de protocolo admitida para processamento assíncrono. Quando concluída, o `result` do polling conterá o status do protocolo.","content":{"application/json":{"schema":{"type":"object","description":"Confirmação de admissão assíncrona da operação FGTS (`202 Accepted`). O processamento ocorre em background; acompanhe pelo `requestId` via polling (`GET /api/v1/fgts/operations/{requestId}`) ou pelo webhook cadastrado.\n**Exceção para `balance-queries`:** quando o saldo já está disponível, a resposta é `200 OK` com `status: COMPLETED`, `source: CAIXA_CALL` e `result` com o saldo — não é necessário polling, e o webhook é enviado também. Caso contrário, retorna `202`.","required":["requestId","status"],"properties":{"requestId":{"type":"string","format":"uuid","description":"Identificador único (UUID) gerado pelo serviço para esta chamada. Em resposta `202` a requisição foi admitida no processamento assíncrono e este é o identificador de polling: use-o em `GET /api/v1/fgts/operations/{requestId}`. Em resposta `200` de `balance-queries` o resultado já vem inline em `result`, e a operação também é admitida com este `requestId`: é o mesmo do webhook e é consultável em `GET /api/v1/fgts/operations/{requestId}`. Só é preciso fazer polling quando o `status` for `QUEUED`."},"status":{"type":"string","enum":["QUEUED","COMPLETED"],"description":"Status da operação no momento da admissão. `QUEUED`: operação enfileirada para processamento assíncrono (resposta `202`). `COMPLETED`: resultado disponível inline no campo `result` — ocorre apenas quando o saldo de `balance-queries` já está disponível (resposta `200`)."},"source":{"type":"string","nullable":true,"enum":["CAIXA_CALL"],"description":"Origem do resultado. Presente apenas em resposta `200` de `balance-queries`. `CAIXA_CALL`: saldo apurado na Caixa. Nulo em respostas `202`."},"result":{"nullable":true,"description":"Resultado da operação. Presente apenas em resposta `200` de `balance-queries`. Nulo em respostas `202`.","oneOf":[{"type":"object","description":"Resultado de consulta de saldo (`BALANCE_QUERY`) com saldo disponível — saldo FGTS do trabalhador, com a lista de períodos e valores por competência.","required":["workerCpf","balanceDate"],"properties":{"workerCpf":{"type":"string","description":"CPF do trabalhador (11 dígitos, sem pontuação)."},"balanceDate":{"type":"string","format":"date","description":"Data de referência do saldo consultado (ISO-8601, ex. `2026-05-20`)."},"hasDisregardedBalance":{"type":"boolean","description":"Indica que o trabalhador possui valores de FGTS não considerados no saldo retornado, por não estarem disponíveis para uso como garantia. Pode vir ausente quando a Caixa não informa o campo."},"activeRequestCount":{"type":"integer","description":"Quantidade de pedidos de garantia ativos para o trabalhador na Caixa, considerando todas as instituições — não apenas as reservas deste originador. Reflete o momento da apuração do saldo, não o da requisição: o valor pode estar desatualizado."},"periods":{"type":"array","description":"Lista de períodos com valor disponível para averbação.","items":{"type":"object","description":"Período de competência com valor disponível para averbação.","required":["transferDate","amount"],"properties":{"transferDate":{"type":"string","format":"date","description":"Data de transferência (competência) do período (ISO-8601, ex. `2026-05-01`)."},"amount":{"type":"number","description":"Valor disponível para averbação neste período."}}}}}},{"type":"object","description":"Resultado de consulta de saldo (`BALANCE_QUERY`) sem saldo disponível para averbação.","required":["hasBalance"],"properties":{"hasBalance":{"type":"boolean","description":"Sempre `false` — indica ausência de saldo."}}}]},"reserveIdentifier":{"type":"string","nullable":true,"minLength":13,"maxLength":14,"pattern":"^GT[FD][0-9]{8}[0-9A-HJKMNP-TV-Z]{2,3}$","description":"Identificador determinístico de 13 ou 14 caracteres (`GTD{contractNumber:8}{code:2..3}`) gerado no momento da submissão de averbação — o código do originador tem 2 ou 3 caracteres. Presente apenas em respostas `202` de `POST /endorsements`. Nulo para todos os outros tipos de operação."}}}}}},"400":{"description":"Requisição inválida — falha de validação de Bean Validation (campos obrigatórios ausentes, formatos incorretos, CPF com dígitos errados, etc.). O campo `errors` contém um mapa `{ \"campo\": \"mensagem\" }` para cada campo inválido. O campo `title` é sempre `\"Bean validation error\"` e `detail` é sempre `\"One or more fields were invalid. See 'errors' for details.\"`.\nRejeições de regra de negócio também chegam como `400`, com `errorCode` próprio (ex.: `CONTRACT_INSTALLMENTS_MISMATCH`). Quando a rejeição aponta um campo do request, ela traz o mesmo `errors` e o mesmo `detail`; quando não há campo associado, `errors` é omitido e `detail` é o reason phrase do status.","content":{"application/problem+json":{"schema":{"type":"object","description":"Erro estruturado segundo RFC 7807 — Problem Details for HTTP APIs. Campos adicionais `errorCode` (código canônico GTLab estável) e `timestamp` (instante do erro no servidor) são extensões proprietárias. O campo `errors` (mapa campo→mensagem) é incluído nos erros que apontam para um campo do request: validação de Bean Validation (`errorCode: VALIDATION_ERROR`, HTTP 400) e rejeições de regra de negócio que identificam o campo culpado (ex.: `CONTRACT_INSTALLMENTS_MISMATCH`). Nos erros que não têm campo associado (`401`, `403`, `404`, `429`, `500`, `503`, e rejeições de negócio sem campo) o campo `errors` está ausente.","properties":{"type":{"type":"string","format":"uri","description":"URI de referência do tipo de problema."},"title":{"type":"string","description":"Título legível do tipo de problema."},"status":{"type":"integer","format":"int32","description":"HTTP status code do problema."},"detail":{"type":"string","description":"Descrição legível específica desta ocorrência do problema."},"instance":{"type":"string","description":"URI reference (relativa ou absoluta) que identifica esta ocorrência específica do problema. Geralmente o path do endpoint que gerou o erro."},"errorCode":{"type":"string","description":"Código de erro canônico GTLab estável para uso programático."},"timestamp":{"type":"string","format":"date-time","description":"Instante em que o erro ocorreu no servidor (ISO-8601 UTC)."},"errors":{"type":"object","nullable":true,"additionalProperties":{"type":"string"},"description":"Mapa de erros no formato `{ \"campo\": \"mensagem\" }`, onde cada chave nomeia um campo do **request enviado por você**. Presente quando `errorCode` é `VALIDATION_ERROR` (falha de Bean Validation — `@NotBlank`, `@NotNull`, `@Size`, `@Pattern`, etc.) e também em rejeições de regra de negócio que conseguem apontar o campo culpado, como `CONTRACT_INSTALLMENTS_MISMATCH`. Quando presente, `detail` é `\"One or more fields were invalid. See 'errors' for details.\"`. Ausente em erros sem campo associado (`401`, `403`, `404`, `429`, `500`, `503`) e em rejeições de negócio que não se referem a um campo do request."}}}}}},"401":{"description":"Não autenticado — JWT ausente, inválido ou expirado. Autentique-se e inclua o token no header `Authorization: Bearer <token>`.","content":{"application/problem+json":{"schema":{"type":"object","description":"Erro estruturado segundo RFC 7807 — Problem Details for HTTP APIs. Campos adicionais `errorCode` (código canônico GTLab estável) e `timestamp` (instante do erro no servidor) são extensões proprietárias. O campo `errors` (mapa campo→mensagem) é incluído nos erros que apontam para um campo do request: validação de Bean Validation (`errorCode: VALIDATION_ERROR`, HTTP 400) e rejeições de regra de negócio que identificam o campo culpado (ex.: `CONTRACT_INSTALLMENTS_MISMATCH`). Nos erros que não têm campo associado (`401`, `403`, `404`, `429`, `500`, `503`, e rejeições de negócio sem campo) o campo `errors` está ausente.","properties":{"type":{"type":"string","format":"uri","description":"URI de referência do tipo de problema."},"title":{"type":"string","description":"Título legível do tipo de problema."},"status":{"type":"integer","format":"int32","description":"HTTP status code do problema."},"detail":{"type":"string","description":"Descrição legível específica desta ocorrência do problema."},"instance":{"type":"string","description":"URI reference (relativa ou absoluta) que identifica esta ocorrência específica do problema. Geralmente o path do endpoint que gerou o erro."},"errorCode":{"type":"string","description":"Código de erro canônico GTLab estável para uso programático."},"timestamp":{"type":"string","format":"date-time","description":"Instante em que o erro ocorreu no servidor (ISO-8601 UTC)."},"errors":{"type":"object","nullable":true,"additionalProperties":{"type":"string"},"description":"Mapa de erros no formato `{ \"campo\": \"mensagem\" }`, onde cada chave nomeia um campo do **request enviado por você**. Presente quando `errorCode` é `VALIDATION_ERROR` (falha de Bean Validation — `@NotBlank`, `@NotNull`, `@Size`, `@Pattern`, etc.) e também em rejeições de regra de negócio que conseguem apontar o campo culpado, como `CONTRACT_INSTALLMENTS_MISMATCH`. Quando presente, `detail` é `\"One or more fields were invalid. See 'errors' for details.\"`. Ausente em erros sem campo associado (`401`, `403`, `404`, `429`, `500`, `503`) e em rejeições de negócio que não se referem a um campo do request."}}}}}},"403":{"description":"Sem permissão — originator autenticado mas sem acesso ao recurso solicitado. Na API pública, ocorre apenas na consulta de operação com `requestId` de outro originator. Contrato, reserva e simulação de outro originator respondem `404`.","content":{"application/problem+json":{"schema":{"type":"object","description":"Erro estruturado segundo RFC 7807 — Problem Details for HTTP APIs. Campos adicionais `errorCode` (código canônico GTLab estável) e `timestamp` (instante do erro no servidor) são extensões proprietárias. O campo `errors` (mapa campo→mensagem) é incluído nos erros que apontam para um campo do request: validação de Bean Validation (`errorCode: VALIDATION_ERROR`, HTTP 400) e rejeições de regra de negócio que identificam o campo culpado (ex.: `CONTRACT_INSTALLMENTS_MISMATCH`). Nos erros que não têm campo associado (`401`, `403`, `404`, `429`, `500`, `503`, e rejeições de negócio sem campo) o campo `errors` está ausente.","properties":{"type":{"type":"string","format":"uri","description":"URI de referência do tipo de problema."},"title":{"type":"string","description":"Título legível do tipo de problema."},"status":{"type":"integer","format":"int32","description":"HTTP status code do problema."},"detail":{"type":"string","description":"Descrição legível específica desta ocorrência do problema."},"instance":{"type":"string","description":"URI reference (relativa ou absoluta) que identifica esta ocorrência específica do problema. Geralmente o path do endpoint que gerou o erro."},"errorCode":{"type":"string","description":"Código de erro canônico GTLab estável para uso programático."},"timestamp":{"type":"string","format":"date-time","description":"Instante em que o erro ocorreu no servidor (ISO-8601 UTC)."},"errors":{"type":"object","nullable":true,"additionalProperties":{"type":"string"},"description":"Mapa de erros no formato `{ \"campo\": \"mensagem\" }`, onde cada chave nomeia um campo do **request enviado por você**. Presente quando `errorCode` é `VALIDATION_ERROR` (falha de Bean Validation — `@NotBlank`, `@NotNull`, `@Size`, `@Pattern`, etc.) e também em rejeições de regra de negócio que conseguem apontar o campo culpado, como `CONTRACT_INSTALLMENTS_MISMATCH`. Quando presente, `detail` é `\"One or more fields were invalid. See 'errors' for details.\"`. Ausente em erros sem campo associado (`401`, `403`, `404`, `429`, `500`, `503`) e em rejeições de negócio que não se referem a um campo do request."}}}}}},"429":{"description":"Teto de vazão das submissões FGTS excedido (`INGRESS_RATE_LIMIT_EXCEEDED`) — a requisição foi rejeitada e nenhum `requestId` foi gerado. Aguarde `Retry-After` (1 segundo) e reduza a taxa. Esta resposta não traz os headers de janela. Abaixo do teto e acima da cota, a requisição é admitida com prioridade `DEFERRED` (`202`).","headers":{"Retry-After":{"description":"Segundos até a próxima janela disponível.","schema":{"type":"integer","format":"int64"}}},"content":{"application/problem+json":{"schema":{"type":"object","description":"Erro estruturado segundo RFC 7807 — Problem Details for HTTP APIs. Campos adicionais `errorCode` (código canônico GTLab estável) e `timestamp` (instante do erro no servidor) são extensões proprietárias. O campo `errors` (mapa campo→mensagem) é incluído nos erros que apontam para um campo do request: validação de Bean Validation (`errorCode: VALIDATION_ERROR`, HTTP 400) e rejeições de regra de negócio que identificam o campo culpado (ex.: `CONTRACT_INSTALLMENTS_MISMATCH`). Nos erros que não têm campo associado (`401`, `403`, `404`, `429`, `500`, `503`, e rejeições de negócio sem campo) o campo `errors` está ausente.","properties":{"type":{"type":"string","format":"uri","description":"URI de referência do tipo de problema."},"title":{"type":"string","description":"Título legível do tipo de problema."},"status":{"type":"integer","format":"int32","description":"HTTP status code do problema."},"detail":{"type":"string","description":"Descrição legível específica desta ocorrência do problema."},"instance":{"type":"string","description":"URI reference (relativa ou absoluta) que identifica esta ocorrência específica do problema. Geralmente o path do endpoint que gerou o erro."},"errorCode":{"type":"string","description":"Código de erro canônico GTLab estável para uso programático."},"timestamp":{"type":"string","format":"date-time","description":"Instante em que o erro ocorreu no servidor (ISO-8601 UTC)."},"errors":{"type":"object","nullable":true,"additionalProperties":{"type":"string"},"description":"Mapa de erros no formato `{ \"campo\": \"mensagem\" }`, onde cada chave nomeia um campo do **request enviado por você**. Presente quando `errorCode` é `VALIDATION_ERROR` (falha de Bean Validation — `@NotBlank`, `@NotNull`, `@Size`, `@Pattern`, etc.) e também em rejeições de regra de negócio que conseguem apontar o campo culpado, como `CONTRACT_INSTALLMENTS_MISMATCH`. Quando presente, `detail` é `\"One or more fields were invalid. See 'errors' for details.\"`. Ausente em erros sem campo associado (`401`, `403`, `404`, `429`, `500`, `503`) e em rejeições de negócio que não se referem a um campo do request."}}}}}},"500":{"description":"Erro interno inesperado no servidor.","content":{"application/problem+json":{"schema":{"type":"object","description":"Erro estruturado segundo RFC 7807 — Problem Details for HTTP APIs. Campos adicionais `errorCode` (código canônico GTLab estável) e `timestamp` (instante do erro no servidor) são extensões proprietárias. O campo `errors` (mapa campo→mensagem) é incluído nos erros que apontam para um campo do request: validação de Bean Validation (`errorCode: VALIDATION_ERROR`, HTTP 400) e rejeições de regra de negócio que identificam o campo culpado (ex.: `CONTRACT_INSTALLMENTS_MISMATCH`). Nos erros que não têm campo associado (`401`, `403`, `404`, `429`, `500`, `503`, e rejeições de negócio sem campo) o campo `errors` está ausente.","properties":{"type":{"type":"string","format":"uri","description":"URI de referência do tipo de problema."},"title":{"type":"string","description":"Título legível do tipo de problema."},"status":{"type":"integer","format":"int32","description":"HTTP status code do problema."},"detail":{"type":"string","description":"Descrição legível específica desta ocorrência do problema."},"instance":{"type":"string","description":"URI reference (relativa ou absoluta) que identifica esta ocorrência específica do problema. Geralmente o path do endpoint que gerou o erro."},"errorCode":{"type":"string","description":"Código de erro canônico GTLab estável para uso programático."},"timestamp":{"type":"string","format":"date-time","description":"Instante em que o erro ocorreu no servidor (ISO-8601 UTC)."},"errors":{"type":"object","nullable":true,"additionalProperties":{"type":"string"},"description":"Mapa de erros no formato `{ \"campo\": \"mensagem\" }`, onde cada chave nomeia um campo do **request enviado por você**. Presente quando `errorCode` é `VALIDATION_ERROR` (falha de Bean Validation — `@NotBlank`, `@NotNull`, `@Size`, `@Pattern`, etc.) e também em rejeições de regra de negócio que conseguem apontar o campo culpado, como `CONTRACT_INSTALLMENTS_MISMATCH`. Quando presente, `detail` é `\"One or more fields were invalid. See 'errors' for details.\"`. Ausente em erros sem campo associado (`401`, `403`, `404`, `429`, `500`, `503`) e em rejeições de negócio que não se referem a um campo do request."}}}}}},"503":{"description":"Serviço temporariamente indisponível. Aguarde `Retry-After` segundos e tente novamente.","headers":{"Retry-After":{"description":"Segundos recomendados até a próxima tentativa.","schema":{"type":"integer","format":"int64"}}},"content":{"application/problem+json":{"schema":{"type":"object","description":"Erro estruturado segundo RFC 7807 — Problem Details for HTTP APIs. Campos adicionais `errorCode` (código canônico GTLab estável) e `timestamp` (instante do erro no servidor) são extensões proprietárias. O campo `errors` (mapa campo→mensagem) é incluído nos erros que apontam para um campo do request: validação de Bean Validation (`errorCode: VALIDATION_ERROR`, HTTP 400) e rejeições de regra de negócio que identificam o campo culpado (ex.: `CONTRACT_INSTALLMENTS_MISMATCH`). Nos erros que não têm campo associado (`401`, `403`, `404`, `429`, `500`, `503`, e rejeições de negócio sem campo) o campo `errors` está ausente.","properties":{"type":{"type":"string","format":"uri","description":"URI de referência do tipo de problema."},"title":{"type":"string","description":"Título legível do tipo de problema."},"status":{"type":"integer","format":"int32","description":"HTTP status code do problema."},"detail":{"type":"string","description":"Descrição legível específica desta ocorrência do problema."},"instance":{"type":"string","description":"URI reference (relativa ou absoluta) que identifica esta ocorrência específica do problema. Geralmente o path do endpoint que gerou o erro."},"errorCode":{"type":"string","description":"Código de erro canônico GTLab estável para uso programático."},"timestamp":{"type":"string","format":"date-time","description":"Instante em que o erro ocorreu no servidor (ISO-8601 UTC)."},"errors":{"type":"object","nullable":true,"additionalProperties":{"type":"string"},"description":"Mapa de erros no formato `{ \"campo\": \"mensagem\" }`, onde cada chave nomeia um campo do **request enviado por você**. Presente quando `errorCode` é `VALIDATION_ERROR` (falha de Bean Validation — `@NotBlank`, `@NotNull`, `@Size`, `@Pattern`, etc.) e também em rejeições de regra de negócio que conseguem apontar o campo culpado, como `CONTRACT_INSTALLMENTS_MISMATCH`. Quando presente, `detail` é `\"One or more fields were invalid. See 'errors' for details.\"`. Ausente em erros sem campo associado (`401`, `403`, `404`, `429`, `500`, `503`) e em rejeições de negócio que não se referem a um campo do request."}}}}}}}}}}}
```

## Resultado no webhook

Concluída a consulta, a Giro.Tech envia ao webhook cadastrado um envelope `{ source, eventType, data }`. Para esta operação o `source` é **`QUERY_PROTOCOL_STATUS`** e os `eventType` possíveis são (consulta **não** tem desfecho `*_NEEDS_VERIFICATION`):

| `eventType`                       | Quando             | `data`                                                                                           |
| --------------------------------- | ------------------ | ------------------------------------------------------------------------------------------------ |
| `QUERY_PROTOCOL_STATUS_COMPLETED` | consulta concluída | `result` com o status atual do protocolo (`protocolNumber`, `protocolStatus` e dados de detalhe) |
| `QUERY_PROTOCOL_STATUS_FAILED`    | erro na consulta   | `error` (`OperationError`)                                                                       |

### QUERY\_PROTOCOL\_STATUS\_COMPLETED

Status atual do protocolo — o `result` é um `ProtocolDetails` com `protocolNumber`, `protocolStatus`, o tipo e a data da requisição, o identificador da reserva, o CPF do trabalhador, o tipo de operação e os `periods[]`.

```json
{
  "source": "QUERY_PROTOCOL_STATUS",
  "eventType": "QUERY_PROTOCOL_STATUS_COMPLETED",
  "data": {
    "requestId": "f5a6b7c8-d9e0-1234-efab-456789012345",
    "protocolNumber": 202412345678,
    "status": "COMPLETED",
    "source": "CAIXA_CALL",
    "result": {
      "protocolNumber": 202412345678,
      "protocolStatus": "ENDORSED",
      "requestType": "RESERVE_REQUEST",
      "requestDateTime": "2026-06-25T10:30:00",
      "reserveIdentifier": "RES-2026-0001",
      "workerCpf": "12345678901",
      "operationKind": "FIDUCIARY_ASSIGNMENT",
      "periods": [
        { "transferDate": "2026-07-01", "amount": 1234.56 }
      ]
    }
  }
}
```

Campos do `result` (`ProtocolDetails`):

| Campo               | Tipo            | Descrição                                                                                                                             |
| ------------------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `protocolNumber`    | `number`        | Número do protocolo da Caixa.                                                                                                         |
| `protocolStatus`    | `string` (enum) | Status atual: `ENDORSED`, `PROCESSING`, `REJECTED`, `NOT_FOUND`, `RATE_LIMITED`.                                                      |
| `requestType`       | `string` (enum) | Tipo da requisição que gerou o protocolo: `RESERVE_REQUEST`, `RESERVE_CANCELLATION_REQUEST`, `RESERVE_GUARANTEE_MAINTENANCE_REQUEST`. |
| `requestDateTime`   | `string`        | Data/hora da requisição.                                                                                                              |
| `reserveIdentifier` | `string`        | Identificador da reserva associada ao protocolo.                                                                                      |
| `workerCpf`         | `string`        | CPF do trabalhador, 11 dígitos.                                                                                                       |
| `operationKind`     | `string` (enum) | Tipo de operação: `FIDUCIARY_ASSIGNMENT`, `FIDUCIARY_ALIENATION`.                                                                     |
| `periods`           | `array`         | Períodos do protocolo (`transferDate`, `amount`).                                                                                     |

### QUERY\_PROTOCOL\_STATUS\_FAILED

Falha na consulta de status do protocolo. Protocolo inexistente chega aqui, com `error.code = PROVIDER_ERROR` e o código cru `29` em `originalErrors`.

```json
{
  "source": "QUERY_PROTOCOL_STATUS",
  "eventType": "QUERY_PROTOCOL_STATUS_FAILED",
  "data": {
    "requestId": "f5a6b7c8-d9e0-1234-efab-456789012347",
    "protocolNumber": 202400010000002,
    "status": "FAILED",
    "source": "CAIXA_CALL",
    "error": {
      "code": "PROVIDER_ERROR",
      "message": "Query protocol status failed — Caixa returned error",
      "originalErrors": [
        { "provider": "CAIXA", "code": "29", "description": "Protocolo não encontrado", "httpStatus": 404, "occurredAt": "2026-06-15T10:00:03Z" }
      ]
    }
  }
}
```

Catálogo completo de eventos e payloads em [Eventos](https://docs.giro.tech/desenvolvedores/api-gtfgts/webhooks/eventos.md) e [Payloads](https://docs.giro.tech/desenvolvedores/api-gtfgts/webhooks/payloads.md).

{% embed url="<https://giro.tech/central-de-atendimento/>" %}
