> 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-gtpayroll/webhooks/configuracao-via-api.md).

# Configuração via API

Endpoints para o originador criar, consultar, atualizar e remover a própria assinatura de webhook e listar as entregas. Autenticação: `Authorization: Bearer {originatorToken}`.

* Cada originador tem no máximo **uma** assinatura.
* **`authKey`** é o nome do header que o GTPayroll envia em cada POST (ex.: `X-Webhook-Secret`, `Authorization`); **`authValue`** é o valor. O `authValue` nunca é devolvido nas respostas.

## Criar subscription

## Criar subscription de webhook

> Cria a configuração de webhook do originator autenticado.\
> Cada originator pode ter apenas uma subscription (1:1).\
> Retorna 409 se já existir subscription para o originator.<br>

```json
{"openapi":"3.0.0","info":{"title":"GT Payroll Originator API","version":"1.1.0"},"tags":[{"name":"Webhooks","description":"Configuração de webhook (subscription) para receber eventos"}],"servers":[{"url":"https://ingress.gtpayroll.staging.giro.tech","description":"Ambiente de Staging"},{"url":"https://ingress.gtpayroll.giro.tech","description":"Ambiente de Produção"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token fornecido pelo administrador"}}},"paths":{"/api/v1/originator/webhooks":{"post":{"summary":"Criar subscription de webhook","description":"Cria a configuração de webhook do originator autenticado.\nCada originator pode ter apenas uma subscription (1:1).\nRetorna 409 se já existir subscription para o originator.\n","tags":["Webhooks"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webhookUrls","authKey","authValue"],"properties":{"webhookUrls":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"string","format":"uri","pattern":"^https://","maxLength":500,"description":"URL HTTPS que receberá os eventos de webhook (POST)."},"description":"Lista de URLs de destino para entrega dos eventos. Pelo menos uma obrigatória."},"authKey":{"type":"string","maxLength":100,"description":"Nome do header HTTP usado para autenticação nas chamadas de webhook (ex. X-Webhook-Secret, Authorization)."},"authValue":{"type":"string","maxLength":500,"description":"Valor do header de autenticação enviado em cada POST para as URLs configuradas."},"events":{"type":"array","items":{"type":"string","enum":["MARGIN_QUERY_COMPLETED","AUTHORIZATION_COMPLETED","AUTHORIZATION_EXPIRED","ENDORSEMENT_ENDORSED","ENDORSEMENT_FAILED","ENDORSEMENT_RETRYING","ENDORSEMENT_PROCESSING","ENDORSEMENT_PENDING","ENDORSEMENT_EXCLUDING","ENDORSEMENT_EXCLUDED","ENDORSEMENT_EXCLUSION_FAILED","PAYMENT_SUCCESS","PAYMENT_REVISION","PAYMENT_FAILURE","CCB_RECEIVED","SIGNATURE_LINK_RESEND","CONTRACT_DOCUMENT_READY","AUTHORIZATION_DOCUMENT_READY","CONTRACT_SIGNED","AUTHORIZATION_SIGNED"]},"description":"Lista de eventos para os quais o webhook será acionado.\nSe não informado ou vazio, todos os eventos serão registrados por padrão.\n"}}}}}},"responses":{"201":{"description":"Subscription criada com sucesso","content":{"application/json":{"schema":{"type":"object","description":"Representa a subscription de webhook do originator (1:1).\nO campo `authValue` não é retornado por segurança.\n","properties":{"publicId":{"type":"string","format":"uuid","nullable":true,"description":"Identificador público opaco da subscription. Pode vir ausente em registros antigos."},"webhookUrls":{"type":"array","items":{"type":"string","format":"uri","pattern":"^https://","maxLength":500,"description":"URL HTTPS que receberá os eventos de webhook (POST)."},"description":"URLs configuradas para receber os eventos."},"authKey":{"type":"string","description":"Nome do header de autenticação configurado."},"active":{"type":"boolean","description":"Indica se a subscription está ativa."},"events":{"type":"array","items":{"type":"string","enum":["MARGIN_QUERY_COMPLETED","AUTHORIZATION_COMPLETED","AUTHORIZATION_EXPIRED","ENDORSEMENT_ENDORSED","ENDORSEMENT_FAILED","ENDORSEMENT_RETRYING","ENDORSEMENT_PROCESSING","ENDORSEMENT_PENDING","ENDORSEMENT_EXCLUDING","ENDORSEMENT_EXCLUDED","ENDORSEMENT_EXCLUSION_FAILED","PAYMENT_SUCCESS","PAYMENT_REVISION","PAYMENT_FAILURE","CCB_RECEIVED","SIGNATURE_LINK_RESEND","CONTRACT_DOCUMENT_READY","AUTHORIZATION_DOCUMENT_READY","CONTRACT_SIGNED","AUTHORIZATION_SIGNED"]},"description":"Lista de eventos aos quais o webhook está inscrito."},"createdDate":{"type":"string","format":"date-time","description":"Data de criação do registro."},"lastModifiedDate":{"type":"string","format":"date-time","nullable":true,"description":"Data da última alteração."}}}}}},"400":{"description":"Dados inválidos","content":{"application/problem+json":{"schema":{"type":"object","description":"Erro de validação de campos (HTTP 400, `type` `#validation-error`). O mapa campo → mensagem vem em\n`properties.errors`. Campos aninhados usam caminho (`pix.key`, `installments[0].dueDate`); regras\nque cruzam campos aparecem com o nome da regra (`paymentInfoValid`). Um campo com mais de uma\nviolação junta as mensagens com `\"; \"`.\n\nCorpo ilegível (JSON malformado, data, enum ou UUID inválidos) **não** usa este formato: vem como\n`type: about:blank` — ver `RequestFormatError`.\n","required":["type","title","status","properties"],"properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"detail":{"type":"string"},"instance":{"type":"string"},"properties":{"type":"object","required":["errors"],"properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"Mapa campo → mensagem de erro de validação"}}}}}}}},"401":{"description":"Não autenticado","content":{"application/problem+json":{"schema":{"type":"object","description":"Erro de autenticação (HTTP 401). Token ausente, com prefixo diferente de `Bearer `, expirado, revogado ou inválido.","required":["type","title","status"],"properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"detail":{"type":"string"},"instance":{"type":"string"},"properties":{"type":"object","nullable":true,"description":"Extensões do ProblemDetail. Ausente (`null`) nas respostas `about:blank`.","additionalProperties":true,"properties":{"message":{"type":"string","description":"Repete o `detail`."},"errorCode":{"type":"string","description":"Código estável da regra violada. Opcional: só parte dos erros de regra de negócio tem.\nLista por status no guia de erros.\n"},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"(Apenas 400 `validation-error`) Mapa campo → mensagem."},"retryAfter":{"type":"integer","description":"(429 e 503) Segundos a aguardar antes de nova requisição."},"limit":{"type":"integer","description":"(Apenas 429) Limite de requisições da janela."},"resetAt":{"type":"integer","format":"int64","description":"(Apenas 429) Fim da janela, em epoch **milissegundos**."}}}}}}}},"403":{"description":"Permissão insuficiente","content":{"application/problem+json":{"schema":{"type":"object","description":"Erro de autorização (HTTP 403). Token válido de outro perfil, sem permissão de originador.\nRecusas de permissão por regra de negócio (ex.: `ORIGINATOR_OPT_IN_NOT_ENABLED`) usam\n`#business-rule-violation` com `properties.errorCode`.\n","required":["type","title","status"],"properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"detail":{"type":"string"},"instance":{"type":"string"},"properties":{"type":"object","nullable":true,"description":"Extensões do ProblemDetail. Ausente (`null`) nas respostas `about:blank`.","additionalProperties":true,"properties":{"message":{"type":"string","description":"Repete o `detail`."},"errorCode":{"type":"string","description":"Código estável da regra violada. Opcional: só parte dos erros de regra de negócio tem.\nLista por status no guia de erros.\n"},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"(Apenas 400 `validation-error`) Mapa campo → mensagem."},"retryAfter":{"type":"integer","description":"(429 e 503) Segundos a aguardar antes de nova requisição."},"limit":{"type":"integer","description":"(Apenas 429) Limite de requisições da janela."},"resetAt":{"type":"integer","format":"int64","description":"(Apenas 429) Fim da janela, em epoch **milissegundos**."}}}}}}}},"404":{"description":"Originator não encontrado (token válido mas originator inexistente no sistema)","content":{"application/problem+json":{"schema":{"type":"object","description":"Resposta de erro no formato RFC 7807 (Problem Details). Os campos extras **não** vêm na raiz:\nficam dentro de `properties` (`message`, `errorCode`, `errors`, `retryAfter`…).\n\nIdentifique o erro por `status` + `properties.errorCode`. O `type` agrupa famílias e sozinho não\nidentifica o erro: `#business-rule-violation` aparece com 400, 403, 404, 409, 413, 422 e 503.\nCatálogo completo em https://docs.giro.tech/desenvolvedores/api-gtpayroll/guias/erros.\n","required":["type","title","status"],"properties":{"type":{"type":"string","description":"URL do guia de erros com o fragmento da família: `validation-error`, `not-authenticated`,\n`forbidden`, `resource-not-found`, `conflict`, `business-rule-violation`,\n`dataprev-suspension-window`, `rate-limit-exceeded`, `internal-error`, `upstream-error`,\n`service-unavailable`. Corpo ilegível, parâmetro de tipo errado, rota inexistente, `405` e\n`415` vêm como `about:blank`, sem `properties`.\n"},"title":{"type":"string","description":"Resumo curto. Na maioria dos casos é a frase padrão do status HTTP."},"status":{"type":"integer","description":"Código HTTP do erro"},"detail":{"type":"string","description":"Mensagem legível desta ocorrência. Pode mudar de texto; use `properties.errorCode` para automação."},"instance":{"type":"string","description":"Path da requisição que falhou"},"properties":{"type":"object","nullable":true,"description":"Extensões do ProblemDetail. Ausente (`null`) nas respostas `about:blank`.","additionalProperties":true,"properties":{"message":{"type":"string","description":"Repete o `detail`."},"errorCode":{"type":"string","description":"Código estável da regra violada. Opcional: só parte dos erros de regra de negócio tem.\nLista por status no guia de erros.\n"},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"(Apenas 400 `validation-error`) Mapa campo → mensagem."},"retryAfter":{"type":"integer","description":"(429 e 503) Segundos a aguardar antes de nova requisição."},"limit":{"type":"integer","description":"(Apenas 429) Limite de requisições da janela."},"resetAt":{"type":"integer","format":"int64","description":"(Apenas 429) Fim da janela, em epoch **milissegundos**."}}}}}}}},"409":{"description":"Já existe subscription de webhook para este originator","content":{"application/problem+json":{"schema":{"type":"object","description":"Resposta de erro no formato RFC 7807 (Problem Details). Os campos extras **não** vêm na raiz:\nficam dentro de `properties` (`message`, `errorCode`, `errors`, `retryAfter`…).\n\nIdentifique o erro por `status` + `properties.errorCode`. O `type` agrupa famílias e sozinho não\nidentifica o erro: `#business-rule-violation` aparece com 400, 403, 404, 409, 413, 422 e 503.\nCatálogo completo em https://docs.giro.tech/desenvolvedores/api-gtpayroll/guias/erros.\n","required":["type","title","status"],"properties":{"type":{"type":"string","description":"URL do guia de erros com o fragmento da família: `validation-error`, `not-authenticated`,\n`forbidden`, `resource-not-found`, `conflict`, `business-rule-violation`,\n`dataprev-suspension-window`, `rate-limit-exceeded`, `internal-error`, `upstream-error`,\n`service-unavailable`. Corpo ilegível, parâmetro de tipo errado, rota inexistente, `405` e\n`415` vêm como `about:blank`, sem `properties`.\n"},"title":{"type":"string","description":"Resumo curto. Na maioria dos casos é a frase padrão do status HTTP."},"status":{"type":"integer","description":"Código HTTP do erro"},"detail":{"type":"string","description":"Mensagem legível desta ocorrência. Pode mudar de texto; use `properties.errorCode` para automação."},"instance":{"type":"string","description":"Path da requisição que falhou"},"properties":{"type":"object","nullable":true,"description":"Extensões do ProblemDetail. Ausente (`null`) nas respostas `about:blank`.","additionalProperties":true,"properties":{"message":{"type":"string","description":"Repete o `detail`."},"errorCode":{"type":"string","description":"Código estável da regra violada. Opcional: só parte dos erros de regra de negócio tem.\nLista por status no guia de erros.\n"},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"(Apenas 400 `validation-error`) Mapa campo → mensagem."},"retryAfter":{"type":"integer","description":"(429 e 503) Segundos a aguardar antes de nova requisição."},"limit":{"type":"integer","description":"(Apenas 429) Limite de requisições da janela."},"resetAt":{"type":"integer","format":"int64","description":"(Apenas 429) Fim da janela, em epoch **milissegundos**."}}}}}}}}}}}}}
```

## Consultar subscription

## Consultar subscription de webhook

> Retorna a configuração de webhook do originator autenticado. 404 se ainda não tiver subscription.

```json
{"openapi":"3.0.0","info":{"title":"GT Payroll Originator API","version":"1.1.0"},"tags":[{"name":"Webhooks","description":"Configuração de webhook (subscription) para receber eventos"}],"servers":[{"url":"https://ingress.gtpayroll.staging.giro.tech","description":"Ambiente de Staging"},{"url":"https://ingress.gtpayroll.giro.tech","description":"Ambiente de Produção"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token fornecido pelo administrador"}}},"paths":{"/api/v1/originator/webhooks":{"get":{"summary":"Consultar subscription de webhook","description":"Retorna a configuração de webhook do originator autenticado. 404 se ainda não tiver subscription.","tags":["Webhooks"],"responses":{"200":{"description":"Subscription retornada com sucesso","content":{"application/json":{"schema":{"type":"object","description":"Representa a subscription de webhook do originator (1:1).\nO campo `authValue` não é retornado por segurança.\n","properties":{"publicId":{"type":"string","format":"uuid","nullable":true,"description":"Identificador público opaco da subscription. Pode vir ausente em registros antigos."},"webhookUrls":{"type":"array","items":{"type":"string","format":"uri","pattern":"^https://","maxLength":500,"description":"URL HTTPS que receberá os eventos de webhook (POST)."},"description":"URLs configuradas para receber os eventos."},"authKey":{"type":"string","description":"Nome do header de autenticação configurado."},"active":{"type":"boolean","description":"Indica se a subscription está ativa."},"events":{"type":"array","items":{"type":"string","enum":["MARGIN_QUERY_COMPLETED","AUTHORIZATION_COMPLETED","AUTHORIZATION_EXPIRED","ENDORSEMENT_ENDORSED","ENDORSEMENT_FAILED","ENDORSEMENT_RETRYING","ENDORSEMENT_PROCESSING","ENDORSEMENT_PENDING","ENDORSEMENT_EXCLUDING","ENDORSEMENT_EXCLUDED","ENDORSEMENT_EXCLUSION_FAILED","PAYMENT_SUCCESS","PAYMENT_REVISION","PAYMENT_FAILURE","CCB_RECEIVED","SIGNATURE_LINK_RESEND","CONTRACT_DOCUMENT_READY","AUTHORIZATION_DOCUMENT_READY","CONTRACT_SIGNED","AUTHORIZATION_SIGNED"]},"description":"Lista de eventos aos quais o webhook está inscrito."},"createdDate":{"type":"string","format":"date-time","description":"Data de criação do registro."},"lastModifiedDate":{"type":"string","format":"date-time","nullable":true,"description":"Data da última alteração."}}}}}},"401":{"description":"Não autenticado","content":{"application/problem+json":{"schema":{"type":"object","description":"Erro de autenticação (HTTP 401). Token ausente, com prefixo diferente de `Bearer `, expirado, revogado ou inválido.","required":["type","title","status"],"properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"detail":{"type":"string"},"instance":{"type":"string"},"properties":{"type":"object","nullable":true,"description":"Extensões do ProblemDetail. Ausente (`null`) nas respostas `about:blank`.","additionalProperties":true,"properties":{"message":{"type":"string","description":"Repete o `detail`."},"errorCode":{"type":"string","description":"Código estável da regra violada. Opcional: só parte dos erros de regra de negócio tem.\nLista por status no guia de erros.\n"},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"(Apenas 400 `validation-error`) Mapa campo → mensagem."},"retryAfter":{"type":"integer","description":"(429 e 503) Segundos a aguardar antes de nova requisição."},"limit":{"type":"integer","description":"(Apenas 429) Limite de requisições da janela."},"resetAt":{"type":"integer","format":"int64","description":"(Apenas 429) Fim da janela, em epoch **milissegundos**."}}}}}}}},"403":{"description":"Permissão insuficiente","content":{"application/problem+json":{"schema":{"type":"object","description":"Erro de autorização (HTTP 403). Token válido de outro perfil, sem permissão de originador.\nRecusas de permissão por regra de negócio (ex.: `ORIGINATOR_OPT_IN_NOT_ENABLED`) usam\n`#business-rule-violation` com `properties.errorCode`.\n","required":["type","title","status"],"properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"detail":{"type":"string"},"instance":{"type":"string"},"properties":{"type":"object","nullable":true,"description":"Extensões do ProblemDetail. Ausente (`null`) nas respostas `about:blank`.","additionalProperties":true,"properties":{"message":{"type":"string","description":"Repete o `detail`."},"errorCode":{"type":"string","description":"Código estável da regra violada. Opcional: só parte dos erros de regra de negócio tem.\nLista por status no guia de erros.\n"},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"(Apenas 400 `validation-error`) Mapa campo → mensagem."},"retryAfter":{"type":"integer","description":"(429 e 503) Segundos a aguardar antes de nova requisição."},"limit":{"type":"integer","description":"(Apenas 429) Limite de requisições da janela."},"resetAt":{"type":"integer","format":"int64","description":"(Apenas 429) Fim da janela, em epoch **milissegundos**."}}}}}}}},"404":{"description":"Subscription não encontrada ou originator não encontrado","content":{"application/problem+json":{"schema":{"type":"object","description":"Resposta de erro no formato RFC 7807 (Problem Details). Os campos extras **não** vêm na raiz:\nficam dentro de `properties` (`message`, `errorCode`, `errors`, `retryAfter`…).\n\nIdentifique o erro por `status` + `properties.errorCode`. O `type` agrupa famílias e sozinho não\nidentifica o erro: `#business-rule-violation` aparece com 400, 403, 404, 409, 413, 422 e 503.\nCatálogo completo em https://docs.giro.tech/desenvolvedores/api-gtpayroll/guias/erros.\n","required":["type","title","status"],"properties":{"type":{"type":"string","description":"URL do guia de erros com o fragmento da família: `validation-error`, `not-authenticated`,\n`forbidden`, `resource-not-found`, `conflict`, `business-rule-violation`,\n`dataprev-suspension-window`, `rate-limit-exceeded`, `internal-error`, `upstream-error`,\n`service-unavailable`. Corpo ilegível, parâmetro de tipo errado, rota inexistente, `405` e\n`415` vêm como `about:blank`, sem `properties`.\n"},"title":{"type":"string","description":"Resumo curto. Na maioria dos casos é a frase padrão do status HTTP."},"status":{"type":"integer","description":"Código HTTP do erro"},"detail":{"type":"string","description":"Mensagem legível desta ocorrência. Pode mudar de texto; use `properties.errorCode` para automação."},"instance":{"type":"string","description":"Path da requisição que falhou"},"properties":{"type":"object","nullable":true,"description":"Extensões do ProblemDetail. Ausente (`null`) nas respostas `about:blank`.","additionalProperties":true,"properties":{"message":{"type":"string","description":"Repete o `detail`."},"errorCode":{"type":"string","description":"Código estável da regra violada. Opcional: só parte dos erros de regra de negócio tem.\nLista por status no guia de erros.\n"},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"(Apenas 400 `validation-error`) Mapa campo → mensagem."},"retryAfter":{"type":"integer","description":"(429 e 503) Segundos a aguardar antes de nova requisição."},"limit":{"type":"integer","description":"(Apenas 429) Limite de requisições da janela."},"resetAt":{"type":"integer","format":"int64","description":"(Apenas 429) Fim da janela, em epoch **milissegundos**."}}}}}}}}}}}}}
```

## Atualizar subscription

## Atualizar subscription de webhook

> Atualiza URLs, header de autenticação e flag ativo da subscription do originator autenticado.

```json
{"openapi":"3.0.0","info":{"title":"GT Payroll Originator API","version":"1.1.0"},"tags":[{"name":"Webhooks","description":"Configuração de webhook (subscription) para receber eventos"}],"servers":[{"url":"https://ingress.gtpayroll.staging.giro.tech","description":"Ambiente de Staging"},{"url":"https://ingress.gtpayroll.giro.tech","description":"Ambiente de Produção"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token fornecido pelo administrador"}}},"paths":{"/api/v1/originator/webhooks":{"put":{"summary":"Atualizar subscription de webhook","description":"Atualiza URLs, header de autenticação e flag ativo da subscription do originator autenticado.","tags":["Webhooks"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webhookUrls","authKey","authValue","active"],"properties":{"webhookUrls":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"string","format":"uri","pattern":"^https://","maxLength":500},"description":"Lista de URLs de destino para entrega dos eventos."},"authKey":{"type":"string","maxLength":100,"description":"Nome do header HTTP de autenticação."},"authValue":{"type":"string","maxLength":500,"description":"Valor do header de autenticação."},"active":{"type":"boolean","description":"Indica se a subscription está ativa (true) ou pausada (false)."},"events":{"type":"array","items":{"type":"string","enum":["MARGIN_QUERY_COMPLETED","AUTHORIZATION_COMPLETED","AUTHORIZATION_EXPIRED","ENDORSEMENT_ENDORSED","ENDORSEMENT_FAILED","ENDORSEMENT_RETRYING","ENDORSEMENT_PROCESSING","ENDORSEMENT_PENDING","ENDORSEMENT_EXCLUDING","ENDORSEMENT_EXCLUDED","ENDORSEMENT_EXCLUSION_FAILED","PAYMENT_SUCCESS","PAYMENT_REVISION","PAYMENT_FAILURE","CCB_RECEIVED","SIGNATURE_LINK_RESEND","CONTRACT_DOCUMENT_READY","AUTHORIZATION_DOCUMENT_READY","CONTRACT_SIGNED","AUTHORIZATION_SIGNED"]},"description":"Lista de eventos para os quais o webhook será acionado.\nSe não informado ou vazio, todos os eventos serão registrados por padrão.\n"}}}}}},"responses":{"200":{"description":"Subscription atualizada com sucesso","content":{"application/json":{"schema":{"type":"object","description":"Representa a subscription de webhook do originator (1:1).\nO campo `authValue` não é retornado por segurança.\n","properties":{"publicId":{"type":"string","format":"uuid","nullable":true,"description":"Identificador público opaco da subscription. Pode vir ausente em registros antigos."},"webhookUrls":{"type":"array","items":{"type":"string","format":"uri","pattern":"^https://","maxLength":500,"description":"URL HTTPS que receberá os eventos de webhook (POST)."},"description":"URLs configuradas para receber os eventos."},"authKey":{"type":"string","description":"Nome do header de autenticação configurado."},"active":{"type":"boolean","description":"Indica se a subscription está ativa."},"events":{"type":"array","items":{"type":"string","enum":["MARGIN_QUERY_COMPLETED","AUTHORIZATION_COMPLETED","AUTHORIZATION_EXPIRED","ENDORSEMENT_ENDORSED","ENDORSEMENT_FAILED","ENDORSEMENT_RETRYING","ENDORSEMENT_PROCESSING","ENDORSEMENT_PENDING","ENDORSEMENT_EXCLUDING","ENDORSEMENT_EXCLUDED","ENDORSEMENT_EXCLUSION_FAILED","PAYMENT_SUCCESS","PAYMENT_REVISION","PAYMENT_FAILURE","CCB_RECEIVED","SIGNATURE_LINK_RESEND","CONTRACT_DOCUMENT_READY","AUTHORIZATION_DOCUMENT_READY","CONTRACT_SIGNED","AUTHORIZATION_SIGNED"]},"description":"Lista de eventos aos quais o webhook está inscrito."},"createdDate":{"type":"string","format":"date-time","description":"Data de criação do registro."},"lastModifiedDate":{"type":"string","format":"date-time","nullable":true,"description":"Data da última alteração."}}}}}},"400":{"description":"Dados inválidos","content":{"application/problem+json":{"schema":{"type":"object","description":"Erro de validação de campos (HTTP 400, `type` `#validation-error`). O mapa campo → mensagem vem em\n`properties.errors`. Campos aninhados usam caminho (`pix.key`, `installments[0].dueDate`); regras\nque cruzam campos aparecem com o nome da regra (`paymentInfoValid`). Um campo com mais de uma\nviolação junta as mensagens com `\"; \"`.\n\nCorpo ilegível (JSON malformado, data, enum ou UUID inválidos) **não** usa este formato: vem como\n`type: about:blank` — ver `RequestFormatError`.\n","required":["type","title","status","properties"],"properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"detail":{"type":"string"},"instance":{"type":"string"},"properties":{"type":"object","required":["errors"],"properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"Mapa campo → mensagem de erro de validação"}}}}}}}},"401":{"description":"Não autenticado","content":{"application/problem+json":{"schema":{"type":"object","description":"Erro de autenticação (HTTP 401). Token ausente, com prefixo diferente de `Bearer `, expirado, revogado ou inválido.","required":["type","title","status"],"properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"detail":{"type":"string"},"instance":{"type":"string"},"properties":{"type":"object","nullable":true,"description":"Extensões do ProblemDetail. Ausente (`null`) nas respostas `about:blank`.","additionalProperties":true,"properties":{"message":{"type":"string","description":"Repete o `detail`."},"errorCode":{"type":"string","description":"Código estável da regra violada. Opcional: só parte dos erros de regra de negócio tem.\nLista por status no guia de erros.\n"},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"(Apenas 400 `validation-error`) Mapa campo → mensagem."},"retryAfter":{"type":"integer","description":"(429 e 503) Segundos a aguardar antes de nova requisição."},"limit":{"type":"integer","description":"(Apenas 429) Limite de requisições da janela."},"resetAt":{"type":"integer","format":"int64","description":"(Apenas 429) Fim da janela, em epoch **milissegundos**."}}}}}}}},"403":{"description":"Permissão insuficiente","content":{"application/problem+json":{"schema":{"type":"object","description":"Erro de autorização (HTTP 403). Token válido de outro perfil, sem permissão de originador.\nRecusas de permissão por regra de negócio (ex.: `ORIGINATOR_OPT_IN_NOT_ENABLED`) usam\n`#business-rule-violation` com `properties.errorCode`.\n","required":["type","title","status"],"properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"detail":{"type":"string"},"instance":{"type":"string"},"properties":{"type":"object","nullable":true,"description":"Extensões do ProblemDetail. Ausente (`null`) nas respostas `about:blank`.","additionalProperties":true,"properties":{"message":{"type":"string","description":"Repete o `detail`."},"errorCode":{"type":"string","description":"Código estável da regra violada. Opcional: só parte dos erros de regra de negócio tem.\nLista por status no guia de erros.\n"},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"(Apenas 400 `validation-error`) Mapa campo → mensagem."},"retryAfter":{"type":"integer","description":"(429 e 503) Segundos a aguardar antes de nova requisição."},"limit":{"type":"integer","description":"(Apenas 429) Limite de requisições da janela."},"resetAt":{"type":"integer","format":"int64","description":"(Apenas 429) Fim da janela, em epoch **milissegundos**."}}}}}}}},"404":{"description":"Subscription não encontrada","content":{"application/problem+json":{"schema":{"type":"object","description":"Resposta de erro no formato RFC 7807 (Problem Details). Os campos extras **não** vêm na raiz:\nficam dentro de `properties` (`message`, `errorCode`, `errors`, `retryAfter`…).\n\nIdentifique o erro por `status` + `properties.errorCode`. O `type` agrupa famílias e sozinho não\nidentifica o erro: `#business-rule-violation` aparece com 400, 403, 404, 409, 413, 422 e 503.\nCatálogo completo em https://docs.giro.tech/desenvolvedores/api-gtpayroll/guias/erros.\n","required":["type","title","status"],"properties":{"type":{"type":"string","description":"URL do guia de erros com o fragmento da família: `validation-error`, `not-authenticated`,\n`forbidden`, `resource-not-found`, `conflict`, `business-rule-violation`,\n`dataprev-suspension-window`, `rate-limit-exceeded`, `internal-error`, `upstream-error`,\n`service-unavailable`. Corpo ilegível, parâmetro de tipo errado, rota inexistente, `405` e\n`415` vêm como `about:blank`, sem `properties`.\n"},"title":{"type":"string","description":"Resumo curto. Na maioria dos casos é a frase padrão do status HTTP."},"status":{"type":"integer","description":"Código HTTP do erro"},"detail":{"type":"string","description":"Mensagem legível desta ocorrência. Pode mudar de texto; use `properties.errorCode` para automação."},"instance":{"type":"string","description":"Path da requisição que falhou"},"properties":{"type":"object","nullable":true,"description":"Extensões do ProblemDetail. Ausente (`null`) nas respostas `about:blank`.","additionalProperties":true,"properties":{"message":{"type":"string","description":"Repete o `detail`."},"errorCode":{"type":"string","description":"Código estável da regra violada. Opcional: só parte dos erros de regra de negócio tem.\nLista por status no guia de erros.\n"},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"(Apenas 400 `validation-error`) Mapa campo → mensagem."},"retryAfter":{"type":"integer","description":"(429 e 503) Segundos a aguardar antes de nova requisição."},"limit":{"type":"integer","description":"(Apenas 429) Limite de requisições da janela."},"resetAt":{"type":"integer","format":"int64","description":"(Apenas 429) Fim da janela, em epoch **milissegundos**."}}}}}}}}}}}}}
```

## Remover subscription

## Remover subscription de webhook

> Remove a configuração de webhook do originator autenticado. O envio de eventos para as URLs cessa.

```json
{"openapi":"3.0.0","info":{"title":"GT Payroll Originator API","version":"1.1.0"},"tags":[{"name":"Webhooks","description":"Configuração de webhook (subscription) para receber eventos"}],"servers":[{"url":"https://ingress.gtpayroll.staging.giro.tech","description":"Ambiente de Staging"},{"url":"https://ingress.gtpayroll.giro.tech","description":"Ambiente de Produção"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token fornecido pelo administrador"}}},"paths":{"/api/v1/originator/webhooks":{"delete":{"summary":"Remover subscription de webhook","description":"Remove a configuração de webhook do originator autenticado. O envio de eventos para as URLs cessa.","tags":["Webhooks"],"responses":{"204":{"description":"Subscription removida com sucesso"},"401":{"description":"Não autenticado","content":{"application/problem+json":{"schema":{"type":"object","description":"Erro de autenticação (HTTP 401). Token ausente, com prefixo diferente de `Bearer `, expirado, revogado ou inválido.","required":["type","title","status"],"properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"detail":{"type":"string"},"instance":{"type":"string"},"properties":{"type":"object","nullable":true,"description":"Extensões do ProblemDetail. Ausente (`null`) nas respostas `about:blank`.","additionalProperties":true,"properties":{"message":{"type":"string","description":"Repete o `detail`."},"errorCode":{"type":"string","description":"Código estável da regra violada. Opcional: só parte dos erros de regra de negócio tem.\nLista por status no guia de erros.\n"},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"(Apenas 400 `validation-error`) Mapa campo → mensagem."},"retryAfter":{"type":"integer","description":"(429 e 503) Segundos a aguardar antes de nova requisição."},"limit":{"type":"integer","description":"(Apenas 429) Limite de requisições da janela."},"resetAt":{"type":"integer","format":"int64","description":"(Apenas 429) Fim da janela, em epoch **milissegundos**."}}}}}}}},"403":{"description":"Permissão insuficiente","content":{"application/problem+json":{"schema":{"type":"object","description":"Erro de autorização (HTTP 403). Token válido de outro perfil, sem permissão de originador.\nRecusas de permissão por regra de negócio (ex.: `ORIGINATOR_OPT_IN_NOT_ENABLED`) usam\n`#business-rule-violation` com `properties.errorCode`.\n","required":["type","title","status"],"properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"detail":{"type":"string"},"instance":{"type":"string"},"properties":{"type":"object","nullable":true,"description":"Extensões do ProblemDetail. Ausente (`null`) nas respostas `about:blank`.","additionalProperties":true,"properties":{"message":{"type":"string","description":"Repete o `detail`."},"errorCode":{"type":"string","description":"Código estável da regra violada. Opcional: só parte dos erros de regra de negócio tem.\nLista por status no guia de erros.\n"},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"(Apenas 400 `validation-error`) Mapa campo → mensagem."},"retryAfter":{"type":"integer","description":"(429 e 503) Segundos a aguardar antes de nova requisição."},"limit":{"type":"integer","description":"(Apenas 429) Limite de requisições da janela."},"resetAt":{"type":"integer","format":"int64","description":"(Apenas 429) Fim da janela, em epoch **milissegundos**."}}}}}}}},"404":{"description":"Subscription não encontrada","content":{"application/problem+json":{"schema":{"type":"object","description":"Resposta de erro no formato RFC 7807 (Problem Details). Os campos extras **não** vêm na raiz:\nficam dentro de `properties` (`message`, `errorCode`, `errors`, `retryAfter`…).\n\nIdentifique o erro por `status` + `properties.errorCode`. O `type` agrupa famílias e sozinho não\nidentifica o erro: `#business-rule-violation` aparece com 400, 403, 404, 409, 413, 422 e 503.\nCatálogo completo em https://docs.giro.tech/desenvolvedores/api-gtpayroll/guias/erros.\n","required":["type","title","status"],"properties":{"type":{"type":"string","description":"URL do guia de erros com o fragmento da família: `validation-error`, `not-authenticated`,\n`forbidden`, `resource-not-found`, `conflict`, `business-rule-violation`,\n`dataprev-suspension-window`, `rate-limit-exceeded`, `internal-error`, `upstream-error`,\n`service-unavailable`. Corpo ilegível, parâmetro de tipo errado, rota inexistente, `405` e\n`415` vêm como `about:blank`, sem `properties`.\n"},"title":{"type":"string","description":"Resumo curto. Na maioria dos casos é a frase padrão do status HTTP."},"status":{"type":"integer","description":"Código HTTP do erro"},"detail":{"type":"string","description":"Mensagem legível desta ocorrência. Pode mudar de texto; use `properties.errorCode` para automação."},"instance":{"type":"string","description":"Path da requisição que falhou"},"properties":{"type":"object","nullable":true,"description":"Extensões do ProblemDetail. Ausente (`null`) nas respostas `about:blank`.","additionalProperties":true,"properties":{"message":{"type":"string","description":"Repete o `detail`."},"errorCode":{"type":"string","description":"Código estável da regra violada. Opcional: só parte dos erros de regra de negócio tem.\nLista por status no guia de erros.\n"},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"(Apenas 400 `validation-error`) Mapa campo → mensagem."},"retryAfter":{"type":"integer","description":"(429 e 503) Segundos a aguardar antes de nova requisição."},"limit":{"type":"integer","description":"(Apenas 429) Limite de requisições da janela."},"resetAt":{"type":"integer","format":"int64","description":"(Apenas 429) Fim da janela, em epoch **milissegundos**."}}}}}}}}}}}}}
```

## Listar deliveries

## Listar deliveries de webhook

> Retorna a lista paginada de deliveries (entregas) de eventos de webhook do originator autenticado.\
> Permite filtrar por tipo de evento, status da entrega e intervalo de datas.<br>

```json
{"openapi":"3.0.0","info":{"title":"GT Payroll Originator API","version":"1.1.0"},"tags":[{"name":"Webhooks","description":"Configuração de webhook (subscription) para receber eventos"}],"servers":[{"url":"https://ingress.gtpayroll.staging.giro.tech","description":"Ambiente de Staging"},{"url":"https://ingress.gtpayroll.giro.tech","description":"Ambiente de Produção"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token fornecido pelo administrador"}}},"paths":{"/api/v1/originator/webhooks/deliveries":{"get":{"summary":"Listar deliveries de webhook","description":"Retorna a lista paginada de deliveries (entregas) de eventos de webhook do originator autenticado.\nPermite filtrar por tipo de evento, status da entrega e intervalo de datas.\n","tags":["Webhooks"],"parameters":[{"name":"eventType","in":"query","required":false,"description":"Filtrar por tipo de evento de webhook.","schema":{"type":"string","description":"Tipo do evento de webhook.\n| Valor | Significado |\n|-------|-------------|\n| MARGIN_QUERY_COMPLETED | Consulta de margem concluída |\n| MARGIN_QUERY_FAILED | Consulta de margem encerrada sem sucesso e sem nova tentativa (CPF inelegível/inexistente, vínculo inelegível ou esgotamento de retentativas) |\n| FGTS_AVAILABILITY_QUERY_COMPLETED | Consulta de FGTS disponível concluída (saldo + multa rescisória) |\n| FGTS_AVAILABILITY_QUERY_FAILED | Consulta de FGTS disponível encerrada sem sucesso e sem nova tentativa (erro permanente Dataprev ou esgotamento de retentativas) |\n| AUTHORIZED_BONDS_LISTED | Listagem de vínculos autorizados concluída; `source: REQUESTED` quando o originador pediu a listagem (com `requestId`), `source: AUTOMATIC` no fluxo pós-autorização (`requestId: null`) |\n| AUTHORIZED_BONDS_LISTING_FAILED | Listagem de lastros encerrada sem sucesso e sem nova tentativa |\n| AUTHORIZATION_COMPLETED | Autorização (termo) concluída |\n| AUTHORIZATION_EXPIRED | Autorização/token Dataprev invalidados (ex.: falha ao renovar token; novo termo necessário) |\n| AUTHORIZATION_FAILED | Autorização Dataprev encerrada sem sucesso e sem nova tentativa (CPF inelegível/inexistente, vínculo inelegível ou esgotamento de retentativas) |\n| ENDORSEMENT_ENDORSED | Averbação confirmada |\n| ENDORSEMENT_FAILED | Falha na averbação (resposta permanente da Dataprev ou esgotamento de retentativas em falhas transitórias) |\n| ENDORSEMENT_RETRYING | Nova tentativa de averbação |\n| ENDORSEMENT_PROCESSING | Averbação em processamento |\n| ENDORSEMENT_PENDING | Averbação pendente |\n| ENDORSEMENT_EXCLUDING | Desaverbação em processamento |\n| ENDORSEMENT_EXCLUDED | Desaverbação confirmada (contrato cancelado) |\n| ENDORSEMENT_EXCLUSION_FAILED | Falha na desaverbação (contrato permanece averbado) |\n| PAYMENT_SUCCESS | Pagamento/desembolso com sucesso |\n| PAYMENT_REVISION | Revisão de pagamento |\n| PAYMENT_FAILURE | Falha no pagamento |\n| CCB_RECEIVED | CCB recebida |\n| SIGNATURE_LINK_RESEND | Reenvio de link de assinatura |\n| CONTRACT_DOCUMENT_READY | PDF do contrato gerado. GIRO: enviado após link de assinatura (payload com signUrl e presignedUrl). ORIGINATOR_MANAGED: enviado quando PDF fica pronto (presignedUrl) |\n| CONTRACT_DOCUMENT_FAILED | Geração/processamento do PDF do contrato encerrado sem sucesso e sem nova tentativa (esgotamento de retentativas) |\n| CONTRACT_REGISTRATION_FAILED | Registro interno do contrato (etapa anterior à averbação) encerrado sem sucesso; endorsement não será executado e originador precisa reiniciar o fluxo |\n| CONTRACT_SIGNING_FAILED | Fluxo de assinatura do contrato encerrado sem sucesso (provedor 4xx persistente ou esgotamento de retentativas) |\n| AUTHORIZATION_DOCUMENT_READY | Documento de autorização pronto para download (ORIGINATOR_MANAGED) |\n| AUTHORIZATION_DOCUMENT_FAILED | Geração/processamento do documento de autorização encerrado sem sucesso e sem nova tentativa |\n| CONTRACT_SIGNED | Contrato assinado digitalmente (estratégia GIRO ou simulação); `data` segue ContractDocumentReadyPayload com `presignedUrl` do PDF assinado e `signUrl` null |\n| AUTHORIZATION_SIGNED | Termo de autorização assinado digitalmente; `data` segue AuthorizationDocumentReadyPayload com `documentUrl` do PDF assinado e `status` SIGNED |\n| AUCTION_OFFER_ACCEPTED | Trabalhador aceitou uma oferta de leilão (CTPS); `sourceId` da entrega é o `proposalNumber` da oferta |\n| AUCTION_SOLICITATIONS_REFRESHED | Emitido quando há novas solicitações de leilão avaliadas; `sourceId` da entrega é o `originatorId`; `data` segue **AuctionSolicitationsRefreshedPayload** |\n| AUTHORIZATION_SIGN_URL_READY | `signUrl` do termo de autorização gerado e pronto para entrega (estratégia GIRO/provedor INTERNAL) |\n| AUTHORIZED_BONDS_LISTED | Listagem de vínculos autorizados concluída; `source: REQUESTED` quando o originador pediu a listagem (com `requestId`), `source: AUTOMATIC` no fluxo pós-autorização (`requestId: null`) |\n| AUTHORIZED_BONDS_LISTING_FAILED | Listagem de vínculos autorizados encerrada sem sucesso (falha permanente da Dataprev) |\n| DATAPREV_WINDOW_OPENED | Janela de suspensão Dataprev (virada de competência) aberta; `sourceId` é o `windowId` |\n| DATAPREV_WINDOW_CLOSED | Janela de suspensão Dataprev fechada; `sourceId` é o `windowId` |\n| TERMINATED_LOAN_NEW_BOND | Emitido quando a plataforma encontra um novo vínculo com um empréstimo encerrado por término de vínculo; `sourceId` da entrega identifica a oportunidade e é o mesmo valor de `data.publicId`; o alvo da ação é o `employmentRelationshipPublicId` do payload; `data` segue **TerminatedLoanNewBondWebhookPayload** |\n| CONTRACT_TERMINATED_BOND | Emitido uma vez por empréstimo que a Dataprev encerra por término de vínculo (situação 15); `source` é `CONTRACT`; `sourceId` da entrega é o `contractPublicId` quando o contrato é nosso, senão o número do contrato na Dataprev; `data` segue **TerminatedBondLoanWebhookPayload** |\n| GUARANTEE_EXECUTED | Emitido quando a Dataprev aceita a execução da garantia FGTS de um contrato encerrado por término de vínculo (Manual 017); `sourceId` da entrega é o `contractPublicId`; `data` segue **GuaranteeExecutionWebhookPayload** |\n| TERMINATED_LOAN_ALTERED | Emitido quando a Dataprev aceita a alteração de parcelas/valor de um contrato encerrado por término de vínculo (Manual 018 §2); `sourceId` da entrega é o `publicId` da alteração; `data` segue **TerminatedLoanAlterationWebhookPayload** |\n| TERMINATED_LOAN_ALTERATION_FAILED | Emitido quando a Dataprev recusa a alteração (código de erro do provedor em `providerErrorCode`) ou a operação falha em definitivo; `data` segue **TerminatedLoanAlterationWebhookPayload** |\n| CONTRACT_MIGRATED_AUTOMATICALLY | Emitido quando a Dataprev migra sozinha um contrato encerrado por término de vínculo para um vínculo novo do mesmo trabalhador (Manual 018 §3); `sourceId` da entrega é o `contractPublicId` quando o contrato é nosso, senão o número do contrato na Dataprev; `data` segue **ContractMigrationWebhookPayload** |\n","enum":["MARGIN_QUERY_COMPLETED","MARGIN_QUERY_FAILED","FGTS_AVAILABILITY_QUERY_COMPLETED","FGTS_AVAILABILITY_QUERY_FAILED","AUTHORIZED_BONDS_LISTED","AUTHORIZED_BONDS_LISTING_FAILED","AUTHORIZATION_COMPLETED","AUTHORIZATION_EXPIRED","AUTHORIZATION_FAILED","ENDORSEMENT_ENDORSED","ENDORSEMENT_FAILED","ENDORSEMENT_RETRYING","ENDORSEMENT_PROCESSING","ENDORSEMENT_PENDING","ENDORSEMENT_EXCLUDING","ENDORSEMENT_EXCLUDED","ENDORSEMENT_EXCLUSION_FAILED","PAYMENT_SUCCESS","PAYMENT_REVISION","PAYMENT_FAILURE","CCB_RECEIVED","SIGNATURE_LINK_RESEND","CONTRACT_DOCUMENT_READY","CONTRACT_DOCUMENT_FAILED","CONTRACT_REGISTRATION_FAILED","CONTRACT_SIGNING_FAILED","CONTRACT_FORMALIZATION_FAILED","AUTHORIZATION_DOCUMENT_READY","AUTHORIZATION_DOCUMENT_FAILED","CONTRACT_SIGNED","AUTHORIZATION_SIGNED","AUCTION_OFFER_ACCEPTED","AUCTION_SOLICITATIONS_REFRESHED","AUTHORIZATION_SIGN_URL_READY","AUTHORIZED_BONDS_LISTED","AUTHORIZED_BONDS_LISTING_FAILED","DATAPREV_WINDOW_OPENED","DATAPREV_WINDOW_CLOSED","TERMINATED_LOAN_NEW_BOND","CONTRACT_TERMINATED_BOND","GUARANTEE_EXECUTED","TERMINATED_LOAN_ALTERED","TERMINATED_LOAN_ALTERATION_FAILED","CONTRACT_MIGRATED_AUTOMATICALLY"]}},{"name":"status","in":"query","required":false,"description":"Filtrar por status da entrega.\n| Valor | Significado |\n|-------|-------------|\n| QUEUED | Aguardando envio |\n| SUCCESS | Entregue com sucesso |\n| FAILURE | Falha na entrega |\n| CANCELLED | Cancelada |\n","schema":{"type":"string","enum":["QUEUED","SUCCESS","FAILURE","CANCELLED"]}},{"name":"from","in":"query","required":false,"description":"Data/hora inicial do filtro (ISO 8601). Filtra por `createdAt >= from`.","schema":{"type":"string","format":"date-time"}},{"name":"to","in":"query","required":false,"description":"Data/hora final do filtro (ISO 8601). Filtra por `createdAt <= to`.","schema":{"type":"string","format":"date-time"}},{"name":"page","in":"query","required":false,"description":"Número da página (0-based).","schema":{"type":"integer","default":0,"minimum":0}},{"name":"size","in":"query","required":false,"description":"Quantidade de registros por página.","schema":{"type":"integer","default":20,"minimum":1,"maximum":100}},{"name":"sort","in":"query","required":false,"description":"Ordenação no formato `campo,direção` (ex. `createdDate,desc`).","schema":{"type":"string"}}],"responses":{"200":{"description":"Lista paginada de deliveries retornada com sucesso","content":{"application/json":{"schema":{"type":"object","description":"Página de resultados de deliveries de webhook.","properties":{"content":{"type":"array","items":{"type":"object","description":"Registro de entrega (delivery) de um evento de webhook.","properties":{"publicId":{"type":"string","format":"uuid","nullable":true,"description":"Identificador público opaco da entrega. Pode vir ausente em registros antigos."},"eventType":{"type":"string","description":"Tipo do evento de webhook entregue.","enum":["MARGIN_QUERY_COMPLETED","AUTHORIZATION_COMPLETED","AUTHORIZATION_EXPIRED","ENDORSEMENT_ENDORSED","ENDORSEMENT_FAILED","ENDORSEMENT_RETRYING","ENDORSEMENT_PROCESSING","ENDORSEMENT_PENDING","PAYMENT_SUCCESS","PAYMENT_REVISION","PAYMENT_FAILURE","CCB_RECEIVED","SIGNATURE_LINK_RESEND","CONTRACT_DOCUMENT_READY","AUTHORIZATION_DOCUMENT_READY","CONTRACT_SIGNED","AUTHORIZATION_SIGNED"]},"sourceType":{"type":"string","description":"Entidade de origem do evento.","enum":["EMPLOYEE","CONTRACT","GTBANKER","AUTHORIZATION_DOCUMENT"]},"sourceId":{"type":"string","description":"Identificador da entidade de origem (ex. publicId do employee, publicId do contrato)."},"status":{"type":"string","description":"Status da entrega do webhook.","enum":["QUEUED","SUCCESS","FAILURE","CANCELLED"]},"httpStatus":{"type":"integer","nullable":true,"description":"Código HTTP retornado pelo endpoint do originador na última tentativa de entrega."},"attemptCount":{"type":"integer","description":"Número de tentativas de entrega realizadas."},"lastAttemptAt":{"type":"string","format":"date-time","nullable":true,"description":"Data/hora da última tentativa de entrega (ISO 8601)."},"createdAt":{"type":"string","format":"date-time","description":"Data/hora de criação do registro (ISO 8601)."}}}},"pageable":{"type":"object","properties":{"pageNumber":{"type":"integer"},"pageSize":{"type":"integer"}}},"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer"},"size":{"type":"integer"},"number":{"type":"integer"},"first":{"type":"boolean"},"last":{"type":"boolean"},"empty":{"type":"boolean"}}}}}},"401":{"description":"Não autenticado","content":{"application/problem+json":{"schema":{"type":"object","description":"Erro de autenticação (HTTP 401). Token ausente, com prefixo diferente de `Bearer `, expirado, revogado ou inválido.","required":["type","title","status"],"properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"detail":{"type":"string"},"instance":{"type":"string"},"properties":{"type":"object","nullable":true,"description":"Extensões do ProblemDetail. Ausente (`null`) nas respostas `about:blank`.","additionalProperties":true,"properties":{"message":{"type":"string","description":"Repete o `detail`."},"errorCode":{"type":"string","description":"Código estável da regra violada. Opcional: só parte dos erros de regra de negócio tem.\nLista por status no guia de erros.\n"},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"(Apenas 400 `validation-error`) Mapa campo → mensagem."},"retryAfter":{"type":"integer","description":"(429 e 503) Segundos a aguardar antes de nova requisição."},"limit":{"type":"integer","description":"(Apenas 429) Limite de requisições da janela."},"resetAt":{"type":"integer","format":"int64","description":"(Apenas 429) Fim da janela, em epoch **milissegundos**."}}}}}}}},"403":{"description":"Permissão insuficiente","content":{"application/problem+json":{"schema":{"type":"object","description":"Erro de autorização (HTTP 403). Token válido de outro perfil, sem permissão de originador.\nRecusas de permissão por regra de negócio (ex.: `ORIGINATOR_OPT_IN_NOT_ENABLED`) usam\n`#business-rule-violation` com `properties.errorCode`.\n","required":["type","title","status"],"properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"detail":{"type":"string"},"instance":{"type":"string"},"properties":{"type":"object","nullable":true,"description":"Extensões do ProblemDetail. Ausente (`null`) nas respostas `about:blank`.","additionalProperties":true,"properties":{"message":{"type":"string","description":"Repete o `detail`."},"errorCode":{"type":"string","description":"Código estável da regra violada. Opcional: só parte dos erros de regra de negócio tem.\nLista por status no guia de erros.\n"},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"(Apenas 400 `validation-error`) Mapa campo → mensagem."},"retryAfter":{"type":"integer","description":"(429 e 503) Segundos a aguardar antes de nova requisição."},"limit":{"type":"integer","description":"(Apenas 429) Limite de requisições da janela."},"resetAt":{"type":"integer","format":"int64","description":"(Apenas 429) Fim da janela, em epoch **milissegundos**."}}}}}}}}}}}}}
```
