Payment

Available in Classic and VPC

Payment

You can sell in-game items using the in-app payment feature provided by the GAMEPOT SDK. Before checking out, you need to set Configuration by store to match the applicable store. Also, if the item has not been added to Dashboard > Payment > In-app, an error "ProductID not found" will occur.

Android

This guide describes how to retrieve product information, request payments, and recover unprocessed payments on Android.

(AOS) Import in-app information

When checking out, you need to display payment information and local currency information on the page. You can use the functions below to get the current payment currency, name, etc. If the import fails, check your console settings.

Kotlin:

import com.nbase.sdk.Store

NBase.getProductItems() {products, e -> 
    if (e != null) {
        Log.e("NBase", e.message)
    } else {
        // In-app item information
        Log.e("NBase", products)
    }
}

Java:

NBase nBase = NBase.INSTANCE;

nBase.getProductItems((products, e) -> {
    if (e != null) {
        Log.e("NBase", "getProductItems fail: " + e.getMessage());
    } else {
        if (products != null) {
            Log.e("NBase", "getProductItems success: " + products.toString());
        }
    }
    return null;
});

The following table describes the values passed to the product information retrieval callback.

• Callback

(AOS) Request payment

You can request a payment using the productId from the imported in-app information.

Kotlin:

import com.nbase.sdk.Store

NBase.purchase (activity, Store.GOOGLE, productId, metadata, options) { purchase, e -> 
    if (e != null) {
        Log.e("NBase", e.message)
    } else {
        Log.e("NBase", purchase)
    }
}

Java:

import com.nbase.sdk.Store;

NBase nBase = NBase.INSTANCE;
nBase.purchase (activity, storeId, productId, metadata, options, (purchase, e) -> {
    if (e != null) {
        Log.e("NBase", "purchase fail: " + e.getMessage());
    } else {
        if (purchase != null) {
            Log.e("NBase", "purchase success: " + purchase.toString());
        }
    }
    return null;
});

The following table describes the parameters passed when making a payment request.

• Parameter

The following table describes the store values that can be passed to storeId.

The following table describes the values passed to the payment request callback.

• Callback

(AOS) Recover unprocessed payment

It restores purchases that were completed but whose results were not delivered to the game. When you request restoration using restorePurchase, the restored purchase information is delivered one entry at a time to the listener registered via setPurchaseRestoreListener.

• Register recovery listener

Since the SDK begins the restore process immediately after login is complete, register the listener once before calling the login method. Recovery results automatically performed by the SDK during login and when returning to the app are also delivered to the same listener, and a successful transaction for the same purchase is delivered only once.

Kotlin:

NBase.setPurchaseRestoreListener { purchase, e ->
    if (e != null) {
        // Recovery failure
        Log.e("NBase", "restore Failed: ${e.message}")
    } else {
        // Recovery success: Grant items using orderId and productId.
        Log.d("NBase", "restore Success: ${purchase?.get("orderId")} / ${purchase?.get("productId")}")
    }
}

Java:

NBase nBase = NBase.INSTANCE;
nBase.setPurchaseRestoreListener((purchase, e) -> {
    if (e != null) {
        // Recovery failure
        Log.e("NBase", "restore Failed: " + e.getMessage());
    } else if (purchase != null) {
        // Recovery success: Grant items using orderId and productId.
        Log.d("NBase", "restore Success: " + purchase.get("orderId") + " / " + purchase.get("productId"));
    }
    return null;
});

This section describes the values passed to the recovery listener callback.

• Callback

• Request recovery

Call after initialization and login.

Kotlin:

NBase.restorePurchase(activity) { success, e ->
    if (e != null) {
        Log.e("NBase", "restorePurchase Failed: ${e.message}")
    } else {
        Log.d("NBase", "restorePurchase Success")
    }
}

Java:

NBase nBase = NBase.INSTANCE;
nBase.restorePurchase(activity, (success, e) -> {
    if (e != null) {
        Log.e("NBase", "restorePurchase Failed: " + e.getMessage());
    } else {
        Log.d("NBase", "restorePurchase Success");
    }
    return null;
});

The following table describes the parameters passed when making a recovery request.

• Parameter

The following table describes the values passed to the recovery request callback.

• Callback

• Remove recovery listener

Remove a registered listener.

Kotlin:

NBase.setPurchaseRestoreListener(null)

Java:

NBase.INSTANCE.setPurchaseRestoreListener(null);

iOS

This section describes how to view product information and request payment on iOS.

(iOS) Import in-app information

When checking out, you need to display payment information and local currency information on the page. You can use the functions below to get the current payment currency, name, etc. If the import fails, check your console settings.

Swift:

let products = NBase.getProductItems()

Objective-C:

[NBaseBridge.shared getProductItems:^(NSString * _Nullable result) {
    NSLog(@"getProductItems result: %@", result);
}];

The following table describes the values passed to the product information retrieval callback.

• Callback

(iOS) Request payment

You can request a payment using the productId from the imported in-app information.

Swift:

NBase.purchase (productId: productId, metadata: metadata, options: options) { result in
    switch result {
    case .success(let data):
        NBase.showToast(message: data?.encodeToJson() ?? "")
    case .failure(let error):
        NBase.showToast(message: error.errorDescription ?? "")
    }
}

Objective-C:

[NBaseBridge.shared purchase:productId metadata:metadata options:options :^(NSDictionary * _Nullable result, NSError * _Nullable error) {
    if (error) {
        NSLog(@"purchase Error: %@", error.localizedDescription);
    } else {
        NSLog(@"purchase succeeded with result: %@", result);
    }
}];

The following table describes the parameters passed when making a payment request.

• Parameter

The following table describes the values passed to the payment request callback.

• Callback

Unity

This section describes how to retrieve product information, request payment, and recover unprocessed Android payments in Unity.

(Unity) Import in-app information

When checking out, you need to display payment information and local currency information on the page.
You can use the functions below to get the current payment currency, name, etc. If the import fails, check your console settings.

NBaseSDK.NBase.getProductItems((products, error) => 
{
    if (products != null && products.Count > 0)
    {
        // Go through the list of products.
        foreach (var product in products)
        {
            // It shows the information of each product as a toast message.
            // In the example, product.ToString() is called,
            // but in reality, you can display the specific properties (e.g., name, price, etc.).
            NBaseSDK.NBase.showToast(product.ToString());
        }
    }
    else
    {
        // If the product list is empty, the user will be notified.
        NBaseSDK.NBase.showToast("The product list is empty.");
    }
});

The following table describes the values passed to the product information retrieval callback.

• Callback

(Unity) Request payment

You can request payment by productId in the imported in-app information.

NBaseSDK.NBase.purchase (Store.google.ToString(), productId, metadata, options, (purchase, error) => 
{
    if (error != null)
    {
        Debug.Log(error.Message.ToString());
        return;
    }
    // Payment succeeded.
});

The following table describes the parameters passed when making a payment request.

• Parameter

The following table describes the store values that can be passed to storeId.

The following table describes the values passed to the payment request callback.

• Callback

(Unity) Recover unprocessed payment

It restores purchases that were completed but whose results were not delivered to the game. When you request restoration using restorePurchase, the restored purchase information is delivered one entry at a time to the listener registered via setPurchaseRestoreListener.

• Register recovery listener

Since the SDK begins the restore process immediately after login is complete, register the listener once before calling the login method. Recovery results automatically performed by the SDK during login and when returning to the app are also delivered to the same listener, and a successful transaction for the same purchase is delivered only once.

NBaseSDK.NBase.setPurchaseRestoreListener((purchase, error) =>
{
    if (error != null)
    {
        // Recovery failure
        Debug.Log("restore Failed: " + error.Message);
        return;
    }
    // Recovery success: Grant items using orderId and productId.
    Debug.Log("restore Success: " + purchase.orderId + " / " + purchase.productId);
});

This section describes the values passed to the recovery listener callback.

• Callback

• Request recovery

Call after initialization and login.

NBaseSDK.NBase.restorePurchase((success, error) =>
{
    if (error != null)
    {
        Debug.Log("restorePurchase Failed: " + error.Message);
        return;
    }
    Debug.Log("restorePurchase Success");
});

The following table describes the values passed to the recovery request callback.

• Callback

• Remove recovery listener

Remove a registered listener.

NBaseSDK.NBase.removePurchaseRestoreListener();

Troubleshooting

This section describes common errors that occur when trying to integrate payments and what to check.

Q. A ProductID not found error occurs.
A. Check if the applicable product ID is registered in Dashboard > Payment > In-app.

Q. The payment is not going through.
A. See Configuration by store and check if the settings applicable for the store have been completed.

Q. (Android) java.lang.NoClassDefFoundError: Failed resolution of: Lcom/android/billingclient/api/BillingClient;
A. Add the following code.

<androidPackage spec="com.android.billingclient:billing:8.0.0" />

Q. (iOS) In-app information cannot be retrieved.
A. Make sure that the in-app product information and app environment (Production/Sandbox) are the same as those registered in Apple Connect.