Package com.stripe.model

Class Review

java.lang.Object
com.stripe.model.StripeObject
com.stripe.net.ApiResource
com.stripe.model.Review
All Implemented Interfaces:
HasId, StripeActiveObject, StripeObjectInterface
public class Review extends ApiResource implements HasId
Reviews can be used to supplement automated fraud detection with human expertise.

Learn more about Radar and reviewing payments here.

  • Constructor Details

    • Review

      public Review()

  • Method Details

    • getCharge

      public String getCharge()
      Get ID of expandable charge object.

    • setCharge

      public void setCharge(String id)

    • getChargeObject

      public Charge getChargeObject()
      Get expanded charge.

    • setChargeObject

      public void setChargeObject(Charge expandableObject)

    • getPaymentIntent

      public String getPaymentIntent()
      Get ID of expandable paymentIntent object.

    • setPaymentIntent

      public void setPaymentIntent(String id)

    • getPaymentIntentObject

      public PaymentIntent getPaymentIntentObject()
      Get expanded paymentIntent.

    • setPaymentIntentObject

      public void setPaymentIntentObject(PaymentIntent expandableObject)

    • approve

      public Review approve() throws StripeException
      Approves a Review object, closing it and removing it from the list of reviews.
      Throws:
      StripeException

    • approve

      public Review approve(RequestOptions options) throws StripeException
      Approves a Review object, closing it and removing it from the list of reviews.
      Throws:
      StripeException

    • approve

      public Review approve(Map<String,Object> params) throws StripeException
      Approves a Review object, closing it and removing it from the list of reviews.
      Throws:
      StripeException

    • approve

      public Review approve(Map<String,Object> params, RequestOptions options) throws StripeException
      Approves a Review object, closing it and removing it from the list of reviews.
      Throws:
      StripeException

    • approve

      public Review approve(ReviewApproveParams params) throws StripeException
      Approves a Review object, closing it and removing it from the list of reviews.
      Throws:
      StripeException

    • approve

      public Review approve(ReviewApproveParams params, RequestOptions options) throws StripeException
      Approves a Review object, closing it and removing it from the list of reviews.
      Throws:
      StripeException

    • list

      public static ReviewCollection list(Map<String,Object> params) throws StripeException
      Returns a list of Review objects that have open set to true. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
      Throws:
      StripeException

    • list

      public static ReviewCollection list(Map<String,Object> params, RequestOptions options) throws StripeException
      Returns a list of Review objects that have open set to true. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
      Throws:
      StripeException

    • list

      public static ReviewCollection list(ReviewListParams params) throws StripeException
      Returns a list of Review objects that have open set to true. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
      Throws:
      StripeException

    • list

      public static ReviewCollection list(ReviewListParams params, RequestOptions options) throws StripeException
      Returns a list of Review objects that have open set to true. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
      Throws:
      StripeException

    • retrieve

      public static Review retrieve(String review) throws StripeException
      Retrieves a Review object.
      Throws:
      StripeException

    • retrieve

      public static Review retrieve(String review, RequestOptions options) throws StripeException
      Retrieves a Review object.
      Throws:
      StripeException

    • retrieve

      public static Review retrieve(String review, Map<String,Object> params, RequestOptions options) throws StripeException
      Retrieves a Review object.
      Throws:
      StripeException

    • retrieve

      public static Review retrieve(String review, ReviewRetrieveParams params, RequestOptions options) throws StripeException
      Retrieves a Review object.
      Throws:
      StripeException

    • setResponseGetter

      public void setResponseGetter(StripeResponseGetter responseGetter)
      Description copied from interface: StripeActiveObject
      Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.
      Specified by:
      setResponseGetter in interface StripeActiveObject
      Overrides:
      setResponseGetter in class ApiResource
      Parameters:
      responseGetter - the StripeResponseGetter instance to use for making further requests.

    • getBillingZip

      public String getBillingZip()
      The ZIP or postal code of the card used, if applicable.

    • getClosedReason

      public String getClosedReason()
      The reason the review was closed, or null if it has not yet been closed. One of approved, refunded, refunded_as_fraud, disputed, redacted, canceled, payment_never_settled, or acknowledged.

    • getCreated

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

    • getIpAddress

      public String getIpAddress()
      The IP address where the payment originated.

    • getIpAddressLocation

      public Review.IpAddressLocation getIpAddressLocation()
      Information related to the location of the payment. Note that this information is an approximation and attempts to locate the nearest population center - it should not be used to determine a specific address.

    • getLivemode

      public Boolean getLivemode()
      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • getObject

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

      Equal to review.

    • getOpen

      public Boolean getOpen()
      If true, the review needs action.

    • getOpenedReason

      public String getOpenedReason()
      The reason the review was opened. One of rule or manual.

    • getReason

      public String getReason()
      The reason the review is currently open or closed. One of rule, manual, approved, refunded, refunded_as_fraud, disputed, redacted, canceled, payment_never_settled, or acknowledged.

    • getSession

      public Review.Session getSession()
      Information related to the browsing session of the user who initiated the payment.

    • setBillingZip

      public void setBillingZip(String billingZip)
      The ZIP or postal code of the card used, if applicable.

    • setClosedReason

      public void setClosedReason(String closedReason)
      The reason the review was closed, or null if it has not yet been closed. One of approved, refunded, refunded_as_fraud, disputed, redacted, canceled, payment_never_settled, or acknowledged.

    • setCreated

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

    • setId

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

    • setIpAddress

      public void setIpAddress(String ipAddress)
      The IP address where the payment originated.

    • setIpAddressLocation

      public void setIpAddressLocation(Review.IpAddressLocation ipAddressLocation)
      Information related to the location of the payment. Note that this information is an approximation and attempts to locate the nearest population center - it should not be used to determine a specific address.

    • setLivemode

      public void setLivemode(Boolean livemode)
      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • setObject

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

      Equal to review.

    • setOpen

      public void setOpen(Boolean open)
      If true, the review needs action.

    • setOpenedReason

      public void setOpenedReason(String openedReason)
      The reason the review was opened. One of rule or manual.

    • setReason

      public void setReason(String reason)
      The reason the review is currently open or closed. One of rule, manual, approved, refunded, refunded_as_fraud, disputed, redacted, canceled, payment_never_settled, or acknowledged.

    • setSession

      public void setSession(Review.Session session)
      Information related to the browsing session of the user who initiated the payment.

    • 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