Notification QrCodes
When a QrCode is paid, the system will send a notification to the address provided by the customer, informing the customer's status update.
The URL that will receive notifications must be informed through the Register/Change Webhook endpoint
The notification will be sent using the POST method, and expects a HTTP 200 response.
The following is the structure of the JSON sent as request body:
Request Body
{
"notification_type": "PIX:QRCODE",
"message": {
"reference_code": "PAY2MPIXQRCODE2",
"external_reference": "INVOICE01",
"value": 2,
"content": "00020101021126580014br.gov.bcb.pix0136d5091c68-5056-481b-88ad-95eb340a1a2152040000530398654040025802BR5925Pay2m SolutionsPAULO62220518PAY2MP IXQRCODE263044FC9",
"status": "paid",
"generator_name": "John Doe",
"generator_document": "67178678097",
"payer_name": "John Doe",
"payer_document": "67178678097",
"payment_date": "2021-11-10T14:52:10.000-03:00",
"end_to_end": "E18236120202206142202a1022c1tg10"
},
}
If a result other than 200 is obtained, the system will try to send for the next 10 minutes, every minute or until a successful result is obtained. If the error persists after 10 attempts, the notification will be marked as canceled in the system and our team will contact you to investigate any integration issues.
Description of Attributes
| ATTRIBUTE | DESCRIPTION | TYPE |
|---|---|---|
| notification_type (Required) | Indicates the type of message transmitted | STRINGE 25 character limit |
| message (Required) | Updated qrcode object, as presented by the List Qrcodes | OBJECT |
| message.reference_code (Required) | Unique QrCode identifier. | STRING 100 character limit |
| message.external_reference (Optional) | Partner-provided identifier | STRING 100 character limit |
| message.value (Required) | Charge amount, in reais | DECIMAL Greater than zero |
| message.content (Required) | QrCode content. (Copy and paste PIX code) | STRING 255 character limit |
| message.status (Required) | Billing status | ENUM expired awaiting_payment paid **canceled **(Cancelled) |
| message.generator_name (Optional) | Generator name | STRING 100 character limit |
| message.generator_document (Optional) | Generator Document | STRING 14 character limit |
| message.payer_name (Optional) | Payer name | STRING 100 character limit |
| message.payer_document (Optional) | Payer document | STRING 100 character limit |
| message.payment_date (Optional) | Charge payment date | STRING datetime format YYYY-mm-ddTHH:MM:ss. z |
| message.end_to_end (Optional) | Unique PIX payment identifier. | STRING 32 character limit |