Samsung Checkout DPI Portal

Overview

The Samsung Checkout DPI (Digital Product Inventory) Portal(https://dpi.samsungcheckout.com/) is a web service portal designed for the Samsung Smart TV partners, which Samsung helps them sell products and items through Smart TV Apps. From the DPI, partners can register and manage products for sale and access the transaction history logs and sales reports for the applications they own.

DPI Main Services

  • Product management (Standard in-app products, Subscriptions, Paid apps)
  • Order management (purchase history for each user)
  • Sales reports and financial reports
  • Coupon management (creation and issuance)

Service Initiation Process

Figure 1. Service Initiation Flow
An account for the Samsung Apps TV Seller Office is required to use the DPI service. Once registered, partners can use the DPI service

※ DPI Mini Guide helps to grasp the overall workflow of Samsung Checkout service and DPI site :
- Mini Guide Download

Issuance of Security Key

An application security key is issued to safely use the service. The issued key can be viewed under "App Setting".

The key is a security key to use API calls, and this is a protection mechanism for invalid access from/to the app and DPI. The related process is described in the section CheckValue.

Figure 2. Security Key Issuance


Product Type

The following table explains the details of "Product Type".

Product Type Description
Consumable Consumers can purchase this type of product anytime. Purchase history can be retrieved for 90 days.
Non-Consumable Consumers can purchase this type of product only once. Purchase history can be retrieved with no time restriction.
Limited Period Once this type of product is purchased, repurchase cannot be made during the time when the product effect set by CP lasts. Purchase history can be retrieved for 90 days. If “Limited Period” product type is chosen, the duration of time for the product effect to last can be entered in the units above minute. The duration time for the product effect to last is allowed for the maximum of 90 days.
Subscription DPI system processes automatic payment on a certain designated cycle.
Paid App For paid apps, when you register your app on DPI system you need to select it as paid app.
Dynamic Product In case that pater and Samsung agree on that products and prices will be managed by CMS of partner not Samsung’s DPI, partner should select “Dynamic Product” as a product type.
Even though all the information of actual products are on CMS, partner need to register a representative item on DPI once so that our system can display information on Samsung Smart TV App/Game store which is legally required and verify which server we need to call for certain products : CMS or DPI.

If Dynamic Product is chosen,
  • Partner does not register each products on DPI that partner sells in their app actually
  • Partner builds and operates its own CMS to manage products information including prices and to verify purchase requests
  • Additional requirements
    • Verification/No Verification:
      ‘Verification’ is a recommended option otherwise partner has to handle the verification process by themselves and take all the responsibility for all the error cases related to verification process.
      If ‘Verification’ is selected, ‘Verify URI’ is also required. This URI should serve the function of checking product information such as product itself, price and currency

    • Price Setting
      Price range information of products that you actually sells in your app is required by country/location. It is not used for actual payment for providing the app information on Samsung Smart TV App/Game store which is legally required.
      Thus, it has to be updated when the price range of your products is changed.

Subscription Plan

Checkout supports upgrade, downgrade, cross-downgrade subscription plan.

Figure 3. Supscription Plan

  • Create a subscription group to set the subscription level.
  • In the same group, consumers can upgrade and downgrade freely.
  • Cross-downgrade API is currently possible,
  • Checkout does not provide Cross-upgrade API.

Field Description

The following table explains the details of input fields.

Input Field Description
Product Name
(Representative product name)

The name of the product used in the representative country/location must be entered in the Country/Location:Product Name field. This field cannot be left empty.
Product ID Alphanumeric and two special characters ('-', '_') are allowed. (Maximum 20 bytes)
Product Description Describe the product.
Type Following product types are allowed;
Consumable, Non-Consumable, Limited Period, Paid App, Subscription, Dynamic Product

Period If the product type is ‘Limited Period’, a number fewer than 129,600 in minutes is allowed. (Maximum 90 days)
Billing Period If the product type is "Subscription" , "Weekly","Monthly","Annualy" is allowed.
Subscription Group It is necessary to make a subscription group before creating subscription item.
Free Trial Period If the product type is "Subscription", a number in Days is allowed.
Visibility A field indicating whether the product can be shown. "Show" , "Hide" and "Optional" is allowed.
Duplication Benefit The condition defines whether a free days offer whether it should be offered once per account/device or both.
Expiration If the product type is "Subscription" , "Not Applicable" ,"1 Month", "6 Month", "1 Year" is allowed.
Country/Location:Product Name The country/location and product name are separated by ':' and a maximum of 50 bytes of product name is allowed. If more than one country/location is entered, use '
Country/Location:Product Price The country/location and price information are separated by ':', and if more than one country/location is input, the use of the '

Transaction Policy

The DPI provides information on the status for the products purchased by users through Request Purchases List API.

In case the purchased product is not applied on the real game, the status can be checked on the “Product Applied Status”. In case the purchased product was refunded to the user, the status can be checked on the “Sales Cancellation Status”.

The period of time the above status information is provided through API to the application can be classified by the product type as shown below.

Product Type Applied Purchases
(Purchase History)

Not Applied Purchases Refund/
Cancellation

Consumable Application Date + 90days All products can be viewed with no restrictions in time period Refund Date+ 90 days
Subscription Subscription expiry date (SubsEndTime) + 90days Subscription expiry date (SubsEndTime) + 90 days Subscription expiry date (SubsEndTime) + 90 days

Glossaries

Term Description
Billing /
Payment Service

A service created in order to help monetary transactions between service providers and users.
Partner /
App Developer

Be in charge of creating products suitable for consumers of the Smart TV.
Paid App A service or app that can be only downloaded after making a payment.
In-App Purchase A method to pay for additional products and features within both free apps and paid apps.
PayPal (PayPal) The global payments company headquartered in the United States that provide the payment service via pre-registered payment method.
Digital Product Inventory (DPI) A system provided to developers to enter and manage extra products and items in their own apps. It is directly connected to the App Store.
Samsung Checkout
(Billing Client)

A payment UI module for consumers to add their choice of payment methods and pay for premium apps or special items.
Operating Zone/ Staging Zone Operating Zone is a live environment where the real users get access to Verification system is a test environment where 3rd party development and QA are conducted. (Sandbox Zone is regarded as Staging Zone.)
Operating TV / Development TV - Operating TV: TV purchased from on/off-line, TV with the same setting environment as the one in general users.
- Development TV: TV that is made in use of a board separately provided by Samsung Electronics, TV that allows a setting environment for development different from the one for general users.

CMS (Content Management System) Product catalogue management server or system including price information. In this document, this word refers to the server for the type “dynamic product” that has all the information of products and handles verification with its own product catalogue. For reference, product information of other product types should be managed in DPI not 3rd party CMS.
DPI will be looking at CMS to pull necessary product information as needed. CMS will be the source of truth regarding content metadata, purchase history (which user bought which title at which resolution of PURCHASE/RENTAL, etc.) whereas DPI will be the source of truth of transactional data (i.e. transaction amount, tax amount). Both systems will be linked by "invoice ID" that is generated by DPI and passed over to CMS for every successful transaction.

※ DPI User Guide Full Version provides detailed desciptions and examples of New DPI site functions/usages.
- Full Guide Download