Webhook para Pix de Entrada

Webhook que servirá para avisar sobre transações Pix que chegaram para um Alias.

Webhook Request Body

Request Body: Pix Recebido

{
  "webhook_type": "baas.pix_transfer.incoming_pix",
  "webhook_datetime": "2021-10-22T20:30:23.459Z",
  "data": {
    "pix_transfer_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
    "end_to_end_id": "E18236120202308111235s14fddf2801",
    "pix_transfer_status": "received",
    "account_key": "7c5a1425-73eb-420e-b4fb-0ce3386c7d0c",
    "alias_key": "fc6862c4-2b20-4057-8063-b8809866e494",
    "receiver_conciliation_id": "745c28c780bc4822bbade86dd875d10b",
    "transfer_amount": 126.97,
    "fee_amount": 0.0,
    "source_account": {
      "account_branch": "0001",
      "account_digit": "3",
      "account_number": "12345678",
      "owner_document_number": "***02502000***",
      "owner_person_type": "legal",
      "owner_name": "Qi Tech",
      "account_type": "checking_account",
      "ispb": "32402502"
    },
    "pix_transfer_type": "dynamic_qr_code",
    "pix_message": "pix message received",
    "created_at": "2021-10-22T20:30:23.459Z",
    "reversals": []
  }
}

Webhook Body Param

Campo	Tipo	Descrição	Max. Caracteres
webhook_type	string	Um enumerador que define o tipo de evento sendo reportado	23
webhook_datetime	string	Data e hora do envio do webhook	20
pix_transfer_type	enumerador	Tipo do pix realizado	Enumerador pix_transfer_type
target_pix_key	string	Chave pix da conta a ser enviada a transação	100
source_account	Object	Conta destino - Só deve ser enviada em transações do tipo "manual"	Objeto source_account
transfer_amount	number	Valor da transferencia	10
receiver_conciliation_id	string	Identicação de conciliação do recebedor	35
end_to_end_id	string	Chave de idempotência de uma transação Pix - só deve ser enviado se o tipo de transferência for "key"	32
pix_message	string	Mensagem a ser enviada junto à transferência Pix	140
fee_amount	number	Valor da transferencia	10
pix_transfer_status	string	Status da transação pix	10
account_key	string	Chave única de identificação da conta QI	36
alias_key	string	Chave única do Alias	36
pix_transfer_key	string	Chave única de identificação da transferência Pix	36

Enumerador pix_transfer_type

Enumerador	Descrição
manual	Pix utilizando os dados da conta destino
key	Pix utilizando uma chave pix
static_qr_code	Pix utilizando um QR code estático
dynamic_qr_code	Pix utilizando um QR code dinâmico
reversal	Devolução Pix

Objeto source_account

Campo	Tipo	Descrição	Caracteres
account_branch *	string	Agência da conta	6
account_digit *	string	Dígito da conta	1
account_number *	string	Número da conta	20
owner_document_number *	string	CPF ou CNPJ (apenas números) do titular da conta	14
owner_name	string	Nome do titular da conta	150
account_type*	enumerador	Tipo da conta	Enumerador account_type
ispb *	string	Código de oito dígitos que identifica os bancos no sistema de transferência de reserva do Banco Central	8

Enumerador account_type

Enumerador	Descrição
checking_account	Conta Corrente
salary_account	Conta Salário
saving_account	Conta Poupança
payment_account	Conta de Pagamentos