Webhooks

Atenção!

Os webhooks da QI Tech não devem ser mapeadas de forma restrita. Campos adicionais podem ser incluídos aos payloads dos webhooks retornados em nossas APIs.

Reenvio de Webhooks

Você pode consultar e reenviar webhooks seguindo as instruções detalhadas na documentação: Reenvio de Webhooks.

Webhook de movimentações

Para toda e qualquer movimentação será enviado um webhook de “account_transaction“.

Cada transação possui um tipo de classificação (Source Sub Type). Essa classificação é utilizada para categorizar cada movimentação na conta. A lista de Source Sub Types pode ser visualizada abaixo.

Crédito em Conta

Os créditos em conta resultarão em um webhook com “data.amount” positivo, “data.origin“ sendo a conta de origem dos recursos e a “data.destination“ sendo a conta de destino dos recursos:

WEBHOOK_TYPE

account_transaction

Response Body: Pix

{
    "key": "\<ACCOUNT-KEY\>",
	"data": {
		"amount": 1000000,
		"origin": {
			"name": "Treasury Account",
			"branch": "0001",
			"document": "32402502000135",
			"account_key": "5d068423-6094-49e4-b15b-7740038295a8",
			"account_digit": "5",
			"account_number": "00002"
		},
		"timestamp": "2022-09-02T21:36:33.446120",
		"description": "329 0001 00002-5 32.402.502/0001-35 - QI SOCIEDADE DE CRÉDITO DIRETO S.A.",
		"destination": {
			"name": "Default",
			"branch": "0001",
			"document": "09080702000105",
			"account_key": "6d30a0b1-cb90-4ceb-b1ea-5bd600cdf3c8",
			"account_digit": "2",
			"account_number": "2359934"
		},
		"reference_key": "983b4a28-7de6-4e71-97ef-60fb50c7b013",
		"reference_type": "movement_request",
		"account_balance": 1000000,
		"source_sub_type": "internal_funds_transfer",
		"transaction_key": "67a62397-2c32-4768-8485-ec9129a46654",
		"source_sub_type_str": "Transferência Interna",
		"transaction_details": {
			"payer_name": "0001",
			"receiver_name": "Default",
			"payer_account_digit": "5",
			"payer_account_branch": "",
			"payer_account_number": "1111111",
			"payer_document_number": "66681638999999",
			"receiver_account_digit": "6",
			"receiver_account_branch": "0000",
			"receiver_account_number": "34256449809",
			"receiver_conciliation_id": null,
			"receiver_document_number": "00809641658"
		}
	},
	"datetime": "2022-09-02T21:36:33.446120",
	"webhook_type": "account_transaction"
}

Response Body: Outras transações

{
    "key": "\<ACCOUNT-KEY\>",
	"data": {
		"amount": 1000000,
		"origin": {
			"name": "Treasury Account",
			"branch": "0001",
			"document": "32402502000135",
			"account_key": "5d068423-6094-49e4-b15b-7740038295a8",
			"account_digit": "5",
			"account_number": "00002"
		},
		"timestamp": "2022-09-02T21:36:33.446120",
		"description": "329 0001 00002-5 32.402.502/0001-35 - QI SOCIEDADE DE CRÉDITO DIRETO S.A.",
		"destination": {
			"name": "Default",
			"branch": "0001",
			"document": "09080702000105",
			"account_key": "6d30a0b1-cb90-4ceb-b1ea-5bd600cdf3c8",
			"account_digit": "2",
			"account_number": "2359934"
		},
		"reference_key": "983b4a28-7de6-4e71-97ef-60fb50c7b013",
		"reference_type": "movement_request",
		"account_balance": 1000000,
		"source_sub_type": "internal_funds_transfer",
		"transaction_key": "67a62397-2c32-4768-8485-ec9129a46654",
		"source_sub_type_str": "Transferência Interna",
	},
	"datetime": "2022-09-02T21:36:33.446120",
	"webhook_type": "account_transaction"
}

Débito em Conta

Os débitos em conta resultarão em um webhook com “data.amount” negativo, “data.origin“ sendo a conta destinatária dos recursos e a “data.destination“ sendo a conta de origem dos recursos:

WEBHOOK_TYPE

account_transaction

Webhook Body

{
	"key": "\<ACCOUNT-KEY\>",
	"data": {
		"amount": -45,
		"origin": {
			"name": "PIX",
			"branch": "0001",
			"document": "32402502000135",
			"account_key": "3d0e7d50-e898-49f3-b23b-05353c8a3c72",
			"account_digit": "3",
			"account_number": "00003"
		},
		"timestamp": "2022-09-02T23:00:05.326738",
		"description": "212 0001 1017372-2 ***.221.81*-** BANCO ORIGINAL S.A.",
		"destination": {
			"name": "Default",
			"branch": "0001",
			"document": "09080702000105",
			"account_key": "6d30a0b1-cb90-4ceb-b1ea-5bd600cdf3c8",
			"account_digit": "2",
			"account_number": "2359934"
		},
		"reference_key": "cea836b5-b02e-4f94-b1e2-4d575671c33d",
		"reference_type": "pix_outgoing",
		"account_balance": 999955,
		"source_sub_type": "pix_withdrawal",
		"transaction_key": "d2ba3817-26d7-4957-ab82-24f78d910a8a",
		"source_sub_type_str": "Transferência de PIX"
	},
	"datetime": "2022-09-02T23:00:05.326738",
	"webhook_type": "account_transaction"
}

Lista de source_sub_types’s:

Enum	Descrição
operation_disbursement	Desembolso da Operação
protest_expense	Despesas de Protesto
automatic_integrated_payment	Pagamento Automático Integrado
tax	Impostos
electronic_funds_fee	Tarifa de TED
credit_operation_fee	Tarifa de Abertura de Crédito
internal_funds_transfer	Transferência Interna
incoming_funds_transfer	Transferência de Entrada
outgoing_funds_transfer	TED
deposit	Depósito
withdrawal	Transferência
withdrawal_reversal	Estorno de Transferência
trade_funds_transfer	Transferência de Pagamento de Cessão
settlement_funds_transfer	Transferência para Liquidação
bank_slip_fee	Tarifa de Boleto
bank_slip_settlement	Liquidação de Boleto
outgoing_funds_transfer_reversal	Estorno de TED
incoming_funds_transfer_refusal	Transferência Negada
electronic_funds_fee_reversal	Estorno de Tarifa de TED
monthly_account_fee_reversal	Estorno de Tarifa de Manutenção de Conta
bank_slip_fee_reversal	Estorno de Tarifa de Boleto
correspondent_bank_transfer	Repasse de Correspondente Bancário
credit_analysis_fee	Tarifa de Análise de Crédito
credit_operation_fee_reversal	Estorno de Tarifa de Abertura de Crédito
financial_investments_income	Renda de Aplicação Financeira
bank_slip_settlement_reversal	Estorno de Liquidação de Boleto
bank_slip_settlement_expense_reversal	Estorno de Tarifa de liquidação de Boleto
bank_slip_settlement_incoming_reversal	Estorno de Recebimento de Liquidação de Boleto
correspondent_bank_transfer_reversal	Estrono de Repasse de Correspondente Bancário
credit_analysis_fee_reversal	Estorno de Tarifa de Análise de Crédito
doc_expense_reversal	Estorno de Tarifa de DOC
incoming_doc_reversal	Estorno de Entrada de DOC
operation_disbursement_reversal	Estorno de Desembolso da Operação
operation_settling_reversal	Estorno de Pagamento de Operação
outgoing_doc_reversal	Estorno de Saída de DOC
rebate_reversal	Estorno de Rebate
settlement_funds_transfer_reversal	Estorno de Transferência para Liquidação
tax_reversal	Estorno de Impostos
trade_funds_transfer_reversal	Estorno de Transferência de Pagamento de Cessão
bank_slip_permanency_fee	Tarifa de Permanência do Título
bank_slip_cancel_protest_fee	Tarifa de Permanência do Título
bank_slip_protest_fee	Tarifa de Pedido de Protesto
bank_slip_notary_office_fee	Custas de Protesto
bank_slip_registration_fee	Tarifa de Registro
bank_slip_extension_fee	Tarifa de Prorrogação
bank_slip_rebate_fee	Tarifa de Abatimento
bank_slip_discount_fee	Tarifa de Desconto
bank_slip_settlement_fee	Tarifa de Liquidação
bank_slip_write_off_term_fee	Tarifa de Baixa por Decurso de Prazo
bank_slip_write_off_fee	Tarifa de Baixa
bank_slip_cancel_protest_write_off_fee	Tarifa de Sustação de Protesto com Baixa
bank_slip_notary_office_settlement_fee	Tarifa de Liquidação em Cartório
rebate_tax_free	Repasse por Conta e Ordem
rebate_tax_free_reversal	Estorno de Repasse por Conta e Ordem
incoming_funds_transfer_reversal	Estorno de Transferência Interna
bank_slip_payment	Pagamento de Boleto
bank_slip_payment_reversal	Estorno de Pagamento de Boleto
warranty_analysis_fee	Tarifa de Análise de Garantia
bank_slip_settlement_deposit	Liquidação de Boleto
bank_slip_payment_withdrawal	Pagamento de Boleto
account_setup_fee	Tarifa de Abertura de Conta
account_setup_fee_reversal	Estorno de Tarifa de Abertura de Conta
bank_slip_payment_withdrawal_reversal	Estorno de Pagamento de Boleto
incoming_anticipation_of_receivable	-
incoming_credit_card_settlement	Liquidação de cartão de crédito
incoming_debit_card_settlement	Liquidação de cartão de débito
assignment_automatic_transfer	Débito de Cessão Automática
assignment_automatic_transfer_reversal	Estorno de Débito de Cessão Automática
pix_fee	Tarifa de PIX
incoming_pix_transfer	Entrada de PIX
outgoing_pix_transfer	Saída de PIX
pix_fee_reversal	Estorno de Tarifa de PIX
incoming_pix_transfer_reversal	Estorno de entrada de PIX
outgoing_pix_transfer_reversal	Estorno de saída de PIX
pix_deposit	Depósito de PIX
pix_withdrawal	Transferência de PIX
pix_withdrawal_reversal	Estorno de transferência de PIX
pix_chargeback_withdrawal	Envio de devolução PIX
outgoing_pix_chargeback	Saída de PIX por devolução
incoming_pix_chargeback	Recebimento de devolução PIX
pix_chargeback_deposit	Entrada de PIX por devolução
pix_chargeback_withdrawal_reversal	Estorno de envio de devolução PIX
outgoing_pix_chargeback_reversal	Estorno de saída de PIX por devolução
incoming_pix_chargeback_reversal	Estorno de recebimento de devolução PIX
operation_pix_disbursement	Desembolso PIX da Operação
operation_pix_disbursement_reversal	Estorno de Desembolso PIX da Operação
receivables_inquiry_fee	Tarifa de Consulta de Agenda de Recebíveis
pix_deposit_reversal	Estorno de Depósito de PIX
internal_pix_transfer	Transferência de PIX
automatic_integrated_payment_reversal	Estorno de Pagamento Automático Integrado
operation_dibursement_reversal	Estorno de Desembolso da Operação
available_yield	Depósito de Investimento Liquido
bank_slip_convenant_payment	Pagamento de Boleto de Convênio

Webhook de bloqueios

O webhook de bloqueios é enviado sempre que houver um bloqueio ou desbloqueio de um determinado valor em uma conta. O campo origin_type identifica o tipo de origem do bloqueio.

Para bloqueios, o valor em blocked_balance será positivo. Para desbloqueios, o valor será negativo, indicando a liberação do valor anteriormente bloqueado.

WEBHOOK_TYPE

baas.account.block_event

Webhook Body: Sisbajud

{
  "webhook_type": "baas.account.block_event",
  "webhook_datetime": "2021-10-22T20:30:23.459Z",
  "data": {
	"account_key": "ca2c934e-5970-4c15-bdef-87e1b5c204e3",
	"blocked_balance": 100,
    "origin_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
    "origin_type": "sisbajud",
	"block_details": {
        "block_order_protocol": "20250028399883",
        "block_order_sequence": "00005",
        "requester_judge": "JUIZ DE DIREITO",
        "defendant_document_number": "15717553064",
        "case_number": "07279467320148070007",
        "court_code": "44815",
        "requested_amount": 10000,
        "lawsuit_author_name": "Pamela Janssen de Araujo Clemente",
        "institution_document_number": null,
        "lawsuit_type": "labor",
        "protocol_datetime": "2025-02-19T10:00:00.000Z"
    }
  }
}

Webhook Body Params

Campo	Tipo	Descrição	Máx. Caracteres
webhook_type	string	Um enumerador que define o tipo de evento sendo reportado	23
blocked_balance	string	Data e hora do envio do webhook	20
data	string	Dados referentes à ordem judicial	Objeto data

Objeto data

Campo	Tipo	Descrição	Máx. Caracteres
account_key	string	Chave única de identificação da conta QI	36
blocked_balance	number	Saldo bloqueado	15
origin_key	string	Chave única de identificação da origem da ordem judicial	36
origin_type	string	Origem da ordem judicial	Enumeradores origin_type
block_details	string	Detalhes do bloqueio	Objeto block_details

Objeto block_details

Campo	Tipo	Descrição	Máx. Caracteres
block_order_protocol	number	Número do protocolo de bloqueio judicial	14
block_order_sequence	number	Número de sequência do bloqueio	5
requester_judge	string	Magistrado	115
defendant_document_number	number	Número de documento do réu	14
case_number	number	Número do processo judicial	30
court_code	string	Código do tribunal responsável pelo caso	5
requested_amount	number	Quantia solicitada para bloqueio	15
lawsuit_author_name	string	Nome do autor da ação judicial	115
institution_document_number	number	Número do documento da instituição	14
lawsuit_type	enumerator	Tipo de ação judicial	Enumeradores lawsuit_type
protocol_datetime	string	Data e hora do protocolo de bloqueio	20

Enumeradores lawsuit_type

Enumerador	Descrição
civil	Processo civil
criminal	Processo criminal
labor	Processo trabalhista
tax	Processo tributário
food	Processo alimentício

Enumeradores origin_type

Enumerador	Tipo	Descrição
credit_operation	string	Operação de crédito
credit_operation_installment	string	Parcela de operação de crédito
wallet_trade	string	Operação de carteira
wallet_settlement	string	Liquidação de carteira
ted_incoming	string	TED recebida
ted_outgoing	string	TED enviada
bank_slip_expense	string	Despesa de boleto
bank_slip	string	Boleto
bank_slip_cnab	string	Boleto CNAB
future_transaction	string	Transação futura
internal_operation	string	Operação interna
lego	string	Lego
siloc	string	SILOC
bank_slip_payment	string	Pagamento de boleto
movement_request	string	Solicitação de movimentação
slc	string	SLC
julius	string	Julius
batch_disbursement	string	Desembolso em lote
card_transaction	string	Transação de cartão
credit_transfer	string	Transferência de crédito
pix_outgoing	string	PIX enviado
pix_incoming	string	PIX recebido
collateral	string	Garantia
celcoin	string	Celcoin
investment	string	Investimento
routing	string	Roteamento
c3	string	C3
billing	string	Cobrança
disbursement	string	Desembolso
rebate	string	Rebate
card_invoice	string	Fatura de cartão
b3_operation	string	Operação B3
bill_payment	string	Pagamento de conta
med	string	MED
peer_to_peer	string	Transferência entre pares
settlement_notification	string	Notificação de liquidação
reversal_notification	string	Notificação de estorno
insurance_premium	string	Prêmio de seguro
liquidation	string	Liquidação
purchase	string	Compra
lending_billing	string	Cobrança de empréstimo
lending_rebate	string	Rebate de empréstimo
sisbajud	string	SISBAJUD

Enumeradores lawsuit_type

Enumerador	Tipo	Descrição
civil	string	Processo Civil
criminal	string	Processo Criminal
labor	string	Processo Trabalhista
tax	string	Processo Tributário
food	string	Processo Alimentício