flutter_notchpay library
A secure, complete, and beautiful Flutter SDK for NotchPay.
Import this single file to get the NotchPay facade, every request/ response model, and the checkout theming types.
Classes
- NotchPay
- The entry point of the flutter_notchpay SDK.
- NotchPayAddress
- A postal address, used for a NotchPayCustomer's billing or shipping information.
- NotchPayBalance
- The available and pending balance of a NotchPay account for a given currency.
- NotchPayBalanceService
- Read a NotchPay account's balance.
- NotchPayCardUtils
- Client-side helpers to validate a bank card before submitting it, improving the user experience by catching typos instantly instead of waiting for a server round trip.
- NotchPayChannel
-
A payment channel supported by NotchPay (e.g. MTN Mobile Money, Orange
Money, or Card), as returned by
GET /channels. - NotchPayCheckoutCustomer
- Describes the customer information to attach to a checkout.
- NotchPayCheckoutRequest
- Everything needed to start a checkout with NotchPay.checkout.
- NotchPayCheckoutResult
- The result returned by NotchPay.checkout once the checkout sheet is dismissed.
- NotchPayClient
- Low level HTTP client for the NotchPay REST API.
- NotchPayCountry
-
A country supported by NotchPay, as returned by
GET /countries. - NotchPayCurrency
-
A currency supported by NotchPay, as returned by
GET /currencies. - NotchPayCurrencyFormatter
- Formats amounts for display in the checkout UI.
- NotchPayCustomer
-
A NotchPay customer (
cus_...). - NotchPayCustomerService
- Manage NotchPay customers.
- NotchPayIdentity
- The result of an identity lookup or validation for a Mobile Money or bank account number.
- NotchPayIdentityService
- Look up and validate Mobile Money / bank account identities.
- NotchPayLocalizations
- User-facing strings shown by the checkout sheet.
- NotchPayLocalizationsProvider
- Makes an explicit NotchPayLocalizations override available to the checkout sheet, taking priority over the ambient Locale.
- NotchPayPayment
-
A NotchPay transaction (
trx.xxx), as created byPOST /payments. - NotchPayPaymentMethod
-
A saved payment method on a NotchPay account, as returned by
GET /payment_methods. - NotchPayPaymentMethodService
- Manage saved payment methods.
- NotchPayPaymentService
- Create and manage NotchPay transactions.
- NotchPayPhoneUtils
- Utilities to recognize the Mobile Money operator behind a phone number, so the checkout UI can highlight the right channel as the customer types.
- NotchPayRecipient
-
A transfer recipient / beneficiary (
bn.xxx) saved on a NotchPay account. - NotchPayRecipientService
- Manage transfer recipients / beneficiaries.
- NotchPayRefund
- A refund issued for a NotchPay transaction.
- NotchPayRefundService
- Read refunds issued for NotchPay transactions.
- NotchPayResourceService
- Read-only reference data: available payment channels, currencies and countries.
- NotchPaySyncAccount
-
A NotchPay Connect sub-account (
acc.xxx), used to grant a platform scoped access to a merchant's account. - NotchPaySyncService
- Manage NotchPay Connect sub-accounts (platform / marketplace use cases).
- NotchPayTheme
- Makes the resolved NotchPayThemeData available to every widget under the checkout sheet.
- NotchPayThemeData
-
Visual configuration for the checkout sheet shown by
NotchPay.checkout. - NotchPayTransfer
-
A payout / transfer (
trf.xxx) sent from a NotchPay account to a recipient. - NotchPayTransferService
- Send payouts to recipients.
Enums
- NotchPayCardBrand
- Card networks recognized by NotchPayCardUtils.detectBrand.
- NotchPayChannelKind
- The broad family a NotchPayChannel belongs to.
- NotchPayCheckoutStatus
- The final outcome of a checkout started with NotchPay.checkout.
- NotchPayEnvironment
- Which NotchPay environment a key belongs to.
- NotchPayPaymentStatus
- The lifecycle status of a NotchPay transaction.
Exceptions / Errors
- NotchPayApiException
- Thrown when the NotchPay API responds with an error payload.
- NotchPayCancelledException
- Thrown when a payment could not be completed on the client side, for example when the user cancels the checkout sheet.
- NotchPayConfigurationException
- Thrown when the SDK is used incorrectly (e.g. missing configuration).
- NotchPayException
- Base class for every error thrown by this package.
- NotchPayNetworkException
- Thrown when the device has no usable network connection or the request could not reach the NotchPay servers.