Sample Hold Request Creation Request and Response in the XML Format

Using the below example, you can create a hold request for an account entity where the bill generation and auto pay process are kept on hold.

Sample Hold Request Creation Request in the XML Format

<C1-CreateHoldRequest>
    <holdRequest>
        <sourceSystem>SMALL_PRIME</sourceSystem>
        <externalTransactionId>567888876666</externalTransactionId>
        <externalSourceId>656565</externalSourceId>
        <holdStartDate>2021-12-01</holdStartDate>
        <holdEndDate>2021-12-31</holdEndDate>
        <holdDays>31</holdDays>
        <holdRequestType>HOLD_WITHOUT_APPROVAL</holdRequestType>
        <holdEntity>ACCT</holdEntity>
        <holdReason>4</holdReason>
        <holdComments>DUE_TO_TORNADO</holdComments>
        <entityIdentifierType>EIN</entityIdentifierType>
        <entityIdentifierValue>1446QIA</entityIdentifierValue>
        <entityId>1144444710</entityId>
        <holdEntityEndDate>2021-12-30</holdEntityEndDate>
        <hierarchySwitch>N</hierarchySwitch>
        <holdProcessData>
            <holdProcess>BILL</holdProcess>
            <holdProcessEndDate>2021-12-20</holdProcessEndDate>
        </holdProcessData>
        <holdProcessData>
            <holdProcess>ATPY</holdProcess>
            <holdProcessEndDate>2021-12-20</holdProcessEndDate>
        </holdProcessData>
        <characteristics>
            <characteristicType>ZZ_HLRQ</characteristicType>
            <characteristicValue>1</characteristicValue>
            <effectiveDate>2021-12-01</effectiveDate>
        </characteristics>
        <characteristics>
            <characteristicType>ZZ_HLDCH</characteristicType>
            <characteristicValue>5</characteristicValue>
            <effectiveDate>2021-12-01</effectiveDate>
        </characteristics>
    </holdRequest>
</C1-CreateHoldRequest>

Sample Hold Request Creation Response in the XML Format

The following information is received as response when the hold request is created successfully.

<C1-CreateHoldRequest>
    <holdRequest>
        <statusCd>SUCCESS</statusCd>
        <holdRequestId>790420762398</holdRequestId>
        <holdStatus>ACTIVE</holdStatus>
        <messageText></messageText>
        <sourceSystem>SMALL_PRIME</sourceSystem>
        <externalTransactionId>567888876666</externalTransactionId>
        <externalSourceId>656565</externalSourceId>
        <holdStartDate>2021-12-01</holdStartDate>
        <holdEndDate>2021-12-31</holdEndDate>
        <holdDays>31</holdDays>
        <holdRequestType>HOLD_WITHOUT_APPROVAL</holdRequestType>
        <holdEntity>ACCT</holdEntity>
        <holdReason>4</holdReason>
        <holdComments>DUE_TO_TORNADO</holdComments>
        <entityIdentifierType>EIN</entityIdentifierType>
        <entityIdentifierValue>1446RAI</entityIdentifierValue>
        <entityId>1144444710</entityId>
        <holdEntityEndDate>2021-12-30</holdEntityEndDate>
        <hierarchySwitch>N</hierarchySwitch>
        <holdProcessData>
            <holdProcess>BILL</holdProcess>
            <holdProcessEndDate>2021-12-20</holdProcessEndDate>
        </holdProcessData>
        <holdProcessData>
            <holdProcess>ATPY</holdProcess>
            <holdProcessEndDate>2021-12-20</holdProcessEndDate>
        </holdProcessData>
        <characteristics>
            <characteristicType>ZZ_HLRQ</characteristicType>
            <characteristicValue>10</characteristicValue>
            <effectiveDate>2021-12-01</effectiveDate>
        </characteristics>
        <characteristics>
            <characteristicType>ZZ_HLDCH</characteristicType>
            <characteristicValue>55</characteristicValue>
            <effectiveDate>2021-12-01</effectiveDate>
        </characteristics>
    </holdRequest>
</C1-CreateAdjustment>

The following information is received when the hold request creation responds with a failure.

<C1-CreateHoldRequest>
    <holdRequest>
        <statusCd>FAILURE</statusCd>
        <holdRequestId>590525732377</holdRequestId>
        <holdStatus>ACTIVE</holdStatus>
        <messageText>The system could not retrieve the Account Id
        using the Account Identifier Type and Value combination.
        </messageText>
        <sourceSystem>ZZ_PRIME_SS</sourceSystem>
        <externalTransactionId>567888875445</externalTransactionId>
        <externalSourceId>256525</externalSourceId>
        <holdStartDate>2021-12-01</holdStartDate>
        <holdEndDate>2021-12-31</holdEndDate>
        <holdDays>31</holdDays>
        <holdRequestType>HOLD_WITHOUT_APPROVAL</holdRequestType>
        <holdEntity>ACCT</holdEntity>
        <holdReason>3</holdReason>
        <holdComments>FLOODS_IN_FL</holdComments>
        <entityIdentifierType>EIN</entityIdentifierType>
        <entityIdentifierValue>2345VB</entityIdentifierValue>
        <entityId>2344444730</entityId>
        <holdEntityEndDate>2021-12-30</holdEntityEndDate>
        <hierarchySwitch>N</hierarchySwitch>
        <holdProcessData>
            <holdProcess>BILL</holdProcess>
            <holdProcessEndDate>2021-12-20</holdProcessEndDate>
        </holdProcessData>
        <holdProcessData>
            <holdProcess>ATPY</holdProcess>
            <holdProcessEndDate>2021-12-20</holdProcessEndDate>
        </holdProcessData>
        <characteristics>
            <characteristicType>ZZ_CHR_HLRQ</characteristicType>
            <characteristicValue>1001</characteristicValue>
            <effectiveDate>2021-12-01</effectiveDate>
        </characteristics>
        <characteristics>
            <characteristicType>ZZ_CHR_HLRQ</characteristicType>
            <characteristicValue>7003</characteristicValue>
            <effectiveDate>2021-12-01</effectiveDate>
        </characteristics>
    </holdRequest>
</C1-CreateAdjustment>

Note: We have given the above request and response samples to illustrate how the tags should be nested while sending a hold creation request from the external system. However, you should not seamlessly use this request sample in your environment because the required pre-requisite data may not be available in your environment. In such case, the system will give erroneous results.

Related Topics

For more information on...	See...
Hold Request Creation Request and Response - Tags in XML Format	Hold Request Creation Request and Response - Tags in XML Format