Sign in

v1

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

Get an upload file latest status

Get latest status of an uploaded payment file

get/payment-files/{fileId}

Path parameters

fileIdstring required

Payment File ID

Response

File upload status response

status'NEW' | 'SUBMITTED' | 'PROCESSING' | 'INVALID' | 'VALID' | 'DUPLICATE' | 'REJECTED' | 'ERROR_RETRYABLE' | 'ACCEPTED' | 'PROCESSED' | 'SENDING' | 'PAYMENT_PROCESSING' | 'SPLIT_FILE' | 'PARTIALLY_ACCEPTED' required

Status of the uploaded file

fileNamestring

File name of the uploaded file

numTransactionsinteger

Total number of transactions within file

numberOfTransactionsinteger

Total number of transactions within file

totalAmountnumber

Sum of all transaction's amount within file

errorsstring

If invalid holds the validation errors

validationResultsstring

If invalid, holds the validation results

Example response

{
  "status": "INVALID",
  "fileName": "file1",
  "numTransactions": 1000,
  "numberOfTransactions": 1000
}