Update PIF
Overview
Users can update the PIF Mapping of an institution to update the order of mapping or to add to remove mapped fields.
Resource Access
PUT https://<hostname>/institution/v1/pifMapping/<pifid>
Attributes
| Field | Sub-field | Additional Information |
|---|---|---|
| mapping | Mandatory | |
| name | Optional | |
| udf1-50 | Optional | |
| format | Optional | |
| header | Optional | |
| footer | Optional | |
| columns | Mandatory SID, Amount | |
| groupBy | Optional | |
| dateFormat | Optional | |
columnOptions
| Optional | |
| dateDelimiter | Optional | |
sampleFile
| Optional | |
| template | actions
| Optional |
preactions
| Optional | |
postactions
| Optional | |
| addDecimal | Optional | |
| isStandardMapping | Optional | |
| isInstitutionMapping | Optional | |
| associatedInstitutionId | Optional | |
| authenticateVirtualCard | Optional | |
| authenticateVirtualCardFields | Optional | |
| multiUseFields | id field columns | Optional |
| columnOptions | id name ranges
| Optional |
| duplicateRules | Optional | |
| id | Optional | |
| fields | Optional |
Example Request
Update PIF:
PUT https://<hostname>/institution/v1/pifMapping/8afd6025-c4d0-537d-a66b-e33605d7619e
Host: <hostname>
Authorization: Bearer <JWT token>
Content-Type: application/json
{
"mapping": {
"name": "Custom PIF File Mapping 2",
"format": "text/csv",
"header": 0,
"footer": 0,
"groupBy": "sid,transactionId",
"sampleFile": {
"file": [
[
"SID",
"1",
"NID",
"FID",
"BID",
"12/03/22",
"TRANSACTION-ID",
"CHK",
"789878987",
"12/03/22",
"10",
"REF1",
"REF 2"
]
],
"fileName": "Sample file.csv"
},
"isInstitutionMapping": false,
"dateFormat": "DDMMYYYY",
"dateDelimiter": "",
"addDecimal": true,
"udf1": "",
"udf2": "",
"udf3": "",
"udf4": "",
"udf5": "",
"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": "",
"multiUseFields": [
{
"id": "453ce40a-568f-406a-9294-8b03aa2615c4",
"field": "invoiceOpenAmounts:multi",
"columns": [
"invoiceCreditAmounts:multi",
"invoiceDiscountAmounts:multi",
"invoiceTotalDues:multi"
]
}
],
"columns": [
[
"0",
"sid"
],
[
"1",
"amount"
],
[
"2",
"nid"
],
[
"3",
"fid"
],
[
"4",
"bid"
],
[
"5",
"fileDate"
],
[
"6",
"transactionId"
],
[
"7",
"accountType"
],
[
"8",
"invoiceNumbers"
],
[
"9",
"invoiceDates"
],
[
"10",
"invoiceAmounts"
],
[
"11",
"reference1"
],
[
"12",
"reference2"
],
[
"13",
"reference3"
],
[
"14",
"reference4"
]
],
"columnOptions": [
{
"id": "0",
"name": "sid",
"ranges": {},
"userRequired": false
},
{
"id": "1",
"name": "amount",
"ranges": {},
"userRequired": false
},
{
"id": "2",
"name": "nid",
"ranges": {},
"userRequired": false
},
{
"id": "3",
"name": "fid",
"ranges": {},
"userRequired": false
},
{
"id": "4",
"name": "bid",
"ranges": {},
"userRequired": false
},
{
"id": "5",
"name": "fileDate",
"ranges": {},
"userRequired": false
},
{
"id": "6",
"name": "transactionId",
"ranges": {},
"userRequired": false
},
{
"id": "7",
"name": "accountType",
"ranges": {},
"userRequired": false
},
{
"id": "8",
"name": "invoiceNumbers",
"ranges": {},
"userRequired": false
},
{
"id": "9",
"name": "invoiceDates",
"ranges": {},
"userRequired": false
},
{
"id": "10",
"name": "invoiceAmounts",
"ranges": {},
"userRequired": false
},
{
"id": "11",
"name": "reference1",
"ranges": {},
"userRequired": false
},
{
"id": "12",
"name": "reference2",
"ranges": {},
"userRequired": false
},
{
"id": "13",
"name": "reference3",
"ranges": {},
"userRequired": false
},
{
"id": "14",
"name": "reference4",
"ranges": {},
"userRequired": false
}
]
},
"template": {
"preactions": [
{
"action": "openCSVFile"
}
],
"actions": [
{
"action": "rename",
"column": 0,
"columnName": "sid"
},
{
"action": "rename",
"column": 1,
"columnName": "amount"
},
{
"action": "rename",
"column": 2,
"columnName": "nid"
},
{
"action": "rename",
"column": 3,
"columnName": "fid"
},
{
"action": "rename",
"column": 4,
"columnName": "bid"
},
{
"action": "rename",
"column": 5,
"columnName": "fileDate"
},
{
"action": "rename",
"column": 6,
"columnName": "transactionId"
},
{
"action": "rename",
"column": 7,
"columnName": "accountType"
},
{
"action": "rename",
"column": 8,
"columnName": "invoiceNumbers"
},
{
"action": "rename",
"column": 9,
"columnName": "invoiceDates"
},
{
"action": "rename",
"column": 10,
"columnName": "invoiceAmounts"
},
{
"action": "rename",
"column": 11,
"columnName": "reference1"
},
{
"action": "rename",
"column": 12,
"columnName": "reference2"
},
{
"action": "rename",
"column": 13,
"columnName": "reference3"
},
{
"action": "rename",
"column": 14,
"columnName": "reference4"
},
{
"action": "dateFormat",
"format": "DDMMYYYY"
},
{
"action": "groupBy",
"columnName": "sid,transactionId"
},
{
"action": "addDecimal",
"columnName": "amount"
},
{
"action": "addDecimal",
"columnName": "invoiceAmounts"
},
{
"action": "fixAmount",
"columnName": "amount"
},
{
"action": "fixAmount",
"columnName": "invoiceAmounts"
}
],
"postactions": []
},
"duplicateRules": [
{
"id": 1,
"order": 1,
"fields": [
"amount",
"transactionId"
]
}
],
"authenticateVirtualCard": true,
"authenticateVirtualCardFields": [
{
"field": "nid",
"label": "Network ID (NID)",
"displayOption": "pre-populate",
"displayName": "Network ID - NID",
"id": 1
},
{
"field": "reference1",
"label": "Reference 1",
"displayOption": "pre-populate",
"displayName": "Auth No.",
"id": 2
},
{
"field": "fid",
"label": "Institution ID (FID)",
"displayOption": "validate",
"displayName": "Institution ID - FID",
"id": 3
}
]
}
Example Response
HTTP Status: 204
Updated 3 days ago