Score Resource

Represent a Score resource for each transaction

🚧

Beta testing phase

This is not the final version of the product, and is still subject to change.

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

A Score resource

{
  "has_more": false,
  "data": [
    {
      "id": "frs_ABCDEFGHIJ123456780",
      "type": "fraud.score",
      "livemode": true,
      "score": 900,
      "external_id": "ORD-20210818-001",
      "external_attribute_name": "order_id",
      "organization_id": "org_123456789",
      "decision_reason": "high_risk",
      "decision": "fraud",
      "payment_method": "credit_card",
      "event_payload": {
        "billing_address_city": "Acme City",
        "amount": 55000,
        "creditcard_bin": "512345",
        "billing_address_1": "123 Main St",
        "billing_address_phone": "9123456777",
        "customer_email": "[email protected]",
        "creditcard_bank": "Unknown Bank",
        "creditcard_country": "PH",
        "creditcard_last4": "0008",
        "creditcard_brand": "mastercard",
        "billing_address_country": "PH",
        "customer_name": "John Doe",
        "billing_address_zipcode": "1000",
        "creditcard_type": "credit"
      },
      "created_at": "2025-08-18T10:30:33Z",
      "updated_at": null
    },
    {
      "id": "frs_ABCDEFGHIJ123456781",
      "type": "fraud.score",
      "livemode": true,
      "score": 100,
      "external_id": "ORD-20210818-002",
      "external_attribute_name": "order_id",
      "organization_id": "org_123456789",
      "decision_reason": "low_risk",
      "decision": "legit",
      "payment_method": "credit_card",
      "event_payload": {
        "billing_address_city": "Acme City",
        "amount": 2500,
        "creditcard_bin": "400993",
        "billing_address_1": "ABC Main St",
        "billing_address_phone": "9012345678",
        "customer_email": "[email protected]",
        "creditcard_bank": "Acme Bank",
        "creditcard_country": "PH",
        "creditcard_last4": "1421",
        "creditcard_brand": "via",
        "billing_address_country": "PH",
        "customer_name": "John Smith",
        "billing_address_zipcode": "1000",
        "creditcard_type": "credit"
      },
      "created_at": "2025-08-18T10:30:33Z",
      "updated_at": null
    }
  ]
}

AttributeTypeDescription
idstringUnique ID of the score resource
typestringResource type (fraud.score)
scoreintegerRisk score (0–1000)
external_idstringUnique reference for the transaction in your system
external_attribute_namestringName/type of the external ID (e.g., order_id, invoice_id)
organization_idstringOrganization that owns the score
decision_reasonstringReason for the assigned decision (high_risk, low_risk, etc.)
decisionstringFinal decision (fraud or legit)
payment_methodstringPayment method used for the transaction
event_payloadobjectDetailed transaction data used for fraud detection
livemodebooleanIndicates if the score is for live or test mode
created_atstringTimestamp when the score was created (ISO8601)
updated_atstringTimestamp when the score was last updated