Skip to main content

Generate report

POST 

https://data-api.prod-au1.tikpay.me/v1/generate-report

Generate a report filtered by start and end time

Request

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

Report job submitted successfully

Schema
    jobIdstring
    Example: 01JRVZKFS0C0G70CDC0B8CR3G0
    statusstring
    Example: IN_PROGRESS

Authorization: oauth2

name: dataapi_authtype: oauth2scopes: data-api.tikpay.me:writeflows: {
  "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.
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());
Request Collapse all
Base URL
https://data-api.prod-au1.tikpay.me/v1
Auth
Body required
{
  "startTime": "2025-01-01T04:00:00",
  "endTime": "2026-01-01T04:00:00",
  "reportType": "TRIPS",
  "fileType": "csv"
}