IAP Reference Result Code - ONE-store/inapp-sdk-eng GitHub Wiki
< NOTE >
This documents are for ONE store IAP SDK v16(API v4). If you are looking for the latest version of ONE store IAP SDK v17(API v5), please refer to the url below:
URL for the latest documents and downloads of ONE store IAP SDK v17(API v5) : https://dev.onestore.co.kr/devpoc/reference/view/IAP_v17
As a new SDK (v16.xx.xx) is distributed, a new API is added. The new API uses a string as the return value of the request method while the existing API returns the Bundle. Both the new and existing APIs only provide the request identifier as key information.
String Return
This returns a request identifier comprised of an Integer. The corresponding value is included and passed in the result.
String requestId = mPlugin.sendCommandCheckPurchasability(mRequestCallbackImpl, ProcessType.FOREGROUND_IF_NEEDED, appId, productId);
Bundle Return
This returns the Bundle, including an Integer-type request identifier. In case of SUCCESS, the content below is included in the bundle. In case of FAILURE, null is passed. The value in the Bundle can be obtained using each key.
Bundle Result Code & Message
Result Code | Result Message | Remarks |
---|---|---|
0 | Request success | Request success |
Bundle bundle = mPlugin.sendCommandRequest(param, mRequestCallback);
String requestId = bundle.getString(IapPlugin.EXTRA_REQUEST_ID);
Related to Inquiry & Payment
void onResponse(Response response)
void onResponse(IapResponse response)
Related to e-Receipt Verification
void onResponse(VerifyReceipt result);
This defines the result code and message passed by the IAP server. If the SDK occupies the screen, directly expose some of the result codes and messages in the SDK. The chart below describes all the information that can be delivered.
Success
Result Code | Result Message | Remarks |
---|---|---|
0000 | The item is successfully checked. | request_product_info |
0000 | The item verification is successful requested. | request_purchase_history |
0000 | The purchase availability inquiry is successfully requested. | check_purchasability |
0000 | The monthly auto renewable subscription is successfully cancelled. | change_product_properties - cancel_subscription |
0000 | The deduction of the item is successfully requested. | change_product_properties - subtract_points |
Validity Error Code
Result Code | Result Message |
---|---|
1000 | The required parameters are insufficient. |
1001 | The request is undefined |
1002 | The required parameter of APPID does not exist. |
1003 | The required parameter of PRODUCTID does not exist. |
1004 | The required parameter of API_VERSION does not exist. |
1005 | The required parameter of IDENTIFIER does not exist. |
1006 | The required parameter of MDN does not exist. |
1007 | The required parameter of CARRIER does not exist. |
1008 | The required parameter of NETWORK_TYPE does not exist. |
1009 | The required parameter of UACD does not exist. |
1010 | The required parameter of IMEI does not exist. |
1011 | The required parameter of PARAM ACTION does not exist. |
1012 | The required parameter of MODEL does not exist. |
1013 | The length of Filter req_date is not valid. |
1014 | The data of Filter req_date is not valid. |
1015 | The length of Filter product_price is not valid. |
1016 | The data of Filter product_price is not valid. |
1017 | The requestJSON format is not valid. |
1027 | The required parameter of T-Membership card number does not exist. |
1028 | The MDN is not valid. |
1029 | The Month is not valid. |
User Authentication Error Code
Result Code | Result Message |
---|---|
2001 | You don’t have a SK Telecom membership. Please sign up and try it out. |
2002 | If you use a prepaid mobile phone (prepaid service, or PPS), you are not allowed to pay information charges. |
2003 | Your device is suspended. |
2004 | You don’t have a T-store membership. Please sign up and try it out. |
2005 | You have not consented to the collection of personal information. |
2006 | This test device is not registered in the developer POC. Please register and try it out. |
2007 | Your consent to the collection of personal information is saved. |
2008 | You have failed to consent to the collection of personal information. Please contact the person in charge. |
2009 | You have already consented to the collection of personal information. |
2010 | Your T-store membership authentication failed. |
2011 | This product is not available for those under the age of 19. |
2012 | It is available after the real name authentication. |
2013 | It is available after the legal representative’s consent. |
2014 | This device cannot be supported. |
2100 | You have already subscribed to the service. |
2101 | You are already signed-up for the service |
2102 | This device cannot be registered. |
2013 | The line cannot be purchased. |
2016 | The SKT customer authentication failed. |
2107 | You failed to sign up for T-store membership. Please contact the person in charge. |
Purchase Check Failure Error
Result Code | Result Message |
---|---|
3001 | The item purchase history does not exist. |
3002 | No product is checked. |
3003 | The product purchase history does not exist. |
3101 | Currently, the purchase is not available with the partial payment version. Please try it out after the version upgrade. |
3102 | Your purchase is blocked. |
3103 | Your device information is not valid. (inconsistent with IMEI) |
3104 | Your device information is not valid. (inconsistent with SIM) |
3105 | Failed to check ICAS membership information. |
3106 | Your device information is not valid. (inconsistent with UACD) |
3107 | An error occurred while checking the T-store membership status. Please try it out again later. |
3108 | This product is not ‘Published’, and payment is not available. |
3109 | An error occurred while checking the publishing status. Please try it out again later. |
3110 | This device does not support the partial payment. |
3111 | You are using the non-consumable In-App. Please purchase it again when the use period expires. |
3112 | You are using the subscription. Please purchase it again when the use period expires. |
3113 | Your trial version In-App purchase history exists. |
3114 | An error occurred while checking the purchase availability of the trial version In-App. Please try it out again later. |
3115 | This monthly auto renewable subscription is available only for SKT’s customers. |
3116 | It is not available to purchase two or more monthly auto renewable subscriptions in the same App. |
3117 | You are using the auto renewal subscription. Please purchase it again when the use period expires. |
3118 | You have cancelled this product. You can re-purchase it in the next month after the month of cancellation. |
3119 | The usage limit of KRW500K per product is exceeded. Please try it out in the next month. |
3120 | The monthly usage limit of KRW500K per App is exceeded. Please try it out in the next month. |
3121 | The monthly usage limit of KRW500K is exceeded. Please try it out in the next month. |
3122 | The usage limit of the rate plan is exceeded. For more inquiry, please contact the customer center. |
3123 | This product is in review. |
3124 | The test is not available since the product is not set up. |
3125 | Your monthly auto renewable subscription will expire. Thank you for using our service. |
3126 | Payment cannot be made with the test phone. |
3127 | The monthly auto renewable subscription that you purchased is cancelled. |
3132 | Mobile payment is not available. Please try other payment method of T-store. |
3133 | Mobile payment is not available. For more inquiry, please contact the MVNO customer center (114). |
3201 | The deferred payment amount is not valid. |
3202 | The payment is not valid. Please try again. |
3203 | Only individual customers are allowed to purchase the monthly auto renewable subscription. |
3204 | T-cash payment amount is not valid. |
3205 | DOTORI payment amount is not valid. |
3206 | OK CASHBAG payment amount is not valid. |
3207 | Culture Land payment amount is not valid. |
3208 | Culture Land payment amount is not valid. |
3209 | PayPin amount is not valid. |
3210 | Transaction TID does not exist. Please try new payment. |
3211 | This is a completed transaction. |
*Error Related to Connecting with External System
Result Code | Result Message |
---|---|
4100 | UAPS connection result is Failure. |
4199 | UAPS connection failed. |
4200 | IDP connection result is Failure. |
4299 | IDP connection failed. |
4300 | T-store connection result is Failure.Please contact the person in charge. |
4301 | [T-STORE]The cash cancellation failed. |
4302 | [T-STORE]The cash usage history does not exist. |
4303 | [T-STORE]It was already cancelled. |
4304 | [T-STORE]Cancellation request point error occurs. |
4305 | [T-STORE]Authentication failure (authentication code error) occurs. |
4306 | [T-STORE]The account balance is negative. |
4307 | [T-STORE]The cash deduction failed. |
4308 | [T-STORE]]It is not available to check your consent to the use of SKT telecommunications billing service. |
4309 | [T-STORE]You are not allowed to consent to the use of SKT telecommunications billing service. |
4310 | CMS connection failed. |
4398 | [T-STORE] Time-out occurs during connection. |
4399 | [T-STORE]T- store connection failed. |
4499 | ICAS connection result is Failure. |
4500 | [Danal] Danal connection result is Failure. |
4501 | [Danal] Please enter a correct mobile operator, mobile phone number and Resident Registration Number (RRN). |
4502 | [Danal] The Resident Registration Number (RRN) does not match. Please check if it is the RRN of the mobile phone subscriber. |
4503 | [Danal] This mobile phone number is registered as suspended. |
4504 | [Danal] This mobile phone number is closed. |
4505 | [Danal] It is not available to use the corporate mobile phone. |
4506 | [Danal] The service is not available due to unpaid telecommunications charges. |
4507 | [Danal] The payment amount is exceeded. The amount available to you is KRW {xxxxx} (please check the amount used). |
4508 | [Danal] This mobile phone number is registered as temporarily suspended in the mobile operator. |
4509 | [Danal] You have requested the mobile operator to block micropayments with this number. Please contact your mobile operator. |
4510 | [Danal] A one-time payment limit is exceeded. [Danal customer center: 1566-3355] |
4511 | [Danal] It is not available for minors (under the age of 20. However, it is available for those aged between 19 and 20 with the consent of the legal guardian). |
4512 | [Danal] You are not allowed to use mobile phones with prepaid plans. |
4513 | [Danal] Less than 60 days have passed since subscription. Usage limit: KRW10K/ month |
4514 | [Danal] It is possible to illegally copy this device. You can use the service after confirming your identification with the mobile operator. Please conact the mobile operator. |
4515 | [Danal] You are not allowed to use mobile payment in this site. Please contact Danal customer center: 1566- 3355. |
4516 | [Danal] Less than 180 days have passed since subscription. |
4517 | [Danal] Micropayments are blocked at your request. Please contact the mobile operator if you want to cancel the block. |
4518 | [Danal] This month’s mobile payment limit is exceeded. Please contact our customer center (1566-3355). |
4519 | [Danal] Micropayments are not available to those whose subscription period has been less than 3 days since subscription (or the change of name). |
4520 | [Danal] You have requested to block automatic payment with this mobile phone number. Please contact the mobile operator. |
4521 | [Danal] This month’s mobile payment limit is exceeded. Please contact our customer center (1566-3355). |
4522 | [Danal] The mobile operator’s policy does not allow you to use automatic payment. |
4523 | [Danal] The mobile operator’s policy does not allow you to use micropayments. |
4524 | [Danal] Please re-enter the Resident Registration Number (RRN) of the mobile phone number subscriber. |
4525 | [Danal] This month’s payment limit is exceeded, and payment is not available. [Dana customer center: 1566-3355] |
4526 | [Danal] Authentication error: the approval number is incorrect. Please check the text message again. |
4527 | [Danal] Age limit error: underage subscribers are not allowed to use Danal’s micropayment service. |
4596 | [Danal] Authentication information and payment information do not match. Please check again. |
4597 | [Danal] Refund failed. Please contact the person in charge. |
4598 | [Danal] The approval number is incorrect. Please check again. |
4599 | [Danal] Danal connection failed. |
4600 | [Culture Land] Culture Land connection result is Failure |
4601 | [Culture Land] This ID has limited login access, and is not available. For inquiry, call to :1577-2111 |
4602 | [Culture Land] This IP has limited login access. Please use other computer. For inquiry, call to: 1577-2111 |
4603 | [Culture Land] This IP is not available due to multiple failed login attempts made from this IP. For inquiry, call to: 1577-5211 |
4604 | [Culture Land] This computer is not available due to multiple failed login attempts made from this computer. For inquiry, call to: 1577-5211 |
4605 | [Culture Land] Access is restricted by the use of multiple Culture Land IDs. For inquiry, call to: 1577-2111 |
4606 | [Culture Land] You entered an incorrect ID or password. Please check it at Culture Land. |
4607 | [Culture Land] Culture Cash has been stored in the Culture Land Security Vault. Please withdraw Culture Cash from the Security Vault. |
4608 | [Culture Land] Login failed. Please try it out later. Customer center: 1577-2111 |
4609 | [Culture Land] This IP is not specified. Please check the specified IPs in the Culture Land Security 4609 Center. |
4610 | [Culture Land] Login failed. Please try it out again. |
4611 | [Culture Land] Payment authentication number does not exist. Please create a payment authentication number in the Culture Land and make payment. |
4612 | [Culture Land] Culture Land login failed. Please check the authentication method and try it out again. |
4613 | [Culture Land] This gift certificate number is not registered. Please enter a correct gift certificate number. [For inquiry, call to: 1577-2111] |
4614 | [Culture Land] This gift certificate has already been used. Please check if the certificate is used in the Culture Land homepage. [For inquiry, call to: 1577-2111] |
4615 | [Culture Land] The number of failed attempts to register the gift certificate is exceeded. Please contact Culture Land customer center (1577-2111). |
4616 | [Culture Land] The limit of use for the one-day cultural gift certificate is exceeded. Please try it again tomorrow. |
4617 | [Culture Land] The Culture Cash balance is negative in your account. Please charge Culture Cash and try it out again. |
4618 | [Culture Land] Your information is incorrect. Please log in again and make payment. |
4619 | [Culture Land] Payment amount is not sufficient. Please charge Culture Cash and try it out. |
4620 | [Culture Land] Please confirm your identification in the Culture Land homepage and try it out. |
4621 | [Culture Land] The payment authentication number that you entered is incorrect. Please check it again and make payment. |
4622 | [Culture Land] The membership information is incorrect. Please log in again and make payment. |
4623 | [Culture Land] The mobile phone number is incorrect. Please check the mobile phone number in the Culture Land homepage. |
4624 | [Culture Land] Payment authentication number does not exist. Please generate a payment authentication number in the Culture Land and make payment. |
4798 | [Culture Land] Time-out occurs during connection |
4699 | [Culture Land] Culture Land connection failed. |
4700 | [OK CASHBAG] OK CASHBAG connection result is Failure. |
4701 | [OK CASHBAG] This conversion-requested point is not registered. |
4702 | [OK CASHBAG] This conversion point is not registered. |
4703 | [OK CASHBAG] Membership conversion limit is exceeded. |
4704 | [OK CASHBAG] Franchise conversion limit is exceeded. |
4705 | [OK CASHBAG] This card does not provide the service. |
4706 | [OK CASHBAG] Membership point does not exist. |
4707 | [OK CASHBAG] Discount amount is exceeded. |
4708 | [OK CASHBAG] The maximum number of failed attempts per day is exceeded. |
4709 | [OK CASHBAG] The coupon is not available. |
4710 | [OK CASHBAG] The monthly limit is exceeded |
4711 | [OK CASHBAG] The number of use limit is exceeded. |
4712 | [OK CASHBAG] The use limit point is exceeded. |
4713 | [OK CASHBAG] Membership limit criteria are not registered. |
4714 | [OK CASHBAG] The number of deduction limit is exceeded. |
4715 | [OK CASHBAG] This membership is confirmed to be deactivated. |
4716 | [OK CASHBAG] The membership status is not normal. |
4717 | [OK CASHBAG] This membership is deactivated. |
4718 | [OK CASHBAG] The sales amount of more than KRW500K cannot be processed. |
4719 | [OK CASHBAG] The sales amount above the limit cannot be processed. |
4720 | [OK CASHBAG] This is not a discount membership. |
4721 | [OK CASHBAG] You are not eligible for discount. |
4722 | [OK CASHBAG] Error occurred since an incorrect password was entered more than 3 times. |
4723 | [OK CASHBAG] The password does not match. |
4724 | [OK CASHBAG] If the available points are less than 5K, you cannot use the points. |
4725 | [OK CASHBAG]If the available points are less than 50K, you cannot redeem the points in cash. |
4726 | [OK CASHBAG] If the password is the date of birth, you cannot use the points. |
4727 | [OK CASHBAG] You cannot use the points due to the lack of points. |
4728 | [OK CASHBAG] You cannot use this card since its validity period expired. |
4729 | [OK CASHBAG] It is not available because usage is restricted in this franchise. |
4730 | [OK CASHBAG] Password number/Authentication number Error |
4731 | [OK CASHBAG] 10 cumulative errors occur with the incorrect password. |
4732 | [OK CASHBAG] It is not available because the approval for use is not made. |
4733 | [OK CASHBAG] The exceeded purchase amount cannot be processed. |
4734 | [OK CASHBAG] Error occurs because the password type is not entered. |
4735 | [OK CASHBAG] The password and the date of birth do match. |
4736 | [OK CASHBAG] Error occurs in the number of online passowords. |
4737 | [OK CASHBAG] Error occurs in 4 consecutive digits. |
4738 | [OK CASHBAG] The online password does not match. |
4739 | [OK CASHBAG] The online password does not exist. |
4794 | Time-out occurs during connection to OK CASHBAG. |
4795 | [OK CASHBAG] This card is not available. |
4796 | [OK CASHBAG] The card cannot be changed and registered. |
4797 | [OK CASHBAG] The card cannot be deleted. |
4798 | [OK CASHBAG] The card cannot be registered. |
4799 | [OK CASHBAG] OK CASHBAG connection failed.. |
4800 | [DOTORI] DOTORI connection result is Failure. |
4801 | [DOTORI] Error occurs in membership information. Please check the membership status. |
4802 | [DOTORI] The available DOTORI amount is insufficient. |
4803 | [DOTORI] DOTORI payment limit is exceeded. |
4804 | [DOTORI] The paid amount is larger than the reserved amount. Please make payment again. |
4805 | [DOTORI] The paid amount is negative. |
4806 | [DOTORI] It is not an allowed IP address. Please check if the IP address is allowed in the website. |
4807 | [DOTORI] The TID was already reserved. Please contact the person in charge. |
4808 | [DOTORI] This service ID is registered to block international IP. Please contact the person in charge. |
4809 | [DOTORI] The mobile phone is suspected of being stolen. Please contact the person in charge. |
4810 | [DOTORI] DOTORI gift is suspected of being stolen. Please contact the person in charge. |
4897 | [DOTORI] Time-out occurs during connection to DOTORI server. |
4898 | [DOTORI] Sending SMS failed. Please contact the person in charge. |
4899 | [DOTORI] DOTORI connection failed. |
4900 | ECG connection result is Failure. |
4999 | ECG connection failed. |
5000 | [T-money] T-money connection result is Failure. |
5001 | [T-money] The USIM chip inserted in the mobile device cannot use Mobile T-money. |
5002 | [T-money] If you cannot continue to check the T-money balance, please check through the Mobile T-money service. |
5003 | [T-money] The payment error is caused by the network failure. Please make payment again. |
5004 | [T-money] You cannot make payment because the version of the Mobile T-money installed in the device is low. Please upgrade the Mobile T-money App. |
5005 | [T-money] The Mobile T-money balance is insufficient. Please check again and make payment. |
5006 | [T-money] The transaction history does not exist. |
5007 | [T-money] Payment failed. |
5098 | [T-money] Time-out occurs during connection. |
5099 | [T-money] T-money connection failed. |
5199 | OCG connection failed. |
5200 | PayPin payment failed. |
5300 | T-membership points are not checked. Please contact the customer center via 114. |
5301 | T- membership card validity period expired. Please contact customer center via 114. |
5302 | T- membership point limit is increased and available. |
5303 | The number of T- membership point use is exceeded, and not available. |
5304 | The date of birth and gender that you entered do not match the membership information. |
5397 | Time-out occurs during connection to the T- membership. |
5398 | T- membership payment amount is not valid. |
5401 | INICIS user authentication failed. |
5402 | INICIS user authentication failed. |
5403 | Failed to issue ISP Billing Key. |
5404 | Card payment TID is not valid. |
5405 | Credit card payment amount is not valid. |
5406 | Credit card payment failed. |
5407 | INICIS connection failed. |
Urgent Notice Message
Result Code | Result Message |
---|---|
9001 | Urgent notice message is passed (ex: The server is under maintenance until 12:00. Please try it out later.) |
User Cancellation & Others
Result Code | Result Message |
---|---|
9000 | Encrypted data is incorrect. |
9100 | Purchase is cancelled. |
9113 | e-Receipt data is not valid. |
9114 | Failed to generate e-Receipt data |
9115 | Failed to generate original receipt data |
9116 | The receipt does not match the purchased product information. |
request_purchase_history Method
Result Code | Result Message | Remarks |
---|---|---|
PH00 | Item authentication succeeded. | Success |
PH01 | Item purchase history does not exist. | Failure |
PH02 | The use period expired. Repurchase is required for contined use. | Failure |
PH03 | The test is not available since the product is not set up. | Failure |
change_product_properties - cancel_subscription Method
Result Code | Result Message | Remarks |
---|---|---|
CS00 | The monthly auto renewable subscription is successfully cancelled. | Success |
CS01 | Failed to cancel the automatic payment additional service. | Failure |
CS02 | Failed to cancel the purchase history of monthly automatic payment. | Failure |
CS03 | Failed to transfer the purchase history of monthly automatic payment. | Failure |
CS04 | It was already cancelled. | Failure |
CS05 | The purchase history of automatic payment service does not exist. | Failure |
CS06 | Failed to refund. Please contact the person in charge. | Failure |
CS07 | The product was already refunded. | Failure |
change_product_properties - subtract_points Method
Result Code | Result Message | Remarks |
---|---|---|
SP00 | The deduction of the item is successfully requested. | Success |
SP01 | The remaining number of products is 0 | Failure |
SP02 | The item purchase history does not exist. | Failure |
void onError(String rid, String errcode, String errmsg);
This defines the error codes and messages passed via the RequestCallback.onError call parameter that is called when an error occurs. This value intends to infer a problem that is created by the system status. It is not defined for the purpose of exposing the user. As for some errors that request the exposure of user, the SDK directly exposes when the screen is occupied.
Error Code | Message | Description |
---|---|---|
-1 | error (command fail) error (pay fail) error (request convert fail) |
This indicates a tansient error.(ex: server connection failure, connection timed out, urgent notice, etc.) |
-2 | error (Login fail) | If an error occurs during the login process |
-3 | error (purchase) | If an error occurs during the authentication process for purchase |
-4 | error (Login is required) | If an explicit Foreground login is needed |
-1000 | error (permission) ONE store service doesn't have permission |
If permission is needed for processing requests |
-1001 | Service has not allowed | If a binay authentication failed |
-1002 | Service not response | If the module connection timed out |
-1003 | Service disconnect | If the module connection is suspended |
-1004 | In Progress | If requests are received while processing the requests |
-3000 | ONE store service is not installed | If the proper version of the module has not been installed |
-3001 | ONE store service install is not allowed by user | If the user does not allow the installation of the proper version of the module |
-3002 | Trying to install ONE store service | The installation of the proper version of the module is attempted |
-5000 | not defined | If an error occurs during the abnormal drive |