ecommpay_flutter_plugin 1.0.3 copy "ecommpay_flutter_plugin: ^1.0.3" to clipboard
ecommpay_flutter_plugin: ^1.0.3 copied to clipboard

Flutter plugin of Mobile SDK UI is a software development kit that can be used to integrate Android applications with the Ecommpay payment platform.

MSDK UI Flutter plugin #

Use #

Opening payment form #

To open the payment form:

  1. Create the EcmpPaymentInfo object.

This object must contain the following required parameters:

  • projectId (int) — a project identifier assigned by Ecommpay
  • paymentId (String) — a payment identifier unique within the project
  • paymentCurrency (String) — the payment currency code in the ISO 4217 alpha-3 format
  • paymentAmount (int) — the payment amount in the smallest currency units
  • customerId (String) — a customer's identifier within the project
  • signature (String) — a request signature generated after all required parameters have been specified
final paymentInfo = EcmpPaymentInfo(
            projectId: 12312,
            paymentId: "paymentId",
            paymentAmount: 100,
            paymentCurrency: "USD",
          );
  1. Sign the parameters contained in the EcmpPaymentInfo object.
final paramsForSignature = await ecmpPlugin.getParamsForSignature(paymentInfo);
paymentInfo.signature = "CALCULATED_SIGNATURE_FROM_YOUR_BACKEND";
  1. Create the EcmpPaymentOptions object that contains the required parameter actionType (enum) with the value specifying the required operation type:
  • EcmpActionType.sale
  • EcmpActionType.auth
  • EcmpActionType.verify
  • EcmpActionType.tokenize In addition to the required EcmpPaymentInfo object and the actionType parameter, the following example contains several additional parameters including the EcmpAdditionalFields object with data specified in the fields that are used for collecting customer information.
 final paymentOptions = EcmpPaymentOptions(
    actionType: EcmpActionType.Sale,
    paymentInfo: paymentInfo,
    isDarkTheme: false,
    //if need use real service- set EcmpMockModeType.disabled
    mockModeType: EcmpMockModeType.success,
    //set display mode if need
    screenDisplayModes: [
      EcmpScreenDisplayMode.hideDeclineFinalScreen
    ],
    //set additional fields if need
    additionalFields: [
      EcmpAdditionalField(type: "email", value: "mail@mail.com"),
      EcmpAdditionalField(type: "first_name", value: "firstName"),
    ],
    //set recipient info if need
    recipientInfo: EcmpRecipientInfo(),
    //set recurrent info if need
    recurrentData: EcmpRecurrentData(),
);
  1. Create the EcmpPlugin object.
final ecmpPlugin = EcmpPlugin();
  1. Open the payment form and handle result.
final response = await ecmpPlugin.sdkRun(paymentOptions);
1
likes
140
pub points
0%
popularity

Publisher

unverified uploader

Flutter plugin of Mobile SDK UI is a software development kit that can be used to integrate Android applications with the Ecommpay payment platform.

Repository (GitHub)
View/report issues

Documentation

API reference

License

MIT (LICENSE)

Dependencies

flutter, json_annotation, plugin_platform_interface

More

Packages that depend on ecommpay_flutter_plugin