3. Custom Pifs

3.1 Overview

Custom PIF :

Whenever an institution is created a standard payment instruction file is associated with it by default. Users can generate custom PIFs as per their preference and associate it with the respective institution. An institution can have multiple custom PIFs associated with it and can associate different buyers with different PIFs as well.

3.2 Attributes

Field	Sub-field	Type	Description
totalRecords		Integer	Total count of records existing
totalType		String	Type of match fetched- exact
recordCount		Integer	Total count of records fetched
id		String	Id of the PIF
acl		array	Access control lost for the PIF
created		string	Date and time of creation of the PIF
creator	id	string	Id of user creating the PIF
	username	string	Username of user creating the PIF
modified		string	Date and time of last modification of PIF
modifier	id	string	Id of user who has last modified the PIF
	username	string	Username of user who has last modified the PIF
mapping		object	The mapping for the fields
	name	string	Name of custom PIF
	udf1-50	string	UDF field mapping. Each field can be added individually till 50 UDFs
	format	Enum	Format of custom PIF Values Fixed-width text/csv tab-delimited
	header	string	Number of headers
	footer	string	Number of footers
	columns	Array of arrays	The column mapping. Column number, field
	groupBy	String	Group payments by field
	dateFormat		Format for date fields
	columnOptions id name ranges userRequired	Array of Objects	Column options for PIF
	dateDelimiter	String	Delimiters for date fields
	sampleFile fileName file	Object String Array of Array	Sample PIF file Name of sample pif file Sample PIF File attachment
template	actions id order action column columnName	Array of objects	Action for template for PIF
	preactions id order action	Array of objects	Pre action for template for PIF
	postactions id order action	Array of objects	Post action for template for PIF
addDecimal		Boolean	Whether to add two decimals in file for amounts or not
isStandardMapping		Boolean	If the file is standard mapped
isInstitutionMapping		Boolean	If the PIF is mapped at the institution level
associatedInstitutionId		Boolean	The Id of the institution associated to the PIF
authenticateVirtualCard		Array	Whether card is to be validated to use card link
authenticateVirtualCardFields		Array	Which fields to be validated for virtual card
multiUseFields	id field columns	Array of objects	Fields that have to be used as multiuse fields
columnOptions	id name ranges start end userRequired	Array of Object	Column details for PIF File
duplicateRules		Array of objects	Rules to check for duplicacy for PIF processing
	id	String	Id of duplicacy rule
	fields	Array	Fields that have to be checked for duplicacy

3.3 Operations

3.3.1. Create PIF
3.3.2. Update PIF
3.3.3. Retrieve Custom PIF
3.3.4. Delete PIF
3.3.5. List Custom PIF Mappings