square/in-app-payments-flutter-plugin

Flutter plugin for In-App Payments SDK

build Pub

The Flutter plugin for Square In-App Payments SDK is a wrapper for the native Android and iOS SDKs and supports the following native In-App Payments SDK versions:

• iOS: 1.6.7
• Android: 1.6.9

Additional documentation

In addition to this README, the following is available in the flutter plugin GitHub repo:

• Getting started guide
• Enable Apple Pay guide
• Enable Google Pay guide
• Technical reference
• Troubleshooting guide
• doc - Root directory for all documentation.
• example - Root directory of the Flutter sample app (with walkthrough).
• Getting started with the example app
• Override the Native In-App Payments SDK Dependency Version

Build requirements

Flutter

• Flutter version 3.44 or higher (required for the Swift Package Manager iOS integration)
• Dart version 3.12 or higher

Android

• Android minSdkVersion is API 28 (Android 9).
• Android Target SDK version: API 36 (Android 16).
• Android SDK build tools: 26.0.3
• Android Gradle Plugin: the plugin inherits your app's version (the plugin build uses the Gradle Kotlin DSL).
• Support library: 27.1.1
• Google Play Services: 16.0.1
• Google APIs Intel x86 Atom_64 System Image

iOS

• Xcode version: 16 or greater (required for Swift Package Manager).
• iOS Base SDK: 14 or greater.
• Deployment target: iOS 14.0 or greater.
• iOS integration uses Swift Package Manager (SPM), which Flutter 3.44 enables by default. CocoaPods is still supported and needs no Podfile changes.
• This plugin will work on Mac with Intel processor and Apple silicon chips.

In-App Payments SDK requirements and limitations

• In-App Payments SDK cannot issue refunds. Refunds can be issued programmatically using the Refunds API or manually in the Square Dashboard.

Sample applications

• Quick start flutter app: You can learn how the In-App-Payments Flutter plugin is used by getting started with the example app, a quick-start Flutter app that lets you take a payment after completing 6 set up steps.
• Quick start backend app: The In-App Payments Server Quickstart takes the nonce created by the flutter app and uses it to create a payment credited to your Square account. Use this backend sample to quickly create a complete payment flow.

License

Copyright 2019 Square Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.