Stripe: Radar schemas
30 Stripe schemas with complete fields and constraints.
← Radar operations · All schemas
Create a Payment Evaluation — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Payment Evaluations represent the risk lifecycle of an externally processed payment. It includes the Radar risk score from Stripe, payment outcome taken by the merchant or processor, and any post transaction events, such as refunds or disputes. See the [Radar API guide](/radar/multiprocessor) for integration steps. |
client_device_metadata_details | Model | Optional | Expand Create a Payment Evaluation — response body — client device metadata details |
created_at | JSON | Required within parent | |
created_at (anyOf 1) | integer | Alternative | Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time |
created_at (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
customer_details | Model | Optional | Expand Create a Payment Evaluation — response body — customer details |
events | array | Required within parent | Event information associated with the payment evaluation, such as refunds, dispute, early fraud warnings, or user interventions. |
events[] | Model | Each item | Expand Create a Payment Evaluation — response body — events item |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
livemode | boolean | Required within parent | If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. |
metadata | JSON | Optional | |
metadata (anyOf 1) | object | Alternative | Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Additional keys: see wildcard field |
metadata (anyOf 1).* | string | Additional keys | Maximum length: 500 |
metadata (anyOf 2) | null | Alternative | |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: radar.payment_evaluation |
outcome | JSON | Optional | |
outcome (anyOf 1) | JSON | Alternative | Indicates the final outcome for the payment evaluation. |
outcome (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a Payment Evaluation — response body — outcome / value / type: failed, merchant blocked, rejected, rerouted, succeeded |
outcome (anyOf 2) | null | Alternative | |
payment_details | Model | Optional | Expand Create a Payment Evaluation — response body — payment details |
recommended_action | string | Required within parent | Recommended action based on the score of the `fraudulent_payment` signal. Possible values are `block`, `continue` and `request_three_d_secure`. Known values: block, continue |
signals | Model | Required within parent | Expand Create a Payment Evaluation — response body — signals |
Referenced models: Create a Payment Evaluation — response body — client device metadata details, Create a Payment Evaluation — response body — customer details, Create a Payment Evaluation — response body — events item, Create a Payment Evaluation — response body — outcome / value / type: failed, merchant blocked, rejected, rerouted, succeeded, Create a Payment Evaluation — response body — payment details, Create a Payment Evaluation — response body — signals
Create a Payment Evaluation — response body — client device metadata details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Client device metadata attached to this payment evaluation. |
radar_session | string | Required within parent | ID for the Radar Session associated with the payment evaluation. A [Radar Session](https://docs.stripe.com/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. Maximum length: 5000 |
Create a Payment Evaluation — response body — customer details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Customer details attached to this payment evaluation. |
customer | JSON | Optional | |
customer (anyOf 1) | string | Alternative | The ID of the customer associated with the payment evaluation. Maximum length: 5000 |
customer (anyOf 2) | null | Alternative | |
customer_account | JSON | Optional | |
customer_account (anyOf 1) | string | Alternative | The ID of the Account representing the customer associated with the payment evaluation. Maximum length: 5000 |
customer_account (anyOf 2) | null | Alternative | |
email | JSON | Optional | |
email (anyOf 1) | string | Alternative | The customer's email address. Maximum length: 5000 |
email (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The customer's full name or business name. Maximum length: 5000 |
name (anyOf 2) | null | Alternative | |
phone | JSON | Optional | |
phone (anyOf 1) | string | Alternative | The customer's phone number. Maximum length: 5000 |
phone (anyOf 2) | null | Alternative |
Create a Payment Evaluation — response body — events item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Event reported for this payment evaluation. |
dispute_opened | Model | Optional | Expand Create a Payment Evaluation — response body — events item dispute opened |
early_fraud_warning_received | Model | Optional | Expand Create a Payment Evaluation — response body — events item early fraud warning received |
occurred_at | JSON | Required within parent | |
occurred_at (anyOf 1) | integer | Alternative | Timestamp when the event occurred. Format: unix-time |
occurred_at (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
refunded | Model | Optional | Expand Create a Payment Evaluation — response body — events item refunded |
type | string | Required within parent | Indicates the type of event attached to the payment evaluation. Known values: dispute_opened, early_fraud_warning_received, refunded, user_intervention_raised, user_intervention_resolved |
user_intervention_raised | Model | Optional | Expand Create a Payment Evaluation — response body — events item user intervention raised |
user_intervention_resolved | Model | Optional | Expand Create a Payment Evaluation — response body — events item user intervention resolved |
Referenced models: Create a Payment Evaluation — response body — events item dispute opened, Create a Payment Evaluation — response body — events item early fraud warning received, Create a Payment Evaluation — response body — events item refunded, Create a Payment Evaluation — response body — events item user intervention raised, Create a Payment Evaluation — response body — events item user intervention resolved
Create a Payment Evaluation — response body — events item dispute opened
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Dispute opened event details attached to this payment evaluation. |
amount | JSON | Required within parent | |
amount (anyOf 1) | integer | Alternative | Amount to dispute for this payment. A positive integer representing how much to charge in [the smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (for example, 100 cents to charge 1.00 USD or 100 to charge 100 Yen, a zero-decimal currency). |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency | string | Required within parent | Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Format: currency |
reason | string | Required within parent | Reason given by cardholder for dispute. Known values: account_not_available, credit_not_processed, customer_initiated, duplicate, fraudulent, general, noncompliant, product_not_received, product_unacceptable, subscription_canceled, unrecognized |
Create a Payment Evaluation — response body — events item early fraud warning received
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Early Fraud Warning Received event details attached to this payment evaluation. |
fraud_type | string | Required within parent | The type of fraud labeled by the issuer. Known values: made_with_lost_card, made_with_stolen_card, other, unauthorized_use_of_card |
Create a Payment Evaluation — response body — events item refunded
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Refunded Event details attached to this payment evaluation. |
amount | JSON | Required within parent | |
amount (anyOf 1) | integer | Alternative | Amount refunded for this payment. A positive integer representing how much to charge in [the smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (for example, 100 cents to charge 1.00 USD or 100 to charge 100 Yen, a zero-decimal currency). |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency | string | Required within parent | Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Format: currency |
reason | string | Required within parent | Indicates the reason for the refund. Known values: duplicate, fraudulent, other, requested_by_customer |
Create a Payment Evaluation — response body — events item user intervention raised
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | User intervention raised event details attached to this payment evaluation |
custom | Model | Optional | Expand Create a Payment Evaluation — response body — events item user intervention raised custom |
key | string | Required within parent | Unique identifier for the user intervention event. Maximum length: 5000 |
type | string | Required within parent | Type of user intervention raised. Known values: 3ds, captcha, custom |
Referenced models: Create a Payment Evaluation — response body — events item user intervention raised custom
Create a Payment Evaluation — response body — events item user intervention raised custom
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | User intervention raised custom event details attached to this payment evaluation |
type | string | Required within parent | Custom type of user intervention raised. The string must use a snake case description for the type of intervention performed. Maximum length: 5000 |
Create a Payment Evaluation — response body — events item user intervention resolved
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | User Intervention Resolved Event details attached to this payment evaluation |
key | string | Required within parent | Unique ID of this intervention. Use this to provide the result. Maximum length: 5000 |
outcome | JSON | Optional | |
outcome (anyOf 1) | string | Alternative | Result of the intervention if it has been completed. Known values: abandoned, failed, passed |
outcome (anyOf 2) | null | Alternative |
Create a Payment Evaluation — response body — outcome / value / type: failed, merchant blocked, rejected, rerouted, succeeded
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Outcome details for this payment evaluation. |
merchant_blocked | Model | Optional | Expand Create a Payment Evaluation — response body — outcome / value / type: failed, merchant blocked, rejected, rerouted, succeeded merchant blocked |
payment_intent_id | string | Optional | The PaymentIntent ID associated with the payment evaluation. Maximum length: 5000 |
rejected | Model | Optional | Expand Create a Payment Evaluation — response body — outcome / value / type: failed, merchant blocked, rejected, rerouted, succeeded rejected |
succeeded | Model | Optional | Expand Create a Payment Evaluation — response body — outcome / value / type: failed, merchant blocked, rejected, rerouted, succeeded succeeded |
type | string | Required within parent | Indicates the outcome of the payment evaluation. Known values: failed, merchant_blocked, rejected, rerouted, succeeded |
Referenced models: Create a Payment Evaluation — response body — outcome / value / type: failed, merchant blocked, rejected, rerouted, succeeded merchant blocked, Create a Payment Evaluation — response body — outcome / value / type: failed, merchant blocked, rejected, rerouted, succeeded rejected, Create a Payment Evaluation — response body — outcome / value / type: failed, merchant blocked, rejected, rerouted, succeeded succeeded
Create a Payment Evaluation — response body — outcome / value / type: failed, merchant blocked, rejected, rerouted, succeeded merchant blocked
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of a merchant_blocked outcome attached to this payment evaluation. |
reason | string | Required within parent | The reason the payment was blocked by the merchant. Known values: authentication_required, blocked_for_fraud, invalid_payment, other |
Create a Payment Evaluation — response body — outcome / value / type: failed, merchant blocked, rejected, rerouted, succeeded rejected
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of an rejected outcome attached to this payment evaluation. |
card | Model | Optional | Expand Create a Payment Evaluation — response body — outcome / value / type: failed, merchant blocked, rejected, rerouted, succeeded rejected card |
Referenced models: Create a Payment Evaluation — response body — outcome / value / type: failed, merchant blocked, rejected, rerouted, succeeded rejected card
Create a Payment Evaluation — response body — outcome / value / type: failed, merchant blocked, rejected, rerouted, succeeded rejected card
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of an rejected card outcome attached to this payment evaluation. |
address_line1_check | string | Required within parent | Result of the address line 1 check. Known values: fail, pass, unavailable, unchecked |
address_postal_code_check | string | Required within parent | Indicates whether the cardholder provided a postal code and if it matched the cardholder’s billing address. Known values: fail, pass, unavailable, unchecked |
cvc_check | string | Required within parent | Result of the CVC check. Known values: fail, pass, unavailable, unchecked |
reason | string | Required within parent | Card issuer's reason for the network decline. Known values: authentication_failed, do_not_honor, expired, incorrect_cvc, incorrect_number, incorrect_postal_code, insufficient_funds, invalid_account, lost_card, other, processing_error, reported_stolen, try_again_later |
Create a Payment Evaluation — response body — outcome / value / type: failed, merchant blocked, rejected, rerouted, succeeded succeeded
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of a succeeded outcome attached to this payment evaluation. |
card | Model | Optional | Expand Create a Payment Evaluation — response body — outcome / value / type: failed, merchant blocked, rejected, rerouted, succeeded succeeded card |
Referenced models: Create a Payment Evaluation — response body — outcome / value / type: failed, merchant blocked, rejected, rerouted, succeeded succeeded card
Create a Payment Evaluation — response body — outcome / value / type: failed, merchant blocked, rejected, rerouted, succeeded succeeded card
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of an succeeded card outcome attached to this payment evaluation. |
address_line1_check | string | Required within parent | Result of the address line 1 check. Known values: fail, pass, unavailable, unchecked |
address_postal_code_check | string | Required within parent | Indicates whether the cardholder provided a postal code and if it matched the cardholder’s billing address. Known values: fail, pass, unavailable, unchecked |
cvc_check | string | Required within parent | Result of the CVC check. Known values: fail, pass, unavailable, unchecked |
Create a Payment Evaluation — response body — payment details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Payment details attached to this payment evaluation. |
amount | JSON | Required within parent | |
amount (anyOf 1) | integer | Alternative | Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency | string | Required within parent | Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Format: currency |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | An arbitrary string attached to the object. Often useful for displaying to users. Maximum length: 5000 |
description (anyOf 2) | null | Alternative | |
money_movement_details | JSON | Optional | |
money_movement_details (anyOf 1) | JSON | Alternative | Details about the payment's customer presence and type. |
money_movement_details (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a Payment Evaluation — response body — payment_details / money_movement_details / value / money_movement_type: card |
money_movement_details (anyOf 2) | null | Alternative | |
payment_method_details | JSON | Optional | |
payment_method_details (anyOf 1) | JSON | Alternative | Details about the payment method used for the payment. |
payment_method_details (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a Payment Evaluation — response body — payment details payment method details value billing details, payment method |
payment_method_details (anyOf 2) | null | Alternative | |
shipping_details | JSON | Optional | |
shipping_details (anyOf 1) | JSON | Alternative | Shipping details for the payment evaluation. |
shipping_details (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a Payment Evaluation — response body — payment details shipping details Shipping details for the payment evaluation Shipping details attached to this payment |
shipping_details (anyOf 2) | null | Alternative | |
statement_descriptor | JSON | Optional | |
statement_descriptor (anyOf 1) | string | Alternative | Payment statement descriptor. Maximum length: 5000 |
statement_descriptor (anyOf 2) | null | Alternative |
Referenced models: Create a Payment Evaluation — response body — payment_details / money_movement_details / value / money_movement_type: card, Create a Payment Evaluation — response body — payment details payment method details value billing details, payment method, Create a Payment Evaluation — response body — payment details shipping details Shipping details for the payment evaluation Shipping details attached to this payment
Create a Payment Evaluation — response body — payment details payment method details value billing details, payment method
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Payment method details attached to this payment evaluation. |
billing_details | JSON | Optional | |
billing_details (anyOf 1) | JSON | Alternative | Billing information associated with the payment evaluation. |
billing_details (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a Payment Evaluation — response body — payment details payment method details value billing details, payment method billing details value Billing details attached to the payment method |
billing_details (anyOf 2) | null | Alternative | |
payment_method | JSON | Required within parent | The payment method used in this payment evaluation. |
payment_method (anyOf 1) | string | Alternative | Maximum length: 5000 |
payment_method (anyOf 2) | Model | Alternative | Expand Create a Payment Method — response body |
Referenced models: Create a Payment Evaluation — response body — payment details payment method details value billing details, payment method billing details value Billing details attached to the payment method, Create a Payment Method — response body
Create a Payment Evaluation — response body — payment details payment method details value billing details, payment method billing details value Billing details attached to the payment method
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Billing details attached to the payment method. |
address | Model | Required within parent | Expand Create a Payment Evaluation — response body — payment details shipping details Shipping details for the payment evaluation Shipping details attached to this payment address |
email | JSON | Optional | |
email (anyOf 1) | string | Alternative | Email address. Maximum length: 5000 |
email (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | Full name. Maximum length: 5000 |
name (anyOf 2) | null | Alternative | |
phone | JSON | Optional | |
phone (anyOf 1) | string | Alternative | Billing phone number (including extension). Maximum length: 5000 |
phone (anyOf 2) | null | Alternative |
Create a Payment Evaluation — response body — payment details shipping details Shipping details for the payment evaluation Shipping details attached to this payment
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Shipping details attached to this payment. |
address | Model | Required within parent | Expand Create a Payment Evaluation — response body — payment details shipping details Shipping details for the payment evaluation Shipping details attached to this payment address |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | Shipping name. Maximum length: 5000 |
name (anyOf 2) | null | Alternative | |
phone | JSON | Optional | |
phone (anyOf 1) | string | Alternative | Shipping phone number. Maximum length: 5000 |
phone (anyOf 2) | null | Alternative |
Create a Payment Evaluation — response body — payment details shipping details Shipping details for the payment evaluation Shipping details attached to this payment address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Address data. |
city | JSON | Optional | |
city (anyOf 1) | string | Alternative | City, district, suburb, town, or village. Maximum length: 5000 |
city (anyOf 2) | null | Alternative | |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). Maximum length: 5000 |
country (anyOf 2) | null | Alternative | |
line1 | JSON | Optional | |
line1 (anyOf 1) | string | Alternative | Address line 1, such as the street, PO Box, or company name. Maximum length: 5000 |
line1 (anyOf 2) | null | Alternative | |
line2 | JSON | Optional | |
line2 (anyOf 1) | string | Alternative | Address line 2, such as the apartment, suite, unit, or building. Maximum length: 5000 |
line2 (anyOf 2) | null | Alternative | |
postal_code | JSON | Optional | |
postal_code (anyOf 1) | string | Alternative | ZIP or postal code. Maximum length: 5000 |
postal_code (anyOf 2) | null | Alternative | |
state | JSON | Optional | |
state (anyOf 1) | string | Alternative | State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). Maximum length: 5000 |
state (anyOf 2) | null | Alternative |
Create a Payment Evaluation — response body — payment_details / money_movement_details / value / money_movement_type: card
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Money Movement details attached to this payment. |
card | JSON | Optional | |
card (anyOf 1) | JSON | Alternative | Describes card money movement details. |
card (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a Payment Evaluation — response body — payment_details / money_movement_details / value / money_movement_type: card card Describes card money movement details customer presence, payment type |
card (anyOf 2) | null | Alternative | |
money_movement_type | string | Required within parent | Describes the type of money movement. Known values: card |
Create a Payment Evaluation — response body — payment_details / money_movement_details / value / money_movement_type: card card Describes card money movement details customer presence, payment type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Money Movement card details attached to this payment. |
customer_presence | JSON | Optional | |
customer_presence (anyOf 1) | string | Alternative | Describes the presence of the customer during the payment. Known values: off_session, on_session |
customer_presence (anyOf 2) | null | Alternative | |
payment_type | JSON | Optional | |
payment_type (anyOf 1) | string | Alternative | Describes the type of payment. Known values: one_off, recurring, setup_one_off, setup_recurring |
payment_type (anyOf 2) | null | Alternative |
Create a Payment Evaluation — response body — signals
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Collection of signals for this payment evaluation. |
early_fraud_warning | JSON | Optional | |
early_fraud_warning (anyOf 1) | JSON | Alternative | The likelihood that this `PaymentEvaluation` results in an early fraud warning. |
early_fraud_warning (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a Payment Evaluation — response body — signals fraudulent payment |
early_fraud_warning (anyOf 2) | null | Alternative | |
fraudulent_dispute | JSON | Optional | |
fraudulent_dispute (anyOf 1) | JSON | Alternative | The likelihood that this `PaymentEvaluation` results in a dispute with reason code `fraudulent`. |
fraudulent_dispute (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a Payment Evaluation — response body — signals fraudulent payment |
fraudulent_dispute (anyOf 2) | null | Alternative | |
fraudulent_payment | Model | Required within parent | Expand Create a Payment Evaluation — response body — signals fraudulent payment |
Referenced models: Create a Payment Evaluation — response body — signals fraudulent payment
Create a Payment Evaluation — response body — signals fraudulent payment
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A payment evaluation signal with evaluated_at, risk_level, and score fields. |
evaluated_at | JSON | Required within parent | |
evaluated_at (anyOf 1) | integer | Alternative | The time when this signal was evaluated. Format: unix-time |
evaluated_at (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
risk_level | string | Required within parent | Risk level of this signal, based on the score. Known values: elevated, highest, low, normal, not_assessed, unknown |
score | JSON | Optional | |
score (anyOf 1) | JSON | Alternative | |
score (anyOf 1) (anyOf 1) | number | Alternative | Numeric score for this signal, returned with two decimal places. Possible values for evaluated payments are between 0 and 100, where higher scores indicate a higher likelihood of the signal being true. |
score (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
score (anyOf 2) | null | Alternative |
Create a value list item — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Value list items allow you to add specific values to a given Radar value list, which can then be used in rules. Related guide: [Managing list items](https://docs.stripe.com/radar/lists#managing-list-items) |
created | JSON | Required within parent | |
created (anyOf 1) | integer | Alternative | Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time |
created (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
created_by | string | Required within parent | The name or email address of the user who added this item to the value list. Maximum length: 5000 |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
livemode | boolean | Required within parent | If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: radar.value_list_item |
value | string | Required within parent | The value of the item. Maximum length: 5000 |
value_list | string | Required within parent | The identifier of the value list this item belongs to. Maximum length: 5000 |
Create a value list — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Value lists allow you to group values together which can then be referenced in rules. Related guide: [Default Stripe lists](https://docs.stripe.com/radar/lists#managing-list-items) |
alias | string | Required within parent | The name of the value list for use in rules. Maximum length: 5000 |
created | JSON | Required within parent | |
created (anyOf 1) | integer | Alternative | Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time |
created (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
created_by | string | Required within parent | The name or email address of the user who created this value list. Maximum length: 5000 |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
item_type | string | Required within parent | The type of items in the value list. One of `card_fingerprint`, `card_bin`, `crypto_fingerprint`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, `customer_id`, `account`, `sepa_debit_fingerprint`, or `us_bank_account_fingerprint`. Known values: account, card_bin, card_fingerprint, case_sensitive_string, country, crypto_fingerprint, customer_id, email, ip_address, sepa_debit_fingerprint, string, us_bank_account_fingerprint |
list_items | object | Required within parent | List of items contained within this value list. |
list_items.data | array | Required within parent | Details about each object. |
list_items.data[] | Model | Each item | Expand Create a value list item — response body |
list_items.has_more | boolean | Required within parent | True if this list has another page of items after this one that can be fetched. |
list_items.object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Always has the value `list`. Known values: list |
list_items.url | string | Required within parent | The URL where this list can be accessed. Maximum length: 5000 |
livemode | boolean | Required within parent | If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. |
metadata | object | Required within parent | Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Additional keys: see wildcard field |
metadata.* | string | Additional keys | Maximum length: 500 |
name | string | Required within parent | The name of the value list. Maximum length: 5000 |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: radar.value_list |
Referenced models: Create a value list item — response body
Delete a value list item — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
deleted | boolean | Required within parent | Always true for a deleted object Known values: True |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: radar.value_list_item |
Delete a value list — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
deleted | boolean | Required within parent | Always true for a deleted object Known values: True |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: radar.value_list |
Retrieve an early fraud warning — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An early fraud warning indicates that the card issuer has notified us that a charge may be fraudulent. Related guide: [Early fraud warnings](https://docs.stripe.com/disputes/measuring#early-fraud-warnings) |
actionable | boolean | Required within parent | An EFW is actionable if it has not received a dispute and has not been fully refunded. You may wish to proactively refund a charge that receives an EFW, in order to avoid receiving a dispute later. |
charge | JSON | Required within parent | ID of the charge this early fraud warning is for, optionally expanded. |
charge (anyOf 1) | string | Alternative | Maximum length: 5000 |
charge (anyOf 2) | Model | Alternative | Expand Create a charge — response body |
created | JSON | Required within parent | |
created (anyOf 1) | integer | Alternative | Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time |
created (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
fraud_type | string | Required within parent | The type of fraud labelled by the issuer. One of `card_never_received`, `fraudulent_card_application`, `made_with_counterfeit_card`, `made_with_lost_card`, `made_with_stolen_card`, `misc`, `unauthorized_use_of_card`. Maximum length: 5000 |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
livemode | boolean | Required within parent | If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: radar.early_fraud_warning |
payment_intent | JSON | Optional | ID of the Payment Intent this early fraud warning is for, optionally expanded. |
payment_intent (anyOf 1) | string | Alternative | Maximum length: 5000 |
payment_intent (anyOf 2) | Model | Alternative | Expand Cancel a Payment Intent — response body |
Referenced models: Create a charge — response body, Cancel a Payment Intent — response body