Skip to content

Commit c05da49

Browse files
Add venmo doc
1 parent 6813730 commit c05da49

7 files changed

Lines changed: 125 additions & 65 deletions

File tree

docs/digital-wallets.md

Lines changed: 0 additions & 61 deletions
This file was deleted.
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"label": "Digital Wallets",
3+
"position": 9
4+
}
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
# Apple and Google Pay
6+
7+
## Cross-platform support
8+
9+
### Web
10+
11+
| Browser | Scenario | Apple Pay | Google Pay |
12+
|:-------:|:--------:|:---------:|:----------:|
13+
| Chrome (and others) | Desktop |||
14+
| Chrome (and others) | Mobile |||
15+
| Chrome (and others) | Embed with an iframe - Desktop |||
16+
| Chrome (and others) | Embed with an iframe - Mobile |||
17+
| Safari | Desktop |||
18+
| Safari | Mobile |||
19+
| Safari | Embed with an iframe - Desktop |||
20+
| Safari | Embed with an iframe - Mobile |||
21+
22+
**Notes:**
23+
- Set `allow="payment"` on the `iframe` when Topper is embed.
24+
- If you are using the `sandbox` attribute on the `iframe`, include `allow-top-navigation`. On *Safari - Embed with an iframe scenario* and using Apple Pay, users are redirected on the main window to continue the payment on Topper.
25+
26+
### Electron
27+
28+
| Apple Pay | Google Pay |
29+
|:----------:|:----------:|
30+
|||
31+
32+
**Notes:**
33+
- When using Google Pay, a browser tab will be open to continue the payment on Topper.
34+
35+
### Mobile App
36+
37+
| OS | Apple Pay | Google Pay |
38+
|:-------:|:---------:|:----------:|
39+
| Android |||
40+
| iOS |||

docs/digital-wallets/intro.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# Intro
6+
7+
**What are the digital wallets supported by Topper?**
8+
9+
Topper currently supports Apple Pay, Google Pay, PayPal and Venmo on `crypto_onramp` flow only.
10+
11+
**What are the benefits of using digital wallets as payment options?**
12+
13+
These payment options offer a seamless and convenient way for your customers to complete transactions. Generally, users tend to prefer these over other payment methods when presented with the choice.
14+
15+
### Mobile integration:
16+
17+
- 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.
19+
- 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+
**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`
24+
- Safari View Controller: `https://app.topperpay.com/?bt=<bootstrap token>&is_safari_view_controller=1`
25+
26+
**Using the [Web SDK](../web-sdk.md):**
27+
28+
- Android: `topper.initialize({ bootstrapToken: <bootstrap token>, { is_android_app: true } });`
29+
- iOS: `topper.initialize({ bootstrapToken: <bootstrap token>, { is_ios_app: true } });`
30+
- Safari View Controller: `topper.initialize({ bootstrapToken: <bootstrap token>, { is_safari_view_controller: true } });`
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
sidebar_position: 3
3+
---
4+
5+
# PayPal and Venmo
6+
7+
PayPal works in **every scenario** with **no extra configuration** required.
8+
9+
## Cross-platform support
10+
11+
### Web
12+
13+
| Browser | Scenario | Venmo |
14+
|:--------:|:--------:|:-----:|
15+
| Chrome (and others) | Desktop ||
16+
| Chrome (and others) | Desktop - Embed with an iframe ||
17+
| Chrome (and others) | iOS Mobile ||
18+
| Chrome (and others) | iOS Mobile - Embed with an iframe ||
19+
| Safari | Desktop ||
20+
| Safari | Desktop - Embed with an iframe ||
21+
| Safari | iOS Mobile ||
22+
| Safari | iOS Mobile - Embed with an iframe ||
23+
| Chrome | Android Mobile ||
24+
| Chrome | Android Mobile - Embed with an iframe ||
25+
| Other browsers | Android Mobile ||
26+
| Other browsers | Android Mobile - Embed with an iframe ||
27+
28+
**Notes:**
29+
When not supported, the payment method will be marked as unavailable on the payment method selection screen.
30+
31+
### Electron
32+
33+
The user is redirected to a new browser tab to continue the payment on Topper.
34+
35+
### Mobile App
36+
37+
| OS | Scenario | Venmo |
38+
|:-------:|:---------:|:----------:|
39+
| Android | WebView ||
40+
| Android | Embed with an iframe * ||
41+
| iOS | WebView ||
42+
| iOS | WebView - embed with an iframe * ||
43+
| iOS | Safari View Controller ||
44+
| iOS | Safari View Controller - embed with an iframe * ||
45+
46+
**Notes:**
47+
On the scenarios marked with *, the user is redirected to a new browser tab to continue the payment on Topper.

docs/flows/crypto-onramp.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The crypto on-ramp flow allows a user to add funds from a credit or debit card t
2828
- `amount` (_optional_): Amount to be paid.
2929
- `asset`: Currency code in the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) format used to make the payment.
3030
- `paymentMethod` (_optional_): An object configuring the pre-selected payment method.
31-
- `network`: Payment method network (e.g.: `apple-pay`, `google-pay`, `card`, `paypal`, `pix`, or `sepa`).
31+
- `network`: Payment method network (e.g.: `apple-pay`, `google-pay`, `card`, `paypal`, `venmo`, `pix`, or `sepa`).
3232
- `target` (_optional_): An object configuring recipient wallet.
3333
- `allowedAssets` (_optional_): Set of cryptoassets that the user can set as target asset. Can be an array of objects with `asset` and `networks` (e.g.: `{ "asset": "ETH", "networks": ["ethereum"] }`), an array of asset codes (e.g.: `["BTC", "ETH"]` where all available networks for each asset are included), or a combination of both for flexibility.
3434
- `amount` (_optional_): Amount the user will receive.

docs/mobile.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ sidebar_position: 10
44

55
# Mobile
66

7-
When integrating Topper with a mobile app you can either open Topper on a **user's browser** (where no extra configuration is required), or embed it in a **WebView**.
7+
When integrating Topper with a mobile app you can either open Topper on a **user's browser** (where no extra configuration is required), **WebView** or **Safari View Controller**.
88

9-
When embedding on a **WebView**, please ensure the following steps have been completed:
9+
On **WebView** and **Safari View Controller** scenarios, please ensure the following steps have been completed:
1010

11-
- Set the correct parameters referenced on [Single Sign-On](./single-sign-on.md#mobile-app) and [Digital Wallets](./digital-wallets.md#mobile-app).
11+
- Set the correct parameters referenced on [Single Sign-On](./single-sign-on.md#mobile-app) and [Digital Wallets](./digital-wallets/intro#mobile-integration).
1212
- Configure the **WebView** to support [Cloudflare Turnstile](https://www.cloudflare.com/products/turnstile/).
1313
- Configure camera and audio app permissions to support [Veriff](https://www.veriff.com/).
1414

0 commit comments

Comments
 (0)