Webhooks — Vehicle Collateral
Attention!
QI Tech webhooks must not be mapped in a restrictive way. Additional fields may be included in the webhook payloads returned by our APIs.
Asynchronous notifications sent via POST. The request must be answered within 10 seconds with HTTP 200.
Order Status Webhook
Notifies about status changes in contract, lien, and image stages.
Payload
| Field | Type | Description |
|---|---|---|
| transactionId | String | Transaction ID (36 chars) |
| status | String | Order status (see Status Map) |
| msgRetornoPlataforma | String | Platform return message |
| codigoQiTech | String | Unique request identifier |
| etapaAtual | String | Current stage (Lien Inclusion / Contract Registration / Contract Addendum / Contract Image) |
| timestamp | DATETIME | Send timestamp |
| dataUltimaAtualizacao | DATETIME | Last update date on the platform |
| gravame | String | Lien number ("0" when none) |
| uf | String | UF where the lien was created (2 chars) |
| chassi | String | Vehicle VIN/chassis |
Attention
The "Processing" status is not sent via webhook for the Contract Registration, Lien Inclusion, and Contract Addendum stages.
Configuration
The Status Webhook requires registered URLs + selection of desired stages/statuses. Consult the onboarding team for configuration.