Webhook

The CDC bank sends notification webhooks to communicate events such as installments FGTS and many other events. You can check the complete list of CDC's webhooks notification events below.

The CDC will send HTTP POST requests to a specified URL endpoint hosted in your environment and configured to receive and process them.

To start using CDC's webhooks, you will need to:

1- Expose an endpoint on your server

2- Register your endpoint and the events you would like to subscribe

3- Process CDC's notifications

Retry Logic

---

The CDC uses at-least-once delivery to ensure that your application has received a notification. If your application has not acknowledged a message within 7 seconds, we will keep sending the request until it is accepted.

Retry attempts will happen regularly, at increasing time intervals:

7 seconds (two times)
2 minutes
5 minutes
15 minutes
1 hour
3 hours
Every 12 hours for the following 5 days.

Your webhook endpoint might occasionally receive the same notification more than once. You can handle these cases by making your event processing idempotent using the "code" unique field to every event.

Prepare receive of callback

---

For every request received by CDC, we will send a HTTP POST requests to a specified URL endpoint hosted in your environment and configured to receive and process them by the webhook in shape of callbacks.

Below are examples of the calls available:

For call of Installments FGTS:

JSON

{
    "return": true,
    "message": "sucess.",
    "data": {
        "code": "db4f79de-3570-4f02-a0fe-7055d6bdb125",
        "message_caixa": "CAIXA - sucess.",
        "http_code_caixa": "200",
        "url": "https//fgts/installments",
        "name_event": "FGTS Installments Results",
        "code_event": "1",
        "document_client": "12345678901",
        "name_client": "Client CDC BANK",
        "created_at": "2023-01-01 00:00:00",
        "installments": [
            {
                "code": "db4f79de-3570-4f02-a0fe-7055d6bdb126",
                "date": "2022-01-01",
                "amount": 10.00
            },
            {
                "code": "db4f79de-3570-4f02-a0fe-7055d6bdb127",
                "date": "2023-01-01",
                "amount": 20.00
            }
        ]
    }
}

For call of Operation Status:

JSON

{
    "return": true,
    "message": "sucess.",
    "data": {
        "code_historic": "db4f79de-3570-4f02-a0fe-7055d6bdb125",
        "code_operation":"d14899aw-3570-4f02-a0fe-705589789ads",
        "number_operation": 2000,
        "number_current_status": 5,
        "number_new_status": 2,
        "message": "Atualização de Status.",
        "updated_at": "2024-01-01 00:00:10",
        "url":"https://cdc/callback/transacao",
        "name_event":"Minha rota principal",
        "code_event":2
    }
}

For call of Assignment Status:

JSON

{
    "return": true,
    "message": "sucess.",
    "data": {
        "code_historic": "db4f79de-3570-4f02-a0fe-7055d6bdb125",
        "code_assignment":"d14899aw-3570-4f02-a0fe-705589789ads",
        "number_assignment": 2000,
        "number_current_status": 5,
        "number_new_status": 2,
        "message": "Atualização de Status.",
        "updated_at": "2024-01-01 00:00:10",
        "url":"https://cdc/callback/transacao",
        "name_event":"Minha rota principal",
        "code_event":3
    }
}