Create Institution

Overview

You can create an Institution with basic details such as name, title, email, etc. using the POST method and use them for various CPX solution offerings.

Resource Access

POST https://<hostname>/institution/v1/institution

Arguments

Field	Sub-field	Additional Information
name		Mandatory
address		Optional
	street1	Optional
	city	Optional
	state	Optional
	country	Optional
	postalCode	Optional
status		Mandatory
externalStatus		Mandatory
Contacts		Optional
	name	Optional
	title	Optional
	email	Optional
	phone	Optional
	primary	Optional
associatedNetworkName		Optional
associatedNetworkId		Mandatory
fid		Mandatory
associatedBrandName		Optional - No value, name picked from Id- should not be exposed
associatedBrandId		Optional
externalUnderwriting		Optional
schedulePaymentsForFuture		Optional
invoiceUploadEnabled		Optional
generateScheduledUserReportActive		Optional
StaticReport		Optional
	enabled	Optional - False by default
	externalLinks label Value	Label - value combination must be passed together
paymentFileTypes		Optional
	id	Optional
	name	Mandatory if ID is passed
bankAccounts		Optional
	accountNumber	Mandatory to be passed if bank account node is being passed
	routingNumber	Mandatory to be passed if bank account node is being passed
	accountType	Mandatory to be passed if bank account node is being passed
	defaults	items: type: string enum: Revenue Fees Goodfunds
debitMethod		Optional
achDelayDays		Mandatory minimum: 0 maximum: 7
vcnHost		Optional falcons braves United vpa Should be passed with VCN config
vcnHostConfig		Optional
	falcons A. products Type value default B. location	One Product is mandatory if vcnhost config is being passed
	braves companyNumber billLevel corpId clientUserId clientOrg	All subnodes are mandatory if braves node is being passed. Only a valid combination for corpID, clientUserID and client Org will be applicable
	vpa clientId implementationType pp rva	clientId is mandatory for VPA. implementationType is mandatory for VPA. Either pp or rva to be passed with default as true
automaticIdentityVerification		Optional, true by default
includeVcnInDisposition		Optional, false by default
automaticVcnCardCreation		Optional, false by default
suppressSIPEmail		Optional, false by default
companyNumber		Not sure where it is used
suppressStatement		Optional, false by default
checkSettings		Optional
	checkProcessorEnabled	Optional
	clientId	Optional , Mandatory Only used if checkProcessorEnabled is true
	apiKey	Optional , Mandatory Only used if checkProcessorEnabled is true
	memoMappingEnabled	Optional
	memoMapping	Optional, Reference 1 by default
	isManagedCheck	Optional, false by default
	checkInsertEnabled	optional, False by default
updateAllBuyers		Optional, False by default
mri	clientID	Optional, mandatory if MRI nodes is being passed
	database	Optional, mandatory if MRI nodes is being passed
	username	Optional, mandatory if MRI nodes is being passed
	password	Optional, mandatory if MRI nodes is being passed
pifConfirmationEmail		Optional
plastiqPayEnabled		Optional

Example Request

🚧
Create an Institution entity
POST https://<hostname>/institution/v1/institution
Host: <hostname>
Authorization: Bearer <JWT token>
Content-Type: application/json


{
   "name": "Test API Institution",
   "address": {
       "street1": "150 Street",
       "city": "New City",
       "state": "AL",
       "country": "USA",
       "postalCode": "10001"
   },
   "status": "Approved",
   "externalStatus": "Active",
   "contacts": [
       {
           "primary": true,
           "name": "John Smith",
           "title": "contact posititon",
           "email": "[email protected]",
           "phone": "1231212321"
       }
   ],
   "associatedNetworkName": "APINetworktesting1234567890",
   "associatedNetworkId": "cebc25a1-186d-509f-bcde-63df16250fbc",
   "fid": "APIinstitute",
   "associatedBrandName": "Wisconsin Bank & Trust",
   "associatedBrandId": "b06dff1a-f378-5487-b403-ee5f17898d58",
   "externalUnderwriting": false,
   "schedulePaymentsForFuture": false,
   "invoiceUploadEnabled": true,
   "generateScheduledUserReportActive": true,
    "staticReport": {
       "enabled": true,
       "externalLinks": [
           {
               "label": "hello",
               "value": "https://uat.cpxchange.com/"
           }
       ]
   },
   "paymentFileTypes": [
           "id": "customfileID",
           "name": "nameOfCustomParser"

   ],
   "bankAccounts": [
       {
           "accountNumber": "12309747239923802",
           "routingNumber": "121000248",
           "accountType": "savings",
           "defaults": [
               "GOODFUNDS",
               "FEES",
               "REVENUE"
           ]
       }
   ],
   "debitMethod": "Manual",
   "achDelayDays": 0,
   "vcnHost": "falcons",
   "vcnHostConfig": {
       "falcons": {
           "products": [
               {
                   "type": "VCN",
                   "value": "6034",
                   "default": true
               },
               {
                   "type": "LDG",
                   "value": "6047",
                   "default": true
               }
           ],
           "location": "12337"
       },
       "braves": {
           "companyNumber": "99999",
           "billLevel": "buyer",
           "corpId": "NA"
       }, 
        "vpa": {
            "pp": {
                "default": true
            },
            "rva": {
                "default": false
            },
            "clientId": "B2BWS_4_9_4477"
        }

   },
   "automaticIdentityVerification": true,
   "companyNumber": "99999",
   "includeVcnInDisposition": true,
   "automaticVcnCardCreation": true,
   "suppressSIPEmail": true,
   "suppressStatement": true,
    "updateAllBuyers": false,
   "checkSettings": {
       "checkProcessorEnabled": true,
       "clientId": "234",
       "apiKey": "retyfgaschagcdhakjciuhdsyf236evascshggydhjc",
       "memoMappingEnabled": true,
       "memoMapping": "reference1",
       "isManagedCheck": true,
       "checkInsertEnabled": false 
      
   },
   "mri": {
       "clientId": "",
       "database": "",
       "username": "",
       "password": ""
   }, 
"plastiqPayEnabled" : true
}

Example Response

👍
HTTP Status: 201 Created
Content-Type → application/json
Response → < id > of Institution Created