Skip to content

Stripe: Radar schemas

30 Stripe schemas with complete fields and constraints.

← Radar operations · All schemas

Create a Payment Evaluation — response body

FieldTypePresenceDescription and constraints
$objectRootPayment 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_detailsModelOptionalExpand Create a Payment Evaluation — response body — client device metadata details
created_atJSONRequired within parent
created_at (anyOf 1)integerAlternativeTime at which the object was created. Measured in seconds since the Unix epoch.
Format: unix-time
created_at (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
customer_detailsModelOptionalExpand Create a Payment Evaluation — response body — customer details
eventsarrayRequired within parentEvent information associated with the payment evaluation, such as refunds, dispute, early fraud warnings, or user interventions.
events[]ModelEach itemExpand Create a Payment Evaluation — response body — events item
idstringRequired within parentUnique identifier for the object.
Maximum length: 5000
livemodebooleanRequired within parentIf the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
metadataJSONOptional
metadata (anyOf 1)objectAlternativeSet 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).*stringAdditional keysMaximum length: 500
metadata (anyOf 2)nullAlternative
objectstringRequired within parentString representing the object's type. Objects of the same type share the same value.
Known values: radar.payment_evaluation
outcomeJSONOptional
outcome (anyOf 1)JSONAlternativeIndicates the final outcome for the payment evaluation.
outcome (anyOf 1) (anyOf 1)ModelAlternativeExpand Create a Payment Evaluation — response body — outcome / value / type: failed, merchant blocked, rejected, rerouted, succeeded
outcome (anyOf 2)nullAlternative
payment_detailsModelOptionalExpand Create a Payment Evaluation — response body — payment details
recommended_actionstringRequired within parentRecommended action based on the score of the `fraudulent_payment` signal. Possible values are `block`, `continue` and `request_three_d_secure`.
Known values: block, continue
signalsModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootClient device metadata attached to this payment evaluation.
radar_sessionstringRequired within parentID 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

FieldTypePresenceDescription and constraints
$objectRootCustomer details attached to this payment evaluation.
customerJSONOptional
customer (anyOf 1)stringAlternativeThe ID of the customer associated with the payment evaluation.
Maximum length: 5000
customer (anyOf 2)nullAlternative
customer_accountJSONOptional
customer_account (anyOf 1)stringAlternativeThe ID of the Account representing the customer associated with the payment evaluation.
Maximum length: 5000
customer_account (anyOf 2)nullAlternative
emailJSONOptional
email (anyOf 1)stringAlternativeThe customer's email address.
Maximum length: 5000
email (anyOf 2)nullAlternative
nameJSONOptional
name (anyOf 1)stringAlternativeThe customer's full name or business name.
Maximum length: 5000
name (anyOf 2)nullAlternative
phoneJSONOptional
phone (anyOf 1)stringAlternativeThe customer's phone number.
Maximum length: 5000
phone (anyOf 2)nullAlternative

Create a Payment Evaluation — response body — events item

FieldTypePresenceDescription and constraints
$objectRootEvent reported for this payment evaluation.
dispute_openedModelOptionalExpand Create a Payment Evaluation — response body — events item dispute opened
early_fraud_warning_receivedModelOptionalExpand Create a Payment Evaluation — response body — events item early fraud warning received
occurred_atJSONRequired within parent
occurred_at (anyOf 1)integerAlternativeTimestamp when the event occurred.
Format: unix-time
occurred_at (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
refundedModelOptionalExpand Create a Payment Evaluation — response body — events item refunded
typestringRequired within parentIndicates 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_raisedModelOptionalExpand Create a Payment Evaluation — response body — events item user intervention raised
user_intervention_resolvedModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRootDispute opened event details attached to this payment evaluation.
amountJSONRequired within parent
amount (anyOf 1)integerAlternativeAmount 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)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currencystringRequired within parentThree-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
reasonstringRequired within parentReason 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

FieldTypePresenceDescription and constraints
$objectRootEarly Fraud Warning Received event details attached to this payment evaluation.
fraud_typestringRequired within parentThe 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

FieldTypePresenceDescription and constraints
$objectRootRefunded Event details attached to this payment evaluation.
amountJSONRequired within parent
amount (anyOf 1)integerAlternativeAmount 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)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currencystringRequired within parentThree-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
reasonstringRequired within parentIndicates the reason for the refund.
Known values: duplicate, fraudulent, other, requested_by_customer

Create a Payment Evaluation — response body — events item user intervention raised

FieldTypePresenceDescription and constraints
$objectRootUser intervention raised event details attached to this payment evaluation
customModelOptionalExpand Create a Payment Evaluation — response body — events item user intervention raised custom
keystringRequired within parentUnique identifier for the user intervention event.
Maximum length: 5000
typestringRequired within parentType 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

FieldTypePresenceDescription and constraints
$objectRootUser intervention raised custom event details attached to this payment evaluation
typestringRequired within parentCustom 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

FieldTypePresenceDescription and constraints
$objectRootUser Intervention Resolved Event details attached to this payment evaluation
keystringRequired within parentUnique ID of this intervention. Use this to provide the result.
Maximum length: 5000
outcomeJSONOptional
outcome (anyOf 1)stringAlternativeResult of the intervention if it has been completed.
Known values: abandoned, failed, passed
outcome (anyOf 2)nullAlternative

Create a Payment Evaluation — response body — outcome / value / type: failed, merchant blocked, rejected, rerouted, succeeded

FieldTypePresenceDescription and constraints
$objectRootOutcome details for this payment evaluation.
merchant_blockedModelOptionalExpand Create a Payment Evaluation — response body — outcome / value / type: failed, merchant blocked, rejected, rerouted, succeeded merchant blocked
payment_intent_idstringOptionalThe PaymentIntent ID associated with the payment evaluation.
Maximum length: 5000
rejectedModelOptionalExpand Create a Payment Evaluation — response body — outcome / value / type: failed, merchant blocked, rejected, rerouted, succeeded rejected
succeededModelOptionalExpand Create a Payment Evaluation — response body — outcome / value / type: failed, merchant blocked, rejected, rerouted, succeeded succeeded
typestringRequired within parentIndicates 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

FieldTypePresenceDescription and constraints
$objectRootDetails of a merchant_blocked outcome attached to this payment evaluation.
reasonstringRequired within parentThe 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

FieldTypePresenceDescription and constraints
$objectRootDetails of an rejected outcome attached to this payment evaluation.
cardModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRootDetails of an rejected card outcome attached to this payment evaluation.
address_line1_checkstringRequired within parentResult of the address line 1 check.
Known values: fail, pass, unavailable, unchecked
address_postal_code_checkstringRequired within parentIndicates whether the cardholder provided a postal code and if it matched the cardholder’s billing address.
Known values: fail, pass, unavailable, unchecked
cvc_checkstringRequired within parentResult of the CVC check.
Known values: fail, pass, unavailable, unchecked
reasonstringRequired within parentCard 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

FieldTypePresenceDescription and constraints
$objectRootDetails of a succeeded outcome attached to this payment evaluation.
cardModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRootDetails of an succeeded card outcome attached to this payment evaluation.
address_line1_checkstringRequired within parentResult of the address line 1 check.
Known values: fail, pass, unavailable, unchecked
address_postal_code_checkstringRequired within parentIndicates whether the cardholder provided a postal code and if it matched the cardholder’s billing address.
Known values: fail, pass, unavailable, unchecked
cvc_checkstringRequired within parentResult of the CVC check.
Known values: fail, pass, unavailable, unchecked

Create a Payment Evaluation — response body — payment details

FieldTypePresenceDescription and constraints
$objectRootPayment details attached to this payment evaluation.
amountJSONRequired within parent
amount (anyOf 1)integerAlternativeAmount 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)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currencystringRequired within parentThree-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
descriptionJSONOptional
description (anyOf 1)stringAlternativeAn arbitrary string attached to the object. Often useful for displaying to users.
Maximum length: 5000
description (anyOf 2)nullAlternative
money_movement_detailsJSONOptional
money_movement_details (anyOf 1)JSONAlternativeDetails about the payment's customer presence and type.
money_movement_details (anyOf 1) (anyOf 1)ModelAlternativeExpand Create a Payment Evaluation — response body — payment_details / money_movement_details / value / money_movement_type: card
money_movement_details (anyOf 2)nullAlternative
payment_method_detailsJSONOptional
payment_method_details (anyOf 1)JSONAlternativeDetails about the payment method used for the payment.
payment_method_details (anyOf 1) (anyOf 1)ModelAlternativeExpand Create a Payment Evaluation — response body — payment details payment method details value billing details, payment method
payment_method_details (anyOf 2)nullAlternative
shipping_detailsJSONOptional
shipping_details (anyOf 1)JSONAlternativeShipping details for the payment evaluation.
shipping_details (anyOf 1) (anyOf 1)ModelAlternativeExpand 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)nullAlternative
statement_descriptorJSONOptional
statement_descriptor (anyOf 1)stringAlternativePayment statement descriptor.
Maximum length: 5000
statement_descriptor (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRootPayment method details attached to this payment evaluation.
billing_detailsJSONOptional
billing_details (anyOf 1)JSONAlternativeBilling information associated with the payment evaluation.
billing_details (anyOf 1) (anyOf 1)ModelAlternativeExpand 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)nullAlternative
payment_methodJSONRequired within parentThe payment method used in this payment evaluation.
payment_method (anyOf 1)stringAlternativeMaximum length: 5000
payment_method (anyOf 2)ModelAlternativeExpand 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

FieldTypePresenceDescription and constraints
$objectRootBilling details attached to the payment method.
addressModelRequired within parentExpand Create a Payment Evaluation — response body — payment details shipping details Shipping details for the payment evaluation Shipping details attached to this payment address
emailJSONOptional
email (anyOf 1)stringAlternativeEmail address.
Maximum length: 5000
email (anyOf 2)nullAlternative
nameJSONOptional
name (anyOf 1)stringAlternativeFull name.
Maximum length: 5000
name (anyOf 2)nullAlternative
phoneJSONOptional
phone (anyOf 1)stringAlternativeBilling phone number (including extension).
Maximum length: 5000
phone (anyOf 2)nullAlternative

Referenced models: Create a Payment Evaluation — response body — payment details shipping details Shipping details for the payment evaluation Shipping details attached to this payment address

Create a Payment Evaluation — response body — payment details shipping details Shipping details for the payment evaluation Shipping details attached to this payment

FieldTypePresenceDescription and constraints
$objectRootShipping details attached to this payment.
addressModelRequired within parentExpand Create a Payment Evaluation — response body — payment details shipping details Shipping details for the payment evaluation Shipping details attached to this payment address
nameJSONOptional
name (anyOf 1)stringAlternativeShipping name.
Maximum length: 5000
name (anyOf 2)nullAlternative
phoneJSONOptional
phone (anyOf 1)stringAlternativeShipping phone number.
Maximum length: 5000
phone (anyOf 2)nullAlternative

Referenced models: Create a Payment Evaluation — response body — payment details shipping details Shipping details for the payment evaluation Shipping details attached to this payment address

Create a Payment Evaluation — response body — payment details shipping details Shipping details for the payment evaluation Shipping details attached to this payment address

FieldTypePresenceDescription and constraints
$objectRootAddress data.
cityJSONOptional
city (anyOf 1)stringAlternativeCity, district, suburb, town, or village.
Maximum length: 5000
city (anyOf 2)nullAlternative
countryJSONOptional
country (anyOf 1)stringAlternativeTwo-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
Maximum length: 5000
country (anyOf 2)nullAlternative
line1JSONOptional
line1 (anyOf 1)stringAlternativeAddress line 1, such as the street, PO Box, or company name.
Maximum length: 5000
line1 (anyOf 2)nullAlternative
line2JSONOptional
line2 (anyOf 1)stringAlternativeAddress line 2, such as the apartment, suite, unit, or building.
Maximum length: 5000
line2 (anyOf 2)nullAlternative
postal_codeJSONOptional
postal_code (anyOf 1)stringAlternativeZIP or postal code.
Maximum length: 5000
postal_code (anyOf 2)nullAlternative
stateJSONOptional
state (anyOf 1)stringAlternativeState, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
Maximum length: 5000
state (anyOf 2)nullAlternative

Create a Payment Evaluation — response body — payment_details / money_movement_details / value / money_movement_type: card

FieldTypePresenceDescription and constraints
$objectRootMoney Movement details attached to this payment.
cardJSONOptional
card (anyOf 1)JSONAlternativeDescribes card money movement details.
card (anyOf 1) (anyOf 1)ModelAlternativeExpand 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)nullAlternative
money_movement_typestringRequired within parentDescribes the type of money movement.
Known values: card

Referenced models: 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

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

FieldTypePresenceDescription and constraints
$objectRootMoney Movement card details attached to this payment.
customer_presenceJSONOptional
customer_presence (anyOf 1)stringAlternativeDescribes the presence of the customer during the payment.
Known values: off_session, on_session
customer_presence (anyOf 2)nullAlternative
payment_typeJSONOptional
payment_type (anyOf 1)stringAlternativeDescribes the type of payment.
Known values: one_off, recurring, setup_one_off, setup_recurring
payment_type (anyOf 2)nullAlternative

Create a Payment Evaluation — response body — signals

FieldTypePresenceDescription and constraints
$objectRootCollection of signals for this payment evaluation.
early_fraud_warningJSONOptional
early_fraud_warning (anyOf 1)JSONAlternativeThe likelihood that this `PaymentEvaluation` results in an early fraud warning.
early_fraud_warning (anyOf 1) (anyOf 1)ModelAlternativeExpand Create a Payment Evaluation — response body — signals fraudulent payment
early_fraud_warning (anyOf 2)nullAlternative
fraudulent_disputeJSONOptional
fraudulent_dispute (anyOf 1)JSONAlternativeThe likelihood that this `PaymentEvaluation` results in a dispute with reason code `fraudulent`.
fraudulent_dispute (anyOf 1) (anyOf 1)ModelAlternativeExpand Create a Payment Evaluation — response body — signals fraudulent payment
fraudulent_dispute (anyOf 2)nullAlternative
fraudulent_paymentModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootA payment evaluation signal with evaluated_at, risk_level, and score fields.
evaluated_atJSONRequired within parent
evaluated_at (anyOf 1)integerAlternativeThe time when this signal was evaluated.
Format: unix-time
evaluated_at (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
risk_levelstringRequired within parentRisk level of this signal, based on the score.
Known values: elevated, highest, low, normal, not_assessed, unknown
scoreJSONOptional
score (anyOf 1)JSONAlternative
score (anyOf 1) (anyOf 1)numberAlternativeNumeric 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)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
score (anyOf 2)nullAlternative

Create a value list item — response body

FieldTypePresenceDescription and constraints
$objectRootValue 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)
createdJSONRequired within parent
created (anyOf 1)integerAlternativeTime at which the object was created. Measured in seconds since the Unix epoch.
Format: unix-time
created (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
created_bystringRequired within parentThe name or email address of the user who added this item to the value list.
Maximum length: 5000
idstringRequired within parentUnique identifier for the object.
Maximum length: 5000
livemodebooleanRequired within parentIf the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
objectstringRequired within parentString representing the object's type. Objects of the same type share the same value.
Known values: radar.value_list_item
valuestringRequired within parentThe value of the item.
Maximum length: 5000
value_liststringRequired within parentThe identifier of the value list this item belongs to.
Maximum length: 5000

Create a value list — response body

FieldTypePresenceDescription and constraints
$objectRootValue 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)
aliasstringRequired within parentThe name of the value list for use in rules.
Maximum length: 5000
createdJSONRequired within parent
created (anyOf 1)integerAlternativeTime at which the object was created. Measured in seconds since the Unix epoch.
Format: unix-time
created (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
created_bystringRequired within parentThe name or email address of the user who created this value list.
Maximum length: 5000
idstringRequired within parentUnique identifier for the object.
Maximum length: 5000
item_typestringRequired within parentThe 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_itemsobjectRequired within parentList of items contained within this value list.
list_items.dataarrayRequired within parentDetails about each object.
list_items.data[]ModelEach itemExpand Create a value list item — response body
list_items.has_morebooleanRequired within parentTrue if this list has another page of items after this one that can be fetched.
list_items.objectstringRequired within parentString representing the object's type. Objects of the same type share the same value. Always has the value `list`.
Known values: list
list_items.urlstringRequired within parentThe URL where this list can be accessed.
Maximum length: 5000
livemodebooleanRequired within parentIf the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
metadataobjectRequired within parentSet 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.*stringAdditional keysMaximum length: 500
namestringRequired within parentThe name of the value list.
Maximum length: 5000
objectstringRequired within parentString 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

FieldTypePresenceDescription and constraints
$objectRoot
deletedbooleanRequired within parentAlways true for a deleted object
Known values: True
idstringRequired within parentUnique identifier for the object.
Maximum length: 5000
objectstringRequired within parentString 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

FieldTypePresenceDescription and constraints
$objectRoot
deletedbooleanRequired within parentAlways true for a deleted object
Known values: True
idstringRequired within parentUnique identifier for the object.
Maximum length: 5000
objectstringRequired within parentString 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

FieldTypePresenceDescription and constraints
$objectRootAn 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)
actionablebooleanRequired within parentAn 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.
chargeJSONRequired within parentID of the charge this early fraud warning is for, optionally expanded.
charge (anyOf 1)stringAlternativeMaximum length: 5000
charge (anyOf 2)ModelAlternativeExpand Create a charge — response body
createdJSONRequired within parent
created (anyOf 1)integerAlternativeTime at which the object was created. Measured in seconds since the Unix epoch.
Format: unix-time
created (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
fraud_typestringRequired within parentThe 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
idstringRequired within parentUnique identifier for the object.
Maximum length: 5000
livemodebooleanRequired within parentIf the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
objectstringRequired within parentString representing the object's type. Objects of the same type share the same value.
Known values: radar.early_fraud_warning
payment_intentJSONOptionalID of the Payment Intent this early fraud warning is for, optionally expanded.
payment_intent (anyOf 1)stringAlternativeMaximum length: 5000
payment_intent (anyOf 2)ModelAlternativeExpand Cancel a Payment Intent — response body

Referenced models: Create a charge — response body, Cancel a Payment Intent — response body

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.