Fraud Detection API

🚧

Preview

If you are interested in early access to this feature please contact [email protected]!

The Paymongo Fraud Detector (FD) API provides robust programmatic access to advanced fraud prevention features, allowing you to automate and integrate fraud management into your payment workflows. This overview summarizes the core capabilities of the Paymongo FD API.

Key Capabilities

1. Transaction Reviews

• List Reviews: Retrieve all transactions that have been flagged for manual review, including their risk scores and triggering reasons.
• Retrieve a Review: Get detailed information about a specific review, including its status, risk assessment, and associated payment.
• Approve a Review: Programmatically approve and close a review, enabling the transaction to proceed or be marked as safe.

2. Rules Engine

• List Rules: View all custom fraud rules currently active in your organization, including their actions (allow, block, review), conditions, and execution order.
• Retrieve a Rule: Access detailed attributes of a specific rule, such as its criteria, action, and status.
• Create a Rule: Define new custom rules to automatically allow, block, or flag transactions for review based on a wide range of attributes (e.g., risk score, country, amount, IP address, email).
• Update a Rule: Modify existing rules, including changing thresholds, actions, or enabling/disabling rules.
• Delete a Rule: Remove rules that are no longer needed to keep your fraud strategy up-to-date.

3. Rule Attributes Discovery

• List Rule Attributes: Retrieve all available attributes that can be used to define custom rules. This allows you to tailor rules to specific transaction characteristics such as risk score, card country, billing country, amount, IP address, and more.

How It Works

• All endpoints are secured and require authentication.
• Actions on reviews and rules are reflected instantly across your fraud monitoring and transaction processing pipeline.
• The API enables full lifecycle management of custom fraud rules and review workflows, supporting both manual and automated fraud intervention strategies.

Use Cases

• Automate Fraud Decisions: Programmatically set up and adjust rules to block, allow, or flag transactions based on live fraud patterns.
• Integrate Review Workflows: Seamlessly incorporate fraud review queues and approvals into your custom back-office tools or dashboards.
• Stay Adaptive: Regularly update or remove rules in response to changing fraud trends, new business requirements, or performance analysis.

For detailed request and response formats, error handling, and examples, refer to the API Reference.