Webhook for Incoming Pix

Webhook to notify about Pix transactions received for an Alias.

Webhook Request Body

Request Body: Pix Received

{
  "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

Field	Type	Description	Max. Characters
webhook_type	string	An enumerator that defines the type of event being reported	23
webhook_datetime	string	Date and time the webhook was sent	20
pix_transfer_type	enumerator	Type of the pix transaction performed	Enumerator pix_transfer_type
target_pix_key	string	Pix key of the account to which the transaction was sent	100
source_account	Object	Source account - Should only be sent for "manual" type transactions	Object source_account
transfer_amount	number	Transfer amount	10
receiver_conciliation_id	string	Reconciliation ID of the receiver	35
end_to_end_id	string	Idempotency key of a Pix transaction - should only be sent if the transfer type is "key"	32
pix_message	string	Message to be sent along with the Pix transfer	140
fee_amount	number	Transfer amount	10
pix_transfer_status	string	Status of the pix transaction	10
account_key	string	Unique identification key for the QI account	36
alias_key	string	Unique alias key	36
pix_transfer_key	string	Unique identification key for the Pix transfer	36

Enumerator pix_transfer_type

Enumerator	Description
manual	Pix using destination account details
key	Pix using a PIX key
static_qr_code	Pix using a static QR code
dynamic_qr_code	Pix using a dynamic QR code
reversal	Pix refund

Object source_account

Field	Type	Description	Characters
account_branch *	string	Account branch	6
account_digit *	string	Account digit	1
account_number *	string	Account number	20
owner_document_number *	string	CPF or CNPJ (numbers only) of the account holder	14
owner_name	string	Account holder's name	150
account_type *	enumerator	Account type	Enumerator account_type
ispb *	string	Eight-digit code that identifies banks in the Central Bank's reserve transfer system	8

Enumerator account_type

Enumerator	Description
checking_account	Checking Account
salary_account	Salary Account
saving_account	Savings Account
payment_account	Payment Account