--- title: Cancellation and Deposit slug: PktI-cancellation-and-deposit docTags: createdAt: 2025-09-10T11:52:05.061Z --- :::ApiMethodV2 ```json { "name": "Cancellation and Deposit ", "method": "POST", "url": "https://wsb.bakuun.com/v2/push-ari/CPBXX/XXXX", "description": "Returns the cancellation and deposit policy for a specific hotel / room / rate plan and date range.\n\nThis action is used by the partner to retrieve:\n\nCancellation rules (deadlines, penalty type & amount, level 1 / level 2, etc.)\n\nDeposit rules (if a deposit is required, how much, when it’s charged)", "tab": "examples", "examples": { "languages": [ { "id": "F6DFMY8yp37HbzLk13k1v", "language": "json", "code": "{\n \"sharePost\": \"string\",\n \"sourceId\": \"string\",\n \"propertyId\": \"string\",\n \"roomId\": \"string\",\n \"rateId\": \"string\",\n \"startDate\": \"YYYY-MM-DD\",\n \"endDate\": \"YYYY-MM-DD\",\n \"refundable\": \"string\",\n \"action\": \"getCancellation\",\n \"policyDetails\": {\n \"cancellation\": [\n {\n \"policyId\": XX,\n \"daysPriorCheckin\": XX,\n \"penaltyType\": XX,\n \"penaltyAmount\": XX,\n \"penaltyApplied\": XX,\n \"level\": X\n }\n ],\n \"deposit\": {\n \"depositPolicy\": \"string\",\n \"depositType\": X,\n \"depositAmount\": XX,\n \"depositApplied\": X,\n \"depositIntervalUnits\": X,\n \"depositTimeInterval\": X\n }\n }\n}", "customLabel": "" }, { "id": "m5KpYFujK8kIYYHyOace9", "language": "curl", "code": "curl --location 'https://wsb.bakuun.com/v2/push-ari/CPB46/881826' \\\n--header 'Accept: application/json' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"sharePost\": \"String\",\n \"sourceId\": \"String\",\n \"propertyId\": \"String\",\n \"roomId\": \"String\",\n \"rateId\": \"String\",\n \"startDate\": \"String\",\n \"endDate\": \"String\",\n \"refundable\": \"String\",\n \"action\": \"String\",\n \"policyDetails\": {\n \"cancellation\": {\n \"policyId\": \"\",\n \"daysPriorCheckin\": \"\",\n \"penaltyType\": \"\",\n \"penaltyAmount\": \"\",\n \"penaltyApplied\": \"\",\n \"level\": \"\"\n },\n \"deposit\": {\n \"depositPolicy\": \"\",\n \"depositType\": \"\",\n \"depositAmount\": \"\",\n \"depositApplied\": \"\",\n \"depositIntervalUnits\": \"\",\n \"depositTimeInterval\": \"\"\n }\n }\n}'", "customLabel": "" }, { "id": "9FlhgzQlCGDO_uJQ7cFYl", "language": "nodejs", "code": "var request = require('request');\nvar options = {\n 'method': 'POST',\n 'url': 'https://wsb.bakuun.com/v2/push-ari/CPB46/881826',\n 'headers': {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({\n \"sharePost\": \"String\",\n \"sourceId\": \"String\",\n \"propertyId\": \"String\",\n \"roomId\": \"String\",\n \"rateId\": \"String\",\n \"startDate\": \"String\",\n \"endDate\": \"String\",\n \"refundable\": \"String\",\n \"action\": \"String\",\n \"policyDetails\": {\n \"cancellation\": {\n \"policyId\": \"\",\n \"daysPriorCheckin\": \"\",\n \"penaltyType\": \"\",\n \"penaltyAmount\": \"\",\n \"penaltyApplied\": \"\",\n \"level\": \"\"\n },\n \"deposit\": {\n \"depositPolicy\": \"\",\n \"depositType\": \"\",\n \"depositAmount\": \"\",\n \"depositApplied\": \"\",\n \"depositIntervalUnits\": \"\",\n \"depositTimeInterval\": \"\"\n }\n }\n })\n\n};\nrequest(options, function (error, response) {\n if (error) throw new Error(error);\n console.log(response.body);\n});\n", "customLabel": "" }, { "id": "4M8A3gMdlQu9j39y0qJCF", "language": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"Accept\", \"application/json\");\nmyHeaders.append(\"Content-Type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"sharePost\": \"String\",\n \"sourceId\": \"String\",\n \"propertyId\": \"String\",\n \"roomId\": \"String\",\n \"rateId\": \"String\",\n \"startDate\": \"String\",\n \"endDate\": \"String\",\n \"refundable\": \"String\",\n \"action\": \"String\",\n \"policyDetails\": {\n \"cancellation\": {\n \"policyId\": \"\",\n \"daysPriorCheckin\": \"\",\n \"penaltyType\": \"\",\n \"penaltyAmount\": \"\",\n \"penaltyApplied\": \"\",\n \"level\": \"\"\n },\n \"deposit\": {\n \"depositPolicy\": \"\",\n \"depositType\": \"\",\n \"depositAmount\": \"\",\n \"depositApplied\": \"\",\n \"depositIntervalUnits\": \"\",\n \"depositTimeInterval\": \"\"\n }\n }\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://wsb.bakuun.com/v2/push-ari/CPB46/881826\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));", "customLabel": "" }, { "id": "pN_-CzBMZq_nj6nIBbUmb", "language": "python", "code": "import requests\nimport json\n\nurl = \"https://wsb.bakuun.com/v2/push-ari/CPB46/881826\"\n\npayload = json.dumps({\n \"sharePost\": \"String\",\n \"sourceId\": \"String\",\n \"propertyId\": \"String\",\n \"roomId\": \"String\",\n \"rateId\": \"String\",\n \"startDate\": \"String\",\n \"endDate\": \"String\",\n \"refundable\": \"String\",\n \"action\": \"String\",\n \"policyDetails\": {\n \"cancellation\": {\n \"policyId\": \"\",\n \"daysPriorCheckin\": \"\",\n \"penaltyType\": \"\",\n \"penaltyAmount\": \"\",\n \"penaltyApplied\": \"\",\n \"level\": \"\"\n },\n \"deposit\": {\n \"depositPolicy\": \"\",\n \"depositType\": \"\",\n \"depositAmount\": \"\",\n \"depositApplied\": \"\",\n \"depositIntervalUnits\": \"\",\n \"depositTimeInterval\": \"\"\n }\n }\n})\nheaders = {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n", "customLabel": "" }, { "id": "YX6wzl5PX-ThnDUm9B31v", "language": "ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://wsb.bakuun.com/v2/push-ari/CPB46/881826\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"Accept\"] = \"application/json\"\nrequest[\"Content-Type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"sharePost\": \"String\",\n \"sourceId\": \"String\",\n \"propertyId\": \"String\",\n \"roomId\": \"String\",\n \"rateId\": \"String\",\n \"startDate\": \"String\",\n \"endDate\": \"String\",\n \"refundable\": \"String\",\n \"action\": \"String\",\n \"policyDetails\": {\n \"cancellation\": {\n \"policyId\": \"\",\n \"daysPriorCheckin\": \"\",\n \"penaltyType\": \"\",\n \"penaltyAmount\": \"\",\n \"penaltyApplied\": \"\",\n \"level\": \"\"\n },\n \"deposit\": {\n \"depositPolicy\": \"\",\n \"depositType\": \"\",\n \"depositAmount\": \"\",\n \"depositApplied\": \"\",\n \"depositIntervalUnits\": \"\",\n \"depositTimeInterval\": \"\"\n }\n }\n})\n\nresponse = https.request(request)\nputs response.read_body\n", "customLabel": "" } ], "selectedLanguageId": "F6DFMY8yp37HbzLk13k1v" }, "results": { "languages": [ { "id": "Nk06oAPM-SJCHzGv2ZylY", "language": "200", "code": "{\n \"success\": true,\n \"trackingId\": \"68c168dd04829387650a476d\"\n}", "customLabel": "" }, { "id": "xp3TwEAGik5AyK9JVHgRU", "language": "402", "code": "{\n \"success\": false,\n \"errors\": [\n {\n \"code\": 402,\n \"message\": \"Invalid parameter\"\n }\n ],\n \"trackingId\": \"68c168dd04829387650a476d\"\n }", "customLabel": "" }, { "id": "mXok8K-nUBsnpLJ22KTle", "language": "405", "code": "{\n \"success\": false,\n \"errors\": [\n {\n \"code\": 405,\n \"message\": \"Invalid end date\"\n }\n ],\n \"trackingId\": \"68c168dd04829387650a476d\"\n }", "customLabel": "" }, { "id": "WCEyfpr--RexmCv0YiAgS", "language": "408", "code": "{\n \"success\": false,\n \"errors\": [\n {\n \"code\": 408,\n \"message\": \"Processing error\"\n }\n ],\n \"trackingId\": \"68c168dd04829387650a476d\"\n }", "customLabel": "" }, { "id": "o47UHRe8ZEsuhYi5Rlvcl", "language": "415", "code": "{\n \"success\": false,\n \"errors\": [\n {\n \"code\": 415,\n \"message\": \"Invalid authentication key\"\n }\n ],\n \"trackingId\": \"68c168dd04829387650a476d\"\n}", "customLabel": "" }, { "id": "bY6marnhie6-kzGkeLKbs", "language": "416", "code": "{\n \"success\": false,\n \"errors\": [\n {\n \"code\": 416,\n \"message\": \"Overlapping data range\"\n }\n ],\n \"trackingId\": \"68c168dd04829387650a476d\"\n}", "customLabel": "" }, { "id": "HF6dJkV-KVqKOoT_ujKbj", "language": "417", "code": "{\n \"success\": false,\n \"errors\": [\n {\n \"code\": 440,\n \"message\": \"Invalid source ID\"\n }\n ],\n \"trackingId\": \"68c168dd04829387650a476d\"\n}", "customLabel": "" }, { "id": "4fpcQzPN0Hx0RP1xGnDmo", "language": "418", "code": "{\n \"success\": false,\n \"errors\": [\n {\n \"code\": 442,\n \"message\": \"Endpoint is not active\"\n }\n ],\n \"trackingId\": \"68c168dd04829387650a476d\"\n}", "customLabel": "" }, { "id": "TmhCxf0m9aw57yUlhuuaJ", "language": "421", "code": "{\n \"success\": false,\n \"errors\": [\n {\n \"code\": 446,\n \"message\": \"Invalid property mapping\"\n }\n ],\n \"trackingId\": \"68c168dd04829387650a476d\"\n}", "customLabel": "" }, { "id": "zW9yU5dUEvvqhh7n3gvgs", "language": "422", "code": "{\n \"success\": false,\n \"errors\": [\n {\n \"code\": 451,\n \"message\": \"Invalid room mapping\"\n }\n ],\n \"trackingId\": \"68c168dd04829387650a476d\"\n}", "customLabel": "" }, { "id": "8DTaz7mwE3-eIGKDxSVcu", "language": "423", "code": "{\n \"success\": false,\n \"errors\": [\n {\n \"code\": 453,\n \"message\": \"Mapping is not active\"\n }\n ],\n \"trackingId\": \"68c168dd04829387650a476d\"\n}", "customLabel": "" }, { "id": "mb14ROd0LiBV6sV9fWfzC", "language": "424", "code": "{\n \"success\": false,\n \"errors\": [\n {\n \"code\": 454,\n \"message\": \"Invalid endpoint\"\n }\n ],\n \"trackingId\": \"68c168dd04829387650a476d\"\n}", "customLabel": "" }, { "id": "Bf1hdhBF0yoxKS1XjD6Bv", "language": "425", "code": "{\n \"success\": false,\n \"errors\": [\n {\n \"code\": 471,\n \"message\": \"Channel ID blocked\"\n }\n ],\n \"trackingId\": \"68c168dd04829387650a476d\"\n}", "customLabel": "" }, { "id": "8ViCnRIkR8kwhnvfylNM_", "language": "426", "code": "{\n \"success\": false,\n \"errors\": [\n {\n \"code\": 453,\n \"message\": \"Mapping is not active\"\n }\n ],\n \"trackingId\": \"68c168dd04829387650a476d\"\n}", "customLabel": "" }, { "id": "2P841Kkn9BOJgc9XDo1hJ", "language": "428", "code": "{\n \"success\": false,\n \"errors\": [\n {\n \"code\": 454,\n \"message\": \"Invalid endpoint\"\n }\n ],\n \"trackingId\": \"68c168dd04829387650a476d\"\n}", "customLabel": "" }, { "id": "REZbdoRAH7pxZfF6O42Z7", "language": "429", "code": "{\n \"success\": false,\n \"errors\": [\n {\n \"code\": 452,\n \"message\": \"Invalid rate plan mapping\"\n }\n ],\n \"trackingId\": \"68c168dd04829387650a476d\"\n}", "customLabel": "" }, { "id": "zcwpkCoaI2Gcs_LMjv5yy", "language": "500", "code": "{\n \"success\": false,\n \"errors\": [\n {\n \"code\": 500,\n \"message\": \"Internal server error\"\n }\n ],\n \"trackingId\": \"68c168dd04829387650a476d\"\n}", "customLabel": "" }, { "id": "em_Kpv2oZfn8MCO7_f1SV", "language": "502", "code": "{\n \"success\": false,\n \"errors\": [\n {\n \"code\": 502,\n \"message\": \"Bad gateway\"\n }\n ],\n \"trackingId\": \"68c168dd04829387650a476d\"\n}", "customLabel": "" }, { "id": "zzzE2J6Y7YZDula_qc4OD", "language": "503", "code": "{\n \"success\": false,\n \"errors\": [\n {\n \"code\": 503,\n \"message\": \"Service unavailable\"\n }\n ],\n \"trackingId\": \"68c168dd04829387650a476d\"\n}", "customLabel": "" }, { "id": "B4wRfM8K9w0KuyctvGtOu", "language": "504", "code": "{\n \"success\": false,\n \"errors\": [\n {\n \"code\": 504,\n \"message\": \"Endpoint request timed-out\"\n }\n ],\n \"trackingId\": \"68c168dd04829387650a476d\"\n}", "customLabel": "" } ], "selectedLanguageId": "Nk06oAPM-SJCHzGv2ZylY" }, "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [], "bodyDataParameters": [ { "name": "sharePost", "kind": "required", "type": "string", "description": "System-generated, human-readable secret API access key (unique per account).", "": "System-generated, human-readable secret API access key (unique per account)." }, { "name": "sourceId", "kind": "required", "type": "string", "description": "Connectivity Partner identifier assigned by Bakuun (e.g. CPBXX)", "": "Connectivity Partner identifier assigned by Bakuun (e.g. CPBXX)" }, { "name": "propertyId", "kind": "required", "type": "string", "description": "Unique property identifier (shared mapping between Bakuun and the Connectivity partner).", "": "Unique property identifier (shared mapping between Bakuun and the Connectivity partner)." }, { "name": "roomId", "kind": "required", "type": "string", "description": "ID identifying the room type (as mapped between Bakuun and the Connectivity partner).", "": "ID identifying the room type (as mapped between Bakuun and the Connectivity partner)." }, { "name": "rateId", "kind": "required", "type": "string", "description": "ID identifying the rate type (as mapped between Bakuun and the Connectivity partner).", "": "ID identifying the rate type (as mapped between Bakuun and the Connectivity partner)." }, { "name": "startDate", "kind": "required", "type": "string", "description": "Start date of the update range, formatted as YYYY-MM-DD.", "": "Start date of the update range, formatted as YYYY-MM-DD." }, { "name": "endDate", "kind": "required", "type": "string", "description": "End date of the update range, formatted as YYYY-MM-DD.", "": "End date of the update range, formatted as YYYY-MM-DD." }, { "name": "refundable", "kind": "required", "type": "string", "description": "\"true\" if the rate is refundable, \"false\" if non-refundable.", "": "\"true\" if the rate is refundable, \"false\" if non-refundable." }, { "name": "action", "kind": "required", "type": "string", "description": "Always set as getCancellation", "": "Always set as getCancellation" }, { "name": "policyDetails", "kind": "required", "type": "object", "description": "", "": "required", "children": [ { "name": "cancellation", "kind": "required", "type": "object", "description": "Each entry represents one cancellation rule level (e.g. first deadline, second deadline).", "children": [ { "name": "policyId", "kind": "required", "type": "integer", "description": "Type of cancellation policy linked to the rate plan: 1 = Standard, 2 = Flexible 1, 3 = Flexible 2, 4 = Flexible 3, 5 = Flexible 4" }, { "name": "daysPriorCheckin", "kind": "required", "type": "integer", "description": "Number of days before check-in a guest can cancel without penalty. Use 0 if cancellation is set at 18:00 on day of arrival." }, { "name": "penaltyType", "kind": "required", "type": "integer", "description": "Penalty cost type. 3 = Percentage of the stay." }, { "name": "penaltyAmount", "kind": "required", "type": "integer", "description": "Percentage value from 1 to 100." }, { "name": "penaltyApplied", "kind": "required", "type": "integer", "description": "Where the penalty is applied: 3 = First Night, 4 = Full stay" }, { "name": "level", "kind": "required", "type": "integer", "description": "Level of the cancellation rule: 1 = First Level, 2 = Second Level (for multi-step policies)." } ] }, { "name": "deposit", "kind": "required", "type": "object", "description": "Represents the deposit policy for the rate plan.", "children": [ { "name": "depositPolicy", "kind": "required", "type": "string", "description": "Whether a deposit is required: \"Required\" = true, \"Not Required\" = false. When refundable is false, deposit will always be \"Required\"" }, { "name": "depositType", "kind": "required", "type": "integer", "description": "Deposit cost parameter. 3 = Percentage." }, { "name": "depositAmount", "kind": "required", "type": "integer", "description": "Percentage value from 1 to 100." }, { "name": "depositApplied", "kind": "required", "type": "integer", "description": "Where the deposit is applied: 3 = First Night, 4 = Full stay." }, { "name": "depositIntervalUnits", "kind": "required", "type": "integer", "description": "When deposit is charged: 1 = Days before arrival, 0 = At moment of booking" }, { "name": "depositTimeInterval", "kind": "required", "type": "integer", "description": "Interval value applied only if depositIntervalUnits = 1. Allowed values: 1–10 or 10, 30, 45, 60. Represents number of days before arrival when deposit is charged." } ] } ], "schema": [ { "name": "cancellation", "kind": "required", "type": "object", "description": "Each entry represents one cancellation rule level (e.g. first deadline, second deadline).", "children": [ { "name": "policyId", "kind": "required", "type": "integer", "description": "Type of cancellation policy linked to the rate plan: 1 = Standard, 2 = Flexible 1, 3 = Flexible 2, 4 = Flexible 3, 5 = Flexible 4" }, { "name": "daysPriorCheckin", "kind": "required", "type": "integer", "description": "Number of days before check-in a guest can cancel without penalty. Use 0 if cancellation is set at 18:00 on day of arrival." }, { "name": "penaltyType", "kind": "required", "type": "integer", "description": "Penalty cost type. 3 = Percentage of the stay." }, { "name": "penaltyAmount", "kind": "required", "type": "integer", "description": "Percentage value from 1 to 100." }, { "name": "penaltyApplied", "kind": "required", "type": "integer", "description": "Where the penalty is applied: 3 = First Night, 4 = Full stay" }, { "name": "level", "kind": "required", "type": "integer", "description": "Level of the cancellation rule: 1 = First Level, 2 = Second Level (for multi-step policies)." } ] }, { "name": "deposit", "kind": "required", "type": "object", "description": "Represents the deposit policy for the rate plan.", "children": [ { "name": "depositPolicy", "kind": "required", "type": "string", "description": "Whether a deposit is required: \"Required\" = true, \"Not Required\" = false. When refundable is false, deposit will always be \"Required\"" }, { "name": "depositType", "kind": "required", "type": "integer", "description": "Deposit cost parameter. 3 = Percentage." }, { "name": "depositAmount", "kind": "required", "type": "integer", "description": "Percentage value from 1 to 100." }, { "name": "depositApplied", "kind": "required", "type": "integer", "description": "Where the deposit is applied: 3 = First Night, 4 = Full stay." }, { "name": "depositIntervalUnits", "kind": "required", "type": "integer", "description": "When deposit is charged: 1 = Days before arrival, 0 = At moment of booking" }, { "name": "depositTimeInterval", "kind": "required", "type": "integer", "description": "Interval value applied only if depositIntervalUnits = 1. Allowed values: 1–10 or 10, 30, 45, 60. Represents number of days before arrival when deposit is charged." } ] } ] } ], "formDataParameters": [] }, "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "hasTryItOut": false, "response": [ { "name": "success", "kind": "optional", "type": "boolean", "description": "" }, { "name": "trackingId", "kind": "optional", "type": "string", "description": "", "children": [] } ], "autoGeneratedAnchorSlug": "cancellation-and-deposit", "legacyHash": "vzhSUehopTtLCuG25WWeH" } ``` :::