List report generation jobs

GET 
https://data-api.prod-au1.tikpay.me/v1/report-jobs-list

Get a list of available report jobs

Responses

200

Successful operation

application/json

Schema

Schema

Array [
statusstring
Possible values: [COMPLETE, NO_DATA, IN_PROGRESS, FAILED]
Example: COMPLETE
timezonestring
Timezone of the operator configured in settings
Example: Australia/Sydney
jobIdstring
Example: 01JRVZKFS0C0G70CDC0B8CR3G0
fileTypestring
Possible values: [csv, xml]
downloadUrlstring
The link to download the generated report if the job is complete
reportTypestring
Possible values: [CUSTOMERS, PAYMENTS, TAPS, TRIPS]
startTimedate-time
Example: 2025-01-01T04:00:00
endTimedate-time
Example: 2026-01-01T04:00:00
createdAtdate-time
Example: 2025-02-03T04:00:00
expiresAtdate-time
The job has an expiry of 7 days from the created date
Example: 2025-02-10T04:00:00
completedAtdate-time
Example: 2025-02-03T04:00:30
]

Example (auto)

[
  {
    "status": "COMPLETE",
    "timezone": "Australia/Sydney",
    "jobId": "01JRVZKFS0C0G70CDC0B8CR3G0",
    "fileType": "csv",
    "downloadUrl": "string",
    "reportType": "CUSTOMERS",
    "startTime": "2025-01-01T04:00:00",
    "endTime": "2026-01-01T04:00:00",
    "createdAt": "2025-02-03T04:00:00",
    "expiresAt": "2025-02-10T04:00:00",
    "completedAt": "2025-02-03T04:00:30"
  }
]

401

Invalid Bearer token or x-api-key

429

Too Many Requests — you have hit your 20 requests per day limit

default

Unexpected error

application/json

Schema

Schema

errorIdstringrequired
Example: f0d10e0d-0219-47c0-8fa0-ea4740327cc1

Example (auto)

{
  "errorId": "f0d10e0d-0219-47c0-8fa0-ea4740327cc1"
}

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.

• 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.Get, "https://data-api.prod-au1.tikpay.me/v1/report-jobs-list");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
request.Headers.Add("x-api-key", "<apiKey>");
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

Bearer Token

x-api-key