ResourceAlert object

Version unstable

Presents information or problems to merchants, with 1 or more actions that they can take. They can optionally have a specific icon and be dismissed by merchants.

Fields

  • Buttons in the alert that link to related information. For example, View risk assessment.

  • content (HTML!)

    Details about the alert.

  • dismissibleHandle (String)

    Unique identifier that appears when an alert is manually closed by the merchant. Most alerts cannot be manually closed.

  • Icon that displays with the alert.

  • Indication of how important the alert is.

  • title (String!)

    The name of the alert.

Types that return ResourceAlert

Version 2021-10 (Release candidate)

Presents information or problems to merchants, with 1 or more actions that they can take. They can optionally have a specific icon and be dismissed by merchants.

Fields

  • Buttons in the alert that link to related information. For example, View risk assessment.

  • content (HTML!)

    Details about the alert.

  • dismissibleHandle (String)

    Unique identifier that appears when an alert is manually closed by the merchant. Most alerts cannot be manually closed.

  • Icon that displays with the alert.

  • Indication of how important the alert is.

  • title (String!)

    The name of the alert.

Types that return ResourceAlert

Version 2021-07 (Latest)

Presents information or problems to merchants, with 1 or more actions that they can take. They can optionally have a specific icon and be dismissed by merchants.

On this page