Sample Hold Creation Request and Response in the JSON Format

Using the below example, you can create a hold request for a bill where the funding process is kept on hold.

Sample Hold Creation Request in the JSON Format

 {
    "CreateHoldRequest": {
        "holdRequest": {
            "sourceSystem": "SMALL_PRIME",
            "externalTransactionId": "567888876665",
            "externalSourceId": "656565",
            "holdStartDate": "2024-12-01",
            "holdEndDate": "",
            "holdDays:"31",
            "holdRequestType": "HOLD_WITHOUT_APPROVAL",
            "holdEntity": "BILL",
            "holdReason": "DSRE",
            "holdComments": "Disaster Recovery",
            "entityIdentifierType": "",
            "entityIdentifierValue": "",
            "entityId": "233960569988",
            "holdEntityEndDate": "2024-12-30",
            "hierarchySwitch": "",
            "holdProcessData": {
           "holdProcess": "FNDG",
                "holdProcessEndDate": "2024-12-30"
          },
"characteristics": [
{
                "characteristicType": "HOLD_TYPE",
                "characteristicValue": "P",
                "effectiveDate": "2024-12-01"
             },
   {
                "characteristicType": "ESC_PATH",
                "characteristicValue": "01",
                "effectiveDate": "2024-12-01"
             }
 ]
        }
    }
  }

Sample Hold Creation Response in the JSON Format

 {
    "CreateHoldRequest": {
        "holdRequest": {
            "statusCd": "Success",
            "holdRequestId": "790420762388",
            "holdStatus": "Active",
"sourceSystem": "SMALL_PRIME",
            "externalTransactionId": "567888876665",
            "externalSourceId": "656565",
            "holdStartDate": "2024-12-01",
            "holdEndDate": "",
            "holdDays:"31",
            "holdRequestType": "HOLD_WITHOUT_APPROVAL",
            "holdEntity": "BILL",
            "holdReason": "DSRE",
            "holdComments": "Disaster Recovery",
            "entityIdentifierType": "",
            "entityIdentifierValue": "",
            "entityId": "233960569988",
            "holdEntityEndDate": "2024-12-30",
            "hierarchySwitch": "",
            "holdProcessData": {
           "holdProcess": "FNDG",
                "holdProcessEndDate": "2024-12-30"
          },
"characteristics": [
{
                "characteristicType": "HOLD_TYPE",
                "characteristicValue": "P",
                "effectiveDate": "2024-12-01"
             },
   {
                "characteristicType": "ESC_PATH",
                "characteristicValue": "01",
                "effectiveDate": "2024-12-01"
             }
]
       }
    }
 }

Note: We have given the above request sample to illustrate how the attribute/value pairs should be structured 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 - Attribute/Value Pairs in JSON Format	Hold Creation Request and Response - Attribute/Value Pairs in JSON Format