Webhooks de Pagamento de Fatura

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.

Introdução

Após a mudança de status de um pagamento de fatura (invoice_payment) dentro do nosso sistema, será enviado um webhook com a mudança de status do pagamento:

Enumerador	Tradução	Descrição
waiting_payment	aguardando pagamento	Pagamento de fatura aguardando pagamento
paid	pago	Pagamento de fatura pago

Informação

O timeout para resposta de nosso webhooks é de 10 segundos.

Exemplos

Pagamento de fatura (payroll_discount)

Webhook Body

{
	"webhook_type": "baas.invoice.invoice_payment_status_change",
	"webhook_datetime": "2024-08-13T21:35:55.679Z",
	"data": {
		"wallet_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
		"invoice_payment_key": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
		"total_amount": 350.00,
		"paid_amount": 0.00,
		"payment_date": "2024-02-15",
		"invoice_payment_type": "payroll_discount",
		"invoice_payment_status": "waiting_payment"
	}
}

Pagamento de fatura (bank_slip)

Webhook Body

{
	"webhook_type": "baas.invoice.invoice_payment_status_change",
	"webhook_datetime": "2024-08-13T21:35:55.679Z",
	"data": {
		"wallet_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
		"invoice_payment_key": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
		"total_amount": 350.00,
		"paid_amount": 0.00,
		"payment_date": "2024-02-15",
		"invoice_payment_type": "bank_slip",
		"invoice_payment_status": "waiting_payment"
	}
}

Campos do Webhook

Campo	Tipo	Descrição	Caracteres
wallet_key	string	Chave única de identificação da carteira no formato uuid v4	36
invoice_payment_key	string	Chave única de identificação do pagamento de fatura no formato uuid v4	36
total_amount	number	Valor total do pagamento de fatura	-
paid_amount	number	Valor pago do pagamento de fatura	-
payment_date	string	Data do pagamento (formato YYYY-MM-DD)	10
invoice_payment_type	string	Tipo do pagamento de fatura	Enumeradores invoice_payment_type
invoice_payment_status	string	Status do pagamento de fatura	Enumeradores invoice_payment_status

Enumeradores invoice_payment_type

Enumerador	Descrição
bank_slip	Boleto bancário
payroll_discount	Desconto via folha de pagamento

Enumeradores invoice_payment_status

Enumerador	Descrição
waiting_payment	Pagamento de fatura aguardando pagamento
paid	Pagamento de fatura pago

Observação

• Para pagamentos do tipo payroll_discount: o pagamento é criado no momento do fechamento da fatura com o status waiting_payment e o desconto é solicitado no INSS. Quando o pagamento do desconto é realizado, o status muda para paid.
• Para pagamentos do tipo bank_slip: o pagamento é criado com status waiting_payment quando recebemos o aviso de pagamento do boleto. No momento da liquidação do boleto, o status muda para paid. O pagamento pode ser criado com status paid diretamente caso não seja recebido um aviso de pagamento.