Skip to content

PaymentStatusBadge

stable

Payment lifecycle status badge covering the full payment state machine from pending through settlement — distinct from StatusBadge (compliance), with temporal/agency color semantics for in-flight vs. blocked payments

import { PaymentStatusBadge } from "@nodus/design-system/finance"
Loading demo…

Props

statusrequired
Type 'pending' | 'authorised' | 'sent' | 'clearing' | 'settled' | 'failed' | 'recalled' | 'on_hold' | 'cancelled'Default

Payment lifecycle status

label
Type stringDefault

Override display label (defaults to status name)

size
Type 'compact' | 'default'Default default

compact = 11px pill, default = 13px pill

style
Type CSSPropertiesDefault

Style override

Accessibility

  • Renders role="status" with an aria-label announcing the payment status.
  • Status is never color-only: each badge pairs its dot and border color with an uppercase text label.
  • The leading dot is aria-hidden decoration; screen readers get the label text.
pendingauthorisedsentclearingsettledfailedrecalledon_holdcancelledcompactdefaultsemantictypefin
MobileWorks As-Is

Inline pill; use size='compact' in dense mobile rows.

Design Rationale

This component was designed to express:

Explore Related

Was this helpful?