Create Institution

post

https://api.cpxenterprise.com/institution/v1/institution

Creates an institution based on the newInstitution Object passed into the payload. newInstitution is a complex object.

Body Params

string

name

string

required

A non-empty string or or string with no leading or trailing whitespace

address

object

A valid address

phone

string

A valid Phone Number

contacts

array of objects

contacts

cardRules

array of objects

cardRules

pifConfirmationEmail

string

A valid email address

deleted

boolean

disabled

boolean

vcnHost

string

enum

Host for getting the Virtual Card Number

Allowed:

vcnHostConfig

object

vcnHostConfig info

alertApi

object

A valid Alert Api

authApi

object

A valid Auth Api

bin

string

A valid Bin

companyNumber

string

A valid CompanyNumber

associatedNetworkId

string

required

A non-empty string or or string with no leading or trailing whitespace

associatedBrandId

string

An empty string or string with no leading or trailing whitespace

associatedBrandName

string

An empty string or string with no leading or trailing whitespace

fid

string

required

A valid FID

achDelayDays

int32

required

0 to 7

A valid delay day number

bankAccountNumber

string

A valid bank account number

bankRoutingNumber

string

A valid bank routing number

goodFunds

object

Good Funds Bank Account Information

fees

object

Fees Bank Account Id

revenue

object

Revenue Bank Account Id

bankAccounts

array of objects

bankAccounts

status

string

enum

required

Allowed:

externalStatus

string

enum

required

Allowed:

debitMethod

string

enum

Allowed:

associatedNetworkName

string

An empty string or string with no leading or trailing whitespace

suppressSIPEmail

boolean

includeVcnInDisposition

boolean

automaticIdentityVerification

boolean

automaticVcnCardCreation

boolean

paymentFileTypes

array of objects

paymentFileTypes

checkSettings

object

customPifMemoMappings

array of objects

customPifMemoMappings

paymentFileType

string

externalUnderwriting

boolean

generateScheduledUserReportActive

boolean

vcnValidDays

integer

staticReport

object

Responses

201

Success

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

defaultError