Skip to main content

Webhook for Incoming PIX Payment of QR Code

Webhook to notify about PIX transactions received for an Alias linked to a QR Code payment.

Webhook Request Body

Request Body: Received QR Code payment
{
"webhook_type": "baas.pix_qr_code.payment",
"webhook_datetime": "2021-10-22T20:30:23.459Z",
"data": {
"request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
"pix_transfer_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
"qr_code_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
"qr_code_type": "dynamic_instant",
"receiver_conciliation_id": "faf1ef5b-e0a9-4430-8aa4-367b4825854c",
"amount": 10.63,
"updated_at": "2021-10-22T20:30:23.459Z"
}
}

Webhook Body Param

FieldTypeDescriptionCharacters
request_control_key *stringUnique UUID4 identifier of the request that originated the QR Code.-
pix_transfer_key *stringPIX key representing the destination account of the transaction.-
qr_code_key *stringUUID4 key identifying the QR Code.-
qr_code_type *stringType of the QR Code."static", "dynamic_term", or "dynamic_instant"
receiver_conciliation_id *stringQR Code identifier for reconciliation after payment.-
amount *stringPayment amount.-
updated_at *datetimeDate and time the QR Code payment was made.-