The Payment Files API gives you the capability to upload files that contain multiple payments, streamlining the payment creation process in our system.
About Payment Files
This part offers extra guidance on how to effectively use the files you import for making payments.
File Upload Formats
Our system is versatile and accepts payment files in
.csv formats. You can also package these files in a
.zip along with any associated check images in TIFF format. For column details, you can refer to the data model provided in the CreatePayment endpoint documentation.
File Upload Steps
Upload Your File: To submit a file, use the CreateImportFile endpoint.
Initial Status: After uploading, your file will have an initial status of "Ready to Process" and will be queued for automatic processing. This usually takes a minute or two, but could take longer when the system is busy.
Check Processing Status: While being processed, the status will change to "In Process." You can check the status anytime by calling GetImportFileById using the ID you got when you first uploaded the file.
Final Status: Once done, the status will change to either "Processed," "Failed," or "Duplicate."
Processed: At least one payment was successfully created.
Failed or Duplicate: No payments were created.
Get Additional Details: After processing is complete, you can get more information from the
messagefield by calling GetImportFileById again. You can also download a detailed payment response file using DownloadResponseFileById.
It's recommended to check the status regularly until it reaches one of the three final statuses ("Processed," "Failed," or "Duplicate").
Understanding Message Field and Response File Content
1. Duplicate Status
Message: You'll see "Duplicate file detected."
Response File: It will also say "Duplicate file detected."
What it Means: No payments were made. Your uploaded file is exactly the same as a file you've uploaded before that didn't fail.
2. Failed Status
Message: You may see either a blank message or a message like "0 of Y payments created successfully."
Response File: Check this file to see why it failed. You might see a general error like "No records found" or specific errors for each incorrect data row.
What it Means: No payments were made. The "Y" will tell you how many payments were in the file if it could be read properly.
3. Processed Status
Message: It will show "X of Y payments created successfully."
Response File: If everything went well, it'll say "All payments were created successfully." If not, it will detail which rows failed.
What it Means: At least one payment was successful. "X" is the number of successful payments and "Y" is the total payments in the file.