Generate report
POSThttps://data-api.prod-au1.tikpay.me/v1/generate-report
Generate a report filtered by start and end time
Request
- application/json
Bodyrequired
Generate a report job for the given report type with data between the start and end time
startTimedate-timerequired
Example:
2025-01-01T04:00:00
endTimedate-timerequired
Example:
2026-01-01T04:00:00
reportTypestringrequired
Possible values: [CUSTOMERS
, PAYMENTS
, TAPS
, TRIPS
]
Example:
TRIPS
fileTypestring
Possible values: [csv
, xml
]
Default value:
csv
Responses
- 200
- 400
- 401
- 429
- 500
Report job submitted successfully
- application/json
- Schema
- Example (auto)
Schema
jobIdstring
Example:
01JRVZKFS0C0G70CDC0B8CR3G0
statusstring
Example:
IN_PROGRESS
{
"jobId": "01JRVZKFS0C0G70CDC0B8CR3G0",
"status": "IN_PROGRESS"
}
Invalid request parameters
Invalid Bearer token or x-api-key
Too Many Requests — you have hit your 20 requests per day limit
Internal server error
- application/json
- Schema
- Example (auto)
Schema
errorIdstringrequired
Example:
f0d10e0d-0219-47c0-8fa0-ea4740327cc1
{
"errorId": "f0d10e0d-0219-47c0-8fa0-ea4740327cc1"
}
Authorization: oauth2
name: dataapi_authtype: oauth2scopes:data-api.tikpay.me:write
flows: { "clientCredentials": { "tokenUrl": "https://auth.data-api.{environment}.tikpay.me/oauth2/token", "scopes": { "data-api.tikpay.me:write": "crate and download reports" } } }
name: x-api-keytype: apiKeyin: headerdescription: Your API key—throttled to 20 requests per 24 hours. If you exceed this, you will receive a 429 Too Many Requests with a `Retry-After` header telling you when you can try again.
- csharp
- curl
- dart
- go
- http
- java
- javascript
- kotlin
- c
- nodejs
- objective-c
- ocaml
- php
- powershell
- python
- r
- ruby
- rust
- shell
- swift
- HTTPCLIENT
- RESTSHARP
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://data-api.prod-au1.tikpay.me/v1/generate-report");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
request.Headers.Add("x-api-key", "<apiKey>");
var content = new StringContent("{\n \"startTime\": \"2025-01-01T04:00:00\",\n \"endTime\": \"2026-01-01T04:00:00\",\n \"reportType\": \"TRIPS\",\n \"fileType\": \"csv\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());