Getting started

Create an SDK key, allow your app and find your journey host in Institution Admin.

Everything here is done by an administrator with the Manage Mobile SDK permission, in Institution Admin under Settings › Mobile SDK. Choose the environment at the top of the screen first: each one is set up separately.

1. Note your journey host

The Connect your app card shows your journey host, for example `https://onboarding.bank.example`. It is the address your customers' journeys are served on, and it is what you configure the SDK with.

2. Create a key

Under Keys, choose Create key. The full key is shown once, straight away. Copy it into your app's build configuration then: PayMedia keeps only a fingerprint of it and cannot show it again. If you lose it, create another.

To change keys, create a new key, release your app with it, and revoke the old key once your customers have updated. A key keeps working until it is revoked, so customers on an older version of your app are not cut off.

3. Allow your app

Under Allowed apps, add each app that will use the SDK in this environment. Until at least one app is allowed, every start is refused.

  • Android: your package name, for example `com.example.bank`. Optionally add your signing certificate's SHA-256 so that only builds signed by you can start journeys.
  • iOS: your bundle id, for example `com.example.bank`.
Shell · Print your Android signing certificate's SHA-256
keytool -list -v -keystore release.keystore -alias release | grep SHA256

If Google Play signs your app, use the SHA-256 shown in the Play Console under App integrity › App signing instead.

4. Set up video call push (optional)

To tell customers on their phone about their video call, upload your Firebase project's service account under Video call push. See Push notifications for the details. Email and SMS are sent either way.

Next

Add the SDK to your app: follow the Android or the iOS page.