Payment Webhook Events

POSThttps://your-server.com/webhooks/easyflow

Listen to payment events to keep your integration always synchronized.

Webhooks are the safest and most reliable way to stay updated in real time. Your application receives a notification whenever the status of a payment changes.

Every business that receives a commission from the payment receives its own notification.

Payment Events

payment.authorized — Payment authorized.
payment.paid — Payment paid.
payment.canceled — Payment canceled.
payment.chargeback — Payment chargeback received.
payment.refunded — Payment refunded.

Example payload

{
  "event": "payment.paid",
  "occurredAt": "2026-01-15T14:32:10.000Z",
  "payload": {
    "id": "7d6c5b4a-3f2e-4d1c-8b0a-9f8e7d6c5b4a",
    "paymentMethod": "pix",
    "status": "paid",
    "valueInCents": 4990,
    "valuePaidInCents": 4990,
    "fineValueInCents": 0,
    "interestValueInCents": 0,
    "installments": 1,
    "pix": {
      "copyAndPasteCode": "00020101021226860014br.gov.bcb.pix2564example.com/pix/v2/0000000000000000000000000000000052040000530398654044990",
      "qrCode": null,
      "expireAt": "2026-01-15T15:30:00.000Z"
    }
  }
}

Events5

payment.authorized
payment.paid
payment.canceled
payment.chargeback
payment.refunded

Easyflow sends an HTTP request with this payload to the URL registered for your webhook.

Payloadrequired

Webhook payload received by your server in the event of an event.

Content typeapplication/jsonobject

eventstring
Name of the event received.

Possible values:payment.authorizedpayment.paidpayment.canceledpayment.chargebackpayment.refunded
occurredAtstring · date-time
Date and time when the notification was sent, in UTC.
payloadobject
Payment data sent in webhook payloads.
Show child attributesHide child attributes
- idstring
- paymentMethodstring
  Payment method, such as credit-card, pix or bank-billet.
- statusstring
  Possible values:pendingin-processingauthorizedpaidpartially-paidrefusedabortedcanceledcharged-backchargeback-in-disputeunpaidaccepteddeniedreversedrefunded
- valueInCentsinteger
- valuePaidInCentsinteger
- fineValueInCentsinteger
- interestValueInCentsinteger
- installmentsinteger
- pixobjectnullable
  Show child attributesHide child attributes
  copyAndPasteCodestringnullable
  qrCodestringnullable
  expireAtstring · date-timenullable
- bankBilletobjectnullable
  Show child attributesHide child attributes
  expireAtstring · date-timenullable
  barCodestringnullable
  linkstringnullable
  linestringnullable
- creditCardobjectnullable
  Show child attributesHide child attributes
  last4Numbersstring
  flagstring
  Possible values:visamastercardamerican-expressdiners-clubdiscoverjcbunionpaymaestromirelohiperhipercard
  expiresAtYearinteger
  expiresAtMonthinteger
  holderNamestring
  nicknamestring
- refuseobjectnullable
  Reason why the payment was refused.
  Show child attributesHide child attributes
  rawDescriptionstring
  typestringnullable