Skip to main content

Register a webhook for a PIX key

PUT 
/webhook/:chave

Associates a webhook URL with a PIX key the PSP holds for the merchant. After registration, every received PIX addressed to this key triggers an HTTPS POST to the URL with the payment payload. The endpoint must respond 2xx within 5 seconds; otherwise the rail retries with exponential backoff for up to 24 hours.

A key supports one webhook at a time. Calling this endpoint a second time replaces the previous registration.

Request​

Responses​

Webhook registered.