Purchase, cancellation, refund history per market Get purchase history Basics Get the purchase history of an app for the given period.
Description Request URL https://hiveiap-void.qpyou.cn/api/creator/market_purchase_list Method POST HTTP Header Content-type: application/json Authorization: Bearer (Optional) You can use a Bearer token only if the Certification Flag at Hive Console AppCenter > Game Management > Game List: Select your company’s game > Game Details > Basic Info The Bearer token is the Certification Key at AppCenter > Game Management > Game List: Select your company’s game > Game Details > Basic Info Response Format JSON
Request Name Type Required Description market String O market name: google, apple, lebi, onestore, amazon, glaxystore, huawei, funtap, oppo, vivo, facebook, steam, hivestore (PG Payment) appid String O the appid of the app startdate String O the start date of the date range to be searched (example: 2023-07-10) enddate String O the end date of the date range to be searched (example: 2023-07-16, the maximum search range is 7 days including the startdate and the enddate) transactionid Array X Only the purchase transactionids provided here will be the target of purchase history search (example: [ 'GPA.3383-2895-4485-57050', 'GPA.3381-4857-7750-97692' ]) When provided with the playerids, the API will return only the results of the transactionids made by the playerids (the playerids and the transactionids are on AND condition). The maximum length of the array is 50. playerid Array X Only the purchase transactions made by the playerids provided here will be the target of purchase history search (example: [ '20000015911', '20000016015' ]) When provided with the purchase transactionids, the API will return only the results of the transactionids made by the playerids (the transactionids and the playerids are on AND condition). The maximum length of the array is 100. page_token String X The maximum number of results per API response page is 100. To request the previous/next page, call API again using this token.
Response Name Type Required Description result_code Integer O response code (20000: success) result_message String O the result message of the response code data Array O the response data ㄴdate String O the date that this API is called (example: 20230714) ㄴplayerid String O playerid (example: 20000015911) ㄴpurchase_price Integer O the price of the purchased goods (example: 10000) ㄴpurchase_currency String O the currency of the purchase (example: KRW, USD) ㄴpurchase_date String O the date of purchase (KST) ㄴhiveiap_market_transaction_id String O the purchase transactionid (example: GPA.3327-1260-4622-40400) ㄴmarket String O the market where the purchase occurred (example: APPLE, GOOGLE) prev_page_token String X the token of the previous page (not returned if the previous page does not exist) next_page_token String X the token of the next page (not returned if the next page does not exist)
Request examples The example of using page_token The example of using transactionid The example of using playerid The example of using transactionid and playerid (AND condition)
Response examples Get voided purchase·refund history Get the voided purchase or the refund history of an app for the given period.
Basics Description URL https://hiveiap-void.qpyou.cn/api/creator/market_voided_purchase_list Method POST HTTP Header Content-type: application/json Authorization: Bearer (Optional) You can use a Bearer token only if the Certification Flag at Hive Console AppCenter > Game Management > Game List: Select your company’s game > Game Details > Basic Info The Bearer token is the Certification Key at AppCenter > Game Management > Game List: Select your company’s game > Game Details > Basic Info Response Format JSON
Request Name Type Required Description market String O market name: google, apple, onestore, amazon, huawei, steam, hivestore(PG Payment) appid String O the appid of the app startdate String O the start date of the date range to be searched (example: 2023-07-10) enddate String O the end date of the date range to be searched (example: 2023-07-16, the maximum search range is 7 days including the startdate and the enddate) transactionid Array X Only the transactionids of the purchases that were voided or refunded will be the targets of voided purchase or refund history search (example: [ 'GPA.3383-2895-4485-57050', 'GPA.3381-4857-7750-97692' ]) When provided with the playerids, the API will return only the results of the voided or refunded purchase transactionids made by the playerids (the playerids and the transactionids are on AND condition). The maximum length of the array is 50. playerId Array X Only the voided or refunded purchase transactions made by the playerids will be the targets of voided purchase or refund history search (example: [ '20000015911', '20000016015' ]) When provided with the purchase transactionids, the API will return only the results of the voided or refunded purchase transactionids made by the playerids (the transactionids and the playerids are on AND condition). The maximum length of the array is 100. page_token String X The maximum number of results per API response page is 100. To request the previous/next page, call API again using this token.
Response Name Type Required Description result_code Integer O response code (20000: success) result_message String O the result message of the response code data Array O the response data ㄴdate String O the date that this API is called (example: 20230714) ㄴplayerid String O playerid (example: 20000015911) ㄴvoided_purchase_date String O the date of voiding·refund (KST) ㄴpurchase_date String O the date of purchase (KST) ㄴhiveiap_market_transaction_id String O the purchase transactionid (example: GPA.3327-1260-4622-40400) ㄴmarket String O the market where the purchase occurred (example: APPLE, GOOGLE) prev_page_token String X the token of the previous page (not returned if the previous page does not exist) next_page_token String X the next of the previous page (not returned if the next page does not exist)
Request examples The example of using page_token The example of using transactionid The example of using playerid The example of using transactionid and playerid (AND condition)
Response examples Response codes response code Description 20000 Success 40000 Error in Request ㄴresult_message Empty Request Invalid json format Invalid request - appid Invalid request - api key Invalid request - enddate Invalid request - startdate Invalid request - page_token 50000 Server Error