v1

latestOpenAPI 3.1.0© Modulr Finance2026-08-04207430590.4 KB
File Upload

Get paginated summaries of child file uploads

Returns a paginated list of child file upload summaries for a delegate payment file. For delegate users the fileId is the parent bid; for regular users it is the file bid.

get/payment-files/{fileId}/summaries

Path parameters

fileIdstring required

Payment File ID

Query parameters

pageinteger

Page to fetch (0 indexed)

sizeinteger

Page size (max 500)

Response

Paginated file upload summaries response

fileIdstring

File ID of the parent upload

fileNamestring

File name of the parent upload

sizeinteger

Number of items in this page

totalSizeinteger

Total number of child file uploads

pageinteger

Current page number (0 indexed)

totalPagesinteger

Total number of pages

Example response

{
  "fileId": "F1100001",
  "fileName": "file",
  "content": [
    {
      "status": "ACCEPTED",
      "customerName": "TestCustomer",
      "batchPaymentId": "D0000001",
      "payments": [
        {
          "sortCode": "111111",
          "accountNumber": "11111111",
          "numberOfPayments": 3
        }
      ]
    }
  ],
  "size": 3,
  "totalSize": 3,
  "totalPages": 1
}