Wallet Transaction Totals

This endpoint returns summed wallet amounts for a date range, rather than the individual transactions. Use it when you need a total, instead of paging through List of Wallet Transactions and adding the amounts up yourself.

Endpoint

Method	URL
GET	https://ws.catappult.io/api/wallet/transactionsTotals

Authentication

To access this API, you need to have an active account subscription on Aptoide Connect and authenticate with an API key (check here how to generate one).

Headers

Header	Type	Required	Description
Api-Key	string	Required	Used to authenticate your API requests. The value is your Aptoide Connect API key.

Query Parameters

Parameter	Type	Required	Description
from	string (YYYY-MM-DD)	Required	Start date of the time range. Example: 2024-01-01.
to	string (YYYY-MM-DD)	Required	End date of the time range. Example: 2024-01-31.
packageName	string	Optional	Filters results by app package name. Example: com.example.test.
countryCode	string	Optional	Filters results by country, using the ISO 3166-1 alpha-2 format. Example: PT.
operatingSystem	string	Optional	Filters results by platform. Possible values: android, ios.
type	string	Optional (default: all)	Filters results by transaction type. Possible values: all, debit, credit.
paymentMethod	string	Optional	Restricts results to sandbox test purchases. Only accepted value: sandbox.
amountType	string	Optional (default: wallet)	Specifies whether to return net or gross amounts. Possible values: wallet (net value, what reaches your wallet) or global (gross value).

Response

Success

If the API call returns an HTTP 200 status code, the request was successful and it returns the summed amounts in USD for the requested range.

Field	Type	Description
iap	object	In-app purchase revenue, as { "usd": number }.
credit	object	Total credited to the wallet, as { "usd": number }.
debit	object	Total debited from the wallet, as { "usd": number }.

Example Response

{
    "credit": {
        "usd": 103.8
    },
    "debit": {
        "usd": 0
    },
    "iap": {
        "usd": 103.8
    }
}

💡

Net and gross are different figures

By default these are the amounts credited to your wallet, which are net of VAT and revenue share. Passing amountType=global returns gross consumer spend including VAT, which is a substantially larger number. The difference varies with the buyer's country, so do not compare a global total against a default one and treat the gap as missing revenue.

Errors

Code	HTTP Status	Description	Resolution
—	401 Unauthorized	The API key was not recognised	Check the key, and that the account is approved
SUBSCRIPTION-REQUIRED	402 Payment Required	No active account subscription	Activate a subscription for the account
DAILY-QUOTA-REACHED	429 Too Many Requests	Daily request quota exceeded	Retry after the quota resets at midnight UTC