Return file Webhooks

Return files are used for reconciliation. In them, each Transaction Record line (Type 1) refers to an instruction (whether issuance, extension, discount, etc.) that was confirmed or rejected by CIP/Nuclea on the previous day.

Attention!

QI Tech webhooks should not be mapped in a restrictive manner. Additional fields may be included in the webhook payloads returned in our APIs.

Webhook Resending

You can consult and resend webhooks by following the detailed instructions in the documentation: Webhook Resending.

Information

The timeout for our webhook response is 10 seconds.

Examples

Return file

Webhook Body

{
    "webhook_type": "baas.bank_slip.discharge_file",
    "webhook_datetime": "2024-08-13T21:35:55.679Z",
    "data": {
        "discharge_file_key": "f1a8fe59-29cd-49e5-8d18-55194869b45c",
        "reference_date": "2024-10-15",
        "requester_profile_key": "fc60a57e-c6ac-4e39-a3cf-2dc3c491dac6",
        "discharge_file_url": "https://storage.googleapis.com/local-bank-slip-api/2024/61a746ca-05bf-429d-99c3-3fba0f9fbea7/329-20-7336-3073959/discharge/CB15102401.RET",
        "cnab_bank": "qi_scd",
        "cnab_layout": "400",
    }
}

Supported Banks

Currently, the return file webhook supports the following banks:

Bradesco (bradesco)
Itaú (itau)
QI SCD (qi_scd)
Santander (santander)

Supported Layouts

Currently, the return file webhook supports the following CNAB layouts:

CNAB 400 (400)

Examples​

Return file​

Examples

Return file