Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
A API Voided Purchases do Google Play oferece uma lista de pedidos
associados a compras anuladas por um usuário. Use as informações
desta lista para implementar um sistema de revogação que impede que o usuário
acesse os produtos desses pedidos.
Essa API se aplica a pedidos únicos no app e assinaturas de apps.
Uma compra pode ser anulada das seguintes maneiras:
O usuário solicita um reembolso pelo pedido.
O usuário cancela o pedido.
Um pedido é estornado.
O desenvolvedor cancela ou reembolsa um pedido.
O Google cancela ou reembolsa um pedido.
Com essa API, você ajuda a criar uma experiência mais equilibrada e justa para todos
os usuários do seu app, principalmente se for um app de jogo.
Conseguir acesso
Para trabalhar com a API Voided Purchases, é preciso ter permissão para ver
informações financeiras. Conceda a autorização usando um cliente OAuth ou uma
conta de serviço. Se você estiver usando uma conta de serviço, ative a permissão "Ver
relatórios financeiros" nessa conta.
Para saber mais sobre como ter acesso autorizado a APIs Google Play Developer, consulte
os seguintes guias:
Use o método GET para solicitar uma lista de compras anuladas. Na solicitação,
inclua o nome do pacote totalmente qualificado do app, como
com.google.android.apps.maps, e o token de autorização que você
recebeu ao conseguir acesso à API.
GET https://www.googleapis.com/androidpublisher/v3/applications/
your_package_name/purchases/voidedpurchases?access_token=your_auth_token
Também é possível incluir os seguintes parâmetros na sua solicitação, sendo que todos
eles são opcionais:
startTime
A hora, em milésimos de segundo, desde o início da época Unix (link em inglês), da compra anulada mais antiga
que você quer ver na resposta. Por padrão,
startTime é definido como 30 dias atrás.
A API só exibe as compras anuladas que ocorreram nos
últimos 30 dias. Compras anuladas anteriores a esse período não são incluídas na
resposta, independentemente do valor definido para startTime.
endTime
A hora, em milésimos de segundo, desde o início da época Unix (link em inglês), da compra anulada mais recente
que você quer ver na resposta. Por padrão,
endTime é definido como a hora atual.
maxResults
O número máximo de compras anuladas exibidas em cada resposta. Por
padrão, esse valor é 1.000. O valor máximo desse parâmetro também
é 1.000.
token
Um token de continuação de uma resposta anterior, que permite ver mais
resultados.
type
O tipo de compras anuladas que aparecem em cada resposta. Se definido como 0,
apenas serão retornadas compras no app. Se for definido como 1, as compras anuladas no app e as assinaturas anuladas serão retornadas. O valor padrão é
0.
includeQuantityBasedPartialRefund
Para incluir ou não compras anuladas de reembolsos parciais com base na quantidade,
que só podem ser aplicados a compras de várias quantidades. Se definido como true,
outras compras anuladas podem ser retornadas com voidedQuantity,
que indica a quantidade do reembolso parcial. O
valor padrão é false.
A resposta é uma string JSON que tem uma lista de compras anuladas. Se houver
mais resultados do que o número especificado no parâmetro da solicitação maxResults,
a resposta incluirá um valor nextPageToken, que poderá ser passado em uma
solicitação subsequente para exibir mais resultados. O primeiro resultado da lista mostra a
compra anulada mais antiga.
A API Voided Purchases define as seguintes cotas por pacote:
6.000 consultas por dia. O dia começa e termina à meia-noite do fuso horário do Pacífico.
30 consultas durante qualquer período de 30 segundos.
Diretrizes para solicitações iniciais
Durante a solicitação de API inicial, é possível buscar todos os dados disponíveis
do seu app. Embora seja improvável, esse processo pode esgotar sua cota diária. Para
receber dados de compras anuladas de uma forma mais segura e consistente, siga estas
práticas recomendadas:
Use o valor padrão para o parâmetro maxResults. Assim, se você usar
toda a cota de consultas de um dia, poderá recuperar os detalhes de 6.000.000 de
compras anuladas.
Se uma resposta incluir um valor para nextPageToken, atribua esse valor ao
parâmetro token durante sua próxima solicitação.
Práticas recomendadas
Quando usar essa API no app, lembre-se de que há muitos
motivos para se anular uma compra e que não há uma solução única que funcione
para todos os casos. Pense nos usuários ao desenvolver suas políticas
e estratégias de revogação. Para isso, utilize estas práticas recomendadas:
Use essa API como um dos vários elementos de uma estratégia abrangente para lidar
com comportamentos inadequados. A revogação de acesso a produtos no aplicativo costuma
ser mais eficiente em combinação com um app que tenha preços razoáveis para
compras no aplicativo, com um design de app que desmotive comportamentos inadequados,
com uma base de usuários sólida que tenha uma cultura que rejeite esses
comportamentos e com canais de suporte ao usuário responsivos e eficientes.
Administre sua política de revogação de maneira uniforme para garantir igualdade a todos os usuários.
Crie uma política dividida em etapas para lidar com comportamentos inadequados. Por
exemplo, comece com avisos no aplicativo para as primeiras ofensas, depois intensifique
suas respostas à medida que o comportamento inadequado do usuário continuar. Como
último recurso, é possível impedir toda a interação do usuário com seu app.
Ao introduzir uma política de revogação e sempre que atualizá-la, use os canais de
comunicação do seu app para informar os usuários sobre as alterações. Permita
que eles tenham tempo para entender claramente essas alterações antes que elas
entrem em vigor no seu app.
Seja transparente com os usuários e informe-os sempre que você tomar uma medida,
por exemplo, revogar o acesso deles a um produto no aplicativo. O ideal é que eles possam contestar suas decisões, e que essas contestações sejam tratadas de
forma justa.
Monitore formulários de feedback e fóruns da comunidade para entender o que
leva os usuários a se comportarem de maneiras inadequadas e como eles desenvolvem
esses comportamentos. Aja com base nesses
insights como primeira linha de defesa.
[null,null,["Última atualização 2025-08-18 UTC."],[[["\u003cp\u003eThe Google Play Voided Purchases API lets you track voided in-app purchases and subscriptions to implement revocation systems, ensuring a fair user experience.\u003c/p\u003e\n"],["\u003cp\u003eVoided purchases include user refunds, cancellations, chargebacks, and cancellations/refunds by the developer or Google.\u003c/p\u003e\n"],["\u003cp\u003eAccess the API using OAuth or a service account with "View financial reports" permission and make requests with your package name and authorization token.\u003c/p\u003e\n"],["\u003cp\u003eTailor your revocation policies to be fair and transparent, escalating responses as needed while informing users of any actions taken.\u003c/p\u003e\n"],["\u003cp\u003eCombine this API with other strategies and real-time notifications for a comprehensive approach to managing user entitlements and addressing undesirable behaviors.\u003c/p\u003e\n"]]],["The Google Play Voided Purchases API lists orders linked to user-voided purchases, including refunds, cancellations, chargebacks, and developer/Google-initiated voids. This API helps developers implement revocation systems to prevent access to products from voided orders. To use it, developers need \"View financial reports\" permission and can use a `GET` method to request voided purchases, filtering by time, quantity, or type. It has quotas, provides best practices and advises using it along side RTDN.\n"],null,["# Voided Purchases API\n\nThe Google Play Voided Purchases API provides a list of orders that\nare associated with purchases that a user has voided. You can use information\nfrom this list to implement a revocation system that prevents the user from\naccessing products from those orders.\n\nThis API applies to one-time in-app orders and App Subscriptions.\n\nA purchase can be voided in the following ways:\n\n- The user requests a refund for their order.\n- The user cancels their order.\n- An order is charged back.\n- Developer cancels or refunds order.\n\n | **Note:** only revoked orders will be shown in the Voided Purchases API. If a developer refunds a purchase without setting the revoke option, the order will not be returned by the API.\n- Google cancels or refunds order.\n\nBy using this API, you help create a more balanced and fair experience for all\nof your app's users, particularly if your app is a game.\n| **Note:** Unlike other order-related data sources, the Voided Purchases API includes purchases that are charged back by payment processors. Therefore, you might see inconsistencies between the information from this API and information from other order-related data sources.\n| **Note:** The Voided Purchases API returns voided purchases only when they need to be revoked. Developers can use this API as an indication for when to take additional action on their end. However, some purchases may be refunded with reason that the purchase was never acknowledged by the developer, and therefore may not exist in the developer's records.\n\nGaining Access\n--------------\n\nTo work with the Voided Purchases API, you need to have permission to view\nfinancial information. You provide authorization using an OAuth client or a\nservice account. If you're using a service account, enable the \"View financial\nreports\" permission within this account.\n\nTo learn more about gaining authorized access to Google Play Developer APIs, see\nthe following guides:\n\n- [Setting Up API Access Clients](/android-publisher/getting_started#setting_up_api_access_clients)\n- [Add developer account users \\& manage permissions](https://support.google.com/googleplay/android-developer/answer/2528691)\n\nViewing Voided Purchases\n------------------------\n\nUse the `GET` method to request a list of voided purchases. In your request,\ninclude the fully-qualified package name for your app---such as\n`com.google.android.apps.maps`---and the authorization token you\nreceived when [gaining access](#gaining_access) to the API. \n\n```\nGET https://www.googleapis.com/androidpublisher/v3/applications/\nyour_package_name/purchases/voidedpurchases?access_token=your_auth_token\n```\n\nYou can also include the following parameters in your request, each of which is\noptional:\n\nstartTime\n\n: The time, in milliseconds since the [Unix epoch](https://en.wikipedia.org/wiki/Unix_time), of the oldest\n voided purchase that you want to see in the response. By default,\n `startTime` is set to 30 days ago.\n\n The API can only show voided purchases that have occurred during the past\n 30 days. Older voided purchases are not included in the response, regardless\n of the value that you've provided for `startTime`.\n | **Note:** The voided purchases within the response are filtered based on the time at which a given record is seen as voided by the API, not by the value of `voidedTimeMillis` returned in the response.\n\nendTime\n\n: The time, in milliseconds since the [Unix epoch](https://en.wikipedia.org/wiki/Unix_time), of the newest\n voided purchase of that you want to see in the response. By default,\n `endTime` is set to the current time.\n\n | **Note:** The voided purchases within the response are filtered based on the time at which a given record is seen as voided by the API, not by the value of `voidedTimeMillis` returned in the response.\n\nmaxResults\n: The maximum number of voided purchases that appear in each response. By\n default, this value is 1000. Note that the maximum value for this parameter is\n also 1000.\n\ntoken\n: A continuation token from a previous response, allowing you to view more\n results.\n\ntype\n\n: The type of voided purchases that appear in each response. If set to 0,\n only voided in-app purchases will be returned. If set to 1, both voided in-app\n purchases and voided subscription purchases will be returned. Default value is\n 0.\n\n | **Note:** Before requesting to receive voided subscription purchases, you must switch to use orderId in the response which uniquely identifies one-time purchases and subscriptions. Otherwise, you will receive multiple subscription orders with the same PurchaseToken.\n\nincludeQuantityBasedPartialRefund\n\n: Whether to include voided purchases of quantity-based partial refunds,\n which are applicable only to multi-quantity purchases. If `true`,\n additional voided purchases may be returned with `voidedQuantity`\n that indicates the refund quantity of a quantity-based partial refund. The\n default value is `false`.\n\n | **Note:** When the remaining total quantity of a purchase is refunded, the corresponding voided purchase won't have `voidedQuantity`, which serves as a signal that the purchase has been fully refunded. For example, if a purchase of quantity 10 is refunded 3 times with quantities 2, 3 and 5, there will be 3 voided purchases. The first two voided purchases will have a `voidedQuantity` of 2 and 3, while the third voided purchase *will not* have a `voidedQuantity`.\n\nThe response is a JSON string that contains a list of voided purchases. If there\nare more results than the number specified in the `maxResults` request parameter\n, the response includes a `nextPageToken` value, which you can pass into a\nsubsequent request to view more results. The first result in the list shows the\noldest voided purchase. \n\n```\n{\n \"tokenPagination\": {\n \"nextPageToken\": \"next_page_token\"\n },\n \"voidedPurchases\": [\n {\n \"kind\": \"androidpublisher#voidedPurchase\",\n \"purchaseToken\": \"some_purchase_token\",\n \"purchaseTimeMillis\": \"1468825200000\",\n \"voidedTimeMillis\": \"1469430000000\",\n \"orderId\": \"some_order_id\",\n \"voidedSource\": \"0\",\n \"voidedReason\": \"4\"\n },\n {\n \"kind\": \"androidpublisher#voidedPurchase\",\n \"purchaseToken\": \"some_other_purchase_token\",\n \"purchaseTimeMillis\": \"1468825100000\",\n \"voidedTimeMillis\": \"1470034800000\",\n \"orderId\": \"some_other_order_id\",\n \"voidedSource\": \"2\",\n \"voidedReason\": \"5\"\n },\n ]\n}\n```\n\nQuotas\n------\n\nThe Voided Purchases API sets the following quotas on a per-package basis:\n\n- 6000 queries per day. (The day begins and ends at midnight Pacific Time.)\n- 30 queries during any 30-second period.\n\n### Guidelines for initial requests\n\nDuring your initial API request, you may want to fetch all available data for\nyour app. Although unlikely, this process could exhaust your daily quota. To\nobtain voided purchases data in a safer, more consistent manner, follow these\nbest practices:\n\n- Use the default value for the `maxResults` parameter. That way, if you use your entire query quota for a day, you can retrieve the details of 6,000,000 voided purchases.\n- If a response includes a value for `nextPageToken`, assign this value to the `token` parameter during your next request.\n\nBest Practices\n--------------\n\n| **Note:** In addition to using this API, developers should integrate with [Real-time developer notifications (RTDN)](https://developer.android.com/google/play/billing/getting-ready#configure-rtdn). With RTDN, you receive notifications from Google whenever there is a change in a user's entitlement within your app, including when a user [voids a purchase](https://developer.android.com/google/play/billing/rtdn-reference#voided-purchase).\n\nWhen using this API in your app, remember that there are many\nreasons to void a purchase and that there is no single solution that works in\nall cases. You should keep your users in mind when designing your revocation\npolicies and strategies. To do so, you can apply these recommended practices:\n\n- Use this API as one of many elements in a comprehensive strategy to address undesired behavior. Revoking access to in-app products is usually more effective when combined with an app that has reasonable prices for in-app purchases, an app design that discourages undesirable behavior, a strong user base whose culture rejects such behavior, and responsive and efficient user support channels.\n- Administer your revocation policy uniformly to ensure fairness for all users.\n- Consider creating a staged policy when addressing undesired behavior. For example, start with in-app warnings for early offenses, then escalate your responses as a user's undesired behavior continues. As a last resort, you can prevent a user from interacting with your app at all.\n- When you introduce a revocation policy, and each time you update it, use your app's outreach channels to inform your users about the changes. Give your users time to clearly understand these changes before they take effect in your app.\n- Be transparent to your users and inform them whenever you take action, such as revoking their access to an in-app product. Ideally, users should be able to dispute your decisions, and such disputes should be treated fairly.\n- Monitor feedback forms and community forums to understand what drives users to behave in undesirable ways and how they carry out such behavior. Act on these insights as a first line of defense."]]