The Early Fraud Warning object
Attributes
- id string Unique identifier for the object.
- object string, value is "radar.early_fraud_warning" String representing the object’s type. Objects of the same type share the same value.
- actionable boolean 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.
- charge string Expandable ID of the charge this early fraud warning is for, optionally expanded.
- created timestamp Time at which the object was created. Measured in seconds since the Unix epoch.
- fraud _ type string The type of fraud labelled by the issuer. One of
card_never_received,fraudulent_card_application,made_with_counterfeit_card,made_with_lost_card,made_with_stolen_card,misc,unauthorized_use_of_card. - livemode boolean If the object exists in live mode, the value is
true. If the object exists in test mode, the value isfalse. - payment _ intent nullable string Expandable ID of the Payment Intent this early fraud warning is for, optionally expanded.
The Early Fraud Warning object
{ "id": "issfr_1NnrwHBw2dPENLoi9lnhV3RQ", "object": "radar.early_fraud_warning", "actionable": true, "charge": "ch_1234", "created": 123456789, "fraud_type": "misc", "livemode": false}
Retrieve an early fraud warning
GET / v1 / radar / early_fraud_warnings /:id
Retrieves the details of an early fraud warning that has previously been created.
Please refer to the early fraud warning object reference for more details.
Parameters
No parameters.
Returns
Returns an EarlyFraudWarning if a valid identifier was provided.
Response
{ "id": "issfr_1NnrwHBw2dPENLoi9lnhV3RQ", "object": "radar.early_fraud_warning", "actionable": true, "charge": "ch_1234", "created": 123456789, "fraud_type": "misc", "livemode": false}
List all early fraud warnings
GET / v1 / radar / early_fraud_warnings
Returns a list of early fraud warnings.
Parameters
- charge string Only return early fraud warnings for the charge specified by this charge ID.
- created object Only return early fraud warnings that were created during the given date interval.
- payment _ intent string Only return early fraud warnings for charges that were created by the PaymentIntent specified by this PaymentIntent ID.
More parameters
- ending _ before string
- limit integer
- starting _ after string
Returns
A dictionary with a data property that contains an array of up to limit EarlyFraudWarnings, starting after EarlyFraudWarnings starting_after. Each entry in the array is a separate EarlyFraudWarning object. If no more EarlyFraudWarnings are available, the resulting array will be empty.
Response
