For the complete documentation index, see llms.txt. This page is also available as Markdown.

API & SDK at a glance

You can check the main features provided by App in Toss and related documents in one place. You can go directly to the required Client SDK documentation or server API documentation for each feature.

View sample project

Please update WebView projects to SDK 3.x.

SDK 3.x is an update that improves the structure of WebView projects. The configuration file names and some properties have changed, and the Client SDK has been reorganized around domain objects.

If you are operating a WebView project SDK 3.x migration Please check the documentation.

Feature
Description

You can issue an anonymous user identification key that can distinguish users without login.

You can verify on the server whether the anonymous user identification key issued by the SDK is valid.

User information

You can retrieve the personal information or age group information the user has agreed to share.

Toss Login

You can log in with a Toss account and receive an authorization code.

Toss Login API

You can use server APIs such as AccessToken issuance, user information lookup, and disconnecting login connections.

Toss Authentication

You can use features such as Toss certificate signing or checking whether Toss Login is linked.

In-app Purchases

You can proceed with in-app purchases in the App Store or Play Store.

In-app Purchase API

You can check the in-app purchase order status on the server.

You can open the Toss Pay payment window and proceed with one-time payment or recurring payment authentication.

Toss Pay API

You can use server APIs for Toss Pay payment execution, status lookup, refunds, and more.

Promotion reward

You can use Toss Points reward payouts or friend invitation features.

Promotion API

You can use APIs for generating Toss Points payout keys and executing reward payouts.

Push, notification API

You can send test messages, single messages, and bulk messages from the server.

Notification consent

You can ask the user for consent to receive notifications.

Sharing

You can create a Toss share link or open a message sharing window.

Review request

You can request users to write an app review at a time when they are likely to feel satisfied.

Ads

You can use ad features such as interstitial ads, rewarded ads, and AdMob ads.

User behavior tracking

You can record click, impression, screen entry, and user behavior events.

Data SDK API

You can check the server APIs required for Data SDK integration.

Safe Area

You can retrieve or subscribe to screen margin values so they are not hidden by notches or rounded corners.

Screen control

You can control actions such as closing the screen, setting orientation, keeping the screen always on, and preventing capture.

Device

You can use device features such as opening external URLs, camera, album, contacts, location, and haptics.

Permissions

You can check or request device permissions such as camera, location, photo library, contacts, and clipboard.

Clipboard

You can retrieve text stored in the clipboard or copy text.

File

You can save a Base64 file to the device or open a PDF file in the native viewer.

Game

You can use Game Center leaderboard, game profile, and score registration features.

Storage

You can save and read user information on the device.

Environment

You can check information such as the runtime environment, Toss app version, network status, server time, and language.

Last updated

Was this helpful?