interface SupportsNotificationsInterface in Commerce Core 8.2
Defines the interface for gateways which support notifications.
Payment providers can use the notification URL (commerce_payment.notify) to inform the site that a new pending/complete payment should be created (if the payment happened off-site), or to provide information about an existing payment (refunds, disputes, etc).
Hierarchy
- interface \Drupal\commerce_payment\Plugin\Commerce\PaymentGateway\SupportsNotificationsInterface
Expanded class hierarchy of SupportsNotificationsInterface
All classes that implement SupportsNotificationsInterface
1 file declares its use of SupportsNotificationsInterface
- PaymentNotificationController.php in modules/
payment/ src/ Controller/ PaymentNotificationController.php
File
- modules/
payment/ src/ Plugin/ Commerce/ PaymentGateway/ SupportsNotificationsInterface.php, line 15
Namespace
Drupal\commerce_payment\Plugin\Commerce\PaymentGatewayView source
interface SupportsNotificationsInterface {
/**
* Processes the notification request.
*
* This method should only be concerned with creating/completing payments,
* the parent order does not need to be touched. The order state is updated
* automatically when the order is paid in full, or manually by the
* merchant (via the admin UI).
*
* Note:
* This method can't throw exceptions on failure because some payment
* providers expect an error response to be returned in that case.
* Therefore, the method can log the error itself and then choose which
* response to return.
*
* @param \Symfony\Component\HttpFoundation\Request $request
* The request.
*
* @return \Symfony\Component\HttpFoundation\Response|null
* The response, or NULL to return an empty HTTP 200 response.
*/
public function onNotify(Request $request);
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
SupportsNotificationsInterface:: |
public | function | Processes the notification request. | 1 |