Package com.stripe.model.radar

Class PaymentEvaluation

java.lang.Object
com.stripe.model.StripeObject
com.stripe.net.ApiResource
com.stripe.model.radar.PaymentEvaluation
All Implemented Interfaces:
HasId, StripeActiveObject, StripeObjectInterface
public class PaymentEvaluation extends ApiResource implements HasId
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.

  • Constructor Details

    • PaymentEvaluation

      public PaymentEvaluation()

  • Method Details

    • create

      public static PaymentEvaluation create(Map<String,Object> params) throws StripeException
      Request a Radar API fraud risk score from Stripe for a payment before sending it for external processor authorization.
      Throws:
      StripeException

    • create

      public static PaymentEvaluation create(Map<String,Object> params, RequestOptions options) throws StripeException
      Request a Radar API fraud risk score from Stripe for a payment before sending it for external processor authorization.
      Throws:
      StripeException

    • create

      public static PaymentEvaluation create(PaymentEvaluationCreateParams params) throws StripeException
      Request a Radar API fraud risk score from Stripe for a payment before sending it for external processor authorization.
      Throws:
      StripeException

    • create

      public static PaymentEvaluation create(PaymentEvaluationCreateParams params, RequestOptions options) throws StripeException
      Request a Radar API fraud risk score from Stripe for a payment before sending it for external processor authorization.
      Throws:
      StripeException

    • setResponseGetter

      public void setResponseGetter(StripeResponseGetter responseGetter)
      Score for this insight. Possible values for evaluated payments are -1 and any value between 0 and 100. The value is returned with two decimal places. A score of -1 indicates a test integration and higher scores indicate a higher likelihood of the signal being true.
      Specified by:
      setResponseGetter in interface StripeActiveObject
      Overrides:
      setResponseGetter in class ApiResource
      Parameters:
      responseGetter - the StripeResponseGetter instance to use for making further requests.

    • getClientDeviceMetadataDetails

      public PaymentEvaluation.ClientDeviceMetadataDetails getClientDeviceMetadataDetails()
      Client device metadata attached to this payment evaluation.

    • getCreatedAt

      public Long getCreatedAt()
      Time at which the object was created. Measured in seconds since the Unix epoch.

    • getCustomerDetails

      public PaymentEvaluation.CustomerDetails getCustomerDetails()
      Customer details attached to this payment evaluation.

    • getEvents

      public List<PaymentEvaluation.Event> getEvents()
      Event information associated with the payment evaluation, such as refunds, dispute, early fraud warnings, or user interventions.

    • getLivemode

      public Boolean getLivemode()
      If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

    • getMetadata

      public Map<String,String> getMetadata()
      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.

    • getObject

      public String getObject()
      String representing the object's type. Objects of the same type share the same value.

      Equal to radar.payment_evaluation.

    • getOutcome

      public PaymentEvaluation.Outcome getOutcome()
      Indicates the final outcome for the payment evaluation.

    • getPaymentDetails

      public PaymentEvaluation.PaymentDetails getPaymentDetails()
      Payment details attached to this payment evaluation.

    • getRecommendedAction

      public String getRecommendedAction()
      Recommended action based on the score of the fraudulent_payment signal. Possible values are block and continue.

      One of block, or continue.

    • getSignals

      public PaymentEvaluation.Signals getSignals()
      Collection of signals for this payment evaluation.

    • setClientDeviceMetadataDetails

      public void setClientDeviceMetadataDetails(PaymentEvaluation.ClientDeviceMetadataDetails clientDeviceMetadataDetails)
      Client device metadata attached to this payment evaluation.

    • setCreatedAt

      public void setCreatedAt(Long createdAt)
      Time at which the object was created. Measured in seconds since the Unix epoch.

    • setCustomerDetails

      public void setCustomerDetails(PaymentEvaluation.CustomerDetails customerDetails)
      Customer details attached to this payment evaluation.

    • setEvents

      public void setEvents(List<PaymentEvaluation.Event> events)
      Event information associated with the payment evaluation, such as refunds, dispute, early fraud warnings, or user interventions.

    • setId

      public void setId(String id)
      Unique identifier for the object.

    • setLivemode

      public void setLivemode(Boolean livemode)
      If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

    • setMetadata

      public void setMetadata(Map<String,String> 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.

    • setObject

      public void setObject(String object)
      String representing the object's type. Objects of the same type share the same value.

      Equal to radar.payment_evaluation.

    • setOutcome

      public void setOutcome(PaymentEvaluation.Outcome outcome)
      Indicates the final outcome for the payment evaluation.

    • setPaymentDetails

      public void setPaymentDetails(PaymentEvaluation.PaymentDetails paymentDetails)
      Payment details attached to this payment evaluation.

    • setRecommendedAction

      public void setRecommendedAction(String recommendedAction)
      Recommended action based on the score of the fraudulent_payment signal. Possible values are block and continue.

      One of block, or continue.

    • setSignals

      public void setSignals(PaymentEvaluation.Signals signals)
      Collection of signals for this payment evaluation.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • getId

      public String getId()
      Unique identifier for the object.
      Specified by:
      getId in interface HasId