Market Cancellation and Refund API searches the voided purcahse lists collected to the Cancellation and Refund List System of each market and informs the result of refund to the Hive IAP Cancellation and Refund List System. Currently the refund data from Google Play Store and Apple App Store are collected.

  • Google Play Store
    It collects and stores the voided purchase list stacked within a month from the registration time of item activation on AppCenter. After the specified period, voided purchase data for the last 24 hours are collected every 30 minutes.
  • Apple App Store
    It collects and stores the voided purchase list after refund by implementing the callback API registered on Apple. The information from Apple contains the recent 100 data about refund user.

Voided Purchase List API

This API helps you to search the voided purchase data collected to the Hive IAP Cancellation and Refund List System.

Market Production URL
Google https://hiveiap-void.qpyou.cn/api/Voided_purchases/google
Apple https://hiveiap-void.qpyou.cn/api/Voided_purchases/apple_market

Call

  • Google
  • Apple

Request

  • Google
  • Apple
Field Type Description Required
package_name String Package name of the game to search (the same with appid of the game app) Y
start_time_utc String Condition to search the collected data
It searches cancellation data collected to the cancellation and refund list of Hive IAP from the setting time of this field. (Based on UTC)
N
end_time_utc String Condition to search the collected data
It searches cancellation data collected to the cancellation and refund list of Hive IAP from the setting time of start_time_utc field to this field. (Based on UTC)
N
max_results Integer The maximum number of cancellation when receiving as request result

  • Maximum: 100
  • Default: 100
N
next_page_token String The field filled with the value of next_page_token in the response to the previous request if existed
Use this field to receive the search result not delivered due to larger value of request result than that of max_results.
N

Response

  • Google
  • Apple
Field Type Description Return required
result_code Integer Response code

  • 20000: Success in search
  • 40000: Request error
Y
result_message String Result message after request completion Y
next_page_token String The value which informs how to re-request the undelivered data if the number of cancellation data to search and send is more than the clarified value of max_results N
voided_purchases Array The list of voided purchase data
It enumerates each item by collection time based on the value of voided_purchases.registered_time_utc.
N
order_id String Order ID on the receipt of Google Play Store If Google, Y
transaction_id String Transaction ID on the receipt of Apple App Store If Apple, Y
status Integer Whether to retrieve the in-app purchase items or not

  • 0: Unprocessed (Data collection only)
  • 1: Success
  • 2: Success in partial retrieval (available only with the games which support partial retrieval)
  • 3: Failure
N
registered_time_utc String The time when voided purchase data is collected to the Hive IAP Cancellation and Refund List (Format: UTC) N
purchase_time_millis BigInt The time when user purchased the item cancelled (Format: Millisecond of Unix Time) N
voided_time_millis BigInt The time of purchase cancellation (Format: Millisecond of Unix Time) N

 

Result Registration API

This API uses Voided Purchase List API for data collection. Based on this data, game server processes item retrieval and the API notifies whether item is delivered or not.

Market Production URL
Google https://hiveiap-void.qpyou.cn/api/Consequence/google
Apple https://hiveiap-void.qpyou.cn/api/Consequence/apple

Call

  • Google
  • Apple

Request

  • Google
  • Apple
Field Type Description Required
order_id String Order ID on the receipt of Google Play Store If Google, Y
transaction_id String Transaction ID on the receipt of Apple App Store If Apple, Y
is_item_delivered Bool Whether the purchased item is delivered or not Y
withdrawal_status Integer Retrieval status of the item to change

  • 1: Retrieval success
  • 2: Success in partial retrieval (available only with the games which support partial retrieval)
  • 3: Failure
  • 4: Deletion of retrieval records (Due to wrong registration)
Y

Response

  • Google
  • Apple
Field Type Description Return Required
result_code Integer Response code

  • 20000: Registration success (Update success if item already exists)
  • 40000: Request error
  • 50000: Server error
Y
result_message String Result message after request completion Y