Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Reserves
Fraud
Issuing
Terminal
Treasury
Payment Records
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Webhooks

The Review object 

Fraud
Reviews
The Review object

Attributes

  • idstring

    Unique identifier for the object.

  • chargenullable stringExpandable

    The charge associated with this review.

  • openboolean

    If true, the review needs action.

  • payment_intentnullable stringExpandable

    The PaymentIntent ID associated with this review, if one exists.

  • reasonstring

    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.

More attributes

  • objectstring

    String representing the object’s type. Objects of the same type share the same value.

  • billing_zipnullable string

    The ZIP or postal code of the card used, if applicable.

  • closed_reasonnullable enum

    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.

  • createdtimestamp

    Time at which the object was created. Measured in seconds since the Unix epoch.

  • ip_addressnullable string

    The IP address where the payment originated.

  • ip_address_locationnullable object

    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.

    • ip_address_location.citynullable string

      The city where the payment originated.

    • ip_address_location.countrynullable string

      Two-letter ISO code representing the country where the payment originated.

    • ip_address_location.latitudenullable float

      The geographic latitude where the payment originated.

    • ip_address_location.longitudenullable float

      The geographic longitude where the payment originated.

    • ip_address_location.regionnullable string

      The state/county/province/region where the payment originated.

  • livemodeboolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

  • opened_reasonenum

    The reason the review was opened. One of rule or manual.

    Possible enum values
    manual
    rule

  • refund_signalsnullable objectPreview feature

    Signals to indicate that the review should be prioritized and a payment refund should be considered.

    • refund_signals.early_fraud_warningnullable stringExpandable

      When present, this signal indicates that the payment associated with the review received an early fraud warning.

    • refund_signals.recommended_refundnullable object

      When present, this signal indicates that Smart Refunds recommends refunding the payment based on risk signals collected after the payment completed.

  • sessionnullable object

    Information related to the browsing session of the user who initiated the payment.

    • session.browsernullable string

      The browser used in this browser session (e.g., Chrome).

    • session.devicenullable string

      Information about the device used for the browser session (e.g., Samsung SM-G930T).

    • session.platformnullable string

      The platform for the browser session (e.g., Macintosh).

    • session.versionnullable string

      The version for the browser session (e.g., 61.0.3163.100).

The Review object
{
  "id": "prv_1NVyFt2eZvKYlo2CjubqF1xm",
  "object": "review",
  "billing_zip": null,
  "charge": null,
  "closed_reason": null,
  "created": 1689864901,
  "ip_address": null,
  "ip_address_location": null,
  "livemode": false,
  "open": true,
  "opened_reason": "rule",
  "payment_intent": "pi_3NVy8c2eZvKYlo2C055h7pkd",
  "reason": "rule",
  "session": null
}