Enabling payments via a payment link

General information

How it works

1. The user taps the pay button in the app.

2. The user goes to the Yandex Pay payment form screen, with the following information displayed:

   • A list of the user’s bank cards.
   • Payment options via the Faster Payment System (SBP).

3. The user selects a payment method and clicks on the order confirmation button.

4. Yandex Pay service completes a payment and returns the operation result.

Full payment

Split payment

Requirements for connecting

Supported version: Android 7.0 and higher.

Before you start the integration, obtain the following IDs and add them to your project:

• Merchant ID
• SHA256 Fingerprints
• Client ID (YANDEX_CLIENT_ID)
• Android package name (applicationId)

Step 1. Obtain the required IDs

1. Get the SHA256 Fingerprints hash value using the keytool utility:

   keytool -list -v -alias <your-key-name> -keystore <path-to-production-keystore>
   

   Once you enter the command, the hash value will be shown under Certificate fingerprints: SHA256.

2. To register the app, go to Yandex OAuth.

3. In the Service name field, enter the name to be displayed to users on the authorization screen.

4. Under Platforms, select Android app and set its parameters:

   • Android package name: Unique app name from the project config file's applicationId.
   • SHA256 Fingerprints: SHA256 hash value from step 1. The hash must contain capital letters only.

5. Make sure that your app has access to Yandex Pay added in Yandex OAuth. To do this, select Paying via Yandex Pay in the Permission name field of the Data access section.

6. Click Create app and copy the Client ID field value.

7. On the Settings page of the Yandex Pay dashboard, specify the Client ID, SHA256, and Android package name values in the Client ID, SHA256 Fingerprint, and Android package name fields, respectively.

Step 2. Enable the Client ID

Specify the resulting Client ID in the build.gradle build script as the YANDEX_CLIENT_ID value in manifestPlaceholders:

   android {
     defaultConfig {
       manifestPlaceholders = [
         // Use your Client ID
         YANDEX_CLIENT_ID: "12345678901234567890",
       ]
     }
   }

Step 3. Initialize FirebaseApp in all the app's workflows

The Mobile SDK uses AppMetrica services to ensure the stable operation of the SDK. This step helps fix the Firebase and AppMetrica service compatibility issues.

If Firebase is used along with the Yandex Pay SDK, call FirebaseApp.initialize(context) in all the app's workflows.

If you use AppMetrica in your app, be sure to activate YandexMetrica after Firebase is initialized.

// don`t forget declare MyApplication in AndroidManifest.xml in <application/> block using android:name
class MyApplication: Application() {

    override fun onCreate() {
        // inited at every app processes
        FirebaseApp.initializeApp(this)
    }
}

For details of the interaction, see AppMetrica is down after Firebase upgrade to version 31+.

Step 4. Enable the Yandex Pay SDK

Add the following dependency to your build.gradle build scripts:

dependencies {
    implementation 'com.yandex.pay:pay:2.3.10'
}

Step 5. Get an object of the payment session

Get an object of the payment session using the getYandexPaymentSession function:

  private val yaPayConfig = YPayConfig(
    merchantData = MerchantData(
        id = MerchantId("merchantId"),
        name = MerchantName("merchantName"),
        url = MerchantUrl("https://merchant.com/"),
    ),
    environment = YPayApiEnvironment.PROD,
  )

  private val paymentSessionKey = PaymentSessionKey(
    generateSessionKey()
  )

  private val paymentSession: PaymentSession = YPay.getYandexPaymentSession(
    context = this,
    config = yaPayConfig,
    sessionKey = paymentSessionKey  // optional if you're using Kotlin for implementation
  )

  private YPayConfig getPayConfig() {
    return new YPayConfig(
        new MerchantData(
            new MerchantId("merchantId"),
            new MerchantName("MERCHANT_NAME"),
            new MerchantUrl("https://merchant.com/")
        ),
        YPayApiEnvironment.PROD
    );
  }

  private PaymentSessionKey getPaymentSessionKey() {
    return new PaymentSessionKey(
        generateSessionKey()
    );
  }

  private PaymentSession getPaymentSession() {
    return YPay.INSTANCE.getYandexPaymentSession(
        this,
        getPaymentSessionKey(),
        getPayConfig()
    );
  }

When getting a PaymentSession, be sure to pass:

• Context: The context of the application or Activity.
• PaymentSessionKey: Key of the payment session.
• YPayConfig: Data about the Yandex Pay SDK configuration.

When creating YPayConfig, be sure to pass:

• merchantData: Data of the merchant:

  • id: Unique merchant ID. You can get it when registering a merchant in Yandex Pay service.
  • name: The name of the merchant that the user will see.
  • url: The URL of the merchant that the user will see.

• environment: The Yandex Pay SDK execution environment:

  • PROD: Production environment.
  • SANDBOX: A test environment.

Step 6. (optional) Place the Yandex Pay button on the screen

Add the button to your layout:

<androidx.constraintlayout.widget.ConstraintLayout
    xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools">

    <com.yandex.pay.YPayButton
        android:id="@+id/y_pay_button"
        android:layout_width="300dp"
        android:layout_height="54dp"
        android:layout_marginTop="4dp"
        app:ypay_color_scheme="by_theme"
        app:ypay_corner_radius="4dp" />

When creating a button, you can pass values for the attributes:

• ypay_color_scheme: With this option, you can define the color palette of the button. Acceptable values:

  • by_theme: The color palette is adapted to match the system theme.
  • light: The color palette is always light.
  • dark: The color palette is always dark.

• ypay_corner_radius: With this option, you can define the corner radius for the button (in dp).

When initializing the view components, bind the current session's object to the button using a PaymentSession object and its bindTo function:

In addition, pass SessionListenerArgs with a list of payment methods allowed for the user.

fun initViews() {
    paymentSession.bindTo(yPayButton, SessionListenerArgs(listOf(PaymentMethodType.CARD,PaymentMethodType.SPLIT)))
}

void initViews() {
    getPaymentSession().bindTo(yPayButton);
}

Step 7. Initialize a contract for Yandex Pay launch

When initializing the contract, add a callback that obtains the YPayResult:

private val yandexPayLauncher = YPayLauncher(this) { result: YPayResult ->
    when (result) {
        is YPayResult.Success -> showToast("Finished with success")
        is YPayResult.Cancelled -> showToast("Finished with cancelled event")
        is YPayResult.Failure -> showToast("Finished with domain error")
    }
}

private final YPayLauncher launcher = new YPayLauncher(this, yPayResult -> {
    if (yPayResult instanceof YPayResult.Success) {
        handleResult("Finished with success");
    } else if (yPayResult instanceof YPayResult.Cancelled) {
        handleResult("Finished with cancelled event");
    } else if (yPayResult instanceof YPayResult.Failure) {
        handleResult("Finished with domain error");
    }
});

In the event of payment failure, the errorMsg error code is also returned:

Step 8. Generate data for launching Yandex Pay

Before launching Yandex Pay, generate payment data using the PaymentData.PaymentUrlFlowData class and payment session data. Create YPayContractParams based on this data.

val paymentData = PaymentData.PaymentUrlFlowData(
    // Order payment URL received from the Yandex Pay API
    paymentUrl = "payment-url"
)

val params = YPayContractParams(
    paymentSession = paymentSession,
    paymentData = paymentData,
)

final PaymentData paymentData = new PaymentData.PaymentUrlFlowData(
    // Order payment URL received from the Yandex Pay API
    "payment-url"
);

// Parameters for launching Yandex Pay
final YPayContractParams params = new YPayContractParams(
    getPaymentSession(),
    paymentData
);

Step 9. Launch Yandex Pay

Launch via the Yandex Pay button

Pass the previously created launcher to the button using the setOnClickListener function and define its launch logic in a lambda expression. When running the launcher, pass the YPayContractParams parameters to it:

yPayButton.setOnClickListener(yandexPayLauncher) { launcher ->
    val params = YPayContractParams(...)
    launcher.launch(params)
}

yPayButton.setOnClickListener(yandexPayLauncher, launcher -> {
    YPayContractParams params = new YPayContractParams(...);
    launcher.launch(params);
});

Launch without using the button

Run the service using the launcher, passing the YPayContractParams launch parameters:

val params = YPayContractParams(...)
yandexPayLauncher.launch(params)

final YPayContractParams params = new YPayContractParams(...);
yandexPayLauncher.launch(params);

Step 10. Handle the results

After Yandex Pay is launched, the SDK will select the optimal strategy and run the payment form to complete the payment in. The result will be obtained using the launch contract YPayLauncher.

Setup for devices with Android version lower than 7.0

Owners of devices with Android 7.0 (API level 24) or higher can use the Yandex Pay SDK without any restrictions. There may be restrictions for devices with Android version lower than 7.0:

• No official support.
• Limited SDK functionality.
• Additional environment setup is required as described below.

1. Enable the SDK dependency in your project's build.gradle file:

   dependencies{
       ...
       implementation "com.yandex.pay:*pay/other*:*version*"
       ...
   }
   

2. Sync the project and try to build it. This should result in the manifest merger error:

   Manifest merger failed : uses-sdk:minSdkVersion *Your min version* cannot be smaller than version 24 declared in library
   

3. Open the AndroidManifest.xml file of the module where you're adding the dependency and list all the libraries this error refers to.

   Example:

   <manifest xmlns:tools="http://schemas.android.com/tools">
       <uses-sdk tools:overrideLibrary="com.yandex.pay, ...* other libraries *... ,com.yandex.pay.base"/>
   </manifest>
   

4. Check if the SDK is supported via the YPay object and initialize all the necessary components after the check:

   if (YPay.isSupported){
       // init Yandex pay
   } else {
       // do some other logic
   }
   

   Warning

   Run the YPay.isSupported availability check each time the Yandex Pay SDK is accessed.