omise_dart #

omise_dart is a Dart package for integrating Omise's payment API. It provides a simple and intuitive interface to handle transactions, charge creation, and other payment-related activities in Dart and Flutter applications.

Features #

• Easily interact with Omise's API in Dart and Flutter.
• Support for tokenization.
• Built-in error handling for common API issues.

Getting Started #

To use the package, first add it to your project by including the following in your pubspec.yaml:

dependencies:
  omise_dart: ^0.2.0

Then, run:

flutter pub get

Or if you are working with a Dart-only project:

dart pub get

You will also need an Omise account and your public/private keys, which you can obtain by signing up at Omise Dashboard.

Usage #

Here's a quick example of how to create a token using omise_dart:

import 'package:omise_dart/omise_dart.dart';

void main() async {
  // Initialize the Omise API with your public and secret keys
  final omiseApi = OmiseApi(
    publicKey:
        "p_key", // Replace with your actual public key
    secretKey:
        "s_key", // Replace with your actual secret key
    enableDebug: true, // Enables debug logging
  );

  // Create a token using card details
  final createTokenRequest = CreateTokenRequest(
    name: "Name",
    number: "4242424242424242", // Example test card number
    expirationMonth: "09", // Card expiry month
    expirationYear: "27", // Card expiry year
  );

  // Call the Omise API to create a token
  final token = await omiseApi.tokens.create(createTokenRequest);
}

For more detailed examples, including how to get account capabilities, check the example folder.

Example #

In the example/ folder, you will find more comprehensive examples showing various use cases, such as:

• Creating a token
• Fetching a token
• Fetching capability object.

To run the examples:

1. Clone the repository.
2. Run the Dart example using:

dart run example/omise_dart_example.dart

Documentation #

Complete API documentation is available at pub.flutter-io.cn documentation.

For the Omise API documentation, refer to the official Omise API docs.

Contributing #

We welcome contributions! Please follow these steps to contribute:

1. Fork this repository.
2. Create a feature branch: git checkout -b my-feature.
3. Commit your changes: git commit -m 'Add some feature'.
4. Push to the branch: git push origin my-feature.
5. Open a pull request.

For bugs or feature requests, please create an issue.

License #

This project is licensed under the MIT License. See the LICENSE file for details.