Webhooks de Entradas de Instrumento de Pagamento

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 criação de uma entrada de instrumento de pagamento (payment_instrument_entry) dentro do nosso sistema, serão enviados webhooks com os seguintes status:

Enumerador	Tradução	Descrição
processing_conclusion	processando conclusão	Entrada de instrumento de pagamento em processamento de conclusão
processing_cancellation	processando cancelamento	Entrada de instrumento de pagamento em processamento de cancelamento
concluded	concluída	Entrada de instrumento de pagamento concluída
canceled	cancelada	Entrada de instrumento de pagamento foi cancelada

Informação

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

Exemplos

---

Confirmação de criação

Webhook Body

{
	"webhook_type": "baas.invoice.payment_instrument_entry",
	"webhook_datetime": "2024-08-13T21:35:55.679Z",
	"data": {
		"payment_instrument_key": "ecf87b4b-fa6e-49c0-a7f0-f2cad6b42d79",
		"payment_instrument_entry_key": "fd86d9b1-2a5e-4e03-9a59-a043c7632c97",
		"payment_instrument_entry_amount": 150.00,
		"payment_instrument_entry_type": "purchase",
		"payment_instrument_entry_status": "concluded"
	}
}

Confirmação de cancelamento

Webhook Body

{
	"webhook_type": "baas.invoice.payment_instrument_entry",
	"webhook_datetime": "2024-08-13T21:35:55.679Z",
	"data": {
		"payment_instrument_key": "ecf87b4b-fa6e-49c0-a7f0-f2cad6b42d79",
		"payment_instrument_entry_key": "fd86d9b1-2a5e-4e03-9a59-a043c7632c97",
		"payment_instrument_entry_amount": 150.00,
		"payment_instrument_entry_type": "purchase",
		"payment_instrument_entry_status": "canceled"
	}
}

Processando ativação

Webhook Body

{
	"webhook_type": "baas.invoice.payment_instrument_entry",
	"webhook_datetime": "2024-08-13T21:35:55.679Z",
	"data": {
		"payment_instrument_key": "ecf87b4b-fa6e-49c0-a7f0-f2cad6b42d79",
		"payment_instrument_entry_key": "fd86d9b1-2a5e-4e03-9a59-a043c7632c97",
		"payment_instrument_entry_amount": 150.00,
		"payment_instrument_entry_type": "purchase",
		"payment_instrument_entry_status": "processing_conclusion"
	}
}

Processando cancelamento

Webhook Body

{
	"webhook_type": "baas.invoice.payment_instrument_entry",
	"webhook_datetime": "2024-08-13T21:35:55.679Z",
	"data": {
		"payment_instrument_key": "ecf87b4b-fa6e-49c0-a7f0-f2cad6b42d79",
		"payment_instrument_entry_key": "fd86d9b1-2a5e-4e03-9a59-a043c7632c97",
		"payment_instrument_entry_amount": 150.00,
		"payment_instrument_entry_type": "purchase",
		"payment_instrument_entry_status": "processing_cancellation"
	}
}

Campos do Webhook

Campo	Tipo	Descrição	Caracteres
payment_instrument_key	string	Chave única de identificação do instrumento de pagamento no formato uuid v4	36
payment_instrument_entry_key	string	Chave única de identificação da entrada do instrumento de pagamento no formato uuid v4	36
payment_instrument_entry_amount	number	Valor da entrada do instrumento de pagamento	-
payment_instrument_entry_type	string	Tipo da entrada do instrumento de pagamento	Enumeradores payment_instrument_entry_type
payment_instrument_entry_status	string	Status da entrada do instrumento de pagamento	Enumeradores payment_instrument_entry_status

Enumeradores payment_instrument_entry_type

Enumerador	Descrição
purchase	Compra
withdrawal	Saque
postpaid_card_issuance	Emissão de cartão pós-pago

Enumeradores payment_instrument_entry_status

Enumerador	Descrição
processing_conclusion	Entrada de instrumento de pagamento em processamento de conclusão
processing_cancellation	Entrada de instrumento de pagamento em processamento de cancelamento
concluded	Entrada de instrumento de pagamento concluída
canceled	Entrada de instrumento de pagamento foi cancelada

Observação

A entrada do instrumento de pagamento pode transicionar diretamente de processing_conclusion para processing_cancellation e canceled. Nesse caso, nenhum invoice item é criado.