Chamada do Webhook

Estrutura do Payload de Callback (Exemplo)

post

https://api.staging.scr.gtbanker.com.br/apihttps://api.scr.gtbanker.com.br/api

/webhook-callback-example

Este endpoint não existe na API. Ele serve apenas para documentar o formato do JSON que a API enviará para a payloadUrl configurada pelo cliente quando uma consulta for concluída.

Corpo

application/json

Resposta de uma consulta ao SCR

uuidstringObrigatório

Identificador único da consulta

statusstring · enumObrigatório

Status atual da consulta

Valores possíveis:

webhookTypestring · enumObrigatório

Tipo de webhook que gerou a resposta

Valores possíveis:

pdfstring · binaryOpcional

Documento PDF com o resultado da consulta

createdAtstring · date-timeObrigatório

Data e hora de criação da consulta

updatedAtstring · date-timeObrigatório

Data e hora da última atualização da consulta

Respostas

200

O cliente deve retornar 200 OK para confirmar o recebimento.

post

/webhook-callback-example

HTTPcURLJavaScriptPython

POST /api/webhook-callback-example HTTP/1.1
Host: https:/.staging.scr.gtbanker.com.br
Content-Type: application/json
Accept: */*
Content-Length: 1194

{
  "uuid": "text",
  "status": "PENDING",
  "webhookType": "SCR",
  "data": {
    "consentTerm": "text",
    "consultedAt": "2025-12-14",
    "createdAt": "2025-12-14",
    "originUuid": "text",
    "reportEndDate": "text",
    "reportStartDate": "text",
    "resultDocument": "text",
    "scrKey": "text",
    "scrStatus": "text",
    "subjectDocumentNumber": "text",
    "subjectName": "text",
    "subjectPersonType": "text",
    "scrData": [
      {
        "referenceDate": "text",
        "financialInstitutionCount": "text",
        "operationCount": "text",
        "assumedCoobligation": "text",
        "receiveCoobligation": "text",
        "startRelationship": "text",
        "disagreementOperationCount": "text",
        "disagreementOperationValue": "text",
        "subjudiceOperationsCount": "text",
        "subjudiceOperationsValue": "text",
        "indirectRisk": "text",
        "error": [
          {
            "errorCode": "text",
            "description": "text"
          }
        ],
        "operationItems": [
          {
            "dueValue": "text",
            "exchangeVariation": "text",
            "categorySub": {
              "category": {
                "category_code": 1,
                "category_description": "text"
              },
              "categorySubCode": 1,
              "description": "text"
            },
            "dueType": {
              "code": "text",
              "description": "text"
            }
          }
        ]
      }
    ],
    "signers": [
      {
        "uuid": "text",
        "name": "text",
        "email": "[email protected]",
        "documentNumber": "text",
        "signatureType": "PART",
        "status": "PENDING"
      }
    ]
  },
  "pdf": "binary",
  "createdAt": "2025-12-14T19:23:22.233Z",
  "updatedAt": "2025-12-14T19:23:22.233Z"
}

200

O cliente deve retornar 200 OK para confirmar o recebimento.

Sem conteúdo

Central de Atendimento | Giro.TechGiro.Tech