Developer Programs
Vendor Integration Program (VIP)
Direct access to Jack Henry's technical integration resources.
Technical Account Manager (TAM)
Get technical integration help from a single point of contact.
Learn
Shared Responsibility
Learn about shared roles and responsibilities of customers and Jack Henry in open banking.
Developer Use Cases
Find a use case that fits your development needs.
Developer Video Gallery
Watch the latest demos, webinars, and more.
Developer Conference
Connect with industry leaders, gain insights from expert speakers, and explore our latest innovations.
Docs
Admin API
Create solutions for an institution's back office support tools.
Authentication Framework
Map customer identities to your existing system IDs.
Consumer API
Access financial data for user accounts, transactions, and more.
Data Broker
Get deeper access to financial institution data.
Enterprise Event System
Respond to events in real-time using this powerful pub/sub-based solution.
jXchange - REST API
Translate business information between Jack Henry and third-party applications using a REST-based API.
jXchange - SOAP API
Translate business information between Jack Henry and third-party applications using a SOAP-based API.
Operational Data Integration (ODI)
Get customized queries for bulk data needs.
Payments
Embed check deposits, ACH, bill pay, cards, and real-time payments.
Plugin Framework
Embed the best of the fintech world directly into your user's dashboard.
SymXchange
Query Symitar core member accounts, post transactions, run PowerOn scripts, and more.
Xperience
Modern UI that provides consistent visual integration across Jack Henry products.
Important notification about upcoming changes to the DMZ environment. Please read.
More info

Platform Product Inquiry

Enterprise SOAP API > API by Reference > Platform Services > Platform Product Inquiry

Platform Product Inquiry

Platform Product Inquiry is a jXchange service designed to allow the consumer product to obtain information related to a platform product via jXchange messaging.

Message Flow

In jXchange, the Platform Product Inquiry service uses a typical exchange of MType messages to allow the consumer product to obtain information related to a platform product via jXchange messaging.

Primary Request

The third-party consumer forwards the PltfmProdInqRq_MType message to the service provider. The message contains the following simple elements:

  • ActIntent
  • BrCode
  • PltfmProdCode
  • PltfmClsfPrimType
  • RegionCode
  • TaxFavProdType

Primary Response

The service provider returns the PltfmProdInqRs_MType message to the third-party consumer. The message contains the following simple elements:

  • ActIntent
  • ActIntentKey
  • BrCode
  • PltfmProdCode
  • PltfmClsfPrimType
  • RegionCode
  • TaxFavProdType

Platform Product Inquiry Behavior

Platform Product Inquiry requires the platform product code be supplied. Then, based on the provider's key requirements, optional elements are provided to allow for selection of a specific platform product offering.

PltfmProdInqRq_MType

PltfmProdInqRq_MType is a message MType element.

Contains:

  • Custom_CType
  • IncXtendElem_AType
  • MsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

ActIntent
Conveys the consumer intention for a subsequent operation for the data set included in the response. Canonical values are:
  • Dlt
  • ReadOnly
  • Upd

The default value is ReadOnly.

BrCode
The branch code.
PltfmClsfPrimType
Elements that further identify the type of loan or deposit products being searched for. For example, if Loan is selected for PltfmAcctTypeCode, then this field could be populated with Mortgage,Auto,Commercial,Ag,Equipment. For example, if Deposit is selected as PltfmAcctTypeCode, then this field could be populated with Checking,Money Market,Savings,CD.
PltfmProdCode
The code that identifies a product type of account within an application.
RegionCode
The code that identifies a financial institution's region that would encompass a group of branches.
TaxFavProdType
Whether the product represents a tax favored product type. Canonical values are:
  • true
  • false

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

IncXtendElemArray_AType

IncXtendElemArray_AType is an array AType element.

Contains:

  • IncXtendElemInfo_CType
IncXtendElemInfo_CType

IncXtendElemInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

XtendElem
Included extended elements. The consumer would ask by name for x_ prefix elements to be included in the response.

MsgRqHdr_CType

MsgRqHdr_CType is a complex CType element. This is the default message request header.

Contains:

  • AuthenUsrCred_CType
  • jXchangeHdr_CType
Simple Elements

The following simple elements are contained within this complex.

AuthenProdCred
Authentication of the Consumer Product Credentials in the form of a WS Security element that contains a single SAML V2.0 Assertion.
AuthenUsrCred_CType

AuthenUsrCred_CType is a complex CType element. This element represents authentication of the end-user credentials in the form of a WS Security element that contains a single SAML V2.0 Assertion.

Simple Elements

The following simple elements are contained within this complex.

Security
Defines the wsse:Security SOAP header element per section 4.
jXchangeHdr_CType

jXchangeHdr_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AuditUsrId
The user ID that the consumer would like written in the audit as performing the requested service. It varies, but it could be the same as the user ID. It is not used to authenticate. It is used to audit the Soap Header Fault.
AuditWsId
The workstation ID that the consumer would like written in the audit as performing the requested service for the Soap Header Fault. It varies, but it could be the same as the user ID.
AuthenUsrId
The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

BusCorrelId
The correlation identification as related to business functions and activities.
ConsumerName
The name of the service consumer (business name) for the Soap Header Fault.
ConsumerProd
The name of the product which is consuming the service (business product name) for the Soap Header Fault.
InstEnv
An identification provided by the consumer that defines the environment in which the institution is operating. Canonical values are:
  • Prod
InstRtId
The identification of the entity of the submitted message. A financial institution entity uses the routing transit or nine-digit number assigned to financial institutions for routing as assigned by the American Bankers Association. Any leading zeros must be provided for a complete routing and transit number. A non-financial institution entity should use a mutually agreed upon identification that must contain at least one non-integer character. The canonical value is JHA.

The element is required in all message requests.

jXLogTrackingId
An identification provided by jXchange to be able to trace the request and response of a message from the third-party gateway, internal gateway, and service provider for the Soap Header Fault.
JxVer
Contains the version jXchange is running for the Soap Header Fault.
ValidConsmName
The consumer name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table. The canonical value is: JHA.
ValidConsmProd
The consumer product name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table.
WorkflowCorrelId
The correlation identification as related to workflow functions and activities.
jXchangeHdr_CType Deprecation Details
AuthenUserId
This element deprecates in three years in accordance with XSD contract tenets. Effective date: 2012–01–01. The new complex element for user authentication credentials was added to the Search Message Request Header, SrchMsgRqHdr_CType, and the Message Request Header, MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

PltfmProdInqRs_MType

PltfmProdInqRs_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRsHdr_CType
  • PltfmProdInqRec_CType
  • x_ImgItemsArray_AType
  • x_ListItemsArray_AType
  • x_TextItemsArray_AType
  • x_WebPgArray_AType

Simple Elements

The following simple elements are contained within this message.

ActIntent
Conveys the consumer intention for a subsequent operation for the data set included in the response. Canonical values are:
  • Dlt
  • ReadOnly
  • Upd

The default value is ReadOnly.

ActIntentKey
The service provider key that is delivered to the consumer to be submitted in a subsequent modification operation.
BrCode
The branch code.
PltfmClsfPrimType
Elements that further identify the type of loan or deposit products being searched for. For example, if Loan is selected for PltfmAcctTypeCode, then this field could be populated with Mortgage,Auto,Commercial,Ag,Equipment. For example, if Deposit is selected as PltfmAcctTypeCode, then this field could be populated with Checking,Money Market,Savings,CD.
PltfmProdCode
The code that identifies a product type of account within an application.
RegionCode
The code that identifies a financial institution's region that would encompass a group of branches.
TaxFavProdType
Whether the product represents a tax favored product type. Canonical values are:
  • true
  • false

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

MsgRsHdr_CType

MsgRsHdr_CType is a complex CType element. This is the default message response header.

Contains:

  • jXchangeHdr_CType
  • MsgRecInfoArray_AType
jXchangeHdr_CType

jXchangeHdr_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AuditUsrId
The user ID that the consumer would like written in the audit as performing the requested service. It varies, but it could be the same as the user ID. It is not used to authenticate. It is used to audit the Soap Header Fault.
AuditWsId
The workstation ID that the consumer would like written in the audit as performing the requested service for the Soap Header Fault. It varies, but it could be the same as the user ID.
AuthenUsrId
The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

BusCorrelId
The correlation identification as related to business functions and activities.
ConsumerName
The name of the service consumer (business name) for the Soap Header Fault.
ConsumerProd
The name of the product which is consuming the service (business product name) for the Soap Header Fault.
InstEnv
An identification provided by the consumer that defines the environment in which the institution is operating. Canonical values are:
  • Prod
InstRtId
The identification of the entity of the submitted message. A financial institution entity uses the routing transit or nine-digit number assigned to financial institutions for routing as assigned by the American Bankers Association. Any leading zeros must be provided for a complete routing and transit number. A non-financial institution entity should use a mutually agreed upon identification that must contain at least one non-integer character. The canonical value is JHA.

The element is required in all message requests.

jXLogTrackingId
An identification provided by jXchange to be able to trace the request and response of a message from the third-party gateway, internal gateway, and service provider for the Soap Header Fault.
JxVer
Contains the version jXchange is running for the Soap Header Fault.
ValidConsmName
The consumer name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table. The canonical value is: JHA.
ValidConsmProd
The consumer product name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table.
WorkflowCorrelId
The correlation identification as related to workflow functions and activities.
jXchangeHdr_CType Deprecation Details
AuthenUserId
This element deprecates in three years in accordance with XSD contract tenets. Effective date: 2012–01–01. The new complex element for user authentication credentials was added to the Search Message Request Header, SrchMsgRqHdr_CType, and the Message Request Header, MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.
MsgRecInfoArray_AType

MsgRecInfoArray_AType is an array AType element. This is an array of messages that can be returned in a response.

Contains:

  • MsgRec_CType
MsgRec_CType

MsgRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

ErrCat
The Soap Header Fault error category.
ErrCode
The Soap Header Fault error code.
ErrDesc
The Soap Header Fault error description.
ErrElem
The Soap Header Fault when an error or fault occurs. This optional element contains the element which is causing the error condition.
ErrElemVal
The Soap Header Fault when an error or fault occurs. This optional element contains the value of the element which is causing the error condition.
ErrLoc
The Soap Header Fault error location. This is typically the program that generated the error condition.

PltfmProdInqRec_CType

PltfmProdInqRec_CType is a complex CType element.

Contains:

  • PltfmProdInfoRec_CType
Simple Elements

The following simple elements are contained within this complex.

BrDesc
A description of the branch name. It includes the Rstr attribute.
CustProfDesc
The description of the code related to the profitability of a customer.
IntBasisDesc
The interest base description.
PltfmCatDesc
Platform Category Description - A long description of the PltfmCatCode.
PltfmProdDesc
Description of the type of account.
ProdCompareDesc
Description of the type of account.
RegionDesc
The description of the code that identifies a financial institution's region that would encompass a group of branches.
PltfmProdInfoRec_CType

PltfmProdInfoRec_CType is a complex CType element.

Contains:

  • CrossSellProdArray_AType
  • DepItems_CType
  • DiscArray_AType
  • FeeArray_AType
  • LnItems_CType
  • PltfmAcctTypeInfo_CType
  • ProdTermArray_AType
  • ProdSvcOptArray_AType
  • ProdCompareArray_AType
  • RateTypeArray_AType
  • SafeBoxItems_CType
  • TimeDepItems_CType
Simple Elements

The following simple elements are contained within this complex.

BrCode
The branch code.
CustProfCode
The code related to the profitability of a customer.
DestProdCode
The code that identifies a product type of account within an application.
InitIntRate
The initial interest rate.
InitIntRateTerm
The interest term.
InitIntRateTermUnits
Interest term units canonical values are:
  • Days
  • Months
  • NA
  • SemiMonthly
  • Years
IntBasis
The interest base method used for the loan. Canonical values are:
  • AddOn
  • Amrtz
  • Act/360
  • Act/365
  • 30/360
  • 360/360
IntTerm
The interest term.
IntTermUnits
Interest term units canonical values are:
  • Days
  • Months
  • NA
  • SemiMonthly
  • Years
MaxIntRate
The maximum interest rate.
MinIntRate
The minimum interest rate.
MktgMsg
Displays messages that have been entered about a customer.
PltfmAcctType
The platform account type.
PltfmCatCode
The code that describes a grouping of products being offered. May be promotional or marketing related.
ProdCompareCode
The code that identifies a product type of account within an application.
PltfmCustType
Identifies the type of customer. Canonical values are:
  • Bus
  • Indv
ProdEffDt
The date assigned to transactions when it is different from the posting date.
ProdExpDt
The expiration date.
PltfmProdCode
The code that identifies a product type of account within an application.
PltfmProdImg
The primary image associated with the platform product.
PltfmProdImgFormatType
Identifies the type of file that contains the Platform Product image. Canonical values include:
  • JPG
  • TIFF
  • GIF
  • PNG
  • BMP
PrstHTML
An HTML formatted platform product presentation that can be used by consumers to display a web page. This element requires CDATA markup due to the possibility of HTML formatting containing invalid characters.
RegionCode
The code that identifies a financial institution's region that would encompass a group of branches.
RegionDesc
The description of the code that identifies a financial institution's region that would encompass a group of branches.
CrossSellProdArray_AType

CrossSellProdArray_AType is an array AType element. This is an array of platform companion products.

Contains:

  • CrossSellProdInfoRec_CType
CrossSellProdInfoRec_CType

CrossSellProdInfoRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

PltfmClsfPrimType
Elements that further identify the type of loan or deposit products being searched for. For example, if Loan is selected for PltfmAcctTypeCode, then this field could be populated with Mortgage,Auto,Commercial,Ag,Equipment. For example, if Deposit is selected as PltfmAcctTypeCode, then this field could be populated with Checking,Money Market,Savings,CD.
PltfmProdCode
The code that identifies a product type of account within an application.
PltfmProdDesc
Description of the type of account.
DepItems_CType

DepItems_CType is a complex CType element.

Contains:

  • ItemTruncArray_AType
Simple Elements

The following simple elements are contained within this complex.

MinAmt
The amount or quantity.
ItemTruncArray_AType

ItemTruncArray_AType is an array AType element. This is an array of transaction options available for the product.

Contains:

  • ItemTruncInfoRec_CType
ItemTruncInfoRec_CType

ItemTruncInfoRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

ItmTrunc
Item truncation/safekeeping with canonical values of:
  • Img
  • ImgAndTrunc
  • NA
  • NoTrunc
  • Trunc
DiscArray_AType

DiscArray_AType is an array AType element. This is an array of discounts available for the product.

Contains:

  • DiscInfoRec_CType
DiscInfoRec_CType

DiscInfoRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

DiscPct
The discount percentage.
DiscType
The discount type. Canonical values are:
  • Dep
  • Emp
  • AutoPmt
FeeArray_AType

FeeArray_AType is an array AType element. This is an array of fees.

Contains:

  • Fee_CType
Fee_CType

Fee_CType is a complex CType element.

Contains:

  • AccountId_CType
AccountId_CType

AccountId_CType is a complex CType element. This element contains the incoming account identification information and any restrictions.

Simple Elements

The following simple elements are contained within this complex.

AcctId
The number or character that identifies an account record.
AcctType
The number or character that categorizes the AcctId.
Rstr
The level of restrictions that can exist at a parent and/or child node. Canonical values are:
  • Hid
  • NoAccess
  • NoAccessPart
  • ReadOnly
  • ReadOnlyPart
  • ReadWrite
  • ReadWritePart
LnItems_CType

LnItems_CType is a complex CType element.

Contains:

  • CollatArray_AType
  • LnRegArray_AType
  • LnTraitArray_AType
  • PmtCodeArray_AType
  • PurposeArray_AType
Simple Elements

The following simple elements are contained within this complex.

AlwRateLockType
Allow Interest Rate locking for the loan product. Canonical values are:
  • true
  • false
LifetimeCapRate
The life time cap for a loan's rate.
LnCapBasisType
Defines the index/rate referenced when setting the Loan Rate Cap. Canonical values are:
  • Mkt
  • Initial
MaxAmt
The amount or quantity.
MinAmt
The amount or quantity.
PeriodCapBasisType
Defines how often the period cap is referenced. Canonical values are:
  • Ann
  • PerAdj
PeriodCapDown
The rate cap downward. The maximum downward change in the rate allowed during any rate cap term.
PeriodCapUp
The rate cap upward. The maximum upward change in the rate allowed during any rate cap term.
PmtRoundMthd
The payment rounding method for rounding newly calculated values.
PmtRoundToPct
The increment to round newly calculated payments.
RateChgDayOfMonth
Identifies the day of the month on which a rate change can occur.
RateCeil
The rate ceiling entry that sets a top rate above which the rate of the loan never rises.
RateFlr
The rate floor entry that sets a base rate below which the rate of the loan never falls.
RateRoundMthd
Rate rounding method. Method to round newly calculated rates.
RateRoundToPct
The rate rounded to percentage. Increment to round newly calculated rates.
CollatArray_AType

CollatArray_AType is an array AType element. This is an array of items that can be used to collateralize a loan.

Contains:

  • CollatInfo_CType
CollatInfo_CType

CollatInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

CollatCode
The collateral code. This code is bank-defined and is used to define the type of collateral used to secure the loan.
CollatDesc
The collateral code description.
LnRegArray_AType

LnRegArray_AType is an array AType element. This is an array of state or federal loan legislation or regulations related to the product.

Contains:

  • LnRegInfoRec_CType
LnRegInfoRec_CType

LnItems_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

LnRegCode
The code that describes the state or federal legislation/regulation that pertains to the loan product.
LnRegDesc
The description of the code that describes the state or federal legislation/regulation that pertains to the loan product.
LnRegStateCode
The 2 alpha long code which represents a state. For example, MO.
LnTraitArray_AType

LnTraitArray_AType is an array AType element. This is an array describing the characteristics that help define a loan product.

Contains:

  • LnTraitInfo_CType
LnTraitInfo_CType

LnTraitInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

LnTraitType
Elements describing the multitude of characteristics that help define a loan product. Canonical values are:
  • ARM
  • ARMConv
  • AutoPayOffer
  • ConstOnly
  • ConstPerm
  • CrBur
  • CrIns
  • Direct
  • Escrw
  • HELOC
  • IntitialRateOffer
  • PPOddDayInt
  • RE
  • Revol
  • RiskMgmt
PmtCodeArray_AType

PmtCodeArray_AType is an array AType element. This is an array of codes and descriptions that relate to the behavior for posting payments to the product.

Contains:

  • PmtCodeInfo_CType
PmtCodeInfoRec_CType

PmtCodeInfoRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

PmtCode
The payment code. The payment code determines how the payment is applied to the loan.
PmtCodeDesc
The payment code description.
PurposeArray_AType

PurposeArray_AType is an AType element. This is an array of items identifying the purpose of a loan.

Contains:

  • PurposeInfo_CType
PurposeInfo_CType

PurposeInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

PurpCode
Bank-defined and is used to define the purpose of the loan.
PurpDesc
The purpose code description.
PltfmAcctTypeInfo_CType

PltfmAcctTypeInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

PltfmAcctTypeCode
Types of platform products offered. Canonical values are:
  • Deposit
  • Loan
PltfmClsfPrimType
Elements that further identify the type of loan or deposit products being searched for. For example, if Loan is selected for PltfmAcctTypeCode, then this field could be populated with Mortgage,Auto,Commercial,Ag,Equipment. For example, if Deposit is selected as PltfmAcctTypeCode, then this field could be populated with Checking,Money Market,Savings,CD.
PltfmClsfSecdType
Elements that further identify the type of Loan or Deposit instrument being searched for. For example, if Loan is selected for PltfmAcctTypeCode, then this field could be populated with Secured,Unsecured. For example, if Deposit is selected for PltfmAcctTypeCode, then this field could be populated with Interest Bearing,Non Interest Bearing.
ProdCompareArray_AType

ProdCompareArray_AType is an array AType element. This is an array of platform comparison products.

Contains:

  • ProdCompareInfoRec_CType
ProdCompareInfoRec_CType

ProdCompareInfoRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

PltfmClsfPrimType
Elements that further identify the type of loan or deposit products being searched for. For example, if Loan is selected for PltfmAcctTypeCode, then this field could be populated with Mortgage,Auto,Commercial,Ag,Equipment. For example, if Deposit is selected as PltfmAcctTypeCode, then this field could be populated with Checking,Money Market,Savings,CD.
ProdCompareCode
The code that identifies a product type of account within an application.
ProdCompareDesc
Description of the type of account.
ProdSvcOptArray_AType

ProdSvcOptArray_AType is an array AType element. This is an array of service options available for the product.

Contains:

  • ProdSvcOptInfo_CType
ProdSvcOptInfo_CType

ProdSvcOptInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

ProdSvcOptCode
Service options available for the product offered.
ProdSvcOptDesc
Descriptions of the service options available for the product.
ProdTermArray_AType

ProdTermArray_AType is an array AType element. This is an array of product terms.

Contains:

  • ProdTermInfo_CType
ProdTermInfo_CType

ProdTermInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

ProdTermCnt
The integer length of the term.
ProdTermType
The description of the product term. Canonical values are:
  • Ceil
  • Flr
ProdTermUnits
The term units: years, months, days, indefinite. Canonical values are:
  • Days
  • Indefinite
  • Months
  • NA
  • SemiMonthly
  • Years
RateTypeArray_AType

RateTypeArray_AType is an array AType element. This is an array of rate types.

Contains:

  • RateTypeInfo_CType
RateTypeInfo_CType

RateTypeInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

RateType
Types of interest rates. Canonical values are:
  • Adj
  • Fix
  • Renew
  • Vrbl
Note: The canonical values Adj, Fix, and Vrbl are supported for this service.
SafeBoxItems_CType

SafeBoxItems_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

KeyDepAmt
The key deposit amount.
TimeDepItems_CType

TimeDepItems_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

MinAmt
The amount or quantity.
PlnType
Tax plan types as approved by the IRS. Canonical values are:
  • EDU=Educational IRA
  • HSA=Health Savings
  • IRA=Regular IRA
  • MSA=Medical Savings
  • QRP=Keogh
  • RCV=ROTH Conversion
  • RTH=ROTH Retirement
  • SEP=Simplified Employer Plan
  • SIM=Simple Retirement
Have a Question?
Have a how-to question? Seeing a weird error? Get help on StackOverflow.
Register for the Digital Toolkit Meetup where we answer technical Q&A from the audience.
Last updated Mon Jan 24 2022