Webhooks

Once transfers occur asynchronously, proper mapping and handling of sent webhooks is of utmost importance.

Attention!

QI Tech webhooks should not be mapped in a restrictive manner. Additional fields may be included in webhook payloads returned by our APIs.

Webhook for Automatic PIX recurrence creation

Webhook intended with information about customer recurrence creation

Webhook Request Body

Request Body: Recurrence creation

{
    "webhook_type": "baas.automatic_pix.incoming_recurrence",
    "webhook_datetime": "2025-10-22T20:30:23.459Z",
    "data": {
        "account_key": "13385acf-b0c3-4389-baf3-a58abbe92d58",
        "incoming_recurrence_key": "12385acf-b0c3-4389-baf3-a58abbe92d58",
        "incoming_recurrence_status": "pending_confirmation",
        "transaction_amount": "150.00",
        "periodicity": "monthly",
        "journey_type": "journey_one",
        "pix_transfer_type": "key",
        "end_to_end_id": "E1234567890123456789012",
        "start_date": "2025-06-01",
        "end_date": "2026-06-01",
        "receiver_conciliation_id": "rec-conc-789",
        "target_pix_key": "receiver@bank.com.br",
        "payer_document_number": "12345678900",
        "pix_message": "Pagamento mensal de serviço",
        "created_at": "2025-05-22T10:00:00Z",
        "updated_at": "2025-05-22T12:00:00Z"
    }
}

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 of webhook sending	20
account_key	uuid4	Unique account identification key.	36
incoming_recurrence_key	uuid4	Unique authorization identification key	36
incoming_recurrence_status	string	PIX recurrence status identifier.	incoming_recurrence_status enumerators
transaction_amount	number	Transfer amount for fixed value occurrence.	10
minimum_transaction_amount	number	Minimum transfer amount for variable value occurrence.	10
maximum_transaction_amount	number	Maximum transfer amount for variable value occurrence.	10
periodicity	enum	Type of periodicity associated with the payment	periodicity enumerators
journey_type	enum	Type of request journey	journey_type enumerators
pix_transfer_type	enum	Type of PIX to be performed	pix_transfer_type enumerators
end_to_end_id	string	Idempotency key of a PIX transaction within SPI.	32
start_date	string	Recurrence start date	-
end_date	string	Recurrence end date, for indefinite time cases, send as null	-
receiver_conciliation_id	string	Receiver conciliation identification.	35
target_pix_key	string	PIX key of the transaction account.	100
payer_document_number	string	Transaction payer's document number	14
pix_message	string	Message to be sent along with the PIX transfer.	140
created_at	string	Recurrence request creation time	-
updated_at	string	Recurrence request update time	-

incoming_recurrence_status Enumerators

Enumerator	Description
pending_confirmation	Recurrence pending confirmation
active	Active recurrence
cancelled	Cancelled recurrence
suspended	Suspended recurrence
expired	Expired recurrence

periodicity Enumerators

Enumerator	Description
weekly	Weekly recurrence
monthly	Monthly recurrence
quarterly	Quarterly recurrence
semiannual	Semiannual recurrence
annual	Annual recurrence

journey_type Enumerators

Enumerator	Description
journey_one	Authorization request through an app notification
journey_two	Authorization request through QR Code reading
journey_three	Recurrence authorization through an immediate PIX via QR Code reading
journey_four	Payment or scheduling of a PIX with a recurrence authorization request in sequence

pix_transfer_type Enumerators

Enumerator	Description
manual	PIX using destination account data
key	PIX using a PIX key
static_qr_code	PIX using a static QR code
dynamic_qr_code	PIX using a dynamic QR code