Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yazeedalkhalaf/hyperpay
A Flutter plugin that wraps the official SDK of HyperPay.
https://github.com/yazeedalkhalaf/hyperpay
android flutter flutter-plugin hyperpay hyperpay-sdk ios
Last synced: 22 days ago
JSON representation
A Flutter plugin that wraps the official SDK of HyperPay.
- Host: GitHub
- URL: https://github.com/yazeedalkhalaf/hyperpay
- Owner: YazeedAlKhalaf
- License: mit
- Created: 2021-03-10T09:50:40.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-08-21T13:09:09.000Z (over 3 years ago)
- Last Synced: 2024-10-27T06:26:46.963Z (2 months ago)
- Topics: android, flutter, flutter-plugin, hyperpay, hyperpay-sdk, ios
- Language: Objective-C
- Homepage:
- Size: 6.12 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# hyperpay
> this plugin is not official.
This plugin is a wrapper around the official SDK of [HyperPay](https://www.hyperpay.com/).
## 🔥 Features:
- 😌 Easy to setup!
- 🚀 Uses the official SDK under the hood!
- 👾 Ability to create custom UI!
- 🧪 Fully tested!
- 🔋 Batteries included!
## 💻 Server Setup
Follow the official guide to setup the two endpoints:
1. For getting a `checkoutId`.
2. For getting the status of a payment using its `checkoutId`.
Official Guide: [https://wordpresshyperpay.docs.oppwa.com/tutorials/mobile-sdk/integration/server](https://wordpresshyperpay.docs.oppwa.com/tutorials/mobile-sdk/integration/server)
## 🍎 iOS Setup
This will guide your through the process of implementing the iOS part that is needed to make the plugin function correctly.
> If you face any problems, look at the example app and how it is implemented. 😉
### Requirements:
- Xcode 12 and iOS 14 SDK
- iOS 10.0+ deployment target
### Steps:
1. Register a custom URL scheme:
1. In Xcode, click on your project in the Project Navigator and navigate to **App Target > Info > URL Types**
2. Click [+] to **add a new URL type**
3. Under URL Schemes, **enter your app switch return URL scheme**. This scheme must start with your app's Bundle ID. For example, if the app bundle ID is `com.companyname.appname`, then your URL scheme could be `com.companyname.appname.payments`.
4. Add scheme URL to a whitelist in your app's Info.plist:
```xml
LSApplicationQueriesSchemes
com.companyname.appname.payments
```
2. Edit your Podfile that is located under your project's iOS folder:
1. Uncomment the line that looks something like this:
```ruby
# Before
# platform :ios, '9.0'
# After
platform :ios, '10.0'
```
2. Add this code code snippet to your Podfile:
```ruby
post_install do |installer|
installer.pods_project.targets.each do |target|
flutter_additional_ios_build_settings(target)
# from here.
target.build_configurations.each do |config|
config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = '10.0'
end
# to here.
end
end
```
This makes sure that all packages and plugins you use have a deployment target of `10.0`.
You Podfile should look similar to:
```ruby
# Uncomment this line to define a global platform for your project
platform :ios, '10.0'
# some code here
post_install do |installer|
installer.pods_project.targets.each do |target|
flutter_additional_ios_build_settings(target)
target.build_configurations.each do |config|
config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = '10.0'
end
end
end
```
## 🤖 Android Setup
not implemented yet.
## 🎯 How to use?
not implemented yet.
## 🚨 Error Handling
All our error codes start with `hyperpay-` prefix.
To handle errors you have to catch `PlatformException`.
| Error Code | Description |
| ------------------------------------ | ------------------------------------------------------------------------------ |
| `hyperpay-method-not-found` | This indicates that the method you invoked through the channel does not exist. |
| `hyperpay-transaction-error` | This indicates that the transaction has an error. |
| `hyperpay-transaction-failure` | This indicates that the transaction failed for unknown reason. |
| `hyperpay-card-payment-params-error` | This indicated that the card payment params has an error. |