English
Search
⌃K
Comment on page

Billing_3rd party

What is 3rd Party Payment?

The 3rd party payment is a payment service provided by the seller (hereafter called the “developer”) through direct interworking with Payment Gateway (PG) without the application of ONE store’s in-app payment module (in-app SDK).

How to Apply 3rd Party Payment

  • Transfer Transaction History

    • When 3rd party payment is used, the transaction history of the 3rd party payment (purchase history, cancellation history) must be transferred to ONE store and the development and review of this 3rd party payment service is needed.
    • The transaction history delivered to ONE store will be utilized for ONE store’s ranking and service and as data for settlement between ONE store and the developer.

  • Development & Review Process

  • ​
    • (A) [Developer] Register new app through ONE store Developer Center > Apps > 'Product Registration' button.
      • On the product registration screen, set the '3rd Party Payment method' option to 'Use'.
      • In the 'Agreement to use 3rd Party payment method' pop-up, you have to agree to click 'confirm'.
  • ​
    • (B) [Developer] You can get OAuth Key (Client secret) issued on the product registration screen.
  • ​
    • (C) [Developer] Development shall be made with reference to Server API Specification.
      • Issuance of an OAuth Access Token and the transmission of the transaction history, etc. shall be developed.
    • (D) [Developer] The developer is required to confirm that the transaction history has been normally transmitted in the Sandbox environment (https://sbpp.onestore.co.kr).
    • (E) [Developer] To be reviewed by ONE store, the final APK shall be uploaded on ONE store Developer Center and shall interwork with the commercial environment.
      • The commercial environment of the developer must interwork with that (https://apis.onestore.co.kr)of ONE store, and
      • the 3rd party payment gateway company interworking with the developer must interwork with the commercial environment of ONE store.
    • (F) [Developer] A review request shall be made.
    • (G) [ONE store] ONE store is required to make payment in the developer’s app and confirm the transaction history has been normally sent to the commercial environment.
    • (H) [ONE store] ONE store shall request the developer to cancel the 3rd party payment used for review (by sending a request email to the developer’s person in charge).
    • (I) [Developer] The developer shall process the requested cancellation of the transactions used for review.
    • (J) [ONE store] ONE store shall confirm that the history of the cancelled transactions has been sent to the commercial environment, and then complete the review process.
    • (K) [Developer] The developer can process to start the sales of the app for which review has been completed.

  • Criteria for Transmitting Transaction History

    • The criteria for transmitting the transaction history is as follows:
      • 3rd party payment occurs,
      • when items are directly purchased by using 3rd party payment methods.
      • when the in-app goods* are recharged by using 3rd party payment methods. (*the in-app goods : goods that can be charged only within the app and items can be purchased with this goods only at that app)
      • when items are purchased by using the developer’s own payment methods**. (**the developer’s own payment methods : payment methods that can be purchased by using 3rd party payment methods through other channels such as other apps or web of the same developer and used by multiple apps of the developer)
      • Exceptional cases occur (3rd party payment does not take place),
      • when items are purchased by using the developer’s own promotional payment methods (free coupon, point cash, etc.)
  • ​
    • Transaction history is confirmed based on Purchase ID(developerOrderId).
      • The app using 3rd party payment options is required to offer purchase ID to the user ‘when the 3rd party payment is completed’. (in the payment completion screen and in the email notice)
      • ONE store’s review team shall confirm that the transaction history has been normally sent to ONE store on a basis of the purchase ID when the 3rd party payment /cancellation is made for this app.
    • If the payment method you use is foreign exchange or encryption money, please note the following:
      • The transaction amount on the '3rd party payment developer guide' shall be transferred in Korean won at the same date. (Google search, based on 00 o'clock on the day)
      • Once confirmed by the ONE store's review team, if the correct transaction amount is not delivered, the validation rejects or sales suspension may be processed.

Server API

  • What is 3rd Party Payment Server API?

    • When the payment is completed (successful), the developer needs to have a process to send the relevant data to ONE store and synchronize the payment history. In addition, when a change (a cancellation) occurs after the payment and synchronization is completed, it is also required to transmit the history. The purchase/cancellation history of the 3rd party payment that has been transmitted to ONE store will be reflected on ONE store ranking and exposed to general customers and used as data for the settlement with the developer.
    • 3rd party payment server API is an API, which is provided to transfer to ONE store the purchase/cancellation history of the 3rd party payment incurred to the developer.
      • send3rdPartyPurchase (transmits the purchase history of the 3rd party payment)
      • cancel3rdPartyPurchase (cancels the purchase history of the 3rd party payment)
    • OAuth authentication is required first for the interworking of each API, and for the OAuth authentication, client_id and client_secret should be issued in advance.

  • Interworking Environment

    • ONE store API server is provided separately for Sandbox (the development environment) and the commercial environment according to its purpose.
      • Sandbox
      • is a virtual interworking environment to which commercial API standards have been applied as they are.
      • can be used for development review before launching the app on Developer Center once the development for interworking between ONE store and server API has been completed.
      • The payment data transferred from the developer will not be used for ranking or settlement.
      • The commercial environment
      • is a real service interworking environment where the payment history needs to be synchronized for completion or cancellation of the customer’s payment.
      • The data transferred to the commercial environment will be reflected on settlement. If a payment test is performed in the commercial environment, the payment MUST be cancelled.
      • Host information of Sandbox and the commercial environment is as follows.
        Environment
        Service Host
        Sandbox
        Commercial
        https://apis.onestore.co.kr

  • Transmit Purchase History of 3rd Party PaymentInterworking Flow

    • If the user requests a product purchase in an app, the app obtains information necessary for interworking (refer to 4. Reference Code)
    • The purchase request of the user along with the information acquired from the app is sent to the developer’s server.
    • Payment will be processed through 3rd party payment (PG company or in-app payment of other markets) in the developer’s server. The result will be sent to the app.
    • Simultaneously, the purchase history of the 3rd party payment will be transferred to ONE store API Server.
      • (In case ONE store OAuth Access Token expires,) it is required to get an OAuth Access Token issued and then perform API interworking.
      • It is recommended to save the result of the API interworking as a status value. If the interworking is in the failure status, perform retry.
​
  • ​
    • Obtain Client Information
      • App installation market information
      • Mobile carrier information
    • Make Payment Request
    • Process 3rd Party Payment
    • Complete Payment
    • [When the OAuth Token expires] Issue an OAuth Token
    • Send Purchase History of 3rd Party Payment

  • Cancel Purchase History of 3rd Party Payment

    • When the purchase history interworked to ONE store is cancelled, this cancellation history of the 3rd party payment will be transferred to ONE store API Server.
    • (In case ONE store’s OAuth Access Token expires,) it is required to get an OAuth Access Token issued and then perform API interworking.
    • It is recommended to save the result of the API interworking as a status value. If the interworking is in the failure status, perform retry.

  • Caution

    • At the time when the payment is completed or cancelled, the developer is required to transfer the relevant data to ONE store on real time.
      However, development is recommended to prevent the failed payment of items even if the transfer of the data to ONE store fails.
    • The developer is required to implement retransmission just in case when the data transfer fails due to errors in the network, etc. Ex) The data on the transfer failure is periodically re-transmitted by using the batch process

ONE store OAuth

Overview

  • For the interworking with Server API related to the transmission of the transaction history of ONE store, it is required to issue an Access Token through OAuth authentication.
  • The Access Token will be valid for 3,600 seconds. When the token expiration time expires or is less than 600 seconds, a new token can be issued by calling getAccessToken().
    • Existing Access Tokens can be used until the end of their expiration
    • Since numerous Access Tokens are issued, different Access Tokens can be obtained and used depending on the developer’s each service instance.
  • The general interworking flow is as follows:
  • The process to get an Access Token (no.1) shall be called when an authentication error occurs at the call of API.
  • To call ONE store Server API, the Authorization Bearer scheme shall be used. A sample of the call is as follows. (Bearer value is the value of Access Token, which has been issued by calling getAccessToken() )
    POST /v2/purchase/developer/com.onestore.game.goindol/send HTTP/1.1Host: apis.onestore.co.krAuthorization: Bearer 680b3621-1234-1234-1234-8adfaef561b4...

  • getAccessToken (issues an accessToken)

    • Desc: Issue an Access Toke to use Server API.
    • URI: https://{host}/v2/oauth/token
    • Method: POST, PUT
    • Request Header
      Parameter Name
      Description
      Example
      Content-Type
      When requesting Http, the Content Type must be set to application/x-www-form-urlencoded.
      Content-Type: application/x-www-form-urlencoded
      Request Body
      Element Name
      Description
      Example
      client_id
      In general, it is the same as the packageName
      com.onestore.game.goindol
      client_secret
      The client secret value, which has been issued at the time of the app registration.
      vxIMAGcVz3DAx20uDBr/IDWNJAPNHFl7YruF4uxB6BI=
      grant_type
      Fixed value
      client_credentials
      Example
      POST /v2/oauth/token HTTP/1.1Host: apis.onestore.comContent-Type: application/x-www-form-urlencoded;charset=UTF-8 grant_type=client_credentials&client_id=com.onestore.game.goindol&client _secret=vxIMAGcVz3DAx20uDBr/IDWNJAPNHFl7YruF4uxB6BI=
      Response Body
      Element Name
      Data Type
      Data Size
      Description
      status
      String
      7
      The result of issuing an Access Token
      client_id
      String
      255
      The OAuth authentication client_id
      access_token
      String
      36
      token_type
      String
      6
      Only the Bearer method is provided.
      expires_in
      Integer
      10
      The token expiration time. The unit is second.
      scope
      String
      1024
      The token use range
      Example
      { "status":"SUCCESS", "client_id":"com.onestore.game.goindol", "access_token":"680b3621-1234-1234-1234-8adfaef561b4", "token_type":"bearer", "expires_in":3010, "scope":"DEFAULT"}
      Example
      Request.setHeader("Authorization", " Bearer <Access-Token>");Request.setHeader("Content-Type", "application/json");

Server API details

  • It is the detailed specification for transmitting to ONE store server the purchase/cancellation history of the 3rd party payment.

    • send3rdPartyPurchase (transfers the purchase history of the 3rd party payment)

  • ​
    • ​
      • Desc: The developer transfers the history of the purchase made by using the 3rd party payment method.
      • URI: https://{host}/v2/purchase/developer/{packageName}/send
      • Method: POST
      • Parameter: String packageName : The package name of an app, which calls API (Data Size: 128).
      • Request Header
        Parameter Name
        Data Type
        Required
        Description
        Authorization
        String
        TRUE
        The access_token issued through the Access Token API
        Content-Type
        String
        TRUE
        application/json
        Request Body
        Element Name
        Data Type
        Data Size
        Required
        Description
        adId
        String
        50
        TRUE
        The ADID obtained from the terminal (if there is no ADID, it will be transferred to UNKNOWN_ADID).
        developerOrderId
        String
        100
        TRUE
        The developer’s purchase ID to identify each purchase case
        (It must be a unique value and error occurs if any duplicate IDs are saved. Refer to Error Response).
        developerProductList
        TRUE
        developerProductId
        String
        150
        TRUE
        The developer’s in-app product ID
        developerProductName
        String
        200
        TRUE
        The developer’s in-app product name
        developerProductPrice
        Integer
        10
        TRUE
        The developer’s in-app product price
        developerProductQty
        Integer
        10
        TRUE
        The developer’s in-app product purchase quantity
        simOperator
        String
        20
        TRUE
        The simOperator information obtained from the terminal
        (if there is no simOperator information, it will be transferred to UNKNOWN_SIM_OPERATOR).
        installerPackageName
        String
        150
        TRUE
        The installerPackageName information obtained from the terminal
        (if there is no installerPackageName information, it will be transferred to UNKNOWN_INSTALLER)
        purchaseMethodList
        TRUE
        purchaseMethodCd
        String
        30
        TRUE
        The payment method code (refer to Code Table)
        purchasePrice
        Integer
        10
        TRUE
        The amount of payment by each payment method
        totalPrice
        Integer
        10
        TRUE
        The total amount of payment
        purchaseTime
        Long
        19
        TRUE
        This is the time when the purchase was made since January 1, 1970. (unit : ms) (9002 error if invalid time is sent. Refer to Error Response.)
        Example
        { "adId": "abcdefgh-abcd-1234-abcd-abcdefgh1234", "developerOrderId" : "your_order_id_1234567890", "developerProductList" : [ {"developerProductId" : "your_product_id_1111", "developerProductName" : "A", "developerProductPrice" : 5000, "developerProductQty" : 2 }, {"developerProductId" : "your_product_id_2222", "developerProductName" : "B", "developerProductPrice" : 5000, "developerProductQty" : 1 } ], "simOperator" : "45005", "installerPackageName" : "com.skt.skaf.A000Z00040", "purchaseMethodList" : [ {"purchaseMethodCd" : "TRD_CREDITCARD", "purchasePrice" : 10000 }, {"purchaseMethodCd" : "TRD_PAYCO", "purchasePrice" : 5000 } ], "totalPrice" : 15000, "purchaseTime" : 1345678920000}
        Response Body
        Element Name
        Data Type
        Data Size
        Required
        Description
        responseCode
        Integer
        1
        TRUE
        Whether the data saving is successful (0: success)
        developerOrderId
        String
        100
        TRUE
        The developer’s purchase ID to identify each purchase case
        Example
        { "responseCode": 0, "developerOrderId" : "your_order_id_1234567890"}

    • cancel3rdPartyPurchase (cancels the purchase history of the 3rd party payment)

      • Desc: The developer cancels the history of the purchase made by using the 3rd party payment method.
      • URI: https://{host}/v2/purchase/developer/{packageName}/cancel
      • Method: POST
      • Parameter: String packageName : the package name of an app, which calls API (Data Size: 128).
      • Request Header
        Parameter Name
        Data Type
        Required
        Description
        Authorization
        String
        TRUE
        The access_token issued through the Access Token API
        Content-Type
        String
        TRUE
        application/json
        Example
        Request.setHeader("Authorization", " Bearer <Access-Token>");Request.setHeader("Content-Type", "application/json");
        Request Body
        Element Name
        Data Type
        Data Size
        Required
        Description
        developerOrderId
        String
        100
        TRUE
        The developer’s purchase ID to identify each purchase case
        (error occurs if any duplicate IDs are saved. Refer to Error Response).
        cancelTime
        Long
        19
        TRUE
        This is the time when the purchase was made since January 1, 1970 (unit: ms)
        cancelCd
        String
        30
        TRUE
        The cancellation reason code (refer to Code Table)
        Example
        { "developerOrderId" : "your_order_id_1234567890", "cancelTime" : 1345678920000, "cancelCd" : "TRD_CANCEL_USER"}
        Response Body
        Element Name
        Data Type
        Data Size
        Required
        Description
        responseCode
        Integer
        1
        TRUE
        Whether the cancellation is successful (0: success)
        developerOrderId
        String
        100
        TRUE
        The developer’s purchase ID to identify each purchase case
        Example
        { "responseCode": 0, "developerOrderId" : "your_order_id_1234567890"}

    • Code Table

      • Payment Method Code (purchaseMethodCd)

        • When you use a payment method not defined in the table below, please make an inquiry to Developer Center ([email protected]).
          Payment Method Code (purchaseMethodCd)
          Payment Method Name
          Remarks
          TRD_MOBILEBILLING
          Mobile phone payment
          DCB, mobile phone micro payment
          TRD_CREDITCARD
          Credit card
          Check cards included
          TRD_11PAY
          11pay
          TRD_NAVERPAY
          N pay
          TRD_KAKAOPAY
          Kakao Pay
          TRD_PAYCO
          Payco
          TRD_SAMSUNGPAY
          Samsung Pay
          TRD_SSGPAY
          SSG Pay
          TRD_TOSS
          TOSS
          TRD_BANKTRANSFER
          Account transfer
          Deposit without a bankbook and virtual bank account transfer included.
          TRD_TMONEY
          Mobile T money
          TRD_CASHBEE
          Mobile Cashbee
          TRD_OKCASHBAG
          OK cashbag
          TRD_CULTURELAND
          Culture Cash
          a culture gift certificate
          TRD_HAPPYMONEY
          Happy Money
          Happy Money culture gift certificate
          TRD_BOOKNLIFE
          Book Culture Gift Certificate
          TRD_CASHGATE
          Convenience store cash
          TRD_PAYPAL
          PayPal
          TRD_TMEMBERSHIP
          T Membership
          TRD_KTMEMBERSHIP
          KT Membership
          TRD_LGMEMBERSHIP
          U+ Membership
          TRD_GOOGLEPLAY
          Google Play
          TRD_BITCOIN
          Bit Coin
          TRD_SKINSCASH
          Skins Cash
          TRD_AMAZONPAY
          Amazon Pay
          TRD_PURCHASE_ETC
          Others
  • ​

    • Cancellation Reason Code (cancelCd)

      carrierCd
      Cancellation Reason Name
      Remarks
      TRD_CANCEL_USER
      Purchase cancellation requested by the user
      TRD_CANCEL_TEST
      Test purchase cancellation
      TRD_CANCEL_ETC
      Others
    • Error Response
      • The server API responds with a JSON-format response when an error occurs in addition to the normal response. Please refer to the following
      • Response Body : JSON format
        Element Name
        Data Type
        Description
        error
        Object
        Error information
        code
        Integer
        Error code
        message
        String
        Error message
        Example
        { "error": { "code": 9401, "message": " ." }}
      • Error Codes
        Element name
        Code
        Message
        common
        9000
        The mandatory does not exist.
        9001
        The checked result value does not exist.
        ​
        9002
        The value entered is not valid.
        ​
        9999
        Undefined error occurs.
        ​
        send3rdPartyPurchase
        9401
        This is duplicate purchase data.
        9402
        The total sum of payments does not match the sum of payments made by each payment method.
        ​
        9404
        This product is not registered as an 3rd party payment.
        ​
        9405
        It is impossible to send/cancel the transaction history of the 3rd party payment. Please check out app sales status.
        ​
        cancel3rdPartyPurchase
        9411
        The purchase data that will be cancelled does not exist or cannot be cancelled.
        9404
        This product is not registered as an 3rd party payment.
        ​
        9405
        It is impossible to send/cancel the transaction history of the 3rd party payment. Please check out app sales status.
        ​
        AccessToken
        400
        Unsupported grant type: grant_type
        If the grant_type is not client_credentials
        If the client_id doesn't exist or is a wrong secret
        If the combination of client_id and secret does not exist or is wrong

Reference Code

  • This guide includes client development content to support the transfer of the transaction history of the apps, which are sold on ONE store by using 3rd party payment options.
  • The developer can check the contents provided as below and directly implement the functions, or use the contents with reference to the sample code.
  • ​
    • Obtain App Installer Information
  • ​
    • The application installed on ONE store will have a total of 8 install package information (Including Samsung Galaxy Store. See the chart below)
    • If the installer, which enables the app to be installed on ONE store with the following code, is ONE store, the payment information of such app should be transferred to ONE store along with the install package name.
    • If it is not possible to check whether there is an installer, "UNKNOWN_INSTALLER" will be sent.
      Example
      /*** Returns the package name of the application that installed a package.* The OneStore has many installer package names.* Please check below list of package names.** Google Play : com.android.vending** ONE Store :* 1. com.skt.skaf.A000Z00040* 2. com.kt.om.ktpackageinstaller* 3. com.android.ktpackageinstaller* 4. com.kt.olleh.storefront* 5. com.kt.olleh.istore* 6. com.lguplus.installer* 7. com.lguplus.appstore* 8. android.lgt.appstore** Samsung Galaxy Apps : com.sec.android.app.samsungapps** If you read null string, return the "UNKNOWN_INSTALLER".** @param context application context* @return Name of installer package name or "UNKNOWN_INSTALLER"*/public static String getInstallerPackageName(@NonNull Context context) { if (context != null) { Context applicationContext = context.getApplicationContext(); PackageManager pm = applicationContext.getPackageManager(); final String installPackageName =pm.getInstallerPackageName(applicationContext.getPackageName()); if (!TextUtils.isEmpty(installPackageName)) { return installPackageName; } } return "UNKNOWN_INSTALLER";}
      #
      Installer
      Installer Package Name
      1
      ONE store SKT
      com.skt.skaf.A000Z00040
      2
      ONE store KT
      ​com.kt.om.ktpackageinstaller com.android.ktpackageinstaller com.kt.olleh.storefront com.kt.olleh.istore
      3
      ONE store LG U+
      com.lguplus.installer com.lguplus.appstore android.lgt.appstore

  • Obtain Mobile Carrier Information

    • The mobile carrier information can be obtained from the USIM card and transferred through the ONE store 3rd party payment transaction history API.
    • The carrier information to be transmitted is the SIM Operator information of MCC + MNC combination and consists of 5 to 6-digit numbers.
    • If it is not possible to obtain the SIM Operator such as Wi-Fi Table, "UNKNOWN_SIM_OPERATOR" will be sent.
      Example
      /*** Returns the MCC+MNC (mobile country code + mobile network code) ofthe provider of the SIM. 5 or 6 decimal digits* If you can't read of SinOpreater, return the "UNKOWN_SIM_OPERATOR".** @param context application context* @return MCC+MNC information or "UNKNOWN_SIM_OPERATOR"*/public static String getSimOperator(@NonNull Context context) {if (context != null) { Context applicationContext = context.getApplicationContext(); TelephonyManager telephonyManager = (TelephonyManager)applicationContext.getSystemService(Context.TELEPHONY_SERVICE); if (telephonyManager != null && telephonyManager.getSimState()== TelephonyManager.SIM_STATE_READY) { return telephonyManager.getSimOperator(); } } return "UNKNOWN_SIM_OPERATOR";}
    • Obtain Advertising ID
      • For the Google Advertising ID, the Google Play Service Library must be included in the project to get the value provided by the play service.
      • The Google Play Service Library guide can be added according to the following link.
      • Link : Google Link​
      • If the user has opted out of receiving the Advertising ID, "UNKNOWN_ADID" will be sent
        Example
        /*** Returns the Google Advertising ID.* The getGoogleAdID Api has dependency of the google service.* Please check include google service api into your project.** If you can't read of Advertising ID, return the "UNKNOWN_ADID".** @param context application context* @return Google AdIDAdvertising ID or "UNKNOWN_ADID"*/public static String getGoogleAdID(@NonNull Context context) { if (context != null) { Context applicationContext = context.getApplicationContext(); try {com.google.android.gms.ads.identifier.AdvertisingIdClient.Info idInfo = com.google.android.gms.ads.identifier.AdvertisingIdClient.getAdvertisingIdInfo(applicationContext); if (idInfo != null) { return idInfo.getId(); } } catch (GooglePlayServicesNotAvailableException e) { } catch (GooglePlayServicesRepairableException e) { } catch (IOException e) { } } return "UNKNOWN_ADID";}
Others

  • Settlement and Payment Process for 3rd party payment Apps.

    • Here we announce the new settlement and payment process for the Apps that applying its own payment(3rd party payment) method.
      Timeline
      Processes on the timeline
      Action for Developers
      Sales month
      Sales occurs during the month.
      3rd of the following month
      - The total fee will be calculated based on the sales. - The fee is shown on the developer's page.
      Please check the sales.
      10th of the following month
      - The invoice will be issued to each developer. - The total fee amount will be shown on the each developer's settlement page. The invoice can be found on the description page of each month as well.
      Please check the total fee amount, and deposit the fee to the virtual bank account provided by ONE store.
      The 25th day of the following month
      The due date for deposit is the last day of the following month. The fee should be transferred to the bank account of each developer.
      Please make sure the total fee amount was successfully transferred by the due date.
      After the 26th day of the following month
      In case of default, sales of the product will be suspended and also will be managed as debt by ONE store
  • ​
    • The total amount of the fee will be automatically calculated, and shown on the each developers settlement page. It is based on the total sales amount of the three major sales channel including ONE store, KT, and U+.
    • The fee should be paid to the virtual bank account of each developer, and the bank account number can be found on the developer's profile page or status of settlement page.
    • Totally three invoices will be issued from three major sales channels including ONE store, KT, and U+.
    • If the information on the invoice need to be updated, please contact us by the 5th day of the issuing month. ([email protected])

  • Technical / Policy Inquiry

    • For more information, please feel free to send an email to ONE store Developer Center. ([email protected])
Last modified 1mo ago