Add account

post

https://dev.meshtech.io/core/accounts

This API endpoint creates a new Bank or Credit Union account. The API requires certain information to be submitted in the request body, such as the product name and other relevant details. Upon successful creation, the API returns the newly created account ID.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

accountNumber

string

Account number provied to the core.

accountSubTypeCode

string

Account subtype code, this is typically setup in the core per FI

accountType

string

enum

Type of account

additionalEscrowBalance

double

Additional Escrow balance of loan. For LOAN account type.

appraisedValue

double

Appraised Value used to calculate Loan-to-Value ratio for monitoring LTV lending exceptions. MUST enter leading zeros.

apyCalculationType

string

enum

Recurrency type to calculate annual percentage yield. For CD account type.

balloonLoanDueDate

string

Due date for balloon loan

billingAccount

object

Information related to billing of loan. For LOAN account type.

billingStatementCode

string

Used to establish the billing buckets for tracking past due amount.

billingStatementDate

string

Date of the first Billing Statement.

blockAdvancesCode

string

Identifies the status for automatically blocking Advances.

branchCode

string

Bank-defined code that indicates the primary bank location that handles the customer’s business

censusTractCode

double

Census Tract Number assigned by the U.S. Census Bureau to identify geographic entities

collateral

array of objects

Collateral object codes.

collateral

committedLiability

double

Total amount of committed liability for this loan.

controlCategoryCode

string

Purpose control category code

craAnnualSalesAmount

double

Annual Sales amount on the Note expressed in thousands of dollars, up to 999,998,000

craCountyCode

string

Community Reinvestment Act County Code

craStateCode

string

Community Reinvestment Act State Code

currentRiskCode

string

This two position code is used to rate the amount of risk associated with this note and the grade.

customerId

string

required

Customer identifier for the account holder.

customerRelationships

array of objects

The customer relationships for the loan.

customerRelationships

dayOfMonth

string

Day of the month payment is made. For LOAN account type.

debtCoverageRatio

double

Measures the ability to pay the monthly mortgage payments and expenses on the property from the rental income.

deferredFees

double

Deferred fee amount. For LOAN account type.

description

string

Description of the account.

emailStatementCode

string

Used to indicate the customer preference for the delivery of note level notices.

escrowBalance

double

Escrow balance of loan. For LOAN account type.

fasbCost

double

Sum of incremental direct originating costs as described by FASB Statement 91.

fasbFee

double

Sum of non-refundable originating fees as described by FASB Statement 91

financeFees

double

Finance fee amount. For LOAN account type.

firstPaymentDate

string

First payment date for the account.

floodZone

string

Used to indicate if the property is in a designated flood zone.

floodZoneMap

string

12 position A/N field can be used to indicate the actual flood zone location.

hmdaCode

string

Used to identify loans that are subject to Home Mortgage Disclosure Act (HMDA) reporting.

interestAccrualMethod

string

enum

Method of interest accrual. For LOAN, CD and SAVINGS account types.

interestBeginDate

string

Start date for interest

interestPaymentFrequency

string

enum

Frequency of interest payments. Required for CD account type.

Allowed:

interestPaymentInterval

string

Recurrence interval between two successive occurrences of statement generation. For LOAN and SAVINGS account types.

interestPaymentRecurrence

string

enum

Recurrence type indicates the pattern of recurrence. For LOAN and SAVINGS account types.

interestRate

double

Current interest rate for the account. For LOAN and CD account types.

internalGeneralLedgerCode

string

Internal general ledger code.

lateChargeCode

string

The Late Charge Code identifies which of the routines is used for this loan.

loanNumber

double

Loan number provided for the new account.

loanOfficer

string

Officer code or initials of the bank's primary officer responsible for originating or servicing the loan.

loanPurposeCode

string

Used to track the purpose of the loan.

loanTerm

double

Term of loan in months. For LOAN account type.

marginAboveBelowBaseRate

double

New Rate is calculated by adding or subtracting this margin from the rate assigned to the Rate Control Code.

marginSign

string

Controls the sign for the Margin Above Below Base.

maturityDate

string

Date of maturity. For CD, LOAN account type

msaCode

string

Metropolitan Statistical Area Code (MSA)

naicsCode

string

North American Industry Classification Code

nextInterestPaymentDate

string

Date of next interest payment. Required for CD account type.

nextPaymentAmount

double

Amount of next payment. For LOAN account type.

nickname

string

Name of the account given by the user.

noticeDeliveryCode

string

Code determines the type of notice delivery, print, email, etc.

occurrences

double

Payment occurrences. For LOAN account type.

openingDayBalance

double

Day's opening fund balance.

originalPrincipal

double

Original principal of loan. For LOAN account type.

originatingDate

string

Loan origination date. For LOAN account type.

originationFees

array of objects

Origination fee amount. For LOAN account type.

originationFees

paymentCalculationType

string

Payment calculation type for hte loan.

paymentFrequency

string

enum

Indicates the pattern of recurrence for payments. For LOAN account type.

Allowed:

prepaidFees

double

Prepaid fee amount. For LOAN account type.

printStatementCode

boolean

Boolean to determine if the statement should be printed.

productName

string

enum

required

Product name for this account.

rateChangeFactors

array of objects

Details of frequency for interest rate adjustment. For SAVINGS account type.

rateChangeFactors

reportingCode

string

Reporing code for the new loan account.

serviceChargeCode

string

Identifies the service charge routine to use.

statementCycle

string

Required codes to determine how to process statements for accounts.

statementPrintCode

string

Statement print control. Used to indicate the customer preference for statement delivery.

term

double

Number of occurrences with respect to the specified unit value. For CD, LOAN account types.

termUnits

string

Units to define the term of the account. For CD, LOAN account types.

timesRenewed

double

Number of times renewed

totalNumberOfPayments

double

Total number of payments. For LOAN account type.

undisbursedCreditLineCode

string

Determines whether the note is a revolving or non-revolving commitment loan.

userDefinedFields

array of strings

User defined fields for the loan.

userDefinedFields

Headers

X-Mesh-Api-Version

string

Responses

201Created

400Bad Request

401Authentication to 3rd party failed

403You do not have permission to access the requested resource

409Conflict

422Unprocessable Entity

500Internal Server Error