magenxcommerce / module-signifyd
Submitting Case Entry to Signifyd on Order Creation
Installs: 3
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Type:magento2-module
Requires
- php: ~7.3.0||~7.4.0
- magenxcommerce/framework: 102.0.*
- magenxcommerce/module-backend: 101.0.*
- magenxcommerce/module-checkout: 100.3.*
- magenxcommerce/module-config: 101.1.*
- magenxcommerce/module-customer: 102.0.*
- magenxcommerce/module-directory: 100.3.*
- magenxcommerce/module-payment: 100.3.*
- magenxcommerce/module-sales: 102.0.*
- magenxcommerce/module-store: 101.0.*
Suggests
- magenxcommerce/module-config: 101.1.*
Replaces
- magento/module-signifyd: *
- dev-placeholder
- dev-default
- dev-2.4.3-release
- 100.3.6.x-dev
- 100.3.6
- 100.3.5.x-dev
- 100.3.5
- 100.3.4.x-dev
- 100.3.4-p2
- 100.3.4
- 100.3.3.x-dev
- 100.3.3
- 100.3.2.x-dev
- 100.3.2
- 100.3.1.x-dev
- 100.3.1
- 100.3.0.x-dev
- 100.3.0
- 100.2.7.x-dev
- 100.2.7
- 100.2.6.x-dev
- 100.2.6
- 100.2.5.x-dev
- 100.2.5
- 2.3.7.x-dev
- 2.3.6.x-dev
- 2.3.5.x-dev
- 2.3.4.x-dev
- 2.3.3.x-dev
- 2.3.2.x-dev
- 2.3.1.x-dev
- 2.3.0.x-dev
- dev-100.3.4-p2
- dev-2.3.6-p1
- dev-2.3.7-p1
- dev-2.3.7-p2
This package is auto-updated.
Last update: 2024-10-21 11:17:10 UTC
README
Overview
The Magento_Signifyd module provides integration with the Signifyd fraud protection system. The integration is based on the Signifyd API; see the Signifyd API docs for technical details.
The module implementation allows to:
- create a Signifyd case for a placed order
- automatically receive a Signifyd guarantee for a created case
- automatically cancel a guarantee when the order is canceled
Extensibility
The Magento_Signifyd module does not add own Events, Layouts, and UI Components as extension points.
Public API
The following interfaces (marked with the @api annotation) provide methods that allow to:
Magento\Signifyd\Api\Data\CaseInterface (common abstraction for the Signifyd case entity):
- set or retrieve all case data fields
Magento\Signifyd\Api\CaseManagementInterface:
- create a new case entity
- retrieve the existing case entity for a specified order
Magento\Signifyd\Api\CaseCreationServiceInterface:
- create a case entity for a specified order
- send a request through the Signifyd API to create a new case
Magento\Signifyd\Api\CaseRepositoryInterface:
- describe methods to work with a case entity
Magento\Signifyd\Api\GuaranteeCreationServiceInterface:
- send a request through the Signifyd API to create a new case guarantee
Magento\Signifyd\Api\GuaranteeCancelingServiceInterface:
- send a request through the Signifyd API to cancel the Signifyd case guarantee
Magento\Signifyd\Api\Data\CaseSearchResultsInterface:
- might be used by
Magento\Signifyd\Api\CaseRepositoryInterfaceto retrieve a list of case entities by specific conditions
For information about a public API in Magento 2, see Public interfaces & APIs.
Additional information
Webhooks
To update the entity data for a case or guarantee, the Magento_Signifyd module uses the Signifyd Webhooks mechanism.
The newly created case entities have the PENDING status for a case and a guarantee. After receiving Webhook, both statuses are changed to appropriate Signifyd statuses.
Debug mode
The Debug Mode may be enabled in the module configuration. This logs the communication data between the Magento_Signifyd module and the Signifyd service in this file:
var/log/debug.log
Backward incompatible changes
The Magento_Signifyd module does not introduce backward incompatible changes.
You can track backward incompatible changes in patch releases.
Processing supplementary payment information
To improve the accuracy of Signifyd's transaction estimation, you may perform these operations (links lead to the Magento Developer Documentation Portal):