# `MishkaPay.Payment.FraudWarning`
[🔗](https://github.com/mishka-group/mishka_pay/blob/v0.0.1/nofile#L1)

A card issuer's early warning that a payment looks like fraud (an early fraud warning,
`issfr_...` at Stripe Radar), often days before the buyer's bank opens a dispute. A guarded_struct
the provider fills in, read with `MishkaPay.fetch_fraud_warning/3` and
`MishkaPay.list_fraud_warnings/3`.

  * `:id`, `:payment_id`, `:charge_id`: the warning and the payment it is about.
  * `:fraud_type`: the issuer's kind of fraud, in the provider's words
    (`"made_with_stolen_card"`, `"unauthorized_use_of_card"`, `"card_never_received"`...).
  * `:actionable`: whether a refund can still head off a dispute: the payment is not refunded
    or disputed yet. Refunding an actionable warning's payment in full usually stops the
    dispute and its fee.
  * `:created_at`.

# `t`

```elixir
@type t() :: %MishkaPay.Payment.FraudWarning{
  actionable: boolean() | nil,
  charge_id: String.t() | nil,
  created_at: DateTime.t() | nil,
  fraud_type: String.t() | nil,
  id: String.t(),
  payment_id: String.t() | nil,
  provider: String.t()
}
```

The struct that `builder/1` returns.

| Field | Type | Required | Default | Description | Derives |
| --- | --- | --- | --- | --- | --- |
| `:provider` | `String.t()` | yes |  |  | `validate(not_nil_value, string)` |
| `:id` | `String.t()` | yes |  |  | `validate(not_nil_value, string, not_empty)` |
| `:payment_id` | `String.t()` \| `nil` | no |  |  | `validate(string)` |
| `:charge_id` | `String.t()` \| `nil` | no |  |  | `validate(string)` |
| `:fraud_type` | `String.t()` \| `nil` | no |  |  | `validate(string)` |
| `:actionable` | `boolean()` \| `nil` | no | `false` |  | `validate(boolean)` |
| `:created_at` | `DateTime.t()` \| `nil` | no |  |  | `validate(struct)` |

# `builder`

# `enforce_keys`

# `enforce_keys`

# `example`

A sample %MishkaPay.Payment.FraudWarning{} populated from defaults + type-based fallbacks.

# `keys`

# `keys`

---

*Consult [api-reference.md](api-reference.md) for complete listing*
