Skip to content

Commit 00aa7b1

Browse files
Rename integration flags
1 parent c05da49 commit 00aa7b1

2 files changed

Lines changed: 17 additions & 10 deletions

File tree

docs/digital-wallets/intro.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,23 @@ These payment options offer a seamless and convenient way for your customers to
1515
### Mobile integration:
1616

1717
- If you are redirecting to Topper through the user's browser, no extra configuration is necessary.
18-
- When Topper is embed with a `WebView`, ensure setting `is_android_app=1` or `is_ios_app=1` as a query parameter in the URL.
18+
- When Topper is embed with a `WebView`, ensure setting `is_android_webview=1` or `is_ios_webview=1` as a query parameter in the URL.
1919
- When Topper is opened using a `Safari View Controller`, ensure setting `is_safari_view_controller=1` as a query parameter in the URL.
20+
21+
### Deprecation Notice
22+
23+
The parameters `is_ios_app` and `is_android_app` have been **renamed** to `is_ios_webview` and `is_android_webview`, respectively.
24+
25+
The old parameters are still supported for backward compatibility; however, they are **deprecated** and will be removed in a future release.
26+
It is recommended to update any existing implementations to use the new parameter names.
2027

2128
**Example URLs:**
22-
- Android: `https://app.topperpay.com/?bt=<bootstrap token>&is_android_app=1`
23-
- iOS: `https://app.topperpay.com/?bt=<bootstrap token>&is_ios_app=1`
29+
- Android: `https://app.topperpay.com/?bt=<bootstrap token>&is_android_webview=1`
30+
- iOS: `https://app.topperpay.com/?bt=<bootstrap token>&is_ios_webview=1`
2431
- Safari View Controller: `https://app.topperpay.com/?bt=<bootstrap token>&is_safari_view_controller=1`
2532

2633
**Using the [Web SDK](../web-sdk.md):**
2734

28-
- Android: `topper.initialize({ bootstrapToken: <bootstrap token>, { is_android_app: true } });`
29-
- iOS: `topper.initialize({ bootstrapToken: <bootstrap token>, { is_ios_app: true } });`
35+
- Android: `topper.initialize({ bootstrapToken: <bootstrap token>, { is_android_webview: true } });`
36+
- iOS: `topper.initialize({ bootstrapToken: <bootstrap token>, { is_ios_webview: true } });`
3037
- Safari View Controller: `topper.initialize({ bootstrapToken: <bootstrap token>, { is_safari_view_controller: true } });`

docs/single-sign-on.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,14 +41,14 @@ This creates a better experience for users because they can use their existing c
4141
**Notes:**
4242

4343
- If you are redirecting to Topper through the user's browser, no extra configuration is necessary.
44-
- When Topper is embed with a `WebView`, ensure setting `is_android_app=1` or `is_ios_app=1` as a query parameter in the URL.
44+
- When Topper is embed with a `WebView`, ensure setting `is_android_webview=1` or `is_ios_webview=1` as a query parameter in the URL.
4545

4646
**Example URLs:**
4747

48-
- Android: `https://app.topperpay.com/?bt=<bootstrap token>&is_android_app=1`
49-
- iOS: `https://app.topperpay.com/?bt=<bootstrap token>&is_ios_app=1`
48+
- Android: `https://app.topperpay.com/?bt=<bootstrap token>&is_android_webview=1`
49+
- iOS: `https://app.topperpay.com/?bt=<bootstrap token>&is_ios_webview=1`
5050

5151
**Using the [Web SDK](./web-sdk.md):**
5252

53-
- Android: `topper.initialize({ bootstrapToken: <bootstrap token>, { is_android_app: true } });`
54-
- iOS: `topper.initialize({ bootstrapToken: <bootstrap token>, { is_ios_app: true } });`
53+
- Android: `topper.initialize({ bootstrapToken: <bootstrap token>, { is_android_webview: true } });`
54+
- iOS: `topper.initialize({ bootstrapToken: <bootstrap token>, { is_ios_webview: true } });`

0 commit comments

Comments
 (0)