Mayson Monorepo Documentation
    Preparing search index...

    Reviews can be used to supplement automated fraud detection with human expertise.

    Learn more about Radar and reviewing payments here.

    interface Review {
        id: string;
        object: "review";
        billing_zip: string;
        charge: string | Stripe.Charge;
        closed_reason: ClosedReason;
        created: number;
        ip_address: string;
        ip_address_location: IpAddressLocation;
        livemode: boolean;
        open: boolean;
        opened_reason: OpenedReason;
        payment_intent?: string | Stripe.PaymentIntent;
        reason: string;
        session: Stripe.Review.Session;
    }
    Index

    Properties

    id: string

    Unique identifier for the object.

    object: "review"

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

    billing_zip: string

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

    charge: string | Stripe.Charge

    The charge associated with this review.

    closed_reason: 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.

    created: number

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

    ip_address: string

    The IP address where the payment originated.

    ip_address_location: 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.

    livemode: boolean

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

    open: boolean

    If true, the review needs action.

    opened_reason: OpenedReason

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

    payment_intent?: string | Stripe.PaymentIntent

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

    reason: string

    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.

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