Get a PIF Status

Guide to getting a status of a PIF File after it has been sent

With this endpoint, you can retrieve the status of the PIF

GET: https://sandbox-api.cpxenterprise.com/file/v1/file?search={fileId}

{
    "aggregations": {
        "totalAmount": {
            "value": 0.03
        }
    },
    "totalRecords": 1,
    "recordCount": 1,
    "records": [
        {
            "creator": {
                "id": "f7432cc9-38ca-508d-3e79-3337e9c9ea28",
                "username": "username+sandbox"
            },
            "displayRecordCount": 2,
            "exceptions": 1,
            "fileDate": "2021-04-14T18:36:23.427Z",
            "fileId": "{fileId}",
            "fileName": "file.pif.WEB_20210414143623.csv",
            "filePath": "file.pif.WEB_20210414143623.csv",
            "fileSource": "api",
            "id": "{fileId}",
            "importDate": "2021-04-14T18:36:23.427Z",
            "isPifPlanCreated": true,
            "isPifPlanLocked": true,
            "isTransactionLoadComplete": true,
            "message": "{message}",
            "originalRecordCount": 2,
            "pifMappingId": "e2dfdwe3d2-117a-c29-cc18-1ddfd1198",
            "recordCount": 3,
            "status": "{status}",
            "totalAmount": 0.03,
            "totalCreditCount": 2,
            "totalDebitCount": 1,
            "uploadedFileName": "file.pif.WEB_20210414143623.csv"
        }
    ]
}