In-App Purchase Details

Overview

The In-App Purchases details can be obtained via different sources. To better understand each values received from the different sources, this guide will explain all the correlations between the data given and how to obtain extra data apart from the default information received after a Purchase is complete in the Android Billing SDK.

Sources that provide Purchase data

The sources that provide information about a Purchase are the following:

Android Billing SDK

After a Purchase is made, the Android Billing SDK, using the PurchasesUpdatedListener, will notify your application of that Purchase with the data explained in the Purchase class.
This information is the base for the rest of the requests you can do to the Aptoide services to obtain more data about the Purchase.

In-App Purchase Validation (Server-to-Server)

Once received the Purchase in the PurchasesUpdatedListener, follow the Server to Server - Server flow to receive additional information. In here you will use the sku/productId of the Purchase and purchaseToken.

In-App Purchase details (Server-to-Server ProductV2 API)

This API is used to obtain the UID , which can be viewed in the Aptoide Connect information page of a transaction made by a User. This UID is used to do further requests which will give more information about the Purchase.

To use this API. use the following endpoint (same endpoint is use for both INAPPs and Subscriptions):https://api.catappult.io/productv2/8.20241201/inapp/purchases/{purchaseToken}

The data received from this endpoint is the following:

{
  "uid": String,
  "sku": String,
  "domain": String,
  "type": String,
  "status": String,
  "state": String,
  "payload": String,
  "created": String,
  "buyer": {
    "type": String,
    "reference": String
  },
  "order": {
    "uid": String,
    "gateway": String,
    "reference": String,
    "status": String,
    "created": String
  }
}

The parameters in this payload are described as the following:

type

status

state

order.status

Broker Purchase Details (Server-to-Server Broker API)

This API is used to obtain more detailed information about the Purchase. In here you are able to obtain information about the price of the Purchase, the TxID , which can be viewed in the Aptoide Connect information page of a transaction made by a User and also in our Wallet Application further used to assists users in resolution of potential issues during the Payments or items attribution.

To use this API. use the following endpoint (same endpoint is use for both INAPPs and Subscriptions):https://api.catappult.io/broker/8.20240901/transactions/{UID}

The data received from this endpoint is the following:

{
  "uid": String,
  "domain": String,
  "product": String,
  "wallet_from": String,
  "type": String,
  "method": String,
  "country": String,
  "reference": String,
  "hash": String,
  "status": String,
  "added": String,
  "modified": String,
  "gateway": {
    "name": String
  },
  "metadata": {
    "purchase_uid": String,
    "developer_payload": String
  },
  "price": {
    "currency": String,
    "value": String,
    "appc": String,
    "usd": String,
    "vat": {
      "percentage": String,
      "value": String,
      "usd": String
    },
    "discount": {
      "percentage": String,
      "value": String,
      "usd": String
    }
  },
  "channel": String,
  "platform": String,
  "market": String
}

The parameters in this payload are described as the following:

type

status

channel

platform

market

Broker Transaction Details (Server-to-Server Broker API)

This API is used to obtain information about the transaction using the TxID. This is used to understand the details of the transaction which the User will report in case there are any issues.

To use this API. use the following endpoint (same endpoint is use for both INAPPs and Subscriptions):https://api.catappult.io/broker/8.20241201/transactions?hash={TxID}

The data received from this endpoint is:

{
  "next": null,
  "items": [
    TransactionObject,
  ]
}

The TransactionObject is defined in here.