Pular para o conteúdo
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Webhooks de progresso da Operação

Progresso da Operação

Os eventos de progresso da operação visam manter o contratante informado do avanço da CCB. Atualmente, são compatíveis os seguintes eventos:

  • Sucesso no recebimento da operação

Sucesso no recebimento da operação

Envio de informações da confirmação de recebimento da operação enviadas e processadas na Giro.Tech. São informados os dados das CCBs recebidas. Para mais informações, avalie o payload do webhook abaixo.

Para cadastrar o envio desses eventos, efetue o cadastro selecionando o tipo de evento RECEBIMENTO_OPERACAO.

Webhook de notificação de recebimento da CCB

post

Envia informações sobre a CCB formalizada com a Giro.

⚠️ Esse endpoint webhook/operations/progress/received é um exemplo, e pode ser customizado conforme necessidade, pelo cadastro do webhook.

Autorizações
AuthorizationstringObrigatório
Parâmetros de cabeçalho
AuthorizationstringObrigatório

Token de autenticação.

Corpo
versaostring · máx: 10Opcional

versão do payload do evento

Example: 1.0
eventostring · enumOpcional

Tipo do evento

Valores possíveis:
id_eventostringOpcional

Identificador único do evento

Example: a9fabe92-4b07-43c4-ba1c-d5d4873d6a28
data_eventostring · date-timeOpcional

Data e horário do evento, conforme o horário universal (UTC).

Example: 2024-04-25T10:30:00Z
Respostas
200

Requisição processada com sucesso, webhook entregue

Sem conteúdo

post/webhook/operations/progress/received
POST /webhook/operations/progress/received HTTP/1.1
Host: webhook-endpoint-cliente.exemplo.com
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 270

{
  "versao": "1.0",
  "evento": "CCB_RECEBIDA",
  "id_evento": "a9fabe92-4b07-43c4-ba1c-d5d4873d6a28",
  "data_evento": "2024-04-25T10:30:00Z",
  "dados": {
    "origem": "PARCEIRO_XYZ",
    "numero_ccb": "12345678",
    "identificador_programa": "PROGRAMA_CREDITO_PESSOAL",
    "data_recebimento": "2024-04-25"
  }
}

Sem conteúdo

Atualizado