The Samsung Checkout DPI (Digital Product Inventory) Portal 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.
The Samsung Checkout DPI provides 3 types of environments as followings.
Operating Zone (Live / Production Environment)
The payment made in Operating Zone causes a charge on the part of partner when refund is made while being categorized as a real payment. Thus, beware not to use for the sake of test purpose.
Staging Zone (Test / Developing Environment)
Dummy Payment (Developing Environment)-
Since the Data on the Operating Zone and the Data in Staging Zone cannot be shared, product type and price on both the Staging Zone and the Operating Zone should correspond when App is put into QA for game release.
When submitting App after completing development integrated with Billing, the submission should be done after setting Staging Zone or Operating Zone to be seen in accordance with TV environment. Refer to the below Example.
An account for the Samsung Apps TV Seller Office is required to use the DPI service. Once registered, partners can use the DPI service by following these steps:
Once a new app is registered, Seller Office will issue an AppID. This AppID is a key value linking the Seller Office and DPI systems for the partner.
For more details, please refer to Application Registration.
When registering the App in the Seller Office, the option of “Use Samsung Billing (found at the 2nd stage at the App registration stage)” should be checked so as to link the DPI and Seller.
Once an AppID is generated, the partners will be able to see the new app from the “My Apps” Details tab from DPI.
Please contact the account manager if the permission isn’t granted within 24 hours.
Once app approval is completed in the DPI service, 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.
The issued security key is a key to be used for Open API calls made by a Smart TV app. Please be careful not to reveal this key to others.
You can check sales country on “App Setting” menu on the App. When expanding the countries available for service, you should additionally register the country.
The list of countries that are additionally registered by seller is synchronized at UTC – 5 ~ 6 o’ clock every day. (During these hours, access to the site is not available.) In order to equally apply the products to the countries that are newly added, you should process the following procedure on DPI: “Product List” > Click on the products > Enter the information of the country newly added > Save > Press “Confirm” button.
The synchronization on the list of countries to include the countries newly added by the seller can be done not only during the time when the daily automatic synchronization occurs, but also by accessing the “App Setting” menu on the App.
For product registration, both individual registration and batch registration are supported. After product registration, the registered product goes into “Inactive” status and can be changed to “Active” status after a confirmation process.
Products can be registered under “Add a New Product” menu.
The following table explains the details of input fields.
The following table explains the details of "Product Type".
More than one item can be registered at the same time under the "Add Multiple Products" menu. Download the provided CSV template, and enter the details according to the registration form and register the products.
The template which is provided for registration of multiple products is using the same template as the downloaded products list from "Product List" menu. This function can be used to match the products information between Staging Zone and Operating Zone as following way.
After the products information setting at Staging Zone, develop and test at Staging Zone.
Download a verified products list at Staging Zone.
Go to the Portal of Staging Zone (https://sbox-dpi.samsungcloudsolution.com), select "Product List" menu and check the checkbox of products that you want, and click "Download" button.
Upload downloaded products list to the Operating Zone.
Go to the Portal of Operating Zone (https://dpi.samsungcheckout.com/), select "Add Multiple Products" and upload the CSV template which is downloaded at the above 2nd step.
At "Product List" menu, check the information of uploaded products, and click the "Confirm Pending Changes" button if all information is correct.
This is a step to confirm the products before putting them directly on sale or making changes. If product is registered, modified or deleted, it is not directly set as available for sale and changes are registered in the Pending tab. If the seller checks the list of registered items and confirms its products, the corresponding products are set as available for sale.
In case of "Dynamic Product", the setting of each product has to managed by CMS not DPI. DPI has only a representative product ID so if you make any changes on the product ID here, it will applies every products referring this representative ID
It is possible to check details in “Product List” menu.
The following diagram explains product lifecycle.
Please refer to the details of each status at the following table.
Table 2-9 Product Status Description
In order to suspend the sales of a particular product, when "Retire" button on the "Product List" > "Product Details" page is pressed, the relevant product is set to be in the Retire status, and the purchase of the product is disenabled since then.
For already made purchases on the product, refund should be considered depending on the policy of partner, and the refund on the purchases should be made by "Transaction List (All Apps)" menu. Return on the products finished with refund should be done in reference to Chapter 1.3.5.
"Retire" function is provided on "Product List" > "Product Details" page.
"Delete" function is provided on "Product List" menu.
The products with no purchase history can be done with "Delete" not "Retire", and the products deleted cannot be purchased and cannot be viewed on the "Product List" page.
To get refund on the purchase history for tests or to request for a refund, partner can directly give refund for each of transaction on "Sales Management" > "Transaction List (All Apps)" page.
If the product type is 'Dynamic Product', please note the each field means as the following.
The DPI only maintains the transaction history along with settlement related information. CMS of partner has to produce content-level sales report if needed.
Table 2.12 Transactions List of "Dynamic Product"
When calling Request Purchases List API after running the application, purchase history with CancelStatus Parameter on the Response being “true” are deemed to be refunded, and CP should retrieve the product by itself. However, the products with subscription can be checked in a different way, and please refer to the following chapter for details.
For the case of the products with subscription, cancellation and refund have different meaning.
Cancellation means payment being disabled from the next Cycle. This means the previous purchase history including the current payment Cycle not being refunded. Thus, the user will be in a status of payment up to the current Cycle.
If the user wants to use the service again, then the user should purchase a subscription product again.
Refund can be made for the payments made for each Cycle. Refund and Cancellation are separate. If only Refund is being made, payment for the next following Cycle will continue.
If a user requests for refund, the request should be distinguished whether the user wants the refund only for the current Cycle, or the user wants no payment for the upcoming Cycle as well.
If the user wants no payment for the upcoming Cycle, the refund and cancellation should be done as stated below:
The following page shows Refund, Cancellation, End date change.
Changing the subscription end date to a date earlier than the date of today is not possible.
In order to check whether the cancellation is being made or not, App code should be configured to identify whether the subscription service period has been expired or not by checking SubsStatus Parameter and SubsEndTime Parameter of the Response when Request Purchases List API was called after running the App.
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.
Table 3.1 Product Purchase Period
Partner can check all product purchase history on the DPI Portal with no restrictions in time period.
Table 3.2 Glossary Table