PaymentSheet class
A pre-built bottom sheet UI for handling M-Pesa payments.
Example:
final result = await PaymentSheet.show(
context: context,
micropay: micropayClient,
amount: 500,
currency: 'KES',
description: 'Premium Subscription',
);
if (result != null && result.isSucceeded) {
print('Payment successful!');
}
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- PaymentSheet
Constructors
-
PaymentSheet({Key? key, required Micropay micropay, required int amount, String currency = 'KES', String? description, Map<
String, dynamic> ? metadata, String? idempotencyKey, ValueChanged<PaymentIntentStatus> ? onStatusChange, PaymentSheetTheme? theme}) -
const
Properties
- amount → int
-
The amount to charge in smallest currency unit.
final
- currency → String
-
The currency code (default: 'KES').
final
- description → String?
-
Optional description for the payment.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- idempotencyKey → String?
-
Optional idempotency key.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
-
metadata
→ Map<
String, dynamic> ? -
Optional metadata to attach to the payment.
final
- micropay → Micropay
-
The Micropay client instance.
final
-
onStatusChange
→ ValueChanged<
PaymentIntentStatus> ? -
Called when the payment status changes.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- theme → PaymentSheetTheme?
-
Custom theme for the payment sheet.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< PaymentSheet> -
Creates the mutable state for this widget at a given location in the tree.
override
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of DiagnosticsNode objects describing this node's
children.
inherited
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDiagnosticsNode(
{String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode -
Returns a debug representation of the object that is used by debugging
tools and by DiagnosticsNode.toStringDeep.
inherited
-
toString(
{DiagnosticLevel minLevel = DiagnosticLevel.info}) → String -
A string representation of this object.
inherited
-
toStringDeep(
{String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String -
Returns a string representation of this node and its descendants.
inherited
-
toStringShallow(
{String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String -
Returns a one-line detailed description of the object.
inherited
-
toStringShort(
) → String -
A short, textual description of this widget.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
show(
{required BuildContext context, required Micropay micropay, required int amount, String currency = 'KES', String? description, Map< String, dynamic> ? metadata, String? idempotencyKey, ValueChanged<PaymentIntentStatus> ? onStatusChange, PaymentSheetTheme? theme}) → Future<PaymentIntent?> - Shows the payment sheet and returns the final payment intent.