Important

You are browsing upcoming documentation for version 7.1 of OroCommerce, scheduled for release in 2027. Read the documentation for the latest LTS version to get up-to-date information.

See our Release Process documentation for more information on the currently supported and upcoming releases.

Order Payment Status Webhooks

When a payment transaction for an order completes, OroOrderBundle dispatches a webhook notification to the order.payment_status_updated topic. The notification is sent automatically whenever the \Oro\Bundle\PaymentBundle\Event\TransactionCompleteEvent event (oro_payment.event.transaction_complete) is dispatched for an Order entity, provided all of the following conditions are met:

The Order entity has webhook_accessible: true configured.
At least one active WebhookProducerSettings record subscribed to the topic exists.

The payload contains the entity type and ID, the new payment status code and its human-readable label, the net amount paid, the remaining amount due, and the currency:

{
  "topic": "order.payment_status_updated",
  "timestamp": 1741267200,
  "messageId": "550e8400-e29b-41d4-a716-446655440000",
  "eventData": {
    "data": {
      "type": "orders",
      "id": 42,
      "attributes": {
        "paymentStatus": "paid",
        "paymentStatusLabel": "Paid in Full",
        "transactionAmount": 100.00,
        "transactionType": "capture",
        "amountPaid": 99.00,
        "amountDue": 0.00,
        "currency": "USD"
      }
    }
  }
}

For the description of the payload attributes, see Payment Status Webhook Notifications.

In addition to the general topic notification, a second notification is dispatched to the entity-specific derived topic order.payment_status_updated.{id} (e.g., order.payment_status_updated.42), carrying the identical payload. This allows subscribers to receive payment status updates for a single order without processing notifications for all orders.