Stripe.Radar reference

RadarValueList

Source: src/Stripe/RadarValueList.ts

A Stripe Radar Value List — a named collection of values (emails, IPs, card fingerprints, …) referenced from Radar rules. alias and itemType are immutable and changing them replaces the list. Name and metadata update in place. Destroy deletes the list and its items; a list referenced by a Radar rule cannot be deleted.

Radar custom lists may require Radar for Fraud Teams.

RadarValueList: Creating a Value List

Generated alias

const blocked = yield* Stripe.RadarValueList("blocked-emails", {
  itemType: "email",
});

Named list with alias

const blocked = yield* Stripe.RadarValueList("blocked-emails", {
  alias: "custom_email_blocklist",
  name: "Blocked emails",
  itemType: "email",
});

RadarValueList: Updating a Value List

const blocked = yield* Stripe.RadarValueList("blocked-emails", {
  alias: "custom_email_blocklist",
  name: "Blocked emails (updated)",
  itemType: "email",
  metadata: { team: "fraud" },
});

RadarValueList: Replacing a Value List

const blocked = yield* Stripe.RadarValueList("blocked", {
  alias: "custom_blocklist",
  itemType: "ip_address",
});

RadarValueListItem

Source: src/Stripe/RadarValueListItem.ts

A Stripe Radar Value List Item — one entry on a Radar value list used in Radar rules. Existence-only: there is nothing to update in place; changing valueList or value replaces the item. Destroy deletes it.

Value list items have no metadata of their own. Ownership for account-wide list() (nuke) is inferred from the parent value list’s Alchemy metadata.

RadarValueListItem: Adding an Item

const blocked = yield* Stripe.RadarValueList("blocked-emails", {
  alias: "blocked_emails",
  name: "Blocked emails",
  itemType: "email",
});
const item = yield* Stripe.RadarValueListItem("spammer", {
  valueList: blocked.id,
  value: "spammer@example.com",
});

RadarValueListItem: Replacing an Item

const item = yield* Stripe.RadarValueListItem("spammer", {
  valueList: blocked.id,
  value: "other@example.com",
});

RetrieveRadarValueList

Source: src/Stripe/RetrieveRadarValueList.ts

Retrieve a bound Stripe Radar Value List over HTTP.

RetrieveRadarValueList: Reading a Value List

const retrieve = yield* Stripe.RetrieveRadarValueList(blocklist);
const live = yield* retrieve();

RetrieveRadarValueListHttp

Source: src/Stripe/RetrieveRadarValueListHttp.ts Kind: Layer · Provides: Stripe.RetrieveRadarValueList

HTTP implementation of RetrieveRadarValueList.

RetrieveRadarValueListItem

Source: src/Stripe/RetrieveRadarValueListItem.ts

Retrieve a bound Stripe Radar Value List Item over HTTP.

RetrieveRadarValueListItem: Reading a Value List Item

const retrieve = yield* Stripe.RetrieveRadarValueListItem(item);
const live = yield* retrieve();

RetrieveRadarValueListItemHttp

Source: src/Stripe/RetrieveRadarValueListItemHttp.ts Kind: Layer · Provides: Stripe.RetrieveRadarValueListItem

HTTP implementation of RetrieveRadarValueListItem.