Get lists
GEThttps://device-api.prod-au1.tikpay.me/v1/lists
Get current contents of lists. Optional filter to limit which lists are returned. If no list types are provided, then all available lists are delivered.
Returns lists as simple lists of tokens and/or ranges, not as collections of ADD/REMOVE actions, for simple initialization or refresh of lists in their entirety.
The provided sequenceNo is the most recent sequence number included in these lists, which must be stored on the device for use in subsequent list delta calls.
Request
Query Parameters
Page Size. Maximum number of records to return. If not set, will return all records
Optional list of ListTypes to filter to
Header Parameters
Header required for all calls. tikpay provided Operator ID
Header required for all calls from devices. Device ID is unique within an Operator
Is the version of the hash key the device is using (as provided by the server)
Is the version of the encryption key the device is using (as provided by the server)
Optional header to specify the language you wish the system to use for response messages.
Pass appropriate IETF Language Tag. (https://en.wikipedia.org/wiki/IETF_language_tag)
Defaults to English (en)
Responses
- 200
Contents of requested lists, as lists of tokens and/or ranges, along with the sequence number associated with the most recent record, for use in subsequent delta requests.
- application/json
- Schema
- Example (auto)
Schema
1686114821lists object[]
{
"sequenceNo": 1686114821,
"lists": [
{
"listType": "DENY",
"tokens": [
"40C0B7E3B1A8179B5BF6B520D6648BC396EC81B5731048C183BBF359605C4037"
],
"ranges": [
4175
],
"pars": [
"12345ABC912345678909876543212"
]
}
]
}
Authorization: mutualTLS
- 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://device-api.prod-au1.tikpay.me/v1/lists");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());