get https://api.paymongo.com/v1/fraud/rule-attributes
Retrieves a list of all available RuleAttribute
resources that can be used to construct custom fraud rules. Each attribute describes a property or characteristic of a transaction (such as risk score, country, payment amount, IP address, or email) along with its expected data type (e.g., number, string).
This endpoint is useful for building rule editors, validating rule creation requests, and discovering all the dimensions your organization can use to tailor fraud prevention logic.
Example Response:
{
"has_more": false,
"data": [
{
"id": "fra_abcdefg123456",
"type": "fraud.rule_attribute",
"rule_attribute": "risk_score_gte",
"rule_data_type": "number",
"description": "Matches transactions when the risk score is greater than or equal to the provided value."
},
{
"id": "fra_defghijk123456",
"type": "fraud.rule_attribute",
"rule_attribute": "risk_score_lte",
"rule_data_type": "number",
"description": "Matches transactions when the risk score is less than or equal to the provided value."
},
{
"id": "fra_efghijkl123456",
"type": "fraud.rule_attribute",
"rule_attribute": "card_country_id",
"rule_data_type": "string",
"description": "Matches transactions where the card’s country code matches the provided two-letter ISO code."
},
{
"id": "fra_fghijklm123456",
"type": "fraud.rule_attribute",
"rule_attribute": "billing_country_id",
"rule_data_type": "string",
"description": "Matches transactions where the customer's billing country code matches the provided two-letter ISO code."
},
{
"id": "fra_ghijklmn123456",
"type": "fraud.rule_attribute",
"rule_attribute": "payment_amount_gte",
"rule_data_type": "number",
"description": "Matches transactions when the payment amount is greater than or equal to the provided value."
},
{
"id": "fra_hijklmno123456",
"type": "fraud.rule_attribute",
"rule_attribute": "payment_amount_lte",
"rule_data_type": "number",
"description": "Matches transactions when the payment amount is less than or equal to the provided value."
},
{
"id": "fra_ijklmnop123456",
"type": "fraud.rule_attribute",
"rule_attribute": "ip_address",
"rule_data_type": "string",
"description": "Matches transactions where the IP address matches the provided value."
},
{
"id": "fra_jklmnopq123456",
"type": "fraud.rule_attribute",
"rule_attribute": "ip_address_cidr",
"rule_data_type": "string",
"description": "Matches transactions where the IP address matches the provided CIDR value."
},
{
"id": "fra_klmnopqr123456",
"type": "fraud.rule_attribute",
"rule_attribute": "billing_email",
"rule_data_type": "string",
"description": "Matches transactions where the billing email address matches the provided value."
}
]
}
attribute | description |
---|---|
id | Unique ID of the RuleAttribute resource |
type | Resource type (fraud.rule_attribute ) |
rule_attribute | Attribute name used in rules |
rule_data_type | Data type for the attribute (number , string ) |
description | Human-readable explanation of how the attribute is matched in rules |