Última Resposta da Averbação

Recupera, sob demanda, o último retorno da Dataprev para a averbação de uma operação — sem esperar um novo webhook. Use quando o webhook foi perdido, quando a operação está em retentativa ("teimosinha") ou para reconciliar o estado da garantia.

O endpoint muda conforme a família da operação: a operação de crédito responde por /debt/.../collateral; a proposta de portabilidade, por /v2/credit_transfer/proposal/.../collateral.

Atenção!

Os webhooks da QI Tech não devem ser mapeadas de forma restrita. Campos adicionais podem ser incluídos aos payloads dos webhooks retornados em nossas APIs.

Reenvio de Webhooks

Você pode consultar e reenviar webhooks seguindo as instruções detalhadas na documentação: Reenvio de Webhooks.

Crédito novo e refinanciamento

A garantia da operação de crédito responde em GET /debt/{credit_operation_key}/collateral.

O last response é uma forma de mapear, de forma simples e objetiva, a resposta da comunicação entre a QI e a Dataprev, possibilitando saber quando essa requisição foi feita e qual o retorno obtido (através de um enumerador). Os enumeradores estão diretamente relacionados aos códigos de retorno da Dataprev e são divididos em duas formas: "errors" e "success".

Cada enumerador tem uma descrição detalhada e o código de referência da Dataprev. Podemos conferir abaixo, com mais detalhes, como serão apresentados os dados do last response.

Casos de sucesso

Request

ENDPOINT

/debt/DEBT-KEY/collateral

MÉTODO

GET

Testar no Playground

Response

Response Body

{
  "collateral_constituted": true,
  "collateral_type": "type",
  "updated_at": "2023-05-24 19:13:02",
  "collateral_data": {
    "state": "SP",
    "benefit_number": 1976703155,
    "status": "reserved",
    "last_response": {
      "success": [
        {
          "enumerator": "succesfully_included",
          "reservation_method" : "new_credit"
        }
      ]
    },
    "last_response_event_datetime": "2023-05-22T19:13:02Z"
  }
}

Detalhamento de campos no retorno da request

Campo	Descrição	Valores
enumerator	Retorno mapeado do código Dataprev	Enumeradores
reservation_method	Método de averbação da reserva	portability, new_credit, refinancing

Casos de erro

Request

ENDPOINT

/debt/DEBT-KEY/collateral

MÉTODO

GET

Response

Response Body

{
  "collateral_constituted": false,
  "collateral_type": "type",
  "updated_at": "2023-05-24 19:13:02",
  "collateral_data": {
    "state": "SP",
    "benefit_number": 1976703155,
    "status": "pending_reservation",
    "last_response": {
      "errors": [
        {
          "enumerator": "benefit_blocked_by_tbm",
          "reservation_method" : "new_credit"
        }
      ]
    },
    "last_response_event_datetime": "2023-05-22T19:13:02Z"
  }
}

Detalhamento de campos no retorno da request

Campo	Descrição	Valores
enumerator	Retorno mapeado do código Dataprev	Enumeradores
reservation_method	Método de averbação da reserva	portability, new_credit, refinancing

Portabilidade e refinanciamento (Troco)

Na portabilidade a garantia é consultada pela proposta, informando em credit-operation-type qual das duas operações se quer ler.

Cada enumerador tem uma descrição detalhada e o código de referência da Dataprev. Podemos conferir abaixo, com mais detalhes, como serão apresentados os dados do last response.

Casos de sucesso

Request

ENDPOINT

/v2/credit_transfer/proposal/PROPOSAL-KEY/CREDIT-OPERATION-TYPE/collateral

MÉTODO

GET

Path Params — `credit-operation-type`

Enumerador	Descrição
refinancing_credit_operation	Operação de refinanciamento
portability_credit_operation	Operação de portabilidade

Response

Response Body

{
   "collateral_data":{
      "benefit_number":1976703155,
      "state":"PI",
      "last_response":{
         "success":[
            {
               "enumerator":"succesfully_included",
               "reservation_method":"portability"
            }
         ]
      },
      "last_response_event_datetime":"2023-05-22T19:13:02Z",
      "status":"reserved"
   },
   "collateral_constituted":true,
   "collateral_type":"social_security"
}

Detalhamento de campos no retorno da request

Campo	Descrição	Valores
enumerator	Retorno mapeado do código Dataprev	Enumeradores
reservation_method	Método de averbação da reserva	portability, new_credit, refinancing

Casos de erro

Request

ENDPOINT

/v2/credit_transfer/proposal/PROPOSAL-KEY/CREDIT-OPERATION-TYPE/collateral

MÉTODO

GET

Response

Response Body

{
  "collateral_constituted": false,
  "collateral_type": "type",
  "updated_at": "2023-05-24 19:13:02",
  "collateral_data": {
    "state": "SP",
    "benefit_number": 1976703155,
    "status": "pending_reservation",
    "last_response": {
      "errors": [
        {
          "enumerator": "benefit_blocked_by_tbm",
          "reservation_method" : "portability"
        },
        {
          "enumerator": "benefit_blocked_by_tbm",
          "reservation_method" : "new_credit"
        }
      ]
    },
    "last_response_event_datetime": "2023-05-22T19:13:02Z"
  }
}

Detalhamento de campos no webhook de falha

Campo	Descrição	Valores
enumerator	Retorno mapeado do código Dataprev	Enumeradores
reservation_method	Método de averbação da reserva	portability, new_credit, refinancing

Última consulta do benefício

Por esse endpoint é possível consultar quando foi a última consulta do benefício na Dataprev.

Request

ENDPOINT

/social_security/benefit/BENEFIT-NUMBER

MÉTODO

GET

Testar no Playground

Response

Response Body

{
    "last_balance_check": "2025-08-22T19:13:02Z",
    "status": "pending_balance_request"
}

Webhook da última tentativa de averbação

Caso a operação não tenha sucesso na averbação, a mesma ficará em retentativa e será enviado o seguinte webhook, detalhando o motivo da não averbação, o horário desta tentativa e o método de averbação utilizado:

Ver exemplos de webhook

Webhook portabilidade
Webhook refinanciamento

WEBHOOK_TYPE

credit_transfer.proposal.credit_operation

{
  "webhook_type": "credit_transfer.proposal.collateral",
  "proposal_key": "<PROPOSAL-KEY>",
  "event_datetime": "2022-11-24T15:42:12",
  "data": {
    "credit_operation_type": "portability",
    "credit_operation_key": "<CREDIT-OPERATION-KEY>",
    "collateral_type": "social_security",
    "collateral_constituted": false,
    "collateral_data": {
      "status": "pending_reservation",
      "last_response": {
        "errors": [{
          "enumerator": "consignable_margin_excceded"
        }]
      },
      "last_response_event_datetime": "2023-05-22T19:13:02Z",
      "reservation_method": "new_credit",
    }
  }
}

WEBHOOK_TYPE

credit_operation.collateral

{
  "webhook_type": "credit_operation.collateral",
  "key": "<CREDIT-OPERATION-KEY>",
  "event_time": "2022-11-24T15:42:12",
  "data": {
    "collateral_type": "social_security",
    "collateral_constituted": false,
    "collateral_data": {
      "status": "pending_reservation",
      "last_response": {
        "errors": [{
          "enumerator": "consignable_margin_excceded"
        }]
      },
      "last_response_event_datetime": "2023-05-22T19:13:02Z",
      "reservation_method": "refinancing",
    }
  }
}

Detalhamento de campos no webhook de falha

Campo	Descrição	Valores
enumerator	Retorno mapeado do código Dataprev	Enumeradores
reservation_method	Método de averbação da reserva	portability, new_credit, refinancing