uss_sdk library
Dart/Flutter SDK for the Universal Subscription System payment APIs.
Classes
- ApiKeyConfigurationDetails
- Payment configuration details attached to a transaction.
- ApiKeySummary
- API key summary nested under transaction details.
- CreatePaymentTransactionRequest
-
Request body for
POST /api/transactionpayment/createtransactionpayment. - CreatePaymentTransactionResponse
- Response returned after creating a payment transaction.
-
PagedResult<
T> - Paginated API result wrapper.
- PaymentProviderSummary
- Payment provider summary nested under an API key.
- PaymentTransactionDetails
-
Full payment transaction details returned by
GET /api/paymenttransactions/gettransactiondetails/{id}. - PaymentTransactionListItem
- Summary row returned in a paginated payment transaction list.
- PaymentTransactionListRequest
-
Request body for
POST /api/paymenttransactions/gettransactionlist. - PaymentTransactionsService
- Payment transaction fetch API operations.
- PaymentTypeOptionDetails
- Payment type option details nested under transaction configuration.
- PaymentTypeSummary
- Payment type summary nested under a payment type option.
- ProjectApiKeyDetails
- Project API key details nested under a transaction configuration.
- ProjectPaymentWay
- A single payment way available for a project.
- ProjectPaymentWaysRequest
-
Request body for
POST /api/projectpaymentways/getprojectpaymentways. - ProjectPaymentWaysResponse
- Response listing all payment ways configured for a project.
- ProjectPaymentWaysService
- Project payment ways API operations.
- ProjectSummary
- Project summary nested under transaction details.
- SubscriptionDetails
- Subscription record returned when verification succeeds.
- SubscriptionsService
- Subscription verification API operations.
- SubscriptionSummary
- Subscription summary linked to a payment transaction.
- TransactionPaymentService
- Payment transaction creation API operations.
- UssClient
- Main entry point for the Universal Subscription System SDK.
- UssConfig
- Configuration for connecting to a Universal Subscription System API host.
- VerifySubscriptionRequest
-
Request body for
POST /api/subscriptions/checkingprojectsubscriptions. - VerifySubscriptionResponse
- Response returned when verifying a project subscription.
Exceptions / Errors
- UssEnvException
- Thrown when required USS environment variables are missing from dotenv.
- UssException
- Thrown when the Universal Subscription System API returns a non-success response.