> For the complete documentation index, see [llms.txt](https://docs.tylt.money/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.tylt.money/tylt-embedded-wallet-service/wallet-management-apis/get-transaction-report.md).

# Get Transaction Report

Generates a transaction report for the end user.

### Endpoint

```http
GET /whitelabel/transactions/getReport
```

### Request Headers

```http
x-tlp-apikey: <api-key>
x-tlp-signature: <hmac-signature>
```

### Query Parameters

The request must include one end-user identifier.

The underlying reporting controller may also require or support:

* Start date
* End date
* Transaction type
* Status
* Asset
* Network
* Report format
* Time zone

### Query Parameters

Provide at least one of the following user identifiers: `endUserEmail`, `endUserId`, or `externalUserId`.

| Field            | Type   |    Required | Description                         |
| ---------------- | ------ | ----------: | ----------------------------------- |
| `endUserEmail`   | String | Conditional | End user’s registered email address |
| `endUserId`      | Number | Conditional | Tylt end-user ID                    |
| `externalUserId` | String | Conditional | Merchant’s own user identifier      |
| `startDate`      | String |         Yes | Starting date filter                |
| `endDate`        | String |         Yes | Ending date filter                  |

### Example Request

```http
GET /whitelabel/transactions/getReport?externalUserId=user-10021&startDate=2026-07-01&endDate=2026-07-31
```

> The exact date and report-format parameter names must follow the deployed transaction-report API schema.

### Code Snippet

{% tabs %}
{% tab title="JavaScript (Axios)" %}

```javascript
import crypto from 'crypto';
import axios from 'axios';

const apiKey = 'your-api-key';
const apiSecret = 'your-api-secret';

const queryParams = {
    endUserId: 20001, // Optional: Provide one user identifier only
    endUserEmail: "joe@example.com", // Optional: Alternative to endUserId and externalUserId
    externalUserId: "user-10021", // Optional: Alternative to endUserId and endUserEmail
    startDate: '2026-07-01',
    endDate: '2026-07-20'
};

const rawPayload = JSON.stringify(queryParams);
const signature = crypto.createHmac('sha256', apiSecret).update(rawPayload).digest('hex');

const headers = {
    'x-tlp-apikey': apiKey,
    'x-tlp-signature': signature
};

const queryString = new URLSearchParams(queryParams).toString();
axios.get(`https://api.tylt.money/whitelabel/transactions/getReport?${queryString}`, { headers })
    .then(response => console.log(response.data))
    .catch(error => console.error('Error:', error.response ? error.response.data : error.message));
```

{% endtab %}
{% endtabs %}

### Example Response

The endpoint may return:

* A structured JSON report
* A downloadable report URL
* A generated CSV file
* A generated PDF file

Illustrative JSON response:

```json
{
  "msg": "",
  "data": [
    {
      "transactionId": 2144884,
      "uniqueInternalID": "7beae3e1-7b7c-11f1-a6bf-42010a2801d1",
      "merchantOrderID": "7beae3e1-7b7c-11f1-a6bf-42010a2801d1",
      "transactionType": "Internal Payin",
      "ledger": "CR",
      "baseAmount": 5,
      "baseAmountReceived": 5,
      "conversionRate": 1,
      "baseCurrency": "USDT",
      "settledCurrency": "USDT",
      "settledAmount": 5,
      "commission": 0,
      "network": "TPNK",
      "walletAddress": "f95bf002-3a05-4f6f-9613-ac5255c07dd4",
      "status": "Completed",
      "createdAt": "2026-07-09T09:56:41Z",
      "toFrom": "setucuhe@forexzig.com",
      "comments": ""
    }
  ]
}
```

The final response format depends on the underlying reporting controller.

### Merchant Responsibilities

The merchant should:

* Restrict reports to the authenticated end user
* Avoid storing report URLs indefinitely
* Protect downloaded reports as sensitive financial data
* Apply appropriate access controls
* Avoid exposing reports through public or guessable links

##