Delete by ID

1 min

{ "name" "endpoint /api/webhookregistrations/{registrationid}", "method" "delete", "url" "https //pushtopaystaging crbnj net/api/webhookregistrations/{registrationid}", "description" "deletes a webhook registration by its registration id", "tab" "examples", "examples" { "languages" \[ { "id" "iwq5enrxzsg8s mvis2qi", "language" "curl", "code" "{\n \\"requestid\\" \\"fhak78ch 9f7x fh86 1nv8 hd84v0n4a82d\\",\n \\"callbackurl\\" \\"string\\",\n \\"callbackusername\\" \\"string\\",\n \\"callbackpassword\\" \\"string\\",\n \\"sourcesenderid\\" \\"3772e240 bc7c 45ec b072 ee2949578481\\"\n}", "customlabel" "" } ], "selectedlanguageid" "iwq5enrxzsg8s mvis2qi" }, "results" { "languages" \[ { "id" "sabj3ikpbulioha81keya", "language" "200", "customlabel" "", "code" "{\n \\"registrationid\\" \\"fhk76smv 12a4 21d4 b45p nbd98l05sc78\\",\n \\"requestid\\" \\"fhak78ch 9f7x fh86 1nv8 hd84v0n4a82d\\",\n \\"callbackurl\\" \\"www yoururl com\\",\n \\"callbackusername\\" \\"jroll\\",\n \\"callbackpassword\\" \\"1234\\",\n \\"merchantid\\" \\"12345qfs8 1a34 n5v5 2kl3 234hko891cvn\\",\n \\"isactive\\" false,\n \\"deactivatedat\\" \\"2020 12 16t09 31 35 617z\\",\n \\"isinerrorstate\\" true,\n \\"errorstatereason\\" \\"string\\",\n \\"detectederrorstateat\\" \\"2022 12 16t09 31 35 617z\\"\n}" } ], "selectedlanguageid" "sabj3ikpbulioha81keya" }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "name" "requestid", "kind" "required", "type" "string", "description" "the guid that enables the application to link request with response" }, { "name" "callbackurl", "kind" "required", "type" "string", "description" "the value is a url webhooks are reported to this url as a result of a triggered action make sure the callback url is added to cross river's allowlist ssl required ", "" "the value is a url webhooks are reported to this url as a result of a triggered action make sure the callback url is added to cross river's allowlist ssl required " }, { "name" "callbackusername", "kind" "optional", "type" "string", "description" "authentication data for webhook api calls if the server requires authentication", "children" \[] }, { "name" "callbackpassword", "kind" "optional", "type" "string", "description" "authentication data for webhook api calls if the server requires authentication", "children" \[] }, { "name" "sourcesenderid", "kind" "optional", "type" "string", "description" "the guid that identifies the merchant partner", "children" \[] } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" }, "response" \[ { "name" "registrationid", "kind" "optional", "type" "string", "description" "unique registration id for a webhook" }, { "name" "requestid", "kind" "optional", "type" "string", "description" "the guid that enables the application to link request with response", "children" \[] }, { "name" "callbackurl", "kind" "optional", "type" "string", "description" "the value is a url webhooks are reported to this url as a result of a triggered action make sure the callback url is added to cross river's allowlist ssl required ", "children" \[] }, { "name" "callbackusername", "kind" "optional", "type" "string", "description" "authentication data for webhook api calls if the server requires authentication", "children" \[] }, { "name" "callbackpassword", "kind" "optional", "type" "string", "description" "authentication data for webhook api calls if the server requires authentication", "children" \[] }, { "name" "submerchantid", "kind" "optional", "type" "string", "description" "identifier of the merchant partner", "children" \[] }, { "name" "isactive", "kind" "optional", "type" "boolean", "description" "true if the card is active, otherwise false", "children" \[] }, { "name" "deactivatedat", "kind" "optional", "type" "string", "description" "date and time card was deactivated, if relevant, in date time format in this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]", "children" \[] }, { "name" "isinerrorstate", "kind" "optional", "type" "boolean", "description" "true if the webhook is in error status, otherwise false", "children" \[] }, { "name" "errorstatereason", "kind" "optional", "type" "string", "description" "reason the registration is in an error state", "children" \[] }, { "name" "detectederrorstateat", "kind" "optional", "type" "string", "description" "time the error was detected in this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]", "children" \[] } ] }