Webhooks

Webhooks are how Paag communicates with your platform. They are triggered for each event related to a transaction and can be enabled or disabled on the platform. Each event can point to a different endpoint in your application. Requests are sent as POST with a JSON payload.

Charge (cash in)

Events related to the receipt of deposits. The auth event initiates the deposit payment process, capture indicates completion, and void occurs when the deposit needs to be returned.

Event	Description
`auth`	Start of the deposit payment process.
`capture`	Payment completed. The deposit has been received in the account.
`void`	The deposit was returned for some reason and reversed from the account.
`expired`	The QR Code of a PIX charge has expired.

Payments (cash out)

Events related to the withdrawal process. The payment event initiates the withdrawal, transfer indicates completion (funds sent), and refund occurs when the amount is returned by the bank back to the account.

Event	Description
`payment`	Start of the withdrawal process; payment is being processed.
`transfer`	Withdrawal completed; the amount has been sent from the account.
`refund`	The withdrawal amount was returned by the bank and credited back to the account.

For developers

Check out our Webhooks section in the API Reference.