Webhooks

Como receber atualizações via webhook

A entrega de certos dados pela API ocorre de maneira assíncrona. Para receber esses dados, é crucial cadastrar o destino para onde devem ser enviados. A responsabilidade de receber os dados cabe à empresa consumidora da API, incluindo a configuração e manutenção adequadas do local de recebimento.

Para realizar o cadastro, será necessário ter à disposição:

  • URL do seu webhook;
  • Método HTTP a ser usado na requisição (ex.: POST, PATCH, PUT);
  • Cabeçalhos personalizados (opcional);

Lembre-se da importância de configurar o seu sistema para lidar com os dados recebidos no webhook e processá-los de maneira adequada

A imagem a seguir apresenta a visualização da tela ‘Dados do Agente’ destinada ao cadastro do webhook.

 

Retorno do saldo

{
“cpf”: “12345678901”, // string
“type”: “saldo_disponivel”, // string
“reference_date”: “2023-08-24”, // date
“periods”: [ // array<object>
{
“due_date”: “2024-07-01”, // date
“amount”: 1301.36 // decimal
},
{
“due_date”: “2025-07-01”, // date
“amount”: 1197.38 // decimal
}
] }

Possíveis erros no retorno do saldo

{
“cpf”: “12345678901”, // string
“type”: “saldo_disponivel”, // string
“error_description”: “Há uma operação em andamento”, // string
“error_enumerator”: “ongoing_operation” // string
}

{
“cpf”: “12345678901”, // string
“type”: “saldo_disponivel”, // string
“error_description”: “A instituição não está autorizada pelo cliente”, // string
“error_enumerator”: “unauthorized_institution” // string
}

{
“cpf”: “12345678901”, // string
“type”: “saldo_disponivel”, // string
“error_description”: “Cliente não tem adesão para retirada de aniversário na data atual”, // string
“error_enumerator”: “inexistent_anniversary_membership” // string
}

{
“cpf”: “12345678901”, // string
“type”: “saldo_disponivel”, // string
“error_description”: “Ação não permitida na data atual”, // string
“error_enumerator”: “on_locked_date_range”, // string
“error_data”: {
“operation_not_allowed_until_date”: “2023-09-02” // date
}
}

{
“cpf”: “12345678901”, // string
“type”: “saldo_disponivel”, // string
“error_description”: “Trabalhador com solicitação de retorno para saque rescisão, que deve
ser cancelada pelo mesmo para possibilitar a solicitação de garantia”, // string
“error_enumerator”: “anniversary_membership_egress”, // string
}

{
“cpf”: “12345678901”, // string
“type”: “saldo_disponivel”, // string
“error_description”: “Alterações nas informações do perfil ocorreram na conta FGTS do cliente”, // string
“error_enumerator”: “processing_pending_changes”, // string
}

{
“cpf”: “12345678901”, // string
“type”: “saldo_disponivel”, // string
“error_description”: “Ocorreu um erro na Caixa Econômica Federal que
impediu o processamento da solicitação”, // string
“error_enumerator”: “caixa_error” // string
}

Atualização da Proposta

{
“key”: “871059bd-4014-41ad-82b4-28275ff0e67b”, // string
“status”: “disbursed”, // string
“webhook_type”: “debt”, // string
“event_datetime”: “2022-09-28 13:01:23” // datetime
}

{
“key”: “6613ebf5-b41d-4257-b2f9-89ce261c5041”, // string
“data”: {
“cancel_reason”: “Available Balance is not sufficient for given periods amount”, // string
“cancel_reason_enumerator”: “fgts_insufficient_balance” // string
},
“status”: “canceled”, // string
“webhook_type”: “debt”, // string
“event_datetime”: “2022-12-22 21:27:41” // datetime
}

Webhooks

Como receber atualizações via webhook

A entrega de certos dados pela API ocorre de maneira assíncrona. Para receber esses dados, é crucial cadastrar o destino para onde devem ser enviados. A responsabilidade de receber os dados cabe à empresa consumidora da API, incluindo a configuração e manutenção adequadas do local de recebimento.

Para realizar o cadastro, será necessário ter à disposição:

  • URL do seu webhook;
  • Método HTTP a ser usado na requisição (ex.: POST, PATCH, PUT);
  • Cabeçalhos personalizados (opcional);

Lembre-se da importância de configurar o seu sistema para lidar com os dados recebidos no webhook e processá-los de maneira adequada

A imagem a seguir apresenta a visualização da tela ‘Dados do Agente’ destinada ao cadastro do webhook.

 

Retorno do saldo

{
“cpf”: “12345678901”, // string
“type”: “saldo_disponivel”, // string
“reference_date”: “2023-08-24”, // date
“periods”: [ // array<object>
{
“due_date”: “2024-07-01”, // date
“amount”: 1301.36 // decimal
},
{
“due_date”: “2025-07-01”, // date
“amount”: 1197.38 // decimal
}
] }

Possíveis erros no retorno do saldo

{
“cpf”: “12345678901”, // string
“type”: “saldo_disponivel”, // string
“error_description”: “Há uma operação em andamento”, // string
“error_enumerator”: “ongoing_operation” // string
}

{
“cpf”: “12345678901”, // string
“type”: “saldo_disponivel”, // string
“error_description”: “A instituição não está autorizada pelo cliente”, // string
“error_enumerator”: “unauthorized_institution” // string
}

{
“cpf”: “12345678901”, // string
“type”: “saldo_disponivel”, // string
“error_description”: “Cliente não tem adesão para retirada de aniversário na data atual”, // string
“error_enumerator”: “inexistent_anniversary_membership” // string
}

{
“cpf”: “12345678901”, // string
“type”: “saldo_disponivel”, // string
“error_description”: “Ação não permitida na data atual”, // string
“error_enumerator”: “on_locked_date_range”, // string
“error_data”: {
“operation_not_allowed_until_date”: “2023-09-02” // date
}
}

{
“cpf”: “12345678901”, // string
“type”: “saldo_disponivel”, // string
“error_description”: “Trabalhador com solicitação de retorno para saque rescisão, que deve
ser cancelada pelo mesmo para possibilitar a solicitação de garantia”, // string
“error_enumerator”: “anniversary_membership_egress”, // string
}

{
“cpf”: “12345678901”, // string
“type”: “saldo_disponivel”, // string
“error_description”: “Alterações nas informações do perfil ocorreram na conta FGTS do cliente”, // string
“error_enumerator”: “processing_pending_changes”, // string
}

{
“cpf”: “12345678901”, // string
“type”: “saldo_disponivel”, // string
“error_description”: “Ocorreu um erro na Caixa Econômica Federal que
impediu o processamento da solicitação”, // string
“error_enumerator”: “caixa_error” // string
}

Atualização da Proposta

{
“key”: “871059bd-4014-41ad-82b4-28275ff0e67b”, // string
“status”: “disbursed”, // string
“webhook_type”: “debt”, // string
“event_datetime”: “2022-09-28 13:01:23” // datetime
}

{
“key”: “6613ebf5-b41d-4257-b2f9-89ce261c5041”, // string
“data”: {
“cancel_reason”: “Available Balance is not sufficient for given periods amount”, // string
“cancel_reason_enumerator”: “fgts_insufficient_balance” // string
},
“status”: “canceled”, // string
“webhook_type”: “debt”, // string
“event_datetime”: “2022-12-22 21:27:41” // datetime
}