PIX Charge Events
Events related to PIX payments (Brazilian instant payment system).
pix.charge.created
Triggered when a new PIX charge (QR Code) is generated.
Available Data
| Field | Type | Description |
|---|---|---|
txid | string | Unique Transaction ID for the PIX charge |
amount | amount | The amount to be paid (in cents) |
currency | string | Currency code (usually BRL) |
qr_code | string | The QR Code payload for payment |
expires_at | string | Expiration date and time of the charge |
pix.charge.paid
Triggered when a PIX payment is successfully received and confirmed.
Available Data
| Field | Type | Description |
|---|---|---|
txid | string | Unique Transaction ID for the PIX charge |
amount | amount | The amount paid (in cents) |
currency | string | Currency code (usually BRL) |
payer | object | Information about the payer |
receiver | object | Information about the receiver |
timestamp | string | Date and time of payment |
Example Usage
{
"hook_type": "pix.charge.paid",
"data": {
"amount": 5000,
"currency": "BRL",
"payer": { "name": "John Doe" }
}
}