Webview Payment integration example

Summary

The aim of this repository is to explain how webview mobile payment integration can be done easily.

How it works
Getting started
Additional feature
Technology
Troubleshooting
Copyright and license

How it works

To be able to do some payments, two elements are required:

A contract with your Payment service provider.
A mobile app with a webview mobile payment integration: this integration is explained with this repository.
A merchant server that executes payments transactions with Payment servers: merchant server demonstration.

Getting started

Two quick start options are available: executes this sample or integrates into your own application.

Execute this sample

See merchant server repo, https://github.com/lyra/webview-payment-sparkjava-integration-sample. Follow steps of getting started chapter and run your server.
Clone the repo, git clone https://github.com/lyra/webview-payment-ios-integration-sample.git.
Open the application with Xcode.
In PaymentProvider.swift class, modify the SERVER_URL value according your merchant server url.
Run the application.

Integration in an existing application

See merchant server repo, https://github.com/lyra/webview-payment-sparkjava-integration-sample. Follow steps of getting started chapter and run your server
Download PaymentProvider.swift and PaymentViewController.swift files, and import it your Xcode project.
In PaymentProvider.swift class, modify the SERVER_URL value according your merchant server url.

Make the class from which the payment will be launched conforms the PaymentProviderDelegate protocol. The didPaymentServiceFinish method tells the delegate that the payment is finish. An optional NSError value is used to indicate that the payment has not been made and the corresponding error message. Otherwise, the payment has been successfully completed.

extension ViewController: PaymentProviderDelegate {
    /// Tells the delegate that the payment is finish.
    ///
    /// - Parameter error: An optional NSError value indicating that the payment has not been made and the corresponding error message. Otherwise, the payment has been successfully completed.
    func didPaymentServiceFinish(error: NSError?) {
       
        //Through this function your application will be notified once the payment process has concluded. Implement here the behavior to follow for your application
    }
}

Call the execute method to trigger the payment process. For this:

5.1. Create PaymentInformation object with required information for payment process:
- email: optional, email
- amount: mandatory, the related amount
- mode: mandatory, TEST or PRODUCTION (your targeted environment)
- lang: mandatory, the language in which you want the payment pages to be displayed.
- cardType: optional, can be CB, VISA, MASTERCARD, so on. If no provided, any card type will be proposed
- currency: mandatory, currency code, https://en.wikipedia.org/wiki/ISO_4217
```
let paymentInfo = PaymentInformation(email: txtEmail.text!, amount: txtAmount.text!, mode: "TEST", lang: language, cardType: selectedCardType!, currency:"978")
```
5.2. Create a PaymentProvider instance.
```
paymentProvider = PaymentProvider(paymentInfo: paymentInfo)
```
5.3. Set PaymentProviderDelegate. The class must implement the protocol PaymentProviderDelegate to receive notifications of the completion of the payment process.
```
paymentProvider?.paymentProviderDelegate = self
```
5.4. Calling the execute method to trigger the payment process.
```
paymentProvider?.execute(contextView: self)
```

Additional feature

Also, an additional feature can be used:

Credit card scanning by mobile camera

In the branch below, you can see a demonstration of credit card scanning by mobile camera based on Card.io SDK

https://github.com/lyra/webview-payment-ios-integration-sample/tree/card_scanning/

Please, notice that the library used for this additional feature is not developped by our company. We do do not guarantee and are not responsible for the quality of this external library. Moreover, be aware that the use of this librairy is not PCI-DSS compliant.

Technology

Tested in Xcode 10.0, written in Swift 4, webViewSample application require iOS 9.0 or superior.

Troubleshooting

The following errors can occurred:

Error	Code	Cause
ERROR_UNKNOW	1	An unknown error has occurred. This error can occur when the url of merchant server is incorrect. Check that your url is syntactically correct.
ERROR_TIMEOUT	2	A timeout error has occurred. This error can occur when your mobile is not able to communicate with your merchant server. Check that your server is up and is reachable.
ERROR_NO_CONNECTION	3	A not connection error has occurred. This error can occur when your mobile is not connected to Internet (by Wifi or by mobile network). Check your mobile connection
ERROR_SERVER	4	A server error has occurred. This error can occur when your merchant server returns an invalid data. Check that your payment data sent are correct.
ERROR_PAYMENT_CANCELATION	5	A payment cancelled error has occurred. This error can occur when user cancels he payment process.
ERROR_PAYMENT_REFUSED	6	A payment refused error has occurred. This error can occur when payment is refused. Check the credit card used.

Copyright and license

The MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

lyra/webview-payment-ios-integration-sample