Get Custom PIF

Overview

To fetch a custom PIF mapped by a user using PIF Id.

Resource Access

GET https://<hostname>/institution/v1/pifMapping/<PIFID>

Example Request

🚧

GET https://<hostname>/institution/v1/pifMapping/3479f174-191d-57cd-b1fb-677bab883c2a

Example Response


{
   "id": "3479f174-191d-57cd-b1fb-677bab883c2a",
   "acl": [
       "pps:cpx-acquiring",
       "institution:0df2d073-64d5-58e2-96ee-4770201facb7",
       "network:45cf4f64-e4f2-5a7e-9344-fbd400d77133"
   ],
   "created": "2023-04-14T05:27:59.835Z",
   "creator": {
       "id": "eda295dc-cb33-5179-913c-5d2128672284",
       "username": "john.smith"
   },
   "mapping": {
       "name": "Sample PIF File",
       "udf1": "UDF 1",
       "udf2": "UDF 2",
       "udf3": "UDF 3",
       "udf4": "UDF 4",
       "udf5": "UDF 5",
       "udf6": "",
       "udf7": "",
       "udf8": "",
       "udf9": "",
       "udf10": "",
       "udf11": "",
       "udf12": "",
       "udf13": "",
       "udf14": "",
       "udf15": "",
       "udf16": "",
       "udf17": "",
       "udf18": "",
       "udf19": "",
       "udf20": "",
       "udf21": "",
       "udf22": "",
       "udf23": "",
       "udf24": "",
       "udf25": "",
       "udf26": "",
       "udf27": "",
       "udf28": "",
       "udf29": "",
       "udf30": "",
       "udf31": "",
       "udf32": "",
       "udf33": "",
       "udf34": "",
       "udf35": "",
       "udf36": "",
       "udf37": "",
       "udf38": "",
       "udf39": "",
       "udf40": "",
       "udf41": "",
       "udf42": "",
       "udf43": "",
       "udf44": "",
       "udf45": "",
       "udf46": "",
       "udf47": "",
       "udf48": "",
       "udf49": "",
       "udf50": "",
       "footer": 0,
       "format": "text/csv",
       "header": 0,
       "columns": [
           [
               "0",
               "nid"
           ],
           [
               "1",
               "fid"
           ],
           [
               "2",
               "supplierName"
           ],
           [
               "3",
               "sid"
           ],
           [
               "4",
               "amount"
           ],
           [
               "5",
               "bid"
           ],
           [
               "6",
               "fileDate"
           ],
           [
               "7",
               "transactionId"
           ],
           [
               "8",
               "udf1"
           ],
           [
               "9",
               "udf2"
           ],
           [
               "10",
               "udf3"
           ],
           [
               "11",
               "udf4"
           ]
       ],
       "groupBy": "",
       "dateFormat": "DDMMYYYY",
       "columnOptions": [
           {
               "id": "0",
               "name": "nid",
               "ranges": {},
               "userRequired": false
           },
           {
               "id": "1",
               "name": "fid",
               "ranges": {},
               "userRequired": false
           },
           {
               "id": "10",
               "name": "udf3",
               "ranges": {},
               "userRequired": false
           },
           {
               "id": "11",
               "name": "udf4",
               "ranges": {},
               "userRequired": false
           },
           {
               "id": "2",
               "name": "supplierName",
               "ranges": {},
               "userRequired": false
           },
           {
               "id": "3",
               "name": "sid",
               "ranges": {},
               "userRequired": false
           },
           {
               "id": "4",
               "name": "amount",
               "ranges": {},
               "userRequired": false
           },
           {
               "id": "5",
               "name": "bid",
               "ranges": {},
               "userRequired": false
           },
           {
               "id": "6",
               "name": "fileDate",
               "ranges": {},
               "userRequired": false
           },
           {
               "id": "7",
               "name": "transactionId",
               "ranges": {},
               "userRequired": false
           },
           {
               "id": "8",
               "name": "udf1",
               "ranges": {},
               "userRequired": false
           },
           {
               "id": "9",
               "name": "udf2",
               "ranges": {},
               "userRequired": false
           }
       ],
       "dateDelimiter": "/"
   },
   "modified": "2023-12-19T07:23:03.934Z",
   "modifier": {
       "id": "404b861c-74df-5e29-b70c-5e9c13c09984",
       "username": "john.doe"
   },
   "template": {
       "actions": [
           {
               "id": 1,
               "order": 1,
               "action": "rename",
               "column": 0,
               "columnName": "nid"
           },
           {
               "id": 2,
               "order": 2,
               "action": "rename",
               "column": 1,
               "columnName": "fid"
           },
           {
               "id": 3,
               "order": 3,
               "action": "rename",
               "column": 2,
               "columnName": "supplierName"
           },
           {
               "id": 4,
               "order": 4,
               "action": "rename",
               "column": 3,
               "columnName": "sid"
           },
           {
               "id": 5,
               "order": 5,
               "action": "rename",
               "column": 4,
               "columnName": "amount"
           },
           {
               "id": 6,
               "order": 6,
               "action": "rename",
               "column": 5,
               "columnName": "bid"
           },
           {
               "id": 7,
               "order": 7,
               "action": "rename",
               "column": 6,
               "columnName": "fileDate"
           },
           {
               "id": 8,
               "order": 8,
               "action": "rename",
               "column": 7,
               "columnName": "transactionId"
           },
           {
               "id": 9,
               "order": 9,
               "action": "addRenameColumn",
               "column": 8,
               "newColumn": "UDF 1",
               "columnName": "udf1"
           },
           {
               "id": 10,
               "order": 10,
               "action": "addRenameColumn",
               "column": 9,
               "newColumn": "UDF 2",
               "columnName": "udf2"
           },
           {
               "id": 11,
               "order": 11,
               "action": "addRenameColumn",
               "column": 10,
               "newColumn": "UDF 3",
               "columnName": "udf3"
           },
           {
               "id": 12,
               "order": 12,
               "action": "addRenameColumn",
               "column": 11,
               "newColumn": "UDF 4",
               "columnName": "udf4"
           },
           {
               "id": 13,
               "order": 13,
               "action": "dateFormat",
               "format": "D/M/YYYY"
           },
           {
               "id": 14,
               "order": 14,
               "action": "addAccountType",
               "columnName": "accounttype"
           },
           {
               "id": 15,
               "order": 15,
               "action": "addDecimal",
               "columnName": "amount"
           },
           {
               "id": 16,
               "order": 16,
               "action": "fixAmount",
               "columnName": "amount"
           }
       ],
       "preactions": [
           {
               "id": 1,
               "order": 1,
               "action": "openCSVFile"
           }
       ]
   },
   "addDecimal": true,
   "isStandardMapping": false,
   "isInstitutionMapping": false,
   "associatedInstitutionId": "0df2d073-64d5-58e2-96ee-4770201facb7",
   "authenticateVirtualCard": false
}




Priority Technology Holdings Logo