For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get Transaction Report

Generates a transaction report for the end user.

Endpoint

GET /whitelabel/transactions/getReport

Request Headers

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

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

Code Snippet

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:

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

Last updated