Wallet Entry Webhooks
Attention!
QI Tech webhooks should not be mapped restrictively. Additional fields may be included in the webhook payloads returned by our APIs.
Webhook Resending
You can consult and resend webhooks following the detailed instructions in the documentation: Webhook Resending.
Introduction
After creating a wallet entry (wallet_entry) within our system, webhooks will be sent with the following status:
| Enumerator | Translation | Description |
|---|---|---|
| concluded | completed | Wallet entry completed |
Information
The timeout for our webhook response is 10 seconds.
Examples
Creation confirmation
Webhook Body
{
"webhook_type": "baas.invoice.wallet_entry",
"webhook_datetime": "2024-08-13T21:35:55.679Z",
"data": {
"wallet_key": "ecf87b4b-fa6e-49c0-a7f0-f2cad6b42d79",
"wallet_entry_key": "fd86d9b1-2a5e-4e03-9a59-a043c7632c97",
"wallet_entry_amount": 150.00,
"wallet_entry_type": "revolving_credit",
"wallet_entry_status": "concluded"
}
}
Webhook Fields
| Field | Type | Description | Characters |
|---|---|---|---|
| wallet_key | string | Unique wallet identification key in uuid v4 format | 36 |
| wallet_entry_key | string | Unique wallet entry identification key in uuid v4 format | 36 |
| wallet_entry_amount | number | Wallet entry amount | - |
| wallet_entry_type | string | Wallet entry type | wallet_entry_type Enumerators |
| wallet_entry_status | string | Wallet entry status | wallet_entry_status Enumerators |
wallet_entry_type Enumerators
| Enumerator | Description |
|---|---|
| revolving_credit | Revolving credit |
| payroll_withdraw | Payroll withdrawal |
| payroll_overdue | Payroll overdue |
Wallet Entry Types
revolving_credit: Credit amounts made available to the customerpayroll_withdraw: Debt generated by withdrawing from the limit that will be deducted monthly from INSSpayroll_overdue: Debt generated by non-payment of the invoice that will also be deducted monthly from INSS
wallet_entry_status Enumerators
| Enumerator | Description |
|---|---|
| concluded | Wallet entry completed |