Sample Hold Request Creation Request and Response in the JSON Format
Using the below example, you can create a hold request for an account entity where the overdue process is kept on hold.
Sample Hold Request Creation Request in the JSON Format
{
"CreateHoldRequest":
{
"holdRequest":
{
"sourceSystem": "HOLD_TEST_TEXT",
"externalTransactionId": "567888876666",
"externalSourceId": "YERFDDD",
"holdStartDate": "2022-01-10",
"holdEndDate": "2022-12-30",
"holdDays:"20",
"holdRequestType": "HOLD_WITHOUT_APPROVAL",
"holdEntity": "ACCT",
"holdReason": "3",
"holdComments": "FIRE_IN_SEAWOODS",
"entityIdentifierType": "EIN",
"entityIdentifierValue": "1446IC",
"entityId": "2334454617",
"holdEntityEndDate": "2022-12-30",
"hierarchySwitch": "N",
"holdProcessData":
{
"holdProcess": "OVDU"
"holdProcessEndDate": "2021-12-30"
}
}
}
}
Sample Hold Request Creation Response in the JSON Format
The following information is received as response when the hold request is created successfully.
{
"CreateHoldRequest":
{
"holdRequest":
{
"statusCd": "SUCCESS",
"holdRequestId": "790420762398",
"holdStatus": "Active",
"sourceSystem": "HOLDTESTEXT",
"externalTransactionId": "567888876666",
"externalSourceId": "YERFDDD",
"holdStartDate": "2022-01-10",
"holdEndDate": "2022-12-30",
"holdDays:"20",
"holdRequestType": "HOLD_WITHOUT_APPROVAL",
"holdEntity": "ACCT",
"holdReason": "3",
"holdComments": "FIRE_IN_SEAWOODS",
"entityIdentifierType": "EIN",
"entityIdentifierValue": "1446IC",
"entityId": "2334454617",
"holdEntityEndDate": "2022-12-30",
"hierarchySwitch": "N",
"holdProcessData":
{
"holdProcess": "OVDU"
"holdProcessEndDate": "2021-12-30"
}
}
}
}
The following information is received when the hold request creation responds with a failure.
{
"CreateHoldRequest":
{
"holdRequest":
{
"statusCd": "FAILURE",
"messageText": "The system could not fetch the account id"
"using the Account Identifier Type / Value combination.",
"holdRequestId": "790420762398",
"holdStatus": "Active",
"sourceSystem": "ZZ_PRIME_TEST",
"externalTransactionId": "323233478998",
"externalSourceId": "YERFDDD",
"holdStartDate": "2022-01-10",
"holdEndDate": "2022-12-30",
"holdDays:"20",
"holdRequestType": "HOLD_WITHOUT_APPROVAL",
"holdEntity": "ACCT",
"holdReason": "3",
"holdComments": "FLOODS_IN_CONNECTICUT",
"entityIdentifierType": "EIN",
"entityIdentifierValue": "2346IC",
"entityId": "1237864231",
"holdEntityEndDate": "2022-12-30",
"hierarchySwitch": "N",
"holdProcessData":
{
"holdProcess": "OVDU"
"holdProcessEndDate": "2021-12-30"
}
}
}
}
Note: We have given the above request and response samples
to illustrate how the attribute value pairs should be structured 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 - Attribute/Value Pairs in JSON Format | Hold Request Creation Request and Response - Attribute/Value Pairs in JSON Format |