Webhooks

Webhooks notify your application when the status of a charge, payout or subscription changes. No polling: the platform calls the URL you configured.

Set the URL on each charge (webhook_url field) or in the merchant portal. The platform sends a POST with the payload below every time the status changes.

Charge webhook

POST https://your-store.com/webhook/charge

{
  "charge_uuid": "c3d4e5f6-7a8b-9c0d-1e2f-3a4b5c6d7e8f",
  "wallet_uuid": "00000000-0000-0000-0000-000000000000",
  "description": "Order #1234",
  "status": "paid",
  "installment_count": 3,
  "reference_external_id": "ORDER-1234",
  "subscription_uuid": null
}

Payout webhook

POST https://your-store.com/webhook/payout

{
  "payout_uuid": "1c2d3e4f-5a6b-7c8d-9e0f-a1b2c3d4e5f6",
  "wallet_uuid": "00000000-0000-0000-0000-000000000000",
  "status": "realized",
  "type_payout": "pix",
  "amount": 1500.00,
  "currency": "BRL",
  "transaction_reference": "REF-0001"
}