react-native-przelewy24-payment
v0.3.2
Published
Przelewy24 (PayPro S.A.) payments implementation for React Native
Downloads
176
Readme
react-native-przelewy24-payment
Based on official docs and examples:
Getting started
Installation
$ npm i --save react-native-przelewy24-payment
or
$ yarn add react-native-przelewy24-payment
Linking (for React Native <= 0.59 only, React Native >= 0.60 skip this as auto-linking should work)
$ react-native link react-native-przelewy24-payment
Extra stepps for iOS
1. Adding P24 library files
Library files (libP24.a
(or libP24-bitcode.a
for projects with bitcode enabled) and P24.h
) should be added to the project. In order to add them, perform the following:
- download files from official repo and save to disk (outside of React Native project)
- in Xcode select „File → Add Files To”
- select files from downloaded folder
- select option „Copy items into destination folder (if needed)”
- select option „Create groups for any added folders”
- in the field „Add to targets” select all the elements to which a library can be added
Make sure that the Target settings have been updated properly. File libP24.a
(or libP24-bitcode.a
) should be added automatically in the field „Link Binary With Libraries”, bookmark „Build Phases”. In order to check that, perform the following:
- select project in “Project Navigator”
- select the Target in which the library is to be used
- select bookmark “Build Phases”
- select section “Link Binary With Libraries”
- if file
libP24.a
(orlibP24-bitcode.a
) is not on the list, drag it from the “Project Navigator” window - repeat the steps above for all the Targets in which a library is to be used
2. CocoaPods
Finally, install CocoaPods by running command:
$ cd ios && pod install && cd ../
Extra steps for Android
1. Adding dependencies
Add the line to the top of the android/app/build.gradle
file:
apply from: 'https://mobile.przelewy24.pl/p24lib.gradle'
Next, at repositories
section, add value p24()
:
repositories {
// other repositories
p24()
}
At the end, at dependencies
section, add entry implementation "pl.przelewy24:p24lib:+"
:
dependencies {
implementation "pl.przelewy24:p24lib:+"
}
Since the library uses the AndroidX library, the following dependency must be added:
implementation 'androidx.appcompat:appcompat:+'
When using SafetyNet you need add:
implementation 'com.google.android.gms:play-services-wallet:16.0.1'
When integrating with GooglePlay you need add:
implementation 'com.google.android.gms:play-services-safetynet:+'
Below is an example of a „dependencies” section:
dependencies {
// other dependencies
implementation "pl.przelewy24:p24lib:+"
implementation 'com.google.android.gms:play-services-wallet:16.0.1' // necessary if google pay used
implementation 'com.google.android.gms:play-services-safetynet:+' // necessary if safetynet function enabled
implementation 'androidx.appcompat:appcompat:1.1.0'
}
3. Proguard
If the target project don't use GooglePlay, the following entry should be added to the proguard file:
-dontwarn com.google.android.gms.wallet.**
4. Definition of AndroidManifest file
Add the following to android/app/src/main/AndroidManifest.xml
file:
<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
Next, in application
section, add TransferActivity
:
<activity android:name="pl.przelewy24.p24lib.transfer.TransferActivity"
android:configChanges="orientation|keyboard|keyboardHidden|screenSize"
android:theme="@style/Theme.AppCompat.Light.DarkActionBar"/>
All Activities in the library draw on the AppCompatActivity, which is why „Theme.AppCompat.*” group styles as well as derivative styles should be used
In the case of default Activity settings, the WebView will get reloaded during the rotation of the library display screen, which may cause a return from the bank’s website to the list of payment forms and render further transaction processing impossible. In order to prevent the reloading of the library window, the following parameter must be set:
android:configChanges="orientation|keyboard|keyboardHidden|screenSize"
Below is an example of an android/app/src/main/AndroidManifext.xml
file:
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
package="pl.przelewy24.p24example"
android:versionCode="1"
android:versionName="1.0.0">
<!--other permissions-->
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<application >
<!--other activities-->
<activity android:name="pl.przelewy24.p24lib.transfer.TransferActivity"
android:configChanges="keyboardHidden|orientation|keyboard|screenSize"
android:theme="@style/Theme.AppCompat.Light.DarkActionBar"/>
</application>
</manifest>
Usage
import Przelewy24Payment from 'react-native-przelewy24-payment';
// Pre-defined constants you may need
const P24_CHANNEL_CARDS = 1;
const P24_CHANNEL_TRANSFERS = 2;
const P24_CHANNEL_TRADITIONAL_TRANSFERS = 4;
const P24_CHANNEL_NA = 8;
const P24_CHANNEL_24_7 = 16;
const P24_CHANNEL_PREPAYMENT = 32;
// Define configuration
const config = {
merchant_id: '[YOUR P24 MERCHANT ID]',
crc: '[YOUR P24 CRC]',
ssl_pinning: false,
is_sandbox: true,
sandbox_crc: '[YOUR P24 CRC FOR SANDBOX]', // required if you want to test in sandbox mode
}
// Get instance
const p24 = new Przelewy24Payment(config);
// Define your callbacks for successfull and cancelled transactions and if error occurs
const p24_callbacks = {
success: (msg) => console.info(msg),
cancel: (msg) => console.info(msg),
error: (error) => console.warn(error),
}
1. Make direct transaction call (trnDirect)
// Define request parameters (in real world you will get it ex. from user order)
const trn_params = {
// required parameters
sessionId: '[SOME UNIQUE SESSION ID AS STRING]',
amount: 2500, // amount 2500 = $25.00
currency: 'USD',
description: 'Order number XYZ',
email: '[email protected]',
country: 'US',
// some optional client data
client: 'John Smith',
address: 'Street with house/flat number',
zip: '00-000',
city: 'New York',
phone: '+1 000 111 2222',
language: 'en',
// some optional other parameters
urlStatus: 'https://yourdomain.com/p24_status_return.php',
timeLimit: 15, // time in minutes
}
// If you need disable all methods except cards
let cardsOnly = true;
if (cardsOnly) {
trn_data.channel = P24_CHANNEL_CARDS;
// Or you can set it to another one
}
// Make transaction call
p24.startTrnDirect(trn_params, p24_callbacks);
You can read full documentation for request parameters here.
2. trnRequest transaction call
// TODO: test and write better documentation
p24.startTrnRequest(token, p24_callbacks);
3. Express transaction call
// TODO: test and write better documentation
p24.startTrnExpress(url, p24_callbacks);
4. Passage 2.0 transaction call
// TODO: test and write better documentation
// trn_params are the same as in startTrnDirect
// Items: array of objects
const items = [];
items.push({
name: 'Item #1',
description: 'Description #1',
number: 1,
quantity: 3,
price: 1000,
targetAmount: 3000, // item.price * item.quantity
targetPosId: '[TARGET POS ID]',
});
// items.push(/* second item */);
p24.startTrnPassage(trn_params, items, p24_callbacks);
5. Apple Pay
// Check if ApplePay is available
if (Przelewy24Payment.canMakeApplePayPayments()) {
try {
// Request data
const ap_request = {
appleMerchantId: '[YOUR APPLE PAY MERCHANT ID]',
amount: 2500, // amount 2500 = $25.00,
currency: 'USD',
description: '[BUSINESS NAME]', // see Apple Pay guidelines: https://developer.apple.com/design/human-interface-guidelines/apple-pay/overview/checkout-and-payment/
};
// Init Apple Pay payment
p24.startApplePay(ap_request, p24_callbacks, processPaymentData);
} catch (e) {
console.warn(e);
}
} else {
console.warn('Cannot make Apple Pay payments');
}
async function processPaymentData(payment_data) {
// Your own logic to process payment data to the server
console.log(payment_data);
}
6. Google Pay
// TODO: Paste from P24 doc and/or own JS code
Quick Example Screen
import React from 'react';
import Example from 'react-native-przelewy24-payment/Example';
export default class P24ExampleComponent extends React.Component
{
render() {
const config = {
merchantId: '[YOUR P24 MERCHANT ID]',
crc: '[YOUR P24 CRC]',
sslPinningEnabled: false,
isSandbox: true,
sandboxCrc: '[YOUR P24 CRC FOR SANDBOX]', // required if you want to test in sandbox mode
}
return (
<Example
merchantId={config.merchantId}
crc={config.crc}
sslPinning={config.sslPinningEnabled}
isSandbox={config.isSandbox}
sandboxCrc={config.sandboxCrc}
/>
)
}
}
TODO
- [x] Android implementation
- [x] Android testting
- [ ] Transfer trnRequest tests
- [ ] Transfer express tests
- [ ] Transfer passage tests
- [ ] [iOS] Change UIModalPresentationStyle to UIModalPresentationFullScreen
- [ ] [Android] Google Pay implementation
- [ ] Update README