O sistema de callback do FGTS é uma solução automatizada para monitoramento em tempo real de cancelamentos de propostas.

Os callbacks do FGTS podem ser enviados via parâmetros na URL ou via eventos no corpo da requisição.

​
Parâmetros de URL e situações de propostas

Os callbacks de proposta são enviados pela URL, neste formato:

www.url-de-exemplo.com.br?proposta={PROPOSTA}&situacao={SITUACAO}&identificador={IDENTIFICADOR}

Ao serem enviados, serão substituídos os valores {PROPOSTA}, {SITUACAO} e {IDENTIFICADOR} por valores reais, descritos na tabela abaixo.

​
Tabela de parâmetros dos callbacks de proposta

ParâmetroDescrição
PropostaGuid único gerado no response durante a inclusão da proposta.
SituaçãoID da situação da proposta em nosso sistema (conforme tabela abaixo).
IdentificadorCaso seja enviado, esse campo representa o código da operação enviado na inclusão da proposta.

​
Tabela de identificação de status de proposta

IDDescriçãoObjetivo
2AprovadaProposta foi criada e está aguardando a assinatura.
4CanceladaProposta foi cancelada automaticamente ou pelo integrador.
5PendenteProposta foi marcada como pendente e necessita de intervenção do integrador para ser solicitada a averbação novamente.
6FinalizadaFoi solicitada a averbação na Caixa Econômica Federal (CEF).
8LiberadaProposta averbada com sucesso e liberada para ser feito o desembolso.
9PagaFoi realizado o desembolso da proposta.
10CedidaProposta foi adicionada em uma remessa de cessão e cedida ao fundo.
11Pendente PagamentoProposta pendente de pagamento por inconsistência em dados bancários, exigindo intervenção do integrador para corrigir e retornar à fila de pagamento.

Caso o callback seja parametrizado com o método POST, além dos dados enviados na URL, o parceiro receberá no corpo da requisição:

  • Status 9: 00 - Crédito ou débito efetivado;
  • Status 11: AB - Descrição da ocorrência.

Caso ocorra algum problema durante o recebimento do callback de proposta, o sistema realizará até 3 tentativas de envio.

​
Eventos

Os eventos de notificação por callback do FGTS são:

​
Boleto Registrado

Esse callback é enviado quando é solicitado o cancelamento de uma proposta e enviamos um boleto híbrido referente ao cancelamento.

{
    "NumCodigoBarras": "27496981100000010000001090000000005902301160",
    "NumLinhaDigitavel": "27490001019000000000159023011600698110000001000",
    "PixCopiaCola": "00020101021226970014br.gov.bcb.pix2575qr-h.cornerpix.com.br/11581339/v2/cobv/e8fb8e99-6f1c-448e-b1b3-f5c45004a6d85204000053039865802BR5914BMP MONEY PLUS6009SAO PAULO62070503***63045155",
    "QRCode": "iVBORw0KGgoAAAANSUhEUgAAAhIAAAISAQAAAACxRhsSAAAEw0lEQVR4nO2dW4rrOBCG/xob+tGBLKCXouzsMEuaHdhLyQIG5MeATM1DqXTp7nNOw0lEJvx6SNtu5UOGou5SRPGnY/vrjxEAGWSQQQYZZJBBBhlkVIbkMQObfYjIBYdgO5X/ng6RCwC57D7/cud1kEHG12O2P2EFgP0MhHgSAFPCdooqwJwATEmASQU4ZsU+JQCA3G8dZJDxHcbu2nF7T1DVmyBcZwDLTRA0AeE6Q1f/ninf+6+DDDK+w5DLPvvHchNgf1P922VSLv7x6HWQQUY75i+",
    "VlrBoleto": 10.00,
    "DtVencimento": "2024-08-17 00:00:00",
    "NumeroBoleto": "59",
    "CodigoBoleto": "7af52ad6-2ef1-4678-a070-29c59e95b0e1",
    "CodigoProposta": "7e2c86b3-bf71-4ce2-a0b3-7d4f198c3c71",
    "CodigoOperacao": "732af968-96e9-4c9f-9ee1-5fade313ffbb",
    "Detalhes": null,
    "ContextoEvento": 7,
    "TipoEvento": 5,
    "NomeEvento": "Boleto Registrado",
    "DtEvento": "2024-08-16 11:29:19"
}
CampoTipoDescrição
NumCodigoBarrasStringNúmero do código de barras.
NumLinhaDigitavelStringLinha digital do boleto.
PixCopiaColaStringPix copia e cola.
QRCodeStringQR code pix copia e cola (base64).
VlrBoletoDecimalValor do boleto.
DtVencimentoDatetimeData de vencimento do boleto.
NumeroBoletoStringNúmero do boleto.
CodigoBoletoGuidIdentificador do boleto.
CodigoPropostaGuidIdentificador da proposta.
CodigoOperacaoGuidIdentificador da operação.
DetalhesStringNeste caso não retornam informações, apenas o contexto e tipo de evento (sempre NULL).
ContextoEventoStringIdentificador do contexto do evento (7 - FGTS callback).
TipoEventoStringIdentificador do tipo do evento = 5.
NomeEventoStringDescrição do nome do evento.
DtEventoDatetimeData do evento.

​
Cancelamento efetivado

Esse callback é enviado quando o parceiro gera um boleto de cancelamento e o cliente realiza o pagamento do boleto. Dessa forma, o cancelamento é executado com sucesso.

{
  "CodigoProposta": "87456806-1652-48c1-92f3-e75b820104ca",
  "CodigoOperacao": null,
  "Detalhes": null,
  "ContextoEvento": 7,
  "TipoEvento": 1,
  "NomeEvento": "Cancelamento Efetivado",
  "MotivoCancelamento": "Valor da alienação/cessão superior ao valor disponível para o trabalhador.",
  "DtEvento": "2024-09-11T12:34:14.4274789-03:00"
}
CampoTipoDescrição
CodigoPropostaGuidIdentificador da proposta.
CodigoOperacaoGuidIdentificador da operação.
DetalhesStringCampo referente às informações do cancelamento.
ContextoEventoStringIdentificador do contexto do evento (7 - FGTS callback).
TipoEventoStringIdentificador do tipo do evento = 1.
NomeEventoStringDescrição do nome do evento.
DtEventoDatetimeData do evento.

​
Pagamento parcial

Esse callback é enviado quando o cliente realiza o pagamento parcial do valor do boleto.

{
    "CodigoProposta": "7e2c86b3-bf71-4ce2-a0b3-7d4f198c3c71",
    "CodigoOperacao": "37a7bb3d-71b0-4dc6-8424-7d036537113b",
    "Detalhes": "Pagamento parcial de 5.00 realizado.",
    "ContextoEvento": 7,
    "TipoEvento": 4,
    "NomeEvento": "Pagamento Parcial Realizado",
    "DtEvento": "2024-08-16T12:36:50.7216804-03:00"
}
CampoTipoDescrição
CodigoPropostaGuidIdentificador da proposta.
CodigoOperacaoGuidIdentificador da operação.
DetalhesStringCampo referente às informações do cancelamento.
ContextoEventoStringIdentificador do contexto do evento (7 - FGTS callback).
TipoEventoStringIdentificador do tipo do evento = 1.
NomeEventoStringDescrição do nome do evento.
DtEventoDatetimeData do evento.

​
Pagamento não realizado

Esse callback é enviado quando o parceiro gera um boleto de cancelamento, mas o cliente não realiza o pagamento do boleto.

{
    "CodigoProposta": "7e2c86b3-bf71-4ce2-a0b3-7d4f198c3c71",
    "CodigoOperacao": "37a7bb3d-71b0-4dc6-8424-7d036537113b",
    "Detalhes": "Pagamento parcial de 5.00 realizado.",
    "ContextoEvento": 7,
    "TipoEvento": 4,
    "NomeEvento": "Pagamento Parcial Realizado",
    "DtEvento": "2024-08-16T12:36:50.7216804-03:00"
}
CampoTipoDescrição
CodigoPropostaGuidIdentificador da proposta.
CodigoOperacaoGuidIdentificador da operação.
DetalhesStringCampo referente às informações do cancelamento.
ContextoEventoStringIdentificador do contexto do evento (7 - FGTS callback).
TipoEventoStringIdentificador do tipo do evento = 1.
NomeEventoStringDescrição do nome do evento.
DtEventoDatetimeData do evento.

​
Cancelamento não efetivado

Esse callback é enviado após o envio do call-back do “Pagamento não Realizado”. Informando que o cancelamento da operação não foi efetivado.

{
    "CodigoProposta": "7e2c86b3-bf71-4ce2-a0b3-7d4f198c3c71",
    "CodigoOperacao": "4745ed52-eb36-44d4-895c-f0d6a9383066",
    "Detalhes": "Pagamento parcial de 5.00 realizado.",
    "ContextoEvento": 7,
    "TipoEvento": 2,
    "NomeEvento": "Cancelamento Não Efetivado",
    "DtEvento": "2024-08-16T12:36:51.160533-03:00"
}
CampoTipoDescrição
CodigoPropostaGuidIdentificador da proposta.
CodigoOperacaoGuidIdentificador da operação.
DetalhesStringCampo referente às informações do cancelamento.
ContextoEventoStringIdentificador do contexto do evento (7 - FGTS callback).
TipoEventoStringIdentificador do tipo do evento = 1.
NomeEventoStringDescrição do nome do evento.
DtEventoDatetimeData do evento.
Caso ocorra algum problema durante o recebimento do callback do FGTS, o sistema não realizará novas tentativas de envio.