Refund Records Export

This endpoint enables you to retrieve all refunds to users processed by Zotlo. It enables you to export refund transactions using various filters such as date range, package, and country. The endpoint allows you to fetch large volumes of refund records efficiently and manage your financial reporting and operational workflows smoothly.

The service operates with the GET method.

Method	GET
URL	https://api.zotlo.com/v1/reports/activity/refund

Request Parameters

Field	Type	Description
limit	Optional	Number of records to return in a single page. Default: 25. Maximum: 100.
country	Optional	Filters refunds by user country (2-letter ISO code, e.g. UK, US).
package_id	Optional	Filters refunds by the associated packageId.
start_date	Optional	Lists refunds created on or after this date. Format: YYYY-MM-DD
end_date	Optional	Lists refunds created on or before this date. Format: YYYY-MM-DD.
before	Optional	Cursor token to fetch the previous page. Use the value returned under paging.cursors.previous from the last response.
after	Optional	Cursor token to fetch the next page. Use the value returned under paging.cursors.next from the last response.

Sample Request

GET https://api.zotlo.com/v1/reports/activity/refund?limit=50?&start_date=2025-11-01&end_date=2025-11-30 HTTP/1.1
AccessKey: ••••••
AccessSecret: ••••••
Content-Type: application/json
ApplicationId: •
Language: ••

You can find your AccessKey and AccessSecret in the Zotlo Panel under Developer Tools → API Keys

Sending ApplicationId is optional.

Successful Response

{
  "meta": {
    "requestId": "5896c0267514-REQ-69246705a5ea3",
    "httpStatus": 200
  },
  "result": {
    "data": [
      {
        "teamId": 1,
        "appId": 1,
        "packageId": "web_premium",
        "subscriberId": "3a33eb5d-3e4b-4875-916f-7e9fb5867f3f",
        "transactionId": "29d557b4-2563-497b-ad1f-677ac6910b81",
        "country": "US",
        "price": "20.00",
        "currency": "USD",
        "exchangeRate": "[]",
        "reason": "{\"reason\":\"\",\"user\":\"API: \"}",
        "refundDate": "2025-11-10 08:28:08",
        "refundType": "REFUND"
      },
      {
        "teamId": 1,
        "appId": 1,
        "packageId": "web_premium",
        "subscriberId": "8aa4de92-a86d-4330-bb3c-6995a5f837ed",
        "transactionId": "6edc57b0-86a1-4ba7-bf9a-81d05afbf505",
        "country": "US",
        "price": "20.00",
        "currency": "USD",
        "exchangeRate": "[]",
        "reason": "{\"reason\":\"\",\"user\":\"API: \"}",
        "refundDate": "2025-11-10 08:26:59",
        "refundType": "REFUND"
      }
    ],
    "paging": {
      "cursors": {
        "previous": null,
        "next": "jxNrkD7SxgoepgGb9tOAdytGbmJYSkh2V2hsVC8xRVlXODZKRmZRMkw4Y1dHcWZ0em5YdmxBa3hqckx3MkxBUitRUjNzL2dkQ0gwa2N2MFBRT3lpbDlsNnFjODZ1OHJsdlI3TmY2S2ZjUlFqYnhBbS9SRG5kdHhocHM1aTJYaFBwNS9STkRwci9YYUp3N2FEODdjZ3FacFNhbVlmUEtRMlZscUR6eFdxNEdZdUhuNWI3SnF2UEJYa29FakcvMEZTbXhrSk1tdktTYjV4c085Q2lTVnN4elJtNll4aEFpSkJ3WWkrSVE9PQ"
      },
      "previous": "https://local-api.zotlo.com:39443/v1/reports/activity/refund",
      "next": "https://local-api.zotlo.com:39443/v1/reports/activity/refund?after=jxNrkD7SxgoepgGb9tOAdytGbmJYSkh2V2hsVC8xRVlXODZKRmZRMkw4Y1dHcWZ0em5YdmxBa3hqckx3MkxBUitRUjNzL2dkQ0gwa2N2MFBRT3lpbDlsNnFjODZ1OHJsdlI3TmY2S2ZjUlFqYnhBbS9SRG5kdHhocHM1aTJYaFBwNS9STkRwci9YYUp3N2FEODdjZ3FacFNhbVlmUEtRMlZscUR6eFdxNEdZdUhuNWI3SnF2UEJYa29FakcvMEZTbXhrSk1tdktTYjV4c085Q2lTVnN4elJtNll4aEFpSkJ3WWkrSVE9PQ"
    }
  }
}

Key Response Fields

Field	Description
meta.requestId	Unique ID generated by Zotlo for this request (useful for debugging and support).
meta.httpStatus	HTTP status code for the response (e.g. 200).
result.data	Array of refund records returned for this page.
result.paging.cursors.previous	Cursor token to fetch the previous page. Send this value as before in the next request.
result.paging.cursors.next	Cursor token to fetch the next page. Send this value as after in the next request.
result.paging.previous	Full URL for the previous page request (helper link).
result.paging.next	Full URL for the next page request (helper link).

Failed Response

All failed responses follow the same standard error format. (See: Error Handling)