Sign in

v1

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

Create payments from an uploaded file

Create a batch payment request from a valid upload file and send for processing to the payment service

post/payment-files/{fileId}/proceed

Path parameters

fileIdstring required

Payment File ID

Request body

useDuplicateboolean

User confirms to proceed with creating payments on a duplicate file

Response

File created response

fileIdstring required

Unique id of the uploaded file

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

batchPaymentIdstring required

Unique id for the Batch Payment

Example response

{
  "fileId": "F1100001",
  "status": "INVALID",
  "fileName": "file1",
  "batchPaymentId": "B1100001"
}