Skip to main content

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:

EnumeratorTranslationDescription
concludedcompletedWallet 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

FieldTypeDescriptionCharacters
wallet_keystringUnique wallet identification key in uuid v4 format36
wallet_entry_keystringUnique wallet entry identification key in uuid v4 format36
wallet_entry_amountnumberWallet entry amount-
wallet_entry_typestringWallet entry typewallet_entry_type Enumerators
wallet_entry_statusstringWallet entry statuswallet_entry_status Enumerators

wallet_entry_type Enumerators

EnumeratorDescription
revolving_creditRevolving credit
payroll_withdrawPayroll withdrawal
payroll_overduePayroll overdue
Wallet Entry Types
  • revolving_credit: Credit amounts made available to the customer
  • payroll_withdraw: Debt generated by withdrawing from the limit that will be deducted monthly from INSS
  • payroll_overdue: Debt generated by non-payment of the invoice that will also be deducted monthly from INSS

wallet_entry_status Enumerators

EnumeratorDescription
concludedWallet entry completed