EarlyFraudWarning.php
68 lines
| 1 | <?php |
| 2 | |
| 3 | // File generated from our OpenAPI spec |
| 4 | namespace ProfilePressVendor\Stripe\Radar; |
| 5 | |
| 6 | /** |
| 7 | * An early fraud warning indicates that the card issuer has notified us that a |
| 8 | * charge may be fraudulent. |
| 9 | * |
| 10 | * Related guide: <a href="https://stripe.com/docs/disputes/measuring#early-fraud-warnings">Early fraud warnings</a> |
| 11 | * |
| 12 | * @property string $id Unique identifier for the object. |
| 13 | * @property string $object String representing the object's type. Objects of the same type share the same value. |
| 14 | * @property bool $actionable An EFW is actionable if it has not received a dispute and has not been fully refunded. You may wish to proactively refund a charge that receives an EFW, in order to avoid receiving a dispute later. |
| 15 | * @property string|\Stripe\Charge $charge ID of the charge this early fraud warning is for, optionally expanded. |
| 16 | * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. |
| 17 | * @property string $fraud_type The type of fraud labelled by the issuer. One of <code>card_never_received</code>, <code>fraudulent_card_application</code>, <code>made_with_counterfeit_card</code>, <code>made_with_lost_card</code>, <code>made_with_stolen_card</code>, <code>misc</code>, <code>unauthorized_use_of_card</code>. |
| 18 | * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode. |
| 19 | * @property null|string|\Stripe\PaymentIntent $payment_intent ID of the Payment Intent this early fraud warning is for, optionally expanded. |
| 20 | */ |
| 21 | class EarlyFraudWarning extends \ProfilePressVendor\Stripe\ApiResource |
| 22 | { |
| 23 | const OBJECT_NAME = 'radar.early_fraud_warning'; |
| 24 | const FRAUD_TYPE_CARD_NEVER_RECEIVED = 'card_never_received'; |
| 25 | const FRAUD_TYPE_FRAUDULENT_CARD_APPLICATION = 'fraudulent_card_application'; |
| 26 | const FRAUD_TYPE_MADE_WITH_COUNTERFEIT_CARD = 'made_with_counterfeit_card'; |
| 27 | const FRAUD_TYPE_MADE_WITH_LOST_CARD = 'made_with_lost_card'; |
| 28 | const FRAUD_TYPE_MADE_WITH_STOLEN_CARD = 'made_with_stolen_card'; |
| 29 | const FRAUD_TYPE_MISC = 'misc'; |
| 30 | const FRAUD_TYPE_UNAUTHORIZED_USE_OF_CARD = 'unauthorized_use_of_card'; |
| 31 | /** |
| 32 | * Returns a list of early fraud warnings. |
| 33 | * |
| 34 | * @param null|array $params |
| 35 | * @param null|array|string $opts |
| 36 | * |
| 37 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 38 | * |
| 39 | * @return \Stripe\Collection<\Stripe\Radar\EarlyFraudWarning> of ApiResources |
| 40 | */ |
| 41 | public static function all($params = null, $opts = null) |
| 42 | { |
| 43 | $url = static::classUrl(); |
| 44 | return static::_requestPage($url, \ProfilePressVendor\Stripe\Collection::class, $params, $opts); |
| 45 | } |
| 46 | /** |
| 47 | * Retrieves the details of an early fraud warning that has previously been |
| 48 | * created. |
| 49 | * |
| 50 | * Please refer to the <a href="#early_fraud_warning_object">early fraud |
| 51 | * warning</a> object reference for more details. |
| 52 | * |
| 53 | * @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key |
| 54 | * @param null|array|string $opts |
| 55 | * |
| 56 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 57 | * |
| 58 | * @return \Stripe\Radar\EarlyFraudWarning |
| 59 | */ |
| 60 | public static function retrieve($id, $opts = null) |
| 61 | { |
| 62 | $opts = \ProfilePressVendor\Stripe\Util\RequestOptions::parse($opts); |
| 63 | $instance = new static($id, $opts); |
| 64 | $instance->refresh(); |
| 65 | return $instance; |
| 66 | } |
| 67 | } |
| 68 |