# 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.

<table data-header-hidden><thead><tr><th width="99.640625"></th><th></th></tr></thead><tbody><tr><td>Method</td><td><h4>  <mark style="color:green;background-color:$primary;"><code>GET</code></mark></h4></td></tr><tr><td>URL</td><td><pre data-overflow="wrap" data-full-width="false"><code>https://api.zotlo.com/v1/reports/activity/refund
</code></pre></td></tr></tbody></table>

## **Request Parameters**

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

## **Sample Request**

{% code overflow="wrap" %}

```js
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: ••
```

{% endcode %}

{% hint style="info" %}
You can find your **AccessKey** and **AccessSecret** in the Zotlo Panel under **Developer Tools → API Keys**

Sending **ApplicationId** is optional.
{% endhint %}

## Successful Response

{% code overflow="wrap" %}

```json
{
  "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"
    }
  }
}
```

{% endcode %}

## Key **Response Fields**

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

## **Failed Response**

All failed responses follow the same standard error format.\
(See: [**Error Handling**](https://docs.zotlo.com/integrating-zotlo/api-reference/error-handling))