Hold Creation Request and Response - Tags in XML Format

Note: We recommend you to refer the Hold Creation Request in the XML Format and Hold Creation Response in the XML Format topics in parallel while understanding the below mentioned tags. This will help you to understand how the tags are nested in the XML format.

Before calling the C1-CreateHoldRequest business service through an inbound web service, you need to ensure that the hold creation request contains the following tags:

Tag Name	Tag Description	Mandatory (Yes or No)
C1-CreateHoldRequest	Used to indicate that you want to invoke the C1-CreateHoldRequest business service. Note: Here, the C1-CreateHoldRequest tag represents the operation in the inbound web service which is used to call the C1-CreateHoldRequest business service. This tag would change depending on the operation name specified in your SOAP or REST based inbound web service. For example, if you have set the operation name to CreateHoldRequest, then you need to specify the CreateHoldRequest tag instead of the C1-CreateHoldRequest tag in the hold creation request.	Yes
holdRequest	Used to specify the details of the hold request.	Yes
sourceSystem	Used to indicate the external system from where the hold creation request is received. Note: You must specify an external system which is already defined in the system. If the Inbound Web Service History feature is enabled, the system validates whether the specified external system matches the external system that is associated with the outbound message type specified in the C1-IWSHIST algorithm. If so, the system stamps the specified external system corresponding to the record in the C1_IWS_HIST table. If the external system is not specified in the hold creation request, the system, by default, stamps the external system associated with the outbound message type (specified in the C1-IWSHIST algorithm) corresponding to the record in the C1_IWS_HIST table. For more information, see Inbound Web Service History.	No
externalTransactionId	Used to indicate the transaction in the external system through which the hold creation request is received. Note: If the Inbound Web Service History feature is enabled, the system stores the external transaction ID corresponding to the record in the C1_IWS_HIST table.	No
externalSourceId	Used to specify the external source system ID. Note: If the Inbound Web Service History feature is enabled, the system stores the external source system ID corresponding to the record in the C1_IWS_HIST table.	No
holdStartDate	Used to specify the date from when the hold request is effective. Note: The hold request start date cannot be later than the hold request end date. You must specify the date in the YYYY-MM-DD format. Here, you can specify the current or any future date but not a past date.	Yes
holdEndDate	Used to specify the date till when the hold request is effective. Note: The hold request end date cannot be earlier than the hold request start date. You must specify the date in the YYYY-MM-DD format.	Yes (Conditional) Note: This data is required when the value is not specified in the holdDays tag.
holdDays	Used to indicate the number of days for which an entity should be kept on hold through the hold request. The system then calculates the hold request end date using the hold days (i.e., hold request end date = hold request start date + hold days). For example, if the hold request start date is 01-Jan-2025 and hold days is 20, then the system sets the hold request end date to 20-Jan-2025. Note: You must specify a positive integer value in this tag.	Yes (Conditional) Note: This data is required when the value is not specified in the holdEndDate tag.
holdRequestType	Used to indicate a hold request type using which you want to create the hold request. Note: You must specify a hold request type which is already defined in the system. It should be in the Active status. Also, ensure that the Activation Approval option is not selected in the specified hold request type. If you do not specify a hold request type, the system, by default, considers the hold request type specified in the Default Hold Request Type for IWS option type of the C1-HOLDSRCH feature configuration.	No
holdEntity	Used to indicate the type of entity for which you want to create the hold request. The valid values are: ACCT - Used when you want to create a hold request for an account. BILL - Used when you want to create a hold request for a bill. PERS - Used when you want to create a hold request for a person. Note: You must specify a value which is already defined in the HOLD_ENTITY_LVL_FLG lookup field. It must be in the Active status.	Yes
holdReason	Used to indicate the reason why you want to hold the entity. Note: You must specify a value which is already defined in the HOLD_REASON_FLG lookup field. It must be in the Active status.	Yes
holdComments	Used to specify additional information about the hold request.	No
entityIdentifierType	Used to specify the person or account identifier type. Note: You must specify a person or account identifier type which is already defined in the system. It should be a primary identifier type for the respective entity.	Yes (Conditional) Note: This data is required when: ACCT or PERS is specified in the holdEntity tag. The value is not specified in the entityId tag.
entityIdentifierValue	Used to specify the entity identifier (i.e., person or account identifier). It should be the primary identifier of the respective entity. Note: The system then derives the person or account ID using the given primary entity identifier details, and accordingly creates a hold request for the respective entity.	Yes (Conditional) Note: This data is required when: ACCT or PERS is specified in the holdEntity tag. The value is not specified in the entityId tag.
entityId	Used to specify the entity ID (i.e., person, account, or bill ID). Note: If you have specified the bill ID, the system checks whether a bill exists in the system with the given ID. If so, the system creates a hold request for the respective bill. However, if the system could not derive the bill using the bill ID, the system considers the given value as the alternate bill ID and then checks whether any bill exists in the system with the alternate bill ID. If so, the system creates a hold request for the respective bill. However, if the system could not derive the bill using the alternate bill ID, the system does not allow you to create a hold request.	Yes (Conditional) Note: This data is required when: ACCT or PERS is specified in the holdEntity tag and the values are not specified in the entityIdentifierType and entityIdentifierValue tags. BILL is specified in the holdEntity tag.
holdEntityEndDate	Used to specify the date till when you want to hold the entity. Note: You must specify the date in the YYYY-MM-DD format. The hold entity end date must be between hold request start and end dates and between at least one process's start and end dates. The hold entity end date cannot be earlier than the hold entity start date. Note that, by default, the system sets the hold entity start date to the hold request start date. If you do not specify the hold entity end date, the system, by default, sets it to the hold request end date.	No
hierarchySwitch	Used to indicate whether all the accounts in the person’s hierarchy or only the persons’ immediate accounts should be kept on hold. Note that the system considers only the child persons and not the grand child persons from the person’s hierarchy and then derives the accounts where the child person is the main customer. The valid values are: Y N Note: This tag is applicable only when PERS is specified in the holdEntity tag.	No
holdProcessData	Used to specify information about the process that you want to hold for the entity.	Yes
holdProcess	Used to specify the process that you want to keep on hold for the entity. The valid values are: ATPY - Used when you want to hold the auto pay process of the entity. It is valid only when ACCT is specified in the holdEntity tag. BILL - Used when you want to hold the bill generation process of the entity. It is valid only when ACCT or PERS is specified in the holdEntity tag. DELQ - Used when you want to hold the delinquency process of the entity. It is valid only when ACCT or PERS is specified in the holdEntity tag. FNDG - Used when you want to hold the funding process of the entity. It is valid when ACCT, PERS, or BILL is specified in the holdEntity tag. OVDU - Used when you want to hold the overdue process of the entity. It is valid only when ACCT is specified in the holdEntity tag. REFD - Used when you want to hold the refund process of the entity. It is valid only when ACCT is specified in the holdEntity tag. Note: You must specify a value which is already defined in the HOLD_PROCESS_FLG lookup field. It must be in the Active status. You cannot specify both the OVDU and DELQ processes at a time in the hold creation request. The Overdue process is valid for the financial services and health insurance domains but the Delinquency process is valid only for the health insurance domain.	Yes
holdProcessEndDate	Used to specify the date till when you want to hold the process of the entity. Note: You must specify the date in the YYYY-MM-DD format. The hold process end date must be between the hold request start and end dates. The hold process end date cannot be earlier than the hold process start date. Note that, by default, the system sets the hold process start date to the hold request start date. If you do not specify the hold process end date, the system, by default, sets it to the hold request end date.	No
characteristics	Used to specify a characteristic for the hold request.	No
characteristicType	Used to indicate the characteristic type. Note: You must specify a characteristic type where the characteristic entity is set to Hold Request.	Yes (Conditional) Note: This data is required while defining a characteristic for the hold request.
characteristicValue	Used to specify the value for the characteristic type.	Yes (Conditional) Note: This data is required while defining a characteristic for the hold request.
effectiveDate	Used to specify the date from when the characteristic is effective for the hold request.	Yes (Conditional) Note: This data is required while defining a characteristic for the hold request.

The following table lists and describes additional tags that are included in the hold creation response:

Tag Name	Tag Description
statusCd	Indicates whether the hold creation request is successfully processed or not. The valid values are: Success Failure
holdRequestId	Displays the hold request ID. Note: This tag appears when the value in the statusCd tag is set to Success.
holdStatus	Indicates the status of the hold request. The valid value is: Active Note: This tag appears when the value in the statusCd tag is set to Success.
messageText	Indicates the error that occurred while creating the hold request. Note: This tag appears when the value in the statusCd tag is set to Failure.

Related Topics

For more information on...	See...
Sample Hold Creation Request and Response in the XML Format	Sample Hold Creation Request and Response in the XML Format