BLbluefin-com
Digital Services API

Start async export of Clearing data for a given Mandator and given Timestamp range

Changed on

Starts asynchronous processing of clearing data export. Returns immediately with a fileId for tracking. Required role for operation: BO_MANDATOR_CLEARING_EXPORT<br> Supports authentication with the following types of tokens:<br>

  • <b>Bearer</b> <token>, which is a Bearer token authentication. The bearer token is a cryptic string, usually generated by the server in response to a login request.
post/public/digitalservices/mandatorClearingExportDownload

Request

  • Base URL
    https://test.tecs.at/merchantservices
  • URL
    https://test.tecs.at/merchantservices/public/digitalservices/mandatorClearingExportDownload
  • Auth
    HTTP bearer

Request body

clearingDateFromstring date-time required

Start date for clearing export (inclusive)

clearingDateTostring date-time required

End date for clearing export (inclusive)

filenameTemplatestring

Optional filename template for the export file

Example request

{
  "clearingDateFrom": "2024-04-25T01:00:00+02:00",
  "clearingDateTo": "2025-01-01T01:00:00+02:00",
  "filenameTemplate": "{mandator}-clearing-transactions-{clearingDateFrom}-{clearingDateTo}"
}

Response

Successful operation - processing started

responseCodeinteger
responseMessagestring
statusstring

Processing status of the export request

fileIdstring

Unique file identifier for tracking and downloading

Example response

{
  "status": "PROCESSING",
  "fileId": "ad6352d9-b992-45f7-adce-ee306a01ef68"
}

Changes