1. Institution

1.1 Overview

Institution :
These are generally Account Payables ERPS which may have multiple buyers on their platform who want to make payments to different vendors. An institution is on-boarded on a network by CPX Admin. For some institutions, the underwriting may be done by a third party. For the others, CPX does the underwriting.

After an institution is successfully onboarded, it can create multiple buyers on the platform. This can be done using CPX APIs, or the portal

1.2 Attributes

ReadMe
cpx-qa-docs
v0.0.1
Enterprise Project
Belongs to cpx-qa-enterprise

Home
Developer Dashboard
My Developers
Project
Metrics
Configuration
Appearance
Owlbot AI
Versions
Suggested Edits
Reusable Content
Documentation
Landing Page
Guides
Recipes
API Reference
Changelog
Custom Pages
New experience coming soon!
Release Notes
Images only
Release Note Images
2023 Icons
v2.38 Pikachu
v2.43 Donald Duck 04/29
v2.44 Edna 05/27
v2.46 Goofy 07/22
2.48 Lago
2.49 Jasmine
v2.16 Cavaliers 01/30
v2.17 Grizzlies 03/03
v2.18 Hornet 04/25
v2.19 Jazz 06/06
v2.20 Kings 07/06
v2.21 Lakers 08/01
v2.22 Mavericks 09/05
v2.23 Nuggets 10/03
v2.24 Pelicans 10/31
v2.25 Rockets 11/30
v2.26 Timberwolves 12/28
v2.27 Altaria 01/30
v2.28 Bayleef 02/27
v 2.29 Charizard 03/27
v2.30 Delibird 04/24
v2.31 Eevee 05/22
v2.32 Finneon 06/19
v2.33 Grookey 07/17
v2.34 Honchcrow 08/14
v2.36 Jellicent 10/09
v2.37 Kleavor
v2.40 Abu
v2.42 Cinderella
v2.33 Goofy 07/17
v2.39 Rapidash 01/08
Sprint Icon
Hercules Cover page
Internal Release Notes Images
2023
2024
Main page icons
Kristoff11 Nov
Lilo
2.52 Mufasa
Arsenal
Barcelona
Table changes
Update buyer
Chelsea
Chelsea Ext
External release notes
Den Haag
Inst buyer releation
Buyer
Payments
Buyer Wallet
Invoices
Reports
Cover pages
Release Notes
Release notes1
Den External Release Notes
Update buyer Latest
Buyer wallet Latest
Invoices Latest
Reports
Buyer wallet 1
Reports 1
Release notes 2
Exeter city Inernal
Tables Release notes
Release notes internal test
API Guide
External Release notes
Test3
Fiortena Release notes internal
Table 1

Guides

New Category

Institution
Description (optional)

Field	Sub-field	Type	Description	Additional Information
_scroll_id		String	The id for the search context
id		String	Id of the Institution assigned by CPX
acl		Array	access control list for the institution
fees		Object	Fee account details
	bankAccountId	String	Bank account ID for fees type bank account
name		String	Name of the Institution	Mandatory
address		Object	Address of the Institution
	street1	String	street address of the institution	String with no special characters but dashes, dots, commas and spaces
	city	String	City of the Institution	String with no special characters but dashes and spaces.
	state	String	State of the Institution
	country	String	Country of the Institution	An empty string or string with no trailing or leading spaces.
	postalCode	string	Postal Code of the Institution
status		Enum	Current status of the buyer	Mandatory Approved Canceled Closed Declined Received Suspended Under Review
externalStatus		Enum	External Status of the Institution	Mandatory Active Inactive
Contacts		Array	Contact Details for the institution
	name	String	Contact Name of the Institution
	title	String	Position of the Contact
	email	String	Email of the Contact
	phone	String	Phone Number of the Contact
	primary	Boolean	To set a contact as default
associatedNetworkName		String	Name of the Network to which Institution is associated
associatedNetworkId		String	Id of the network to which an Institution is associated	Mandatory
fid		String	Unique id for an institution	Mandatory
associatedBrandName		String	Name of the Brand to which an institution is associated
associatedBrandId		String	Id of the Brand to which an institution is associated	No value, name picked from Id- should not be exposed
externalUnderwriting		boolean	Whether Institution will have buyer underwriting from CPX or third party/self. If enabled, then third party/institution is responsible for underwriting.
schedulePaymentsForFuture		boolean	To allow buyers to schedule payments for future date up to 90 days
invoiceUploadEnabled		boolean	To allow buyers to upload invoice documents in PDF format
alertApi		Object	To setup API alerts for card, ACH, Check, wire and supplier
	enabled	Boolean	Endpoint configuration to send webhooks to institutions
	username	String	Username to set API alerts
	password	String	Password to send API alerts
	endpoint	String	Endpoint to send API alerts
generateScheduledUserReportActive		Boolean	To generate daily report for active users for the institution
StaticReport		Object	enable static reports for the institution
	enabled	Boolean	If static reports are enabled
	externalLinks id label Value	Array string string	Id of External link Label for external link Value/link to be redirected for externallink
paymentFileType		string	ID of the payment File set for the institution
paymentFileTypes		array	File details for Custom Parsing files The file types are : PIF THECLIFFS SUNGARD LINCOLN HARRIS_HLG	Custom Flat parser
	id	string	Id of custom PIF file
	name	string	Name of custom PIF file
bankAccounts		Array of objects	Bank accounts associated with the Institution
	id	string	Id of bank account of the institution
	accountNumber	String	Institution’s bank account number
	routingNumber	String	Institution’s bank routing number
	accountType	String	Type of the account i.e. checking or savings
	defaults	Array	Used to select a default account if more than 1 detail is provided for the bankAccounts	items: type: string enum: Revenue Fees Goodfunds
debitMethod		Enum	Determines how the debit will be happening for all the buyers associated to that institution	Manual Debit by batch Debit for Each Transaction Debit by Day
achDelayDays		Integer	Determines after how much days the money will be given to supplier once it is deducted from the buyer	Mandatory minimum: 0 maximum: 7
vcnHost		String	Determines the card processor of the Institution	falcons braves United vpa Should be passed with VCN config
vcnHostConfig		Object	Card provider and Virtual Card configuration
	falcons A. products Type value default id name isSingleUse B. location C. vendor	Type : String Value: String Default: Boolean Id: string Name: string Location : String Vendor : string	type determines the card type i.e. VCN or LDG. value is the product Id associated with the Institution provided by Galileo. default determines the default product type for the institution in case more than 1 product type is given. Id is the id of the card product assigned by CPX. Name is the name of the card product set by Falcons. Vendor is the vendor of the card product - Galileo. isSingleUse denotes whether card product is single use or not
	braves companyNumber billLevel corpId clientUserId clientOrg vendor	Object string string enum enum enum	company number is the number to be associated with the new Exact Auth Account on DXC bill level defined the CPX entity which will hold the control to manage card rules corpId is the Corporation ID clientUserId and clientOrg are DXC login api parameters. Vendor is the vendor of the card product - hpdxc	corpID- NA/NB/NC clientUserID - U84NACPX U84NBCPX U84NCCPX clientOrg- COMMERCIAL CARD NA COMMERCIAL CARD NB COMMERCIAL CARD NC Only a valid combination for corpID, clientUserID and client Org will be applicable
	vpa clientId implementationType pp default rva default	Object string Enum object boolean object boolean	Visa (VPA) card processor Client Id for VPA Implementation Type set Process Payment Request Virtual Account	Enum for implementation type PSEUDO_ACCOUNTS
automaticIdentityVerification		Boolean	used for verification purpose
includeVcnInDisposition		Boolean	Include Card number in disposition file
automaticVcnCardCreation		Boolean	This is for PPD account creation. If this is set as false, account will not be generated.
suppressSIPEmail		Boolean	To suppress SIP email to supplier or not
suppressStatement		Boolean	To disable email notification to alert buyer about the statement from Card processor
checkSettings		Object	Settings for Buyers for check payments
	checkProcessorEnabled	Boolean	Used if an institution is having custom client Id and API key
	clientId	String	Custom Client Id of the Institution for the Smart Payable processor	Only used if checkProcessorEnabled is true
	apiKey	String	Custom API Key of the Institution for the Smart Payable processor	Only used if checkProcessorEnabled is true
	memoMappingEnabled	Boolean	Enable it to select a field to print in the “Memo” (Check) and “Notes” (Check Stub) fields. Only the first 40 characters entered by the user will be printed.
	memoMapping	String	The field which will be printed in the “Memo” (Check) and “Notes” (Check Stub) fields.
	isManagedCheck	Boolean	To give buyers an option to choose their check Processor as Passport
	checkInsertEnabled	Boolean	To allow inclusion of PDF inserts with check payments
updateAllBuyers		boolean	flag for updating all downstream buyers vcnHost
mri	clientID	string	Client ID for MRI Network
	database	string	Database name for MRI Network
	username	string	Username for Database for MRI Network
	password	string	Password for Database for MRI Network
pifConfirmationEmail		String	Optional	Email for disposition notification
pifApproval		Boolean	To enable or disable pifApprovalEnable this feature to offer buyers the option to review and approve payment files prior to processing.
pifApprovalConfig		array	To To set up approval process for PIF files
	level	enum	Level for pif approval pif is the accepted value	Mandatory
	DEFAULT threshold firstLevel secondLevel requireAllLevelApproval Approvers firstLevel secondLevel	Array Array String String Boolean Array String string	Mandatory Mandatory Optional Optional Optional Optional Optional Mandatory Optional
plastiqPayEnabled		boolean	To enable plastiqPay for buyers to pay via external card
buyerWalletEnabled		Boolean	To enable virtual wallets for buyers
created		string	Date and time of creation of institution
creator	id	string	Id of user creating the institution
	username	string	Username of user creating the institution
modified		string	Date and time of last modification of institution
modifier	id	string	Id of user who has last modified the institution
	username	string	Username of user who has last modified the institution
flagsEnable		array	Features enabled for the buyer
Cpa		object	CPA sync node to capture information from CPA
	id	string	Id of institution on CPA
	syncError	string	Sync error if any

What’s Next
Tell your users what they should do after they've finished this page

1.3 Error Status Code and Messages

Error Code	Condition
400	<Error Message>
401	Unauthorized access
403	Forbidden
404	Not found

1.4 Operations

1.4.1. Create Institution
1.4.2. Update Institution
1.4.3. Retrieve Institution By Id
1.4.4. Retrieve Institution by Custom Field
1.4.5. List Institutions