A webhook sent by the system when a Pix payment expires.
Flow: cashin
Event: expired
Webhook triggered when the QR Code of a PIX charge generated on the platform expires without being paid. The system delivers a POST request in the format below.
This webhook is triggered when a Pix charge goes 2 hours (a fixed system parameter) without payment confirmation. Note that the QR Code generated via the create a PIX charge endpoint is valid for 15 minutes. The 2-hour window refers to the time the system waits before marking the transaction as expired and trigger this event.
Before marking a charge as expired, the partner bank is re-queried to confirm that the payment was indeed not made, preventing a charge that has already been paid, but whose confirmation has not yet arrived, from being incorrectly expired.
Finally, expiration does not generate any credit, debit, or additional event on the transaction beyond the status change to expired, since no amount was ever received.
Payload Example
{
"event":"expired",
"transaction":{
"id":"123-456-789",
"merchant_id":"123-456-789",
"user_id":"123-456-789",
"processor_id":"123-456-789",
"merchant_transaction_id":"0000001",
"transaction_type":"pix",
"first_name":"Foo",
"last_name":"Bar",
"email":"[email protected]",
"document_number":"12345678067",
"status":"expired",
"flow_type":"cashin",
"e2e_id":null,
"created_at":"2022-02-02T21:34:07+0000",
"updated_at":"2022-02-02T23:34:08+0000",
"error":null,
"events":[
{
"id":"123-456-789",
"success":true,
"status":"success",
"event_type":"auth",
"amount":"1.00",
"ip_address":null,
"processor_code":"1",
"processor_message":"pending",
"processor_transaction_id":"123-456-789",
"batch_id":null,
"qrcode":"COPYPASTEPIXCODE",
"qrcode_image":"data:image/png;base64,123123456546789789",
"pix_key_type":null,
"pix_key_value":null,
"pix_message":null,
"created_at":"2022-02-02T21:34:07+0000",
"updated_at":"2022-02-02T21:34:10+0000"
}
],
"statement":[
]
}
}