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

application/json

Body

required

fromDate date-timerequired
Date range start, must be before toDate.
Use the RFC 3339 date-time format.
Example: 2001-02-03T04:05:06Z
toDate date-timerequired
Date range end, must be after fromDate.
Use the RFC 3339 date-time format.
Example: 2001-02-03T04:05:06Z
format FileFormat (string)required
Representation of returned files.
Possible values: [link, base64]
Default value: link

Responses

200

Push transaction response.

application/json

Schema

Schema

success booleanrequired

Success indicator.

numFiles int64
Total number of pages.
Example: 2

settlementFiles

object[]

List of settlement files.

Array [

_TYPE

string

required

Type of file.

Possible values: [settlement-file]

settlement-file

circular(SettlementFile)

filename string

Name of the file.

Example: file.csv

creationDate date-time

Date the file was created.

RFC 3339 Internet Date/Time Format date-time.

Example: 2001-02-03T04:05:06+02:00

format FileFormat (string)

Representation of returned files.

Possible values: [link, base64]

Default value: link

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

Example: https://gateway.ixopay.com/link-to-file

relatedFiles undefined[]

Files related to this file.

Default value: []

]

property name* any

Example (from schema)

{
  "success": true,
  "numFiles": 2,
  "settlementFiles": [
    {
      "_TYPE": "settlement-file",
      "filename": "file.csv",
      "creationDate": "2019-04-01T00:00:00",
      "format": "link",
      "content": "https://gateway.ixopay.com/link-to-file.csv",
      "relatedFiles": [
        {
          "_TYPE": "settlement-file",
          "filename": "filename.xslx",
          "format": "link",
          "content": "https://gateway.ixopay.com/link-to-file.xlsx",
          "relatedFiles": []
        },
        {
          "_TYPE": "settlement-file",
          "filename": "filename.pdf",
          "format": "link",
          "content": "https://gateway.ixopay.com/link-to-file.pdf",
          "relatedFiles": []
        }
      ]
    }
  ]
}

Loading...