Webhooks de Consulta de Saldo

O webhook retornado terá duas opções. Ou ele retorna um sucesso, ou uma falha.

Em caso de sucesso:

Response Body

{
    "key": "843ab07e-b16f-4dfa-b048-37c464483aa5",
    "status": "success",
    "webhook_type": "fgts_available_balance",
    "event_datetime": "2022-07-14T18:31:29",
    "data": {
        "reference_date": "2022-07-14",
        "periods": [{
                "amount": 776.41,
                "due_date": "2023-01-01"
            },
            {
                "amount": 508.25,
                "due_date": "2024-01-01"
            },
            {
                "amount": 286,
                "due_date": "2025-01-01"
            }
        ]
    }
}

Em caso de falha:

Request Body

{
    "key": "843ab07e-b16f-4dfa-b048-37c464483aa5",
    "status": "failed",
    "webhook_type": "fgts_available_balance",
    "event_datetime": "2022-07-14T18:31:29",
    "data": {
        "enumerator": "unauthorized_institution",
        "description": "Institution isn’t authorized by the client"
    }
}

Erros existentes na consulta:

Os erros existentes são:

Dígitos do CPF	Enumerador	Descrição
90	ongoing_operation	There's an ongoing operation
91	unauthorized_institution	Institution isn't authorized by the client
92	inexistent_anniversary_membership	Client does not have membership for anniversary withdraw on current date
93	on_locked_date_range	Not permitted action on current date
94	anniversary_membership_egress	Client moving away from anniversary membership. It needs to be canceled before requesting a reserve
95	processing_pending_changes	Changes on client's FGTS account are still being processed
96, 97, 98 e 99	caixa_error	Request wasn't able to process due to an error on CEF