Enterprise Solutions

Collection Add

Enterprise SOAP API > API by Reference > Core Services > Collection Add
<?xml version="1.0" encoding="UTF-8"?>Collection Add

Collection Add

Collection Add is a jXchange service designed to add collection account records.

Message Flow

In jXchange, the Collection Add service uses a typical exchange of MType messages to add collection records to support consumer integration with collection accounts.

Primary Request

The consumer forwards the ColAddRq_MType message to the service provider.

The message contains the following complex elements:

  • AccountId_CType
  • ColRec_CType
  • Custom_CType
  • MsgRqHdr_CType

The message contains the following arrays:

  • ErrOvrRdInfoArray_AType

Primary Response

The service provider returns the ColAddRs_MType message to the consumer.

The message contains the following simple elements:

  • RsStat

The message contains the following complex elements:

  • Custom_CType
  • MsgRsHdr_CType

Collection Add Behavior

Collection Add is a jXchange service designed to add collection account records.

The collection record is required, but all encapsulated elements are optional. Each provider must determine what is required for adding a collection record.

  • The standard Addition message tenants are applicable.
  • Adhere to the tenets related to the JHANull attribute.
  • Adhere to the tenets for fault reporting.
  • Adhere to the tenets related to the correlation identifications.

ColAddRq_MType

ColAddRq_MType is a message MType element.

Contains:

  • AccountId_CType
  • ColRec_CType
  • Custom_CType
  • ErrOvrRdInfoArray_AType
  • MsgRqHdr_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

ColRec_CType

ColRec_CType is a complex CType element.

Contains:

  • ColExpenseArray_AType
  • ColIncmArray_AType
  • Custom_CType
  • ImporMsgArray references Rmk_AType
  • SvcPrvdInfo references ColRec_EType

Simple Dictionary

ActnTakenCode
The action taken on a collection account.
ColAcctStat

Collection Account Status. This is a hybrid enumerated element with a preset list of values. Canonical values are:

  • ChgdOff
  • Manual
  • NonAccr
  • PastDue
  • PartChgOff
ColAddDt
The date an account was added to collections.
ColExpDt
The expiration date.
ColLtrCode
The code that represents the collection letter to be sent to the customer.
ColPromisedAmt
The collection amount promised on account.
ColPromisedDt
The date the collection amount was promised to be paid.
ColQueCode
The Collection Queue Code.
ConPartyCode
The Code that represents the party contacted for the collection account.
ConRsltCode
The code that represents the result of the contact regarding the collection account.
ExpenseLastUpdBy
A user name assigned to a person.
ExpenseLastUpdDt
The last day a record was updated.
IncmLastUpdBy
A user name assigned to a person.
IncmLastUpdDt
The last day a record was updated.
NxtWorkDt
The day an item was worked.
PrtLtrNowType

Print collection letter now? Canonical values are:

  • True
  • False
PrtNonPastDueType

Print collection letter if the account is not past due? Canonical values are:

  • True
  • False
RemInQueType

Should this remain in this queue? Canonical values are:

  • true
  • false
StayInColType

Should the account always stay in collections? Canonical values are:

  • True
  • False

ColExpenseArray_AType

ColExpenseArray_AType is an array AType element. This array is an array of responses for borrowers' expenses.

Contains:

  • ColExpenseInfo_CType
ColExpenseInfo_CType

ColExpenseInfo_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Dictionary
BorwType

The type of borrower. Canonical values are:

  • Borw
  • CoBorw
ExpenseAmt
The amount or quantity.
ExpenseName
Application or user remarks free-form text.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

ColIncmArray_AType

ColIncmArray_AType is an array AType element. This array is an array of responses for borrowers income.

Contains:

  • ColIncmInfo_CType
ColIncmInfo_CType

ColIncmInfo_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Dictionary
BorwType

The type of borrower. Canonical values are:

  • Borw
  • CoBorw
IncmAmt
The amount or quantity.
IncmName
Application or user remarks free-form text.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

ImporMsgArray

Rmk_AType is an array AType element.

ImporMsgArray references Rmk_AType.

Rmk_AType

Rmk_AType is an array AType element. This is an array of application or user remarks in free form text.

Contains:

  • RmkInfo_CType
RmkInfo_CType

RmkInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

Rmk
Application or user remarks free-form text.

SvcPrvdInfo

ColRec_EType is an extended EType element.

SvcPrvdInfo references ColRec_EType.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

ErrOvrRdInfoArray_AType

ErrOvrRdInfoArray_AType is an array AType element. This is an array of overrides for faults.

Contains:

  • ErrOvrRd_CType

ErrOvrRd_CType

ErrOvrRd_CType is a complex CType element. This element is used to override errors created in a previous request. This element is optional.

Simple Elements

The following simple elements are contained within this complex.

BusSvcType
The business service type used to convey certain Add and Mod message handling. The canonical value is NoValidate.
ErrCode
The error code.

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
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.

ColAddRs_MType

ColAddRs_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRsHdr_CType

Simple Dictionary

RsStat
The status of the response. Canonical values are:
  • Fail
  • Success

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
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.

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 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.
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 Tue Aug 8 2023