Retrieve Installments Result

GET https://api.caas.staging.bancocdc.com.br/operation/fgts/installments/result/{code}

The retrieve installment route is responsible for consulting the result of a consultation that was scheduled through the webhook.

🚧

Attention point:

To consume the route, it is necessary to pass the webhook scheduling code made available when the client's query to the FGTS module is not successful according to the occurrences listed in the main route.

Response

Http Code	Return Code	Message
200	200-01	Success.
400	400-01	Something unexpected happened.
400	400-02	Invalid hash.
400	400-09	There are no results for the query.
401	401-05	Unauthorized or token invalid.
429	429-01	Too many requests.

Response Parameters

Parameter	Type	Description
return	boolean	Indicates whether the request was successful.
return_code	string	Return code of the request.
message	string	Message indicating the reason for the response.
data	object	Object containing additional information.
data.code	string	Code of the scheduled consultation.
data.http_code_caixa	string	HTTP code returned by CAIXA.
data.message_caixa	string	Return message from CAIXA.
data.document_client	string	Client's document.
data.name_client	string	Client's name.
data.created_at	string	Date and time of the consultation creation.
data.installments	array	Array containing installment information.
data.installments.code	string	Code of the installment.
data.installments.date	string	Due date of the installment.
data.installments.amount	string	Amount of the installment.

Request Parameters