Create a Payment Evaluation 

Fraud
Payment Evaluations
Create a Payment Evaluation

Request a Radar API fraud risk score from Stripe for a payment before sending it for external processor authorization.

Parameters

  • customer_detailsobjectRequired

    Details about the customer associated with the payment evaluation.

    • customer_details.customerstring

      The ID of the customer associated with the payment evaluation.

    • customer_details.customer_accountstring

      The ID of the Account representing the customer associated with the payment evaluation.

    • customer_details.emailstring

      The customer’s email address.

      The maximum length is 800 characters.

    • customer_details.namestring

      The customer’s full name or business name.

    • customer_details.phonestring

      The customer’s phone number.

  • payment_detailsobjectRequired

    Details about the payment.

    • payment_details.amountintegerRequired

      The intended amount to collect with this payment. A positive integer representing how much to charge in the smallest currency unit (for example, 100 cents to charge 1.00 USD or 100 to charge 100 Yen, a zero-decimal currency).

    • payment_details.currencyenumRequired

      Three-letter ISO currency code, in lowercase. Must be a supported currency.

    • payment_details.payment_method_detailsobjectRequired

      Details about the payment method to use for the payment.

      • payment_details.payment_method_details.payment_methodstringRequired

        ID of the payment method used in this payment evaluation.

      • payment_details.payment_method_details.billing_detailsobject

        Billing information associated with the payment evaluation.

        • payment_details.payment_method_details.billing_details.addressobject

          Billing address.

          • payment_details.payment_method_details.billing_details.address.citystring

            City, district, suburb, town, or village.

          • payment_details.payment_method_details.billing_details.address.countrystring

            Two-letter country code (ISO 3166-1 alpha-2).

          • payment_details.payment_method_details.billing_details.address.line1string

            Address line 1, such as the street, PO Box, or company name.

          • payment_details.payment_method_details.billing_details.address.line2string

            Address line 2, such as the apartment, suite, unit, or building.

          • payment_details.payment_method_details.billing_details.address.postal_codestring

            ZIP or postal code.

          • payment_details.payment_method_details.billing_details.address.statestring

            State, county, province, or region (ISO 3166-2).

        • payment_details.payment_method_details.billing_details.emailstring

          Email address.

          The maximum length is 800 characters.

        • payment_details.payment_method_details.billing_details.namestring

          Full name.

        • payment_details.payment_method_details.billing_details.phonestring

          Billing phone number (including extension).

    • payment_details.descriptionstring

      An arbitrary string attached to the object. Often useful for displaying to users.

    • payment_details.money_movement_detailsobject

      Details about the payment’s customer presence and type.

      • payment_details.money_movement_details.money_movement_typeenumRequired

        Describes the type of money movement. Currently only card is supported.

        Possible enum values
        card

        The money movement details for a card payment.

      • payment_details.money_movement_details.cardobject

        Describes card money movement details for the payment evaluation.

        • payment_details.money_movement_details.card.customer_presenceenum

          Describes the presence of the customer during the payment.

          Possible enum values
          off_session

          Customer isn’t present because the payment was initiated automatically or by the merchant.

          on_session

          Customer is present in the checkout flow.

        • payment_details.money_movement_details.card.payment_typeenum

          Describes the type of payment.

          Possible enum values
          one_off

          Charge an on-session or off-session customer using a previously stored card.

          recurring

          Charge an on-session or off-session customer using a previously stored card.

          setup_one_off

          Charge an on-session customer and store their card for future unscheduled on-session or off-session usage.

          setup_recurring

          Charge an on-session customer and store their card for future off-session usage on recurring payments.

    • payment_details.shipping_detailsobject

      Shipping details for the payment evaluation.

      • payment_details.shipping_details.addressobject

        Shipping address.

        • payment_details.shipping_details.address.citystring

          City, district, suburb, town, or village.

        • payment_details.shipping_details.address.countrystring

          Two-letter country code (ISO 3166-1 alpha-2).

        • payment_details.shipping_details.address.line1string

          Address line 1, such as the street, PO Box, or company name.

        • payment_details.shipping_details.address.line2string

          Address line 2, such as the apartment, suite, unit, or building.

        • payment_details.shipping_details.address.postal_codestring

          ZIP or postal code.

        • payment_details.shipping_details.address.statestring

          State, county, province, or region (ISO 3166-2).

      • payment_details.shipping_details.namestring

        Shipping name.

      • payment_details.shipping_details.phonestring

        Shipping phone number.

    • payment_details.statement_descriptorstring

      Payment statement descriptor.

  • client_device_metadata_detailsobject

    Details about the Client Device Metadata to associate with the payment evaluation.

    • client_device_metadata_details.radar_sessionstringRequired

      ID for the Radar Session to associate with the payment evaluation. A Radar Session is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.

  • metadataobject

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

Returns

Returns the payment evaluation object.

POST /v1/radar/payment_evaluations
curl https://api.stripe.com/v1/radar/payment_evaluations \
-u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
-H "Stripe-Version: 2026-01-28.preview" \
-d "payment_details[payment_method_details][payment_method]"=pm_123456789 \
-d "payment_details[amount]"=100 \
-d "payment_details[currency]"=usd \
--data-urlencode "customer_details[email]"="jennyrosen@example.com" \
-d "client_device_metadata_details[radar_session]"=rse_123456789
Response
{
"id": "peval_123456789",
"created_at": 1704067200,
"insights": {
"evaluated_at": 1726181396,
"fraudulent_dispute": {
"recommended_action": "continue",
"risk_score": 50
}
},
"livemode": false,
"metadata": {},
"status": "requires_action"
}