API Reference

Retrieve files paged from BTM

get
https://api-mtls.eu.tispayments.com/rest/api/btm/files

Retrieve all files which are not yet downloaded by the given client from BTM. A download has to be confirmed explicitly by the client so that it gets removed from the list of available files. Besides up to 250 files will be retrieved at once. Files can be downloaded either from a message channel or from the BTM mapping engine. For the BTM mapping engine please check the general notes above.

Query Params
integer
Defaults to 1

Specify which page of results to return

integer
Defaults to 50

specifies the number of items per page

string
required

specifies the system id of the requesting client

string
required

specifies the message channel where the file should be uploaded to. For the BTM mapping engine, the channel must be set to _btm.mappingEngine.

string

specifies the file format of the file; required when the channel is set to _btm.MappingEngine

Headers
string

specifies the API Mode of the TIS BTM file API. For BTM mapping engine the value must be set to BTM

Responses

400

Error response code which is returned when invalid parameters are passed to the service

401

Error response code which is returned when the client cannot be authorized

404

Error response code which is returned when the given message channel does not exist

500

Error response code which is returned when an internal server error occurs

Updated 12 months ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 12 months ago