InsightsResourcesPaymentEvaluation
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 for integration steps.
Summary
Types
@type client_device_metadata_details() :: %{ optional(:radar_session) => String.t() | nil, optional(String.t()) => term() }
radar_session- ID for the Radar Session associated 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. Max length: 5000.
@type customer_details() :: %{ optional(:customer) => String.t() | nil, optional(:customer_account) => String.t() | nil, optional(:email) => String.t() | nil, optional(:name) => String.t() | nil, optional(:phone) => String.t() | nil, optional(String.t()) => term() }
customer- The ID of the customer associated with the payment evaluation. Max length: 5000. Nullable.customer_account- The ID of the Account representing the customer associated with the payment evaluation. Max length: 5000. Nullable.email- The customer's email address. Max length: 5000. Nullable.name- The customer's full name or business name. Max length: 5000. Nullable.phone- The customer's phone number. Max length: 5000. Nullable.
@type events() :: %{ optional(:dispute_opened) => events_dispute_opened() | nil, optional(:early_fraud_warning_received) => events_early_fraud_warning_received() | nil, optional(:occurred_at) => integer() | nil, optional(:refunded) => events_refunded() | nil, optional(:type) => String.t() | nil, optional(:user_intervention_raised) => events_user_intervention_raised() | nil, optional(:user_intervention_resolved) => events_user_intervention_resolved() | nil, optional(String.t()) => term() }
dispute_openedearly_fraud_warning_receivedoccurred_at- Timestamp when the event occurred. Format: Unix timestamp.refundedtype- Indicates the type of event attached to the payment evaluation. Possible values:dispute_opened,early_fraud_warning_received,refunded,user_intervention_raised,user_intervention_resolved.user_intervention_raiseduser_intervention_resolved
@type events_dispute_opened() :: %{ optional(:amount) => integer() | nil, optional(:currency) => String.t() | nil, optional(:reason) => String.t() | nil, optional(String.t()) => term() }
amount- Amount to dispute for 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).currency- Three-letter ISO currency code, in lowercase. Must be a supported currency. Format: ISO 4217 currency code.reason- Reason given by cardholder for dispute. Possible values:account_not_available,credit_not_processed,customer_initiated,duplicate,fraudulent,general,noncompliant,product_not_received,product_unacceptable,subscription_canceled,unrecognized.
@type events_early_fraud_warning_received() :: %{ optional(:fraud_type) => String.t() | nil, optional(String.t()) => term() }
fraud_type- The type of fraud labeled by the issuer. Possible values:made_with_lost_card,made_with_stolen_card,other,unauthorized_use_of_card.
@type events_refunded() :: %{ optional(:amount) => integer() | nil, optional(:currency) => String.t() | nil, optional(:reason) => String.t() | nil, optional(String.t()) => term() }
amount- Amount refunded for 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).currency- Three-letter ISO currency code, in lowercase. Must be a supported currency. Format: ISO 4217 currency code.reason- Indicates the reason for the refund. Possible values:duplicate,fraudulent,other,requested_by_customer.
@type events_user_intervention_raised() :: %{ optional(:custom) => events_user_intervention_raised_custom() | nil, optional(:key) => String.t() | nil, optional(:type) => String.t() | nil, optional(String.t()) => term() }
customkey- Unique identifier for the user intervention event. Max length: 5000.type- Type of user intervention raised. Possible values:3ds,captcha,custom.
@type events_user_intervention_raised_custom() :: %{ optional(:type) => String.t() | nil, optional(String.t()) => term() }
type- Custom type of user intervention raised. The string must use a snake case description for the type of intervention performed. Max length: 5000.
@type events_user_intervention_resolved() :: %{ optional(:key) => String.t() | nil, optional(:outcome) => String.t() | nil, optional(String.t()) => term() }
key- Unique ID of this intervention. Use this to provide the result. Max length: 5000.outcome- Result of the intervention if it has been completed. Possible values:abandoned,failed,passed. Nullable.
@type insights() :: %{ optional(:card_issuer_decline) => insights_card_issuer_decline() | nil, optional(:evaluated_at) => integer() | nil, optional(:fraudulent_dispute) => insights_fraudulent_dispute() | nil, optional(String.t()) => term() }
card_issuer_decline- Stripe Radar's evaluation of the likelihood of a card issuer decline on this payment. Nullable.evaluated_at- The timestamp when the evaluation was performed. Format: Unix timestamp.fraudulent_dispute
@type insights_card_issuer_decline() :: %{ optional(:model_score) => float() | nil, optional(:recommended_action) => String.t() | nil, optional(String.t()) => term() }
model_score- Stripe Radar's evaluation of the likelihood that the payment will be declined by the card issuer. Scores range from 0 to 100, with higher values indicating a higher likelihood of decline.recommended_action- Recommended action based on the model score. Possible values areblockandcontinue. Possible values:block,continue.
@type insights_fraudulent_dispute() :: %{ optional(:recommended_action) => String.t() | nil, optional(:risk_score) => integer() | nil, optional(String.t()) => term() }
recommended_action- Recommended action based on the risk score. Possible values areblockandcontinue. Possible values:block,continue.risk_score- Stripe Radar’s evaluation of the risk level of the payment. Possible values for evaluated payments are between 0 and 100, with higher scores indicating higher risk.
@type outcome() :: %{ optional(:merchant_blocked) => outcome_merchant_blocked() | nil, optional(:payment_intent_id) => String.t() | nil, optional(:rejected) => outcome_rejected() | nil, optional(:succeeded) => outcome_succeeded() | nil, optional(:type) => String.t() | nil, optional(String.t()) => term() }
merchant_blockedpayment_intent_id- The PaymentIntent ID associated with the payment evaluation. Max length: 5000.rejectedsucceededtype- Indicates the outcome of the payment evaluation. Possible values:failed,merchant_blocked,rejected,succeeded.
@type outcome_merchant_blocked() :: %{ optional(:reason) => String.t() | nil, optional(String.t()) => term() }
reason- The reason the payment was blocked by the merchant. Possible values:authentication_required,blocked_for_fraud,invalid_payment,other.
@type outcome_rejected() :: %{ optional(:card) => outcome_rejected_card() | nil, optional(String.t()) => term() }
card
@type outcome_rejected_card() :: %{ optional(:address_line1_check) => String.t() | nil, optional(:address_postal_code_check) => String.t() | nil, optional(:cvc_check) => String.t() | nil, optional(:reason) => String.t() | nil, optional(String.t()) => term() }
address_line1_check- Result of the address line 1 check. Possible values:fail,pass,unavailable,unchecked.address_postal_code_check- Indicates whether the cardholder provided a postal code and if it matched the cardholder’s billing address. Possible values:fail,pass,unavailable,unchecked.cvc_check- Result of the CVC check. Possible values:fail,pass,unavailable,unchecked.reason- Card issuer's reason for the network decline. Possible 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.
@type outcome_succeeded() :: %{ optional(:card) => outcome_succeeded_card() | nil, optional(String.t()) => term() }
card
@type outcome_succeeded_card() :: %{ optional(:address_line1_check) => String.t() | nil, optional(:address_postal_code_check) => String.t() | nil, optional(:cvc_check) => String.t() | nil, optional(String.t()) => term() }
address_line1_check- Result of the address line 1 check. Possible values:fail,pass,unavailable,unchecked.address_postal_code_check- Indicates whether the cardholder provided a postal code and if it matched the cardholder’s billing address. Possible values:fail,pass,unavailable,unchecked.cvc_check- Result of the CVC check. Possible values:fail,pass,unavailable,unchecked.
@type payment_details() :: %{ optional(:amount) => integer() | nil, optional(:currency) => String.t() | nil, optional(:description) => String.t() | nil, optional(:money_movement_details) => payment_details_money_movement_details() | nil, optional(:payment_method_details) => payment_details_payment_method_details() | nil, optional(:shipping_details) => payment_details_shipping_details() | nil, optional(:statement_descriptor) => String.t() | nil, optional(String.t()) => term() }
amount- Amount intended to be collected by this payment. A positive integer representing how much to charge in the smallest currency unit (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. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).currency- Three-letter ISO currency code, in lowercase. Must be a supported currency. Format: ISO 4217 currency code.description- An arbitrary string attached to the object. Often useful for displaying to users. Max length: 5000. Nullable.money_movement_details- Details about the payment's customer presence and type. Nullable.payment_method_details- Details about the payment method used for the payment. Nullable.shipping_details- Shipping details for the payment evaluation. Nullable.statement_descriptor- Payment statement descriptor. Max length: 5000. Nullable.
@type payment_details_money_movement_details() :: %{ optional(:card) => payment_details_money_movement_details_card() | nil, optional(:money_movement_type) => String.t() | nil, optional(String.t()) => term() }
card- Describes card money movement details for the payment evaluation. Nullable.money_movement_type- Describes the type of money movement. Currently onlycardis supported. Possible values:card.
@type payment_details_money_movement_details_card() :: %{ optional(:customer_presence) => String.t() | nil, optional(:payment_type) => String.t() | nil, optional(String.t()) => term() }
customer_presence- Describes the presence of the customer during the payment. Possible values:off_session,on_session. Nullable.payment_type- Describes the type of payment. Possible values:one_off,recurring,setup_one_off,setup_recurring. Nullable.
@type payment_details_payment_method_details() :: %{ optional(:billing_details) => payment_details_payment_method_details_billing_details() | nil, optional(:payment_method) => String.t() | Stripe.Resources.PaymentMethod.t() | nil, optional(String.t()) => term() }
billing_details- Billing information associated with the payment evaluation. Nullable.payment_method- The payment method used in this payment evaluation.
@type payment_details_payment_method_details_billing_details() :: %{ optional(:address) => payment_details_payment_method_details_billing_details_address() | nil, optional(:email) => String.t() | nil, optional(:name) => String.t() | nil, optional(:phone) => String.t() | nil, optional(String.t()) => term() }
addressemail- Email address. Max length: 5000. Nullable.name- Full name. Max length: 5000. Nullable.phone- Billing phone number (including extension). Max length: 5000. Nullable.
@type payment_details_payment_method_details_billing_details_address() :: %{ optional(:city) => String.t() | nil, optional(:country) => String.t() | nil, optional(:line1) => String.t() | nil, optional(:line2) => String.t() | nil, optional(:postal_code) => String.t() | nil, optional(:state) => String.t() | nil, optional(String.t()) => term() }
city- City, district, suburb, town, or village. Max length: 5000. Nullable.country- Two-letter country code (ISO 3166-1 alpha-2). Max length: 5000. Nullable.line1- Address line 1, such as the street, PO Box, or company name. Max length: 5000. Nullable.line2- Address line 2, such as the apartment, suite, unit, or building. Max length: 5000. Nullable.postal_code- ZIP or postal code. Max length: 5000. Nullable.state- State, county, province, or region (ISO 3166-2). Max length: 5000. Nullable.
@type payment_details_shipping_details() :: %{ optional(:address) => payment_details_shipping_details_address() | nil, optional(:name) => String.t() | nil, optional(:phone) => String.t() | nil, optional(String.t()) => term() }
addressname- Shipping name. Max length: 5000. Nullable.phone- Shipping phone number. Max length: 5000. Nullable.
@type payment_details_shipping_details_address() :: %{ optional(:city) => String.t() | nil, optional(:country) => String.t() | nil, optional(:line1) => String.t() | nil, optional(:line2) => String.t() | nil, optional(:postal_code) => String.t() | nil, optional(:state) => String.t() | nil, optional(String.t()) => term() }
city- City, district, suburb, town, or village. Max length: 5000. Nullable.country- Two-letter country code (ISO 3166-1 alpha-2). Max length: 5000. Nullable.line1- Address line 1, such as the street, PO Box, or company name. Max length: 5000. Nullable.line2- Address line 2, such as the apartment, suite, unit, or building. Max length: 5000. Nullable.postal_code- ZIP or postal code. Max length: 5000. Nullable.state- State, county, province, or region (ISO 3166-2). Max length: 5000. Nullable.
@type t() :: %Stripe.Resources.Radar.PaymentEvaluation{ client_device_metadata_details: client_device_metadata_details() | nil, created_at: integer(), customer_details: customer_details() | nil, events: [events()] | nil, id: String.t(), insights: insights(), livemode: boolean(), metadata: %{required(String.t()) => String.t()}, object: String.t(), outcome: outcome() | nil, payment_details: payment_details() | nil }
client_device_metadata_details- Expandable.created_at- Time at which the object was created. Measured in seconds since the Unix epoch. Format: Unix timestamp.customer_details- Expandable.events- Event information associated with the payment evaluation, such as refunds, dispute, early fraud warnings, or user interventions. Expandable.id- Unique identifier for the object. Max length: 5000.insights- Expandable.livemode- Has the valuetrueif the object exists in live mode or the valuefalseif the object exists in test mode.metadata- 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. Nullable.object- String representing the object's type. Objects of the same type share the same value. Possible values:radar.payment_evaluation.outcome- Indicates the final outcome for the payment evaluation. Nullable. Expandable.payment_details- Expandable.