NAME

Net::API::Stripe::Fraud::Review - A Stripe Fraud Review Object

SYNOPSIS

            

              
              
my $review = $stripe->review({
    billing_zip => '123-4567',
    # Could also be a Net::API::Stripe::Charge object when expanded
    charge => 'ch_fake1234567890',
    ip_address => '1.2.3.4',
    ip_address_location => 
        {
        city => 'Tokyo',
        country => 'jp',
        latitude => '35.6935496',
        longitude => '139.7461204',
        region => undef,
        },
    open => $stripe->true,
    payment_intent => $payment_intent_object,
    reason => 'Some issue',
    session => $session_object,
});
            
          

See documentation in Net::API::Stripe for example to make api calls to Stripe to create those objects.

VERSION

            

              
              
v0.100.0
            
          

DESCRIPTION

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

CONSTRUCTOR

new( %ARG )

Creates a new Net::API::Stripe::Fraud::Review object. It may also take an hash like arguments, that also are method of the same name.

METHODS

id string

Unique identifier for the object.

object string, value is "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 (expandable)

The charge associated with this review.

When expanded, this is a Net::API::Stripe::Charge object.

closed_reason string

The reason the review was closed, or null if it has not yet been closed. One of approved, refunded, refunded_as_fraud, or disputed.

created timestamp

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 hash

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.

This is a Net::API::Stripe::GeoLocation object.

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 string

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

payment_intent string (expandable)

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

When expanded, this is a Net::API::Stripe::Payment::Intent object.

reason string

The reason the review is currently open or closed. One of rule, manual, approved, refunded, refunded_as_fraud, or disputed.

session hash

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

This is a Net::API::Stripe::Session object.

API SAMPLE

            

              
              
{
  "id": "prv_fake123456789",
  "object": "review",
  "billing_zip": null,
  "charge": "ch_fake123456789",
  "closed_reason": null,
  "created": 1571480456,
  "ip_address": null,
  "ip_address_location": null,
  "livemode": false,
  "open": true,
  "opened_reason": "rule",
  "reason": "rule",
  "session": null
}
            
          

HISTORY

v0.1

Initial version

AUTHOR

Jacques Deguest <jack@deguest.jp>

SEE ALSO

Stripe API documentation:

https://stripe.com/docs/api/radar/reviews, https://stripe.com/radar

COPYRIGHT & LICENSE

Copyright (c) 2019-2020 DEGUEST Pte. Ltd.

You can use, copy, modify and redistribute this package and associated files under the same terms as Perl itself.