Sample Hold Creation Request and Response in the XML Format

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

Sample Hold Creation Request in the XML Format

<C1-CreateHoldRequest>
    <holdRequest>
        <sourceSystem>SMALL_PRIME</sourceSystem>
        <externalTransactionId>567888876666</externalTransactionId>
        <externalSourceId>656565</externalSourceId>
        <holdStartDate>2024-12-01</holdStartDate>
        <holdEndDate>2024-12-31</holdEndDate>
        <holdDays></holdDays>
        <holdRequestType>HOLD_WITHOUT_APPROVAL</holdRequestType>
        <holdEntity>ACCT</holdEntity>
        <holdReason>DSRE</holdReason>
        <holdComments>Disaster Recovery</holdComments>
        <entityIdentifierType>IBAN</entityIdentifierType>
        <entityIdentifierValue>XX00XXXX111111</entityIdentifierValue>
        <entityId></entityId>
        <holdEntityEndDate>2024-12-30</holdEntityEndDate>
        <hierarchySwitch></hierarchySwitch>
        <holdProcessData>
            <holdProcess>BILL</holdProcess>
            <holdProcessEndDate>2024-12-20</holdProcessEndDate>
        </holdProcessData>
        <holdProcessData>
            <holdProcess>ATPY</holdProcess>
            <holdProcessEndDate>2024-12-31</holdProcessEndDate>
        </holdProcessData>
        <characteristics>
            <characteristicType>HOLD_TYPE</characteristicType>
            <characteristicValue>P</characteristicValue>
            <effectiveDate>2024-12-01</effectiveDate>
        </characteristics>
        <characteristics>
            <characteristicType>ESC_PATH</characteristicType>
            <characteristicValue>01</characteristicValue>
            <effectiveDate>2024-12-01</effectiveDate>
        </characteristics>
    </holdRequest>
</C1-CreateHoldRequest>

Sample Hold Creation Response in the XML Format

<C1-CreateHoldRequest>
    <holdRequest>
        <statusCd>Success</statusCd>
        <holdRequestId>790420762398</holdRequestId>
        <holdStatus>Active</holdStatus>
        <sourceSystem>SMALL_PRIME</sourceSystem>
        <externalTransactionId>567888876666</externalTransactionId>
        <externalSourceId>656565</externalSourceId>
        <holdStartDate>2024-12-01</holdStartDate>
        <holdEndDate>2024-12-31</holdEndDate>
        <holdDays></holdDays>
        <holdRequestType>HOLD_WITHOUT_APPROVAL</holdRequestType>
        <holdEntity>ACCT</holdEntity>
        <holdReason>DSRE</holdReason>
        <holdComments>Disaster Recovery</holdComments>
        <entityIdentifierType>IBAN</entityIdentifierType>
        <entityIdentifierValue>XX00XXXX111111</entityIdentifierValue>
        <entityId></entityId>
        <holdEntityEndDate>2024-12-30</holdEntityEndDate>
        <hierarchySwitch></hierarchySwitch>
        <holdProcessData>
            <holdProcess>BILL</holdProcess>
            <holdProcessEndDate>2024-12-20</holdProcessEndDate>
        </holdProcessData>
        <holdProcessData>
            <holdProcess>ATPY</holdProcess>
            <holdProcessEndDate>2024-12-31</holdProcessEndDate>
        </holdProcessData>
        <characteristics>
            <characteristicType>HOLD_TYPE</characteristicType>
            <characteristicValue>P</characteristicValue>
            <effectiveDate>2024-12-01</effectiveDate>
        </characteristics>
        <characteristics>
            <characteristicType>ESC_PATH</characteristicType>
            <characteristicValue>01</characteristicValue>
            <effectiveDate>2024-12-01</effectiveDate>
        </characteristics>
    </holdRequest>
</C1-CreateAdjustment>

Note: We have given the above request sample to illustrate how the tags should be nested while receiving a hold creation request from the external system. However, you should not seamlessly use this 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 Creation Request and Response - Tags in XML Format	Hold Creation Request and Response - Tags in XML Format