Skip to content

Commit 4f46db0

Browse files
committed
Add documentation for bank apps
1 parent 61520dd commit 4f46db0

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,26 @@ On Android, the library uses intent APIs. Some bank apps can be opened directly
9595
### iOS
9696
On iOS, the library generates the QR code and opens a sheet to share the QR code to another app. The user can then pick the bank app that can decode the QR code and pre-fill a payment order. If the bank app does not support sharing images, the user can save the generated QR code in their photo library and open it within the bank app for the same purpose.
9797

98+
99+
## For bank apps: How to support this library?
100+
101+
### Android
102+
It's preferred to accept Intent with SPAYD payload:
103+
104+
```xml
105+
<receiver android:name=".YourSpaydReceiver" android:exported="true">
106+
<intent-filter>
107+
<action android:name="android.intent.action.VIEW" />
108+
<data android:mimeType="application/x-shortpaymentdescriptor" />
109+
</intent-filter>
110+
</receiver>
111+
```
112+
113+
In your receiver, get SPAYD payload via `intent.getStringExtra("spayd")`.
114+
115+
### iOS
116+
Support accepting an image with QR code containing SPAYD.
117+
98118
## Future plans & contributing
99119

100120
We would like to add support to more banks and markets, such as banks supporting the [EPC code format](https://en.wikipedia.org/wiki/EPC_QR_code).

0 commit comments

Comments
 (0)