Skip to main content

In-app Payments SDK for Kotlin/Java (version 10.3.0)

With RuStore you can integrate payments in your mobile app.

tip

Getting Started​

build.gradle
repositories {
    maven {
        url = uri("https://artifactory-external.vkpartner.ru/artifactory/maven-rustore-exposed/")
    }
}

Connecting the dependency

Add the following code to your configuration file to add the dependency.

build.gradle
dependencies {
    implementation(platform("ru.rustore.sdk:bom:2026.04.01"))
    implementation("ru.rustore.sdk:pay")
}

Deeplink handling in the RuStore SDK allows you to efficiently interact with third-party applications when processing payments via banking applications (SBP, SberPay, etc.). This makes it possible to redirect the user to the payment screen and, after the transaction is completed, return them to your app.

To configure deeplink handling in your app and Pay SDK, specify the deeplinkScheme using sdk_pay_scheme_value in your AndroidManifest.xml file and override the onNewIntent method of your Activity.

Warning
  • When using deeplinks, specifying the scheme is mandatory.
  • If a payment is initiated without a scheme, an error will occur.
  • Only ASCII characters are allowed. The format must comply with RFC-3986.

Specifying deeplinkScheme:

AndroidManifest.xml
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    package="your.app.package.name">

    <application
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:supportsRtl="true"
        android:theme="@style/Theme.App"
        tools:targetApi="n">
        <!-- ... -->

        <activity
            android:name=".YourPayActivity">

            <intent-filter>
                <action android:name="android.intent.action.MAIN" />
                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>

            <intent-filter>
                <action android:name="android.intent.action.VIEW" />
                <category android:name="android.intent.category.DEFAULT" />
                <category android:name="android.intent.category.BROWSABLE" />
                <data android:scheme="yourappscheme" />
            </intent-filter>

        </activity>

        <meta-data
            android:name="sdk_pay_scheme_value"
            android:value="yourappscheme" />

    </application>
</manifest>
tip

Replace yourappscheme with your own scheme name, for example ru.package.name.rustore.scheme. Then add the following code to the Activity you want to return to after the payment is completed (your app page):

Calling the getPurchaseAvailability method
class YourBillingActivity: AppCompatActivity() {
      
    private val intentInteractor: IntentInteractor by lazy {
        RuStorePayClient.instance.getIntentInteractor()
    }
 
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        if (savedInstanceState == null) {
            intentInteractor.proceedIntent(intent, sdkTheme = SdkTheme.LIGHT)  // Optional theme
        }
    }
  
    override fun onNewIntent(intent: Intent?) {
        super.onNewIntent(intent)    
        intentInteractor.proceedIntent(intent, sdkTheme = SdkTheme.LIGHT)  // Optional theme
    }
}

To restore your app state when returning via a deeplink, add the android:launchMode="singleTop" attribute to AndroidManifest.xml.

Specifying console app id
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    package="your.app.package.name">
    <!-- ... -->

    <application>
      <!-- ... -->
        <activity
            android:name=".YourPayActivity"
            android:launchMode="singleTop"
            android:exported="true"
            android:screenOrientation="portrait"
            android:windowSoftInputMode="adjustResize">

            <!-- ... -->

        </activity>
      <!-- ... -->
    </application>

</manifest>

SDK Initialization​

Initialize the library before calling its methods. The initialization itself is done automatically, however, for your SDK to work, define console_app_id_key in your manifest.xml.

You can so it the following way:

A deeplink in the RuStore Payments SDK is required for proper interaction with third-party payment applications. It helps users complete purchases faster in an external app and return to your application.

To set up deeplink support in your application and the RuStore SDK, specify the deeplinkScheme inside your AndroidManifest file and override the onNewIntent method of your Activity. Additionally, for the SDK to work, you need to specify sdk_pay_scheme_value in your Manifest.xml file.

AndroidManifest.xml
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    package="your.app.package.name">
 
    <application
            android:allowBackup="true"
            android:icon="@mipmap/ic_launcher"
            android:label="@string/app_name"
            android:roundIcon="@mipmap/ic_launcher_round"
            android:supportsRtl="true"
            android:theme="@style/Theme.App"
            tools:targetApi="n">
        ...
 
        <meta-data
                android:name="console_app_id_value"
                android:value="@string/CONSOLE_APPLICATION_ID" />
 
    </application>
</manifest>

  • CONSOLE_APPLICATION_ID — product ID form the RuStore Console.

    Example: https://console.rustore.ru/apps/111111.
Where are app IDs in the RuStore Console?
  1. Navigate to the Applications tab and selected the needed app.
  2. Copy the ID from the URL address of the app page — it is a set of numbers between apps/ and /versions. FOr example, for URL address https://console.rustore.ru/apps/123456/versions the app ID is 123456.

Important
  • The ApplicationId specified in build.gradle must match the applicationId of the APK file that you published in the RuStore Console.

  • The keystore signature must match the signature that was used to sign the app published in the RuStore Console. Make sure that buildType used (example: debug) uses the same signature as the published app (example: release).

info

For security purposes, the SDK sets android:usesCleartextTraffic="false" by default to prevent data transmission over unencrypted HTTP and protect against "Man-in-the-Middle" attacks. If your application requires the use of HTTP, you can change this attribute to true, but do so at your own risk, as this increases the chance of data interception and substitution. We recommend allowing unencrypted traffic only in exceptional cases and for trusted domains, preferring HTTPS for all network interactions.

Required Permissions and Security Parameters​

The Pay SDK automatically adds some permissions and parameters to the application's manifest that are necessary for the functionality related to payment security.

Permissions BLUETOOTH and BLUETOOTH_CONNECT

<uses-permission android:name="android.permission.BLUETOOTH" />
<uses-permission android:name="android.permission.BLUETOOTH_CONNECT" />

These permissions are required for the session anti-fraud system, which protects user payments. Collecting such data can be useful for incident analysis, for example, when investigating account theft.

If you do not want to provide access to Bluetooth, these permissions can be removed from the manifest — the Pay SDK will continue to work, it just won't collect these additional data for scoring.

Other Permissions

The Pay SDK may also require other standard permissions, such as:

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />

SDK Methods​

Available public interactors:

  • PurchaseInteractor – an interactor that lets you work with payments and provides several public methods.

    • getPurchase(purchaseId: PurchaseId): Task<Purchase> – returns information about a purchase by its ID.
    • getPurchases(productType: ProductType? = null, purchaseStatus: PurchaseStatus? = null): Task<List<Purchase>> — returns the user’s purchases. This method supports optional filtering by product type (consumable, non-consumable products or subscriptions) and by purchase status (supported statuses are PAID, CONFIRMED, ACTIVE, and PAUSED). By default, filters are disabled and all user purchases (regardless of product type) in the PAID, CONFIRMED, ACTIVE, and PAUSED statuses are returned.
    • getPurchaseAvailability(): Task<PurchaseAvailabilityResult> – returns the result of checking whether payments are available.
    • purchase(params: ProductPurchaseParams, preferredPurchaseType: PreferredPurchaseType = PreferredPurchaseType.ONE_STEP,sdkTheme: SdkTheme = SdkTheme.LIGHT,purchaseEventListener: PurchaseEventListener? = null): Task<ProductPurchaseResult> – makes a product purchase with the specified payment type: one-step (ONE_STEP) or two-step (TWO_STEP). For this method, all available payment methods are shown on the payment screen. If the parameter is not specified, a one-step payment flow is used by default.
    Important

    If the TWO_STEP payment type is specified, the SDK will attempt to start a two-step payment flow, but the final result will directly depend on which payment method (card, SBP, etc.) the user selects.

    Note that the TWO_STEP payment type is not available:

    • When SBP is selected as the payment method.
    • When purchasing subscriptions.

    Two-step payment is available only for a specific set of payment methods (at the moment — cards and SberPay only). If the selected payment method does not support authorization hold, the purchase will fall back to a one-step payment flow.

    • purchaseTwoStep(params: ProductPurchaseParams,sdkTheme: SdkTheme = SdkTheme.LIGHT,purchaseEventListener: PurchaseEventListener? = null): Task<ProductPurchaseResult> – starts a guaranteed two-step purchase flow. When this method is used, only payment methods that support two-step payment are available to the user on the payment screen. During the payment flow, the customer’s funds are first put on hold and are charged only after the purchase is confirmed with the confirmTwoStepPurchase method.
    • confirmTwoStepPurchase(purchaseId: PurchaseId, developerPayload: DeveloperPayload? = null) – confirms a purchase made with a two-step payment flow.
    • cancelTwoStepPurchase(purchaseId: PurchaseId) – cancels a purchase made with a two-step payment flow.

  • ProductInteractor – an interactor that lets you work with products:

    • getProducts(productsId: List<ProductId>): Task<List<Product>> – returns information about active products published in the RuStore Console.
      Important

      This method returns no more than 1000 products and works without user authorization or RuStore being installed on the user’s device.

  • UserInteractor – an interactor that lets you get the user’s authorization status (UserAuthorizationStatus). This model has two possible states:

    • Authorized – the user is authorized in RuStore.
    • Unauthorized – the user is not authorized in RuStore.

  • IntentInteractor – an interactor that lets you handle intents and deeplinks. It is required to correctly return from the banking app back to your app and restore the state of the payment screen.

    • proceedIntent(intent: Intent?, sdkTheme: SdkTheme = SdkTheme.LIGHT) – a method for handling deeplinks and restoring the state of the payment screen when returning to your app from a banking app. You must call this method to correctly display the payment screen when returning to the app from a banking app.

  • The RuStoreUtils block – a set of public helper methods, such as:

    • isRuStoreInstalled – checks whether the RuStore app is installed on the user’s device.
    • openRuStoreDownloadInstruction – opens the web page for downloading the RuStore app.
    • openRuStore – launches the RuStore app.
    • openRuStoreAuthorization – launches the RuStore app for user authorization. After the user is successfully authorized, the RuStore app closes automatically.

Retrieving product list​

To retrieve the products added to your application via the RuStore Console, you must use the method:s getProducts.

Calling getProducts method
RuStorePayClient.instance.getProductInteractor().getProducts(productsId = listOf(ProductId("id1"), ProductId("id2")))
    .addOnSuccessListener { products: List<Product> ->
        // Logic for working with a list of products
    }
    .addOnFailureListener { throwable: Throwable ->
        // Handling error
    }

productsId: List<ProductId> — the list of product IDs that are set when products are created in the RuStore Console. The list is limited by 1000 items.

Where are product IDs in the RuStore Console?
  1. Navigate to the Applications tab and selected the needed app.
  2. Select Monetization in the left menu.
  3. Select product type: Subscriptions or In-App purchases.
  4. Copy the IDs of the required products.

The method returns a list of products. The product model is provided below.

Product structure
public class Product internal constructor(
    public val productId: ProductId,
    public val type: ProductType,
    public val amountLabel: AmountLabel,
    public val price: Price?,
    public val currency: Currency,
    public val imageUrl: Url,
    public val title: Title,
    public val description: Description?,
    public val subscriptionInfo: SubscriptionInfo?,
)
  • productId — product ID assigned to product in RuStore Console (mandatory).
  • type — product type. CONSUMABLE/NON-CONSUMABLE/SUBSCRIPTION (consumable/non-consumable/subscription).
  • amountLabel — formatted purchase price, including currency symbol.
  • price — price in minimum currency units.
  • currency — ISO 4217 currency code.
  • title — product name in language.
  • description — descriptions in language.
  • imageUrl — image URL.

The subscriptionInfo model contains information about the subscription product.

Important

The presence of these fields does not mean that the free or introductory period is still available to the user: they may have already used these periods earlier.

The model is shown below.

Subscription info structure
public class SubscriptionInfo internal constructor(
    public val periods: List<SubscriptionPeriod>,
)
 
public sealed interface SubscriptionPeriod
 
public class TrialPeriod internal constructor(
    public val duration: String,
    public val currency: String,
    public val price: Int,
) : SubscriptionPeriod {
 
public class PromoPeriod internal constructor(
    public val duration: String,
    public val currency: String,
    public val price: Int,
) : SubscriptionPeriod
 
public class MainPeriod internal constructor(
    public val duration: String,
    public val currency: String,
    public val price: Int,
) : SubscriptionPeriod
 
public class GracePeriod internal constructor(
    public val duration: String,
) : SubscriptionPeriod
 
public class HoldPeriod internal constructor(
    public val duration: String,
) : SubscriptionPeriod
  • duration - period duration in ISO 8601 format (same as in Public API)
  • currency - currency code in ISO 4217 format.
  • price - price in minimum units.

Subscription periods

  • TrialPeriod — free period

  • PromoPeriod — introductory period

  • MainPeriod — standard subscription period

  • GracePeriod — grace period

  • HoldPeriod — hold period

tip

For more information about how subscription periods work, see the article.

subscriptionInfo example

Working with subscriptionInfo
RuStorePayClient.instance.getProductInteractor().getProducts(productsId = listOf(ProductId("id1"), ProductId("id2")))
    .addOnSuccessListener { products: List<Product> ->
        products.forEach { product ->
            val periods = product.subscriptionInfo?.periods
            when (period) {
                is TrialPeriod -> {
                    println("Free period: ${period.duration} за ${period.price} ${period.currency}")
                }
                is PromoPeriod -> {
                    println("Trial period: ${period.duration} за ${period.price} ${period.currency}")
                }
                is MainPeriod -> {
                    println("Main period: ${period.duration} за ${period.price} ${period.currency}")
                }
                is GracePeriod -> {
                    println("Grace period: ${period.duration}")
                }
                is HoldPeriod -> {
                    println("Hold period: ${period.duration}")
                }
                null -> {
                  println("subscriptionInfo is null")
                }
            }
        }
    }
    .addOnFailureListener { throwable: Throwable ->
        // Handling error
    }

Response examples

Consumable product response example
Product(
    productId = ProductId("conProduct1"),
    type = ProductType.CONSUMABLE_PRODUCT,
    amountLabel = AmountLabel("100.00 руб."),
    price = Price(10000),
    currency = Currency("RUB"),
    imageUrl = Url("https://your_image_consumable_product.png"),
    title = Title("Название Потребляемого продукта"),
    description = Description("Описание потребляемого продукта"),
 )
Non consumable product response example
Product(
    productId = ProductId("nonConProduct1"),
    type = ProductType.NON_CONSUMABLE_PRODUCT,
    amountLabel = AmountLabel("200.00 руб."),
    price = Price(20000),
    currency = Currency("RUB"),
    imageUrl = Url("https://your_image_non_consumable_product.png"),
    title = Title("Название Непотребляемого продукта"),
    description = Description("Описание Непотребляемого продукта"),
 )
Subscription response example
Product(
    productId = ProductId("sub_1"),
    type = ProductType.SUBSCRIPTION,
    amountLabel = AmountLabel("300.00 руб."),
    price = Price(30000),
    currency = Currency("RUB"),
    imageUrl = Url("https://your_image_subscription.png"),
    title = Title("Название вашей подписки"),
    description = Description("Описание вашей подписки"),
    subscriptionInfo = SubscriptionInfo(
        periods = listOf(
            TrialPeriod(
                duration = "P1M",
                currency = "RUB",
                price = 0
            ),
            PromoPeriod(
                duration = "P5D",
                currency = "RUB",
                price = 149
            ),
            MainPeriod(
                duration = "P1Y",
                currency = "RUB",
                price = 299
            ),
            GracePeriod(
                duration = "P3D"
            ),
            HoldPeriod(
                duration = "P5D"
            )
        )
    )
 )

Determine user authorization status​

To check the user's authorization status, call the getUserAuthorizationStatus method on the UserInteractor. The result of this method is the UserAuthorizationStatus class.

::: Use the getUserAuthorizationStatus method only in scenarios where you need to know in advance whether the user is authorized in RuStore (or whether RuStore is installed on the device). This method is not required on its own to start a payment. :::

There are 2 possible values:

  • AUTHORIZED – the user is authorized in RuStore or via VK ID on the payment sheet.
  • UNAUTHORIZED – the user is not authorized. This value is also returned if RuStore is not installed on the user’s device.
Calling getUserAuthorizationStatus method
RuStorePayClient.instance.getUserInteractor().getUserAuthorizationStatus()
    .addOnSuccessListener { result ->
        when (result) {
            UserAuthorizationStatus.AUTHORIZED -> {
                 // Logic for when the user is authorized in RuStore or via VK ID on the payment sheet.
            }
 
            UserAuthorizationStatus.UNAUTHORIZED -> {
                // Logic for when the user is not authorized.
            }
        }
    }.addOnFailureListener { throwable ->
        // Handling error
    }

Check payment availability​

To check payment availability, call the getPurchaseAvailability method on PurchaseInteractor. When called, the following conditions are checked:

  • The company has monetization enabled via the RuStore Developer Console.
  • The application must not be banned in RuStore.
  • The user must not be banned in RuStore.

If all conditions are met, PurchaseAvailabilityResult.Available is returned. Otherwise, PurchaseAvailabilityResult.Unavailable(val cause: Throwable) is returned, where cause is the error indicating the unmet condition. To check the reason for this result, you should check the error type for RuStoreException (these errors are described in the Error Handling section).

Calling getPurchaseAvailability method
RuStorePayClient.instance.getPurchaseInteractor().getPurchaseAvailability()
    .addOnSuccessListener { result ->
        when (result) {
            is PurchaseAvailabilityResult.Available -> {
                 // Handling payment availability result
            }
 
            is PurchaseAvailabilityResult.Unavailable -> {
                // Handling payment unavailability result
            }
        }
    }.addOnFailureListener { throwable ->
       // Handling error
    }

Purchase types​

In the SDK, there is a base Purchase interface that unifies the common fields for all purchase types. It has two implementations:

  • ProductPurchase — for consumable and non-consumable purchases.
  • SubscriptionPurchase — for subscriptions.

This separation allows each purchase type to expose its own specific properties and behavior.

Purchase interface
public interface Purchase {
    public val purchaseId: PurchaseId
    public val invoiceId: InvoiceId
    public val orderId: OrderId?
    public val purchaseType: PurchaseType
    public val status: PurchaseStatus
    public val description: Description
    public val purchaseTime: Date?
    public val price: Price
    public val amountLabel: AmountLabel
    public val currency: Currency
    public val developerPayload: DeveloperPayload?
    public val sandbox: Boolean
}

One-time purchase model ProductPurchase​

One-time purchase model ProductPurchase
public class ProductPurchase internal constructor(
    public override val purchaseId: PurchaseId,
    public override val invoiceId: InvoiceId,
    public override val orderId: OrderId?,
    public override val purchaseType: PurchaseType,
    public override val status: ProductPurchaseStatus,
    public override val description: Description,
    public override val purchaseTime: Date?,
    public override val price: Price,
    public override val amountLabel: AmountLabel,
    public override val currency: Currency,
    public override val developerPayload: DeveloperPayload?,
    public override val sandbox: Boolean,
    public val productId: ProductId,
    public val quantity: Quantity,
    public val productType: ProductType,
) : Purchase
  • purchaseId — product ID. Purchase identifier. Used for retrieving the information about the purchase in SDK using the getting purchase information method.
  • invoiceId — invoice ID. Bill identifier. Used for payment server validation, searching for payment in the Console and also it's shown in the payment history section in RuStore.
  • orderId - unique payment identifier, specified by the developer or generated automatically (uuid).
  • PurchaseType — purchase type:
    • ONE_STEP - one-stage payment;
    • TWO_STEP - two-stage payment;
    • UNDEFINED — number of payment stages is undefined.
  • status — purchase state:
    • INVOICE_CREATED — purchase invoice is created and awaiting payment;
    • CANCELLED — purchase canceled by the user;
    • PROCESSING — payment initiated;
    • REJECTED — purchase rejected (for example: due to insufficient funds);
    • EXPIRED — payment time expired;
    • PAID — only for two-stage payments, intermediate status, funds are put on hold on the user's account, the purchase is awaiting confirmation from the developer;
    • CONFIRMED — purchase successfully paid for;
    • REFUNDING — refund initiated, request sent to acquirer ;
    • REFUNDED — purchase successfully refunded;
    • REVERSED — only for two-stage payment: wither the purchase was canceled by the developer or there was no payment within 6 hours, the funds on the user's account are put off hold.
  • description - purchase description.
  • purchaseTime — purchase time.
  • price — price in minimum currency units.
  • amountLabel — formatted purchase price, including currency symbol.
  • currency — ISO 4217 currency code.
  • developerPayload — a string with additional order information that you can set when confirming the purchase. This string overrides the value set during initialization
  • — test payment flag. true — test payment, false — actual payment
  • productId — product ID assigned to product in RuStore Console (mandatory). Product identifier, which was assigned to the product in RuStore Console (required parameter).
  • quantity — product quantity.
  • productType — product type. (CONSUMABLE/NON-CONSUMABLE - consumable/non-consumable.)

Purchase status model​

One-stage payment status model.

Two-stage payment status model.

Subscription model SubscriptionPurchase​

Subscription model SubscriptionPurchase
public class SubscriptionPurchase internal constructor(
    public override val purchaseId: PurchaseId,
    public override val invoiceId: InvoiceId,
    public override val orderId: OrderId?,
    public override val purchaseType: PurchaseType,
    public override val status: SubscriptionPurchaseStatus,
    public override val description: Description,
    public override val purchaseTime: Date?,
    public override val price: Price,
    public override val amountLabel: AmountLabel,
    public override val currency: Currency,
    public override val developerPayload: DeveloperPayload?,
    public override val sandbox: Boolean,
    public val productId: ProductId,
    public val expirationDate: Date,
    public val gracePeriodEnabled: Boolean,
) : Purchase

  • purchaseId — product ID — the purchase identifier. Used to retrieve purchase details in the SDK via the purchase info method.

  • invoiceId — invoice ID — the invoice identifier. Used for server-side payment validation, for searching payments in the Developer Console, and is shown to the buyer in their payment history.

  • orderId — a unique payment identifier provided by the developer or generated automatically (UUID).

  • PurchaseType — purchase type:

    • ONE_STEP - one-stage payment;
    • TWO_STEP - two-stage payment;
    • UNDEFINED — number of payment stages is undefined.

  • status — subscription flow status:

    • INVOICE_CREATED — an invoice has been created; the subscription is waiting for payment.
    • CANCELLED — the subscription invoice was canceled.
    • EXPIRED — the time to pay the initial invoice has expired; no subscription was created.
    • PROCESSING — the first subscription payment is being processed.
    • REJECTED — the first subscription payment was rejected. The subscription was not created.
    • ACTIVE — the subscription is active.
    • PAUSED — the subscription is paused due to payment issues.
    • TERMINATED — all retry attempts for the subscription failed. The subscription was automatically closed due to payment issues.
    • CLOSED — the subscription was canceled by the user or the developer. After the paid period ended, the subscription was closed.

  • description — purchase description.

  • purchaseTime — purchase time.

  • price — price in minimum currency units.

  • amountLabel — formatted purchase price, including currency symbol.

  • currency — ISO 4217 currency code.

  • developerPayload — a string with additional order information that you can set when confirming the purchase. This string overrides the value set during initialization.

  • — test payment flag. true — test payment, false — actual payment.

  • productId — product ID assigned to product in RuStore Console (mandatory) — the product identifier assigned in RuStore Console (required).

  • expirationDate — the subscription end date.

  • gracePeriodEnabled — a flag indicating whether the grace period is enabled for the subscription.

Subscription status model​

Purchase product​

Explanation of one-step and two-step payments
  • When using a single-stage payment, the purchase does not require confirmation; the funds are immediately debited from the buyer’s account, and a commission is charged to the developer. In this case, if a refund to the customer is required (for example, if the product cannot be delivered for some reason), a refund can only be processed via the RuStore Console, and the funds will be returned to the buyer within a few days. The full purchase amount is refunded, but the commission previously withheld from the developer is not reimbursed.
  • In the case of a two-stage payment, the funds are first held (authorized) on the buyer’s account. No commission is charged at this stage. After the hold, the purchase requires either confirmation or cancellation. The commission is charged to the developer upon purchase confirmation. Cancelling the purchase releases the hold, and the funds instantly become available to the buyer again.
Payment method restrictions for subscriptions

At this time, a subscription purchase (SubscriptionPurchase) can only be made using the one-step payment flow (PurchaseType.ONE_STEP).

Important

Two-stage payment is available only for a specific set of payment methods (currently — only for cards). SBP technologies do not support two-stage payment. If a payment method that does not support holding funds is selected, the purchase will be processed using the single-stage scenario.

Payment with a choice of purchase type

To initiate a product purchase with a selectable payment flow, use the purchase method.

Calling the product purchase method
val params = ProductPurchaseParams(
    productId = ProductId("productId"),
    orderId = null,
    quantity = null,
    developerPayload = null,
    appUserId = null,
    appUserEmail = null,
)
RuStorePayClient.instance.getPurchaseInteractor()
    .purchase(params = params, preferredPurchaseType = PreferredPurchaseType.ONE_STEP, sdkTheme = SdkTheme.LIGHT)
    .addOnSuccessListener { result ->
        // Successful payment result handling logic
    }
    .addOnFailureListener { throwable: Throwable ->
        when(throwable){
            is RuStorePaymentException.ProductPurchaseException -> // Handling the product purchase error
            is RuStorePaymentException.ProductPurchaseCancelled -> // Handling the product purchase error
            else -> // Handling error
        }
    }
  • productId — product ID assigned to product in RuStore Console (mandatory).
  • quantity — product amount (optional, value 1 will be used if not specified).
  • orderId — payment ID generated by the app (optional). If you specify this parameter in your system, you will receive it via our API. If not specified, will be generated automatically (uuid). 150 characters max.
  • developerPayload — a string with additional order information that you can set when confirming the purchase. This string overrides the value set during initialization. Maximum length is 250 characters. Characters are not escaped.
  • <AppUserId name="appUserId"/>
  • appUserEmail is an optional parameter that lets you set the user’s email address in your app. If the customer’s email address was specified during registration in your app, you can pass it to automatically prefill the email field when sending a receipt — both for payments outside RuStore and in cases where the user is not authorized in RuStore. This removes the need for the user to enter their email manually, shortens the path to purchase, and helps improve conversion.
  • preferredPurchaseType – the desired purchase flow type: one-step (ONE_STEP) or two-step (TWO_STEP).
  • sdkTheme – the color theme of the payment screen. Two options are available: LIGHT and DARK (light and dark themes, respectively). To preserve backward compatibility between SDK versions, this parameter has the default value LIGHT.
  • purchaseEventListener — a set of callback functions that lets you receive invoiceId and purchaseId at different stages of the purchase flow — optional.
warning

This method is launched by default using the single-stage payment scenario (preferredPurchaseType = PreferredPurchaseType.ONE_STEP), i.e., without funds being held.

For two-stage payment, you need to specify preferredPurchaseType = PreferredPurchaseType.TWO_STEP. Two-stage payment (i.e., payment with funds being held) is not guaranteed for this method and directly depends on the payment method (card, SPB, etc.) selected by the user.

When launching this method (with the preferred preferredPurchaseType = twoStep), until the user selects a payment method, the purchase stage will be UNDEFINED. Please take this behavior into account when handling purchase cancellation results (ProductPurchaseCancelled) or purchase errors (ProductPurchaseException).

Two stage (with funds holding)

To initiate a product purchase using two stage scenario use purchaseTwoStep method.

info

When you call this method, the user will see a limited set of payment methods—only those that support the two-step payment flow.

Payment type restrictions for subscriptions

At this time, a subscription purchase (SubscriptionPurchase) can only be made using the one-step payment flow (PurchaseType.ONE_STEP).

Calling product purchase method
val params = ProductPurchaseParams(
    productId = ProductId("productId"),
    orderId = null,
    quantity = null,
    developerPayload = null,
    appUserId = null,
    appUserEmail = null,
)
RuStorePayClient.instance.getPurchaseInteractor()
    .purchaseTwoStep(params = params, sdkTheme = SdkTheme.LIGHT)
    .addOnSuccessListener { result ->
        // Successful payment result handling logic
    }
    .addOnFailureListener { throwable: Throwable ->
        when(throwable){
            is RuStorePaymentException.ProductPurchaseException -> // Handling the product purchase error
            is RuStorePaymentException.ProductPurchaseCancelled -> // Handling the product purchase error
            else -> // Handling error
        }
    }
  • productId — product ID assigned to product in RuStore Console (mandatory).
  • quantity — product amount (optional, value 1 will be used if not specified).
  • orderId — payment ID generated by the app (optional). If you specify this parameter in your system, you will receive it via our API. If not specified, will be generated automatically (uuid). 150 characters max.
  • developerPayload — a string with additional order information that you can set when confirming the purchase. This string overrides the value set during initialization. Maximum length is 250 characters. Characters are not escaped.
  • <AppUserId name="appUserId"/>
  • appUserEmail is an optional parameter that lets you set the user’s email address in your app. If the customer’s email address was specified during registration in your app, you can pass it to automatically prefill the email field when sending a receipt — both for payments outside RuStore and in cases where the user is not authorized in RuStore. This removes the need for the user to enter their email manually, shortens the path to purchase, and helps improve conversion.
  • preferredPurchaseType – the desired purchase flow type: one-step (ONE_STEP) or two-step (TWO_STEP).
  • sdkTheme – the color theme of the payment screen. Two options are available: LIGHT and DARK (light and dark themes, respectively). To preserve backward compatibility between SDK versions, this parameter has the default value LIGHT.
  • purchaseEventListener — a set of callback functions that lets you receive invoiceId and purchaseId at different stages of the purchase flow — optional.

Purchase parameters structure

Purchase parameters structure
public class ProductPurchaseParams(
    public val productId: ProductId,
    public val quantity: Quantity? = null,
    public val orderId: OrderId? = null,
    public val developerPayload: DeveloperPayload? = null,
    public val appUserId: AppUserId? = null,
    public val appUserEmail: AppUserEmail? = null,
)
  • productId — product ID assigned to product in RuStore Console (mandatory).
  • quantity — product amount (optional, value 1 will be used if not specified).
  • orderId — payment ID generated by the app (optional). If you specify this parameter in your system, you will receive it via our API. If not specified, will be generated automatically (uuid). 150 characters max.
  • developerPayload — a string with additional order information that you can set when confirming the purchase. This string overrides the value set during initialization. Maximum length is 250 characters.
  • appUserId — the internal user ID in your application (optional parameter). A string with a maximum length of 128 characters.
    tip

    For example, this parameter can be used to detect cases of fraud in your application, which will help improve its security.

  • appUserEmail — this is an optional parameter that allows you to specify the user's email address in your application. If the buyer's email address was provided during registration in the app, it can be passed for automatic filling of the email field when sending a receipt — both for payments outside RuStore and in cases where the user is not authorized in RuStore. This saves the user from having to manually enter their email, shortens the purchase flow, and helps increase conversion.

Working with PurchaseEventListener

This interface is a set of callbacks that are triggered during the purchase process.

PurchaseEventListener interface
public interface PurchaseEventListener {
    public fun onPurchaseCreated(purchaseId: PurchaseId, invoiceId: InvoiceId)
    public fun onPaymentStarted(purchaseId: PurchaseId, invoiceId: InvoiceId)
    public fun onPaymentCompleted(purchaseId: PurchaseId, invoiceId: InvoiceId)
    public fun onPaymentFailed(purchaseId: PurchaseId?, invoiceId: InvoiceId?)
    public fun onPurchaseCancelled(purchaseId: PurchaseId?, invoiceId: InvoiceId?)
}

The implementation is passed to the purchase() and purchaseTwoStep() methods. These notifications allow you to receive purchaseId and invoiceId data at different stages of the purchase flow so you can work with this information. For example, you can send these values to analytics or store them in a database.

PurchaseEventListener usage example
val params = ProductPurchaseParams(
    productId = ProductId("productId"),
    orderId = null,
    quantity = null,
    developerPayload = null,
    appUserId = null,
    appUserEmail = null,
)
val purchaseEventListener = object : PurchaseEventListener {
    override fun onPurchaseCreated(purchaseId: PurchaseId, invoiceId: InvoiceId) {
        // Method implementation when a purchase is created
    }
    override fun onPaymentStarted(purchaseId: PurchaseId, invoiceId: InvoiceId) {
        // Method implementation when the payment starts
    }
    override fun onPaymentCompleted(purchaseId: PurchaseId, invoiceId: InvoiceId) {
        // Method implementation when the payment is successfully completed
    }
    override fun onPaymentFailed(purchaseId: PurchaseId?, invoiceId: InvoiceId?) {
        // Method implementation when the payment fails
    }
    override fun onPurchaseCancelled(purchaseId: PurchaseId?, invoiceId: InvoiceId?) {
        // Method implementation when the purchase is cancelled
    }
}
RuStorePayClient.instance.getPurchaseInteractor()
    .purchase(params = params, sdkTheme = SdkTheme.LIGHT, purchaseEventListener = purchaseEventListener)
    .addOnSuccessListener { result ->
        // Logic for handling a successful purchase result
    }
    .addOnFailureListener { throwable: Throwable ->
        when(throwable){
            is RuStorePaymentException.ProductPurchaseException -> // Handle product purchase error
            is RuStorePaymentException.ProductPurchaseCancelled -> // Handle product purchase cancellation
            else -> // Handle error
        }
    }

Confirming purchase​

Only purchases started with the two-step payment flow (with an authorization hold) require confirmation. After a successful hold, such purchases will have the status PurchaseStatus.PAID.

To capture funds from the buyer’s card, you must confirm the purchase using confirmTwoStepPurchase.

Calling confirmation method
RuStorePayClient.instance.getPurchaseInteractor().confirmTwoStepPurchase(
    purchaseId = PurchaseId("purchaseId"),
    developerPayload = null,
    )
    .addOnSuccessListener {
        // Successful purchase confirmation logic
    }.addOnFailureListener { throwable: Throwable ->
        // Handling error
    }
  • purchaseId — product ID.
  • developerPayload — a string with additional order information that you can set when confirming the purchase. This string overrides the value set during initialization. Up to 250 characters. If provided, it overrides the value set when starting the purchase via purchase / purchaseTwoStep.

Cancelling purchase​

With our SDK you can cancel only the purchases that undergo a two-stage payment process, i.e. when the user's money is put on hold. After a successful hold, such purchases are in the PurchaseStatus.PAID status. If a purchase is canceled it has the PurchaseStatus.REVERSED status.

tip

Cancel purchases if you cannot deliver your product after payment is made (when the user's money is put on hold).

To cancel a purchase (put the user's money off hold), use the cancelTwoStepPurchase method.

RuStorePayClient.instance.getPurchaseInteractor().cancelTwoStepPurchase(
    purchaseId = PurchaseId("purchaseId"),
    )
    .addOnSuccessListener {
        // Process success
    }.addOnFailureListener { throwable: Throwable ->
        // Process error
    }
  • purchaseId — product ID.

Retrieving purchase information​

Go get purchase information, use the getPurchase method.
Calling the method to retrieve the user’s purchases
RuStorePayClient.instance.getPurchaseInteractor().getPurchase(PurchaseId("purchaseId"))
     .addOnSuccessListener { purchase: Purchase ->
        when(purchase) {
            is ProductPurchase -> {
                // Product purchase result handling logic
            }
            is SubscriptionPurchase -> {
                // Subscription purchase result handling logic
            }
            else -> {
                // Purchase result with basic fields handling logic
            }
        }
    }
    .addOnFailureListener { throwable: Throwable ->
        // Handling error
    }

The method returns information about a specific purchase in any status.

Details of the purchase models ProductPurchase and SubscriptionPurchase are provided in their respective sections.

Getting purchase list​

Go get the user's purchases list, use the getPurchases method.

Calling the method to retrieve the user’s purchases
RuStorePayClient.instance.getPurchaseInteractor().getPurchases()
     .addOnSuccessListener { purchases: List<Purchase> ->
        // Logic of working with a list of user's purchases
    }
    .addOnFailureListener { throwable: Throwable ->
       // Handling error
    }

This method allows to filter purchases by product type and purchase status:

Product types:

  • Consumable products - ProductType.CONSUMABLE_PRODUCT
  • Non-consumable products - ProductType.NON_CONSUMABLE_PRODUCT
  • Subscriptions - ProductType.SUBSCRIPTION

Purchases status:

  • For products:

    • PAID: Successful holding of funds, purchase awaiting confirmation from the developer.
    • CONFIRMED: Purchase confirmed, funds debited.

  • For subscriptions:

    • ACTIVE: Subscription is active.
    • PAUSED: Subscription is Hold period (for example if funds are sufficient), charge attempts continue according to the subscription plan settings..

By default, filters are disabled. If no values are provided, the method returns all user purchases with statuses PAID, CONFIRMED, ACTIVE, and PAUSED, regardless of product type.

Calling the method to retrieve the user’s purchases with filters
RuStorePayClient.instance.getPurchaseInteractor().getPurchases(
    productType = ProductType.CONSUMABLE_PRODUCT,
    purchaseStatus = ProductPurchaseStatus.PAID,
)
     .addOnSuccessListener { purchases: List<Purchase> ->
        // Logic of working with a list of user's purchases
    }
    .addOnFailureListener { throwable: Throwable ->
        // Handling error
    }

Purchase result structure​

ProductPurchaseResult - the result of a successful digital product payment (for one-step payments) or a successful fund hold (for two-step payments).

public class ProductPurchaseResult internal constructor(
public val orderId: OrderId?,
public val purchaseId: PurchaseId,
public val productId: ProductId,
public val invoiceId: InvoiceId,
public val purchaseType: PurchaseType,
public val productType: ProductType,
public val quantity: Quantity,
public val sandbox: Boolean,
)

  • ProductPurchaseResult — the result of a successful digital product payment (for one-step payments) or a successful fund hold (for two-step payments).

    • purchaseId - purchase identifier. Used to get purchase information in the SDK using the get purchase information method.
    • productId - identifier of the purchased product, specified when creating it in the RuStore developer console.
    • invoiceId - invoice identifier. Used for server-side payment validation, searching for payments in the developer console, and is also displayed to the buyer in the payment history in the RuStore mobile app.
    • orderId - unique payment identifier, specified by the developer or generated automatically (uuid).
    • purchaseType - purchase type (ONE_STEP/TWO_STEP/UNDEFINED - one-step/two-step/undefined).
    • quantity - product quantity - optional. If not specified, the value will be set to 1. Applicable only for purchasing consumable products.
    • sandbox - a flag indicating a test payment in the sandbox. If TRUE - the purchase was made in test mode.

Error handling​

If an error occurs during the payment process or the user cancels the purchase, the execution of the payment method (both with the choice of purchase type and the two-step method) terminates with an error:

  • ProductPurchaseException - product purchase error.
  • ProductPurchaseCancelled - an error caused by cancelling a product purchase (the user closed the payment sheet) before receiving the purchase result. In this case, it is recommended to additionally check the purchase status using the get purchase information method.

Error and purchase cancellation structure

public class ProductPurchaseException internal constructor(
    public val orderId: OrderId?,
    public val purchaseId: PurchaseId?,
    public val productId: ProductId?,
    public val invoiceId: InvoiceId?,
    public val quantity: Quantity?,
    public val purchaseType: PurchaseType?,
    public val productType: ProductType?,
    public val sandbox: Boolean?,
    public override val cause: Throwable,
) : RuStorePaymentException(message = "Error purchase product", cause = cause)
  • purchaseId — purchase identifier. Used to get purchase information in the SDK using the get purchase information method.
  • productId — identifier of the purchased product, specified when creating it in the RuStore developer console.
  • invoiceId — invoice identifier. Used for server-side payment validation, searching for payments in the developer console, and is also displayed to the buyer in the payment history in the RuStore mobile app.
  • orderId — unique payment identifier, specified by the developer or generated automatically (uuid).
  • purchaseType — purchase type (ONE_STEP/TWO_STEP/UNDEFINED — one-step/two-step/undefined).
  • quantity — product quantity - optional. If not specified, the value will be set to 1. Applicable only for purchasing consumable products.

ProductPurchaseCancelled — cancellation of a digital product purchase. The payment dialog was closed before receiving the purchase result, so the purchase status is unknown. It is recommended to request the purchase status separately using the get purchase information method.

public class ProductPurchaseCancelled internal constructor(
    public val purchaseId: PurchaseId?,
    public val purchaseType: PurchaseType?,
    public val productType: ProductType?,
) : RuStorePaymentException(message = "Purchase product is cancelled")
  • purchaseId — purchase identifier. Used to get purchase information in the SDK using the get purchase information method.
  • purchaseType — purchase type (ONE_STEP/TWO_STEP/UNDEFINED — one-step/two-step/undefined).
  • productType - product type (NON_CONSUMABLE_PRODUCT - non-consumable product, CONSUMABLE_PRODUCT - consumable product, SUBSCRIPTION - subscription).

Server-side purchase validation​

If you need to validate a successful purchase in RuStore, you can use the public validation APIs. Different methods are used for products and subscriptions:

  • To validate a product purchase, use the invoiceId from the ProductPurchaseResult returned after the purchase completes.
  • To validate a subscription purchase, use the purchaseId from the ProductPurchaseResult returned after the purchase completes.

You can determine the purchased product type from the data contained in the ProductPurchaseResult.

Getting invoiceId from purchase result
val params = ProductPurchaseParams(ProductId("productId"))
 
RuStorePayClient.instance.getPurchaseInteractor()
    .purchase(params = params, preferredPurchaseType = PreferredPurchaseType.TWO_STEP)
    .addOnSuccessListener { result ->
        when (purchaseResult.productType) {
            CONSUMABLE_PRODUCT,
            NON_CONSUMABLE_PRODUCT -> {
                val invoiceId = purchaseResult.invoiceId.value
                yourApi.validateProduct(invoceId)
            }
 
            SUBSCRIPTION -> {
                val purchaseId = purchaseResult.purchaseId.value
                yourApi.validateSubscription(purchaseId)
            }
        }
    }

You can also get invoiceId in Purchase model. Purchase model can be retrieved using getPurchases() or getPurchase methods.

Getting subscriptionToken from purchase result
RuStorePayClient.instance.getPurchaseInteractor().getPurchases()
    .addOnSuccessListener { purchases ->
        purchases.forEach { purchase ->
            if(purchase is SubscriptionPurchase){
                val purchaseId = purchase.purchaseId.value
                yourApi.validateSubscription(purchaseId)       
            } else {
                val invoiceId = purchase.invoiceId.value
                yourApi.validateProduct(invoiceId)
            }
        }
    }

RuStoreUtils​

RuStoreUtils is a block in the native SDK containing a set of public methods intended for interacting with the RuStore app on the user's device.

To access the block's methods in the Unity environment, use the singleton class RuStoreCoreClient.

The IsRuStoreInstalled method checks if the RuStore app is installed on the user's device.

Calling the IsRuStoreInstalled method
if (RuStorePayClient.Instance.IsRuStoreInstalled()) {
    // RuStore is installed on the user's device
} else {
    // RuStore is not installed on the user's device
}

The openRuStoreDownloadInstruction method opens a web page for downloading the RuStore mobile application.

Calling the openRuStoreDownloadInstruction method
RuStoreCoreClient.Instance.openRuStoreDownloadInstruction();

The openRuStore method launches the RuStore mobile application. When this method is called, if the RuStore app is not installed, a Toast notification with the message "Failed to open the application" will be displayed.

Calling the openRuStore method
RuStoreCoreClient.Instance.openRuStore();

The openRuStoreAuthorization method launches the RuStore mobile application for authorization. After successful user authorization, the RuStore app will automatically close. When this method is called, if the RuStore app is not installed, a Toast notification with the message "Failed to open the application" will be displayed.

Calling the openRuStoreAuthorization method
RuStoreCoreClient.Instance.openRuStoreAuthorization();

Список ошибок​

Error list​

RuStorePaymentNetworkException - SDK network interaction error. The error model returns an error code (the code field), which can be used to determine the cause of the error. A table with error codes is available in the error codes section.

The message field contains a description of the error's cause.

public class RuStorePaymentNetworkException internal constructor(  
    public val code: String?,  
    public val id: String,  
    public override val message: String,  
    public override val cause: Throwable? \= null,  
) : RuStorePaymentException(message, cause)
  • RuStorePaymentNetworkException — SDK network communication error;
  • RuStorePaymentCommonException — general SDK error;
  • RuStorePayClientAlreadyExist — SDK re-initialization error;
  • RuStorePayClientNotCreated — attempt to access public SDK interfaces before initialization;
  • RuStorePayInvalidActivePurchase — payment initiated for unknown product type;
  • RuStorePayInvalidConsoleAppId — the required parameter console_application_id for SDK initialization is not specified;
  • RuStorePaySignatureException — invalid response signature. Occurs when attempting fraudulent actions;
  • EmptyPaymentTokenException — error obtaining payment token;
  • InvalidCardBindingIdException — error when paying with a saved card;
  • ApplicationSchemeWasNotProvided — scheme for the return deeplink is not specified;
  • ProductPurchaseException — product purchase error. The model structure is described in the section purchase result structure;
  • ProductPurchaseCancelled — product purchase was cancelled (the user closed the payment sheet). The model structure is described in the section purchase result structure;
  • ProductPurchaseException — product purchase error;
  • RuStoreNotInstalledException — RuStore is not installed on the user's device;
  • RuStoreOutdatedException — the installed version of RuStore on the device does not support payments;
  • RuStoreUserUnauthorizedException — the user is not authorized in RuStore;
  • RuStoreApplicationBannedException — the application is banned in RuStore;
  • RuStoreUserBannedException — the user is banned in RuStore.

Error Codes​

Error CodeDescription
4000001The request is malformed: a required parameter is missing or incorrectly filled, or the data format is invalid.
4000002, 4000016, 4040005Application not found.
4000003Application is banned.
4000004Application signature does not match the registered one.
4000005Company not found.
4000006Company is banned.
4000007Company monetization is disabled or inactive.
4000014Product not found.
4000015Product not published.
4000017Invalid quantity parameter.
4000018Purchase limit exceeded.
4000020Product already purchased.
4000021Unfinished product purchase.
4000022Purchase not found.
4000025No suitable payment method found.
4000026Invalid purchase type for confirmation (should be two-stage payment).
4000027Invalid purchase status for confirmation.
4000028Invalid purchase type for cancellation (should be two-stage payment).
4000029Invalid purchase status for cancellation.
4000030The issued token does not match the purchased product.
4000041An active subscription already exists for this product code.
4000045Maximum size limit exceeded.
4010001Access to the requested resource is forbidden (unauthorized).
4010002Token lifetime has expired.
4010003Payment token is invalid.
4030001Payment token not provided.
4030002User is blocked due to security requirements.
4040002, 4040003, 4040004Payment system error.
5000***Internal error.