Skip to main content

Get settlement files

POST 

/getSettlementFiles

Retrieves a list of all settlement files.

Please note that you can only retrieve files generated by the following export steps:

  • WriteSettlementCsv,
  • Write Standard Settlement CSV with Aggregation File, and
  • Write customized Settlement CSV

Furthermore, it's essential to note that file retrieval is only possible if the Accessible by Merchant (through Settlement-API) option is enabled in the configuration of these steps.

Request

Body

required
    fromDate date-timerequired

    Date range start, must be before toDate.

    Use the RFC 3339 date-time format.

    toDate date-timerequired

    Date range end, must be after fromDate.

    Use the RFC 3339 date-time format.

    format FileFormatrequired

    Possible values: [link, base64]

    Default value: link

    Representation of returned files.

Responses

Push transaction response.

Schema
    success booleanrequired

    Success indicator.

    numFiles int64

    Total number of pages.

    settlementFiles object[]

    List of settlement files.

  • Array [

  • _TYPE stringrequired

    Possible values: [settlement-file]

    Type of file.

    circular(SettlementFile)

    filename string

    Name of the file.

    creationDate date-time

    Date the file was created.

    RFC 3339 Internet Date/Time Format date-time.

    format FileFormat

    Possible values: [link, base64]

    Default value: link

    Representation of returned files.

    content string

    Depending on format this will either be

    • the base64 encoded content of the file, or
    • a URL to download the contents of the file
    relatedFiles undefined[]

    Default value: ``

    Files related to this file.

  • ]

  • property name* any
Loading...