--- title: Create Booking slug: create-booking createdAt: 2024-01-20T05:41:02.227Z --- :::ApiMethodV2 ```json { "name": "Create Booking", "method": "POST", "url": "https://api.paydocker.com/{version}/booking/{partnerid}/{randomkey}", "description": " This API is used to create booking in your PayDocker account", "tab": "examples", "examples": { "languages": [ { "id": "iMAIKMCO5byA8vMxinYEE", "language": "json", "code": "{\n \"share_secret\": \"EVBZIHZhKqsPoopQ4GW7uceHQz4yIEdGB1JjNJyUJmvp77xj1lInlilZc5LkZgA8IllRRDLZTaaftmUwT3WapIRHP67VAskyJOjybSH03RdDXVXPhAcCH00l3dKYqCJjsqikrnpsy0B7WonvWWpK5mz\",\n \"booking_event\": \"new\",\n \"source_id\": \"PDR28\",\n \"buyer_id\": \"\",\n \"booking_id\": \"1396\",\n \"booking_date\": \"21-01-2024\",\n \"booking_category\": \"Payable\",\n \"supplier_id\": \"PD01\",\n \"property_name\": \"Roy\",\n \"property_country\": \"IN\",\n \"guests_count\": \"45\",\n \"room_count\": \"12\",\n \"check_in\": \"20-01-2024\",\n \"check_out\": \"22-01-2024\",\n \"transaction_currency\": \"INR\",\n \"transaction_amount\": \"100.00\",\n \"margin_category\": \"%\",\n \"transaction_margin\": \"1\",\n \"nonrefundable_amount\": \"0.00\",\n \"refundable_amount\": \"0.00\",\n \"firstnight_amount\": \"10.00\",\n \"cancellation_days\": \"0\",\n \"auth_code\":\"trusted\",\n \"pre_auth\":\"true\"\n}", "customLabel": "" }, { "id": "4Edz3Bl6mECfO9P-Bp6Qz", "language": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"Accept\", \"application/json\");\nmyHeaders.append(\"Content-Type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"share_secret\": \"EVBZIHZhKqsPoopQ4GW7uceHQz4yIEdGB1JjNJyUJmvp77xj1lInlilZc5LkZgA8IllRRDLZTaaftmUwT3WapIRHP67VAskyJOjybSH03RdDXVXPhAcCH00l3dKYqCJjsqikrnpsy0B7WonvWWpK5mz\",\n \"booking_event\": \"new\",\n \"source_id\": \"PDR28\",\n \"buyer_id\": \"\",\n \"booking_id\": \"1396\",\n \"booking_date\": \"21-01-2024\",\n \"booking_category\": \"Payable\",\n \"supplier_id\": \"PD01\",\n \"property_name\": \"Roy\",\n \"property_country\": \"IN\",\n \"guests_count\": \"45\",\n \"room_count\": \"12\",\n \"check_in\": \"20-01-2024\",\n \"check_out\": \"22-01-2024\",\n \"transaction_currency\": \"INR\",\n \"transaction_amount\": \"100.00\",\n \"margin_category\": \"%\",\n \"transaction_margin\": \"1\",\n \"nonrefundable_amount\": \"0.00\",\n \"refundable_amount\": \"0.00\",\n \"firstnight_amount\": \"10.00\",\n \"cancellation_days\": \"0\",\n \"auth_code\":\"trusted\",\n \"pre_auth\":\"true\"\n});\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.cakes.com\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));", "customLabel": "" }, { "id": "GrzaNIFf94UDor0PLztjW", "language": "nodejs", "code": "var request = require('request');\nvar options = {\n 'method': 'POST',\n 'url': 'https://api.paydocker.com/v1/booking/PDR28/375053',\n 'headers': {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({\n \"share_secret\": \"EVBZIHZhKqsPoopQ4GW7uceHQz4yIEdGB1JjNJyUJmvp77xj1lInlilZc5LkZgA8IllRRDLZTaaftmUwT3WapIRHP67VAskyJOjybSH03RdDXVXPhAcCH00l3dKYqCJjsqikrnpsy0B7WonvWWpK5mz\",\n \"booking_event\": \"new\",\n \"source_id\": \"PDR28\",\n \"buyer_id\": \"\",\n \"booking_id\": \"1396\",\n \"booking_date\": \"21-01-2024\",\n \"booking_category\": \"Payable\",\n \"supplier_id\": \"PD01\",\n \"property_name\": \"Roy\",\n \"property_country\": \"IN\",\n \"guests_count\": \"45\",\n \"room_count\": \"12\",\n \"check_in\": \"20-01-2024\",\n \"check_out\": \"22-01-2024\",\n \"transaction_currency\": \"INR\",\n \"transaction_amount\": \"100.00\",\n \"margin_category\": \"%\",\n \"transaction_margin\": \"1\",\n \"nonrefundable_amount\": \"0.00\",\n \"refundable_amount\": \"0.00\",\n \"firstnight_amount\": \"10.00\",\n \"cancellation_days\": \"0\",\n \"auth_code\":\"trusted\",\n \"pre_auth\":\"true\"\n})\n\n};\nrequest(options, function (error, response) {\n if (error) throw new Error(error);\n console.log(response.body);\n});\n", "customLabel": "" }, { "id": "WhrVI5BdFONhHPtiegkiV", "language": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"Accept\", \"application/json\");\nmyHeaders.append(\"Content-Type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"share_secret\": \"EVBZIHZhKqsPoopQ4GW7uceHQz4yIEdGB1JjNJyUJmvp77xj1lInlilZc5LkZgA8IllRRDLZTaaftmUwT3WapIRHP67VAskyJOjybSH03RdDXVXPhAcCH00l3dKYqCJjsqikrnpsy0B7WonvWWpK5mz\",\n \"booking_event\": \"new\",\n \"source_id\": \"PDR28\",\n \"buyer_id\": \"\",\n \"booking_id\": \"1396\",\n \"booking_date\": \"21-01-2024\",\n \"booking_category\": \"Payable\",\n \"supplier_id\": \"PD01\",\n \"property_name\": \"Roy\",\n \"property_country\": \"IN\",\n \"guests_count\": \"45\",\n \"room_count\": \"12\",\n \"check_in\": \"20-01-2024\",\n \"check_out\": \"22-01-2024\",\n \"transaction_currency\": \"INR\",\n \"transaction_amount\": \"100.00\",\n \"margin_category\": \"%\",\n \"transaction_margin\": \"1\",\n \"nonrefundable_amount\": \"0.00\",\n \"refundable_amount\": \"0.00\",\n \"firstnight_amount\": \"10.00\",\n \"cancellation_days\": \"0\",\n \"auth_code\":\"trusted\",\n \"pre_auth\":\"true\"\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.paydocker.com/v1/booking/PDR28/375053\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));", "customLabel": "" } ], "selectedLanguageId": "GrzaNIFf94UDor0PLztjW" }, "results": { "languages": [ { "id": "alwbPZnGJtK-lve90-1fx", "language": "200", "customLabel": "", "code": "{\n \"message\": \"Success\",\n \"success\": \"true\"\n}" }, { "id": "6k5aE3xSoTL1bdUl00kFn", "language": "400", "code": "{\n \"success\": \"false\",\n \"errors\": {\n \"code\": \"400\",\n \"message\": \"Booking ID Not Found\"\n }\n}", "customLabel": "" }, { "id": "4xZoTmm8BecwXWU_JA37c", "language": "402", "code": "{\n \"success\": \"false\",\n \"errors\": {\n \"code\": \"402\",\n \"message\": \"Source Not Allowed\"\n }\n}", "customLabel": "" }, { "id": "mCtwhBy6_T0kbGzQ7ulGE", "language": "405", "customLabel": "", "code": "{\n \"success\": \"false\",\n \"errors\": {\n \"code\": \"405\",\n \"message\": \"Method Not Allowed\"\n }\n}" }, { "id": "UsJ8qHMEtSdeeNwX5P91Z", "language": "407", "code": "{\n \"success\": \"false\",\n \"errors\": {\n \"code\": \"407\",\n \"message\": \"Partner Inactive\"\n }\n}", "customLabel": "" }, { "id": "bYez2W11fGTLGrujXPyoB", "language": "413", "code": "{\n \"success\": \"false\",\n \"errors\": {\n \"code\": \"413\",\n \"message\": \"Destination ID Unknown\"\n }\n}", "customLabel": "" }, { "id": "tWZGhzSZ2Rj7It-qDwiky", "language": "401", "code": "{\n \"success\": \"false\",\n \"errors\": {\n \"code\": \"401\",\n \"message\": \"Destination ID Inactive\"\n }\n}", "customLabel": "" }, { "id": "VHpfUSurcSSO-2igNhQDN", "language": "403", "code": "{\n \"success\": \"false\",\n \"errors\": {\n \"code\": \"403\",\n \"message\": \"IP Not Allowed\"\n }\n}", "customLabel": "" }, { "id": "Yd0fqr_CEO2hCGVpYRiKm", "language": "404", "code": "{\n \"success\": \"false\",\n \"errors\": {\n \"code\": \"404\",\n \"message\": \"Booking ID Quota Exceeded\"\n }\n}", "customLabel": "" }, { "id": "vhpdrD0KJJBhc9vuW67ON", "language": "406", "code": "{\n \"success\": \"false\",\n \"errors\": {\n \"code\": \"406\",\n \"message\": \"Endpoint Bad Format\"\n }\n}", "customLabel": "" }, { "id": "SDPCShIkeTDH_ZRcNf3D9", "language": "408", "code": "{\n \"success\": \"false\",\n \"errors\": {\n \"code\": \"408\",\n \"message\": \"Endpoint Suspended\"\n }\n}", "customLabel": "" }, { "id": "rTeBTbg2UTGk63bjHQVID", "language": "409", "code": "{\n \"success\": \"false\",\n \"errors\": {\n \"code\": \"409\",\n \"message\": \"Event Not Allowed\"\n }\n}", "customLabel": "" }, { "id": "efQKmmeuVMI9HS9TxUj0J", "language": "410", "code": "{\n \"success\": \"false\",\n \"errors\": {\n \"code\": \"410\",\n \"message\": \"Invalid Secret Key\"\n }\n}", "customLabel": "" }, { "id": "kd7h0vMFGrP88iUh4d_8N", "language": "411", "code": "{\n \"success\": \"false\",\n \"errors\": {\n \"code\": \"411\",\n \"message\": \"Duplicated Booking ID\"\n }\n}", "customLabel": "" }, { "id": "AlkKrT93-rBXPgPdAUsgp", "language": "412", "code": "{\n \"success\": \"false\",\n \"errors\": {\n \"code\": \"412\",\n \"message\": \"Missing Booking ID\"\n }\n}", "customLabel": "" }, { "id": "uFMKkfRmvbNMWss4_g9eX", "language": "415", "code": "{\n \"success\": \"false\",\n \"errors\": {\n \"code\": \"415\",\n \"message\": \"Booking Date Bad Format\"\n }\n}", "customLabel": "" }, { "id": "WrcoWQIbd_TJ1o7gUWppL", "language": "416", "code": "{\n \"success\": \"false\",\n \"errors\": {\n \"code\": \"416\",\n \"message\": \"Booking Date Not Allowed\"\n }\n}", "customLabel": "" }, { "id": "sDfywWfHVOQt6IFtxm3X9", "language": "417", "code": "{\n \"success\": \"false\",\n \"errors\": {\n \"code\": \"417\",\n \"message\": \"Missing Booking Category\"\n }\n}", "customLabel": "" }, { "id": "LJzKKt2D11b3DXgtloQuk", "language": "418", "code": "{\n \"success\": \"false\",\n \"errors\": {\n \"code\": \"418\",\n \"message\": \"Booking Category Bad Format\"\n }\n}", "customLabel": "" }, { "id": "cGQv2pdrZQL2bPsLke2M6", "language": "421", "code": "{\n \"success\": \"false\",\n \"errors\": {\n \"code\": \"421\",\n \"message\": \"Missing Destination Name\"\n }\n}", "customLabel": "" }, { "id": "j_hzaAjNFHENXsF-RkvVM", "language": "422", "code": "{\n \"success\": \"false\",\n \"errors\": {\n \"code\": \"422\",\n \"message\": \"Destination Name Quota Exceeded\"\n }\n}", "customLabel": "" }, { "id": "kdvDnXSWGq3wfue359GMd", "language": "423", "code": "{\n \"success\": \"false\",\n \"errors\": {\n \"code\": \"423\",\n \"message\": \"Missing Guests Count\"\n }\n}", "customLabel": "" }, { "id": "U1RZ_hmZzTxPIW-4Ck0DM", "language": "424", "code": "{\n \"success\": \"false\",\n \"errors\": {\n \"code\": \"424\",\n \"message\": \"Guests Count Bad Format\"\n }\n}", "customLabel": "" }, { "id": "qFHGkAgdoRPkRvGUTP_N0", "language": "425", "code": "{\n \"success\": \"false\",\n \"errors\": {\n \"code\": \"425\",\n \"message\": \"Missing Check-in Date\"\n }\n}", "customLabel": "" }, { "id": "j-RPNEyOa4Qru27ThrTjH", "language": "426", "code": "{\n \"success\": \"false\",\n \"errors\": {\n \"code\": \"426\",\n \"message\": \"Check-in Date Bad Format\"\n }\n}", "customLabel": "" }, { "id": "bJWRLyoBRnIvX1mackXCW", "language": "428", "code": "{\n \"success\": \"false\",\n \"errors\": {\n \"code\": \"428\",\n \"message\": \"Check-in Date Quota Exceeded\"\n }\n}", "customLabel": "" }, { "id": "DOw6CpIHvMLRZJ87IhIBC", "language": "429", "code": "{\n \"success\": \"false\",\n \"errors\": {\n \"code\": \"429\",\n \"message\": \"Missing Check-out Date\"\n }\n}", "customLabel": "" }, { "id": "X-2HR8J4qYCUI2lNMd6Q4", "language": "431", "code": "{\n \"success\": \"false\",\n \"errors\": {\n \"code\": \"431\",\n \"message\": \"Check-out Date Not Allowed\"\n }\n}", "customLabel": "" }, { "id": "6OFggVxHcO4U7t_9tWXr4", "language": "451", "code": "{\n \"success\": \"false\",\n \"errors\": {\n \"code\": \"451\",\n \"message\": \"Refundable Amount Bad Format\"\n }\n}", "customLabel": "" }, { "id": "wKOxBibzdieABQopxbB7B", "language": "500", "code": "{\n \"success\": \"false\",\n \"errors\": {\n \"code\": \"500\",\n \"message\": \"Internal Server Error\"\n }\n}", "customLabel": "" }, { "id": "U92byU7zDBvCzipwQ9Nfw", "language": "502", "code": "{\n \"success\": \"false\",\n \"errors\": {\n \"code\": \"502\",\n \"message\": \"Bad Gateway\"\n }\n}", "customLabel": "" }, { "id": "8wi-3FsHgYnV321nrnH1O", "language": "503", "code": "{\n \"success\": \"false\",\n \"errors\": {\n \"code\": \"503\",\n \"message\": \"Service Unavailable\"\n }\n}", "customLabel": "" }, { "id": "8LCWXOCrIVwVtJ7IRQAn0", "language": "504", "code": "{\n \"success\": \"false\",\n \"errors\": {\n \"code\": \"504\",\n \"message\": \"Gateway Timeout\"\n }\n}", "customLabel": "" }, { "id": "cRIe5o0CFLqXvyq6BkLeb", "language": "100", "code": "", "customLabel": "" } ], "selectedLanguageId": "alwbPZnGJtK-lve90-1fx" }, "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [], "bodyDataParameters": [ { "name": "share_secret", "kind": "required", "type": "string", "description": "Test mode secret keys and live mode secret keys are available in your PayDocker account under Integration menu.\n\nDon't share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth." }, { "name": "booking_event", "kind": "required", "type": "string", "description": "Used to identify the action connected to the booking and the allowed action for this request would be \"new\".", "children": [] }, { "name": "source_id", "kind": "required", "type": "string", "description": "Your PayDocker Account ID assigned upon account creation (e.g. PDR1). It is case sensitive.", "children": [] }, { "name": "buyer_id", "kind": "optional", "type": "string", "description": "Buyer ID (e.g. ID 001) generated in your platform. It represents the account that has performed the purchase in your platform. ", "children": [] }, { "name": "booking_id", "kind": "required", "type": "string", "description": "Used to identify the Booking ID. \nMaximum 150 characters allowed.", "children": [] }, { "name": "booking_date", "kind": "required", "type": "string", "description": "The format is DD-MM- YYYY e.g. 25-12-2023\n\nAllowed date range is same or lower than import date\nE.g. Import Date - 18 Oct 2023, Booking Date could be 18 Oct 2023 or lower", "children": [] }, { "name": "booking_category", "kind": "required", "type": "string", "description": "Used to identify the category connected to the booking and the allowed categories are \nPayable \nReceivable", "children": [] }, { "name": "supplier_id", "kind": "required", "type": "string", "description": "Supplier ID (e.g. ID 001) generated in your platform\nMaximum 150 characters allowed.", "children": [] }, { "name": "property_name", "kind": "required", "type": "string", "description": "Used to identify the property name associated within the booking . \nMaximum 80 characters allowed.", "children": [] }, { "name": "property_country", "kind": "required", "type": "string", "description": "Country ID ISO 3166-1 alpha-3 codes standard format associated within the token value.\nCountry ID ISO 3166-1 alpha-3 codes are available in API Reference --> Standard Codes --> Country Code ", "children": [] }, { "name": "guests_count", "kind": "required", "type": "Number", "description": "Used to identify the number of guests associated within the booking . \nOnly number accepted\nMin. value is 1 \nMax value is 99", "children": [] }, { "name": "room_count", "kind": "required", "type": "Number", "description": "Used to identify the number of room associated within the booking.\nOnly number accepted\nMin. value is 1 \nMax value is 99", "children": [] }, { "name": "check_in", "kind": "required", "type": "string", "description": "The format is DD-MM- YYYY e.g. 25-12-2023\n\nSelectable date range is from the booking date up to 2 years in the future. The check_in date cannot be later than the check_out date.\n", "children": [] }, { "name": "check_out", "kind": "required", "type": "string", "description": "The format is DD-MM- YYYY e.g. 25-12-2023\n\nSelectable date range is from the check_in date up to 180 days in the future. The check_out date cannot be before the check_in date.\n", "children": [] }, { "name": "transaction_currency", "kind": "required", "type": "string", "description": "Currency ID ISO 4217 standard format associated within the token value.\nSupported currency and ISO code are available in API Reference --> Standard Codes --> Currency Code ", "children": [] }, { "name": "transaction_amount", "kind": "required", "type": "string", "description": "Used to identify the total booking amount.\n\nMinimum accepted value is 0.00\nMax accepted value is 9,999,999,999.00\n \nThe amount value supports up to twelve digits (e.g. a value of 9,999,999,999.99) divided by decimal. ", "children": [] }, { "name": "margin_category", "kind": "required", "type": "string", "description": "Used to identify the margin category connected to the booking and the allowed categories are \n$\n%", "children": [] }, { "name": "transaction_margin", "kind": "required", "type": "string", "description": "Used to identify the transaction margin value connected to the booking.\n\nIf margin_category is $ \nMinimum accepted value is 1.00 \nMax accepted value is 9,999,999,999.00\n \nThe amount value supports up to twelve digits (e.g. a value of 9,999,999,999.99) divided by decimal. \n\n--------- \nIf margin_category is % \nMinimum accepted value is 0.01 \nMax accepted value is 99.99 \n \nThe amount value supports up to four digits (e.g. a value of 99.99) ", "children": [] }, { "name": "nonrefundable_amount", "kind": "required", "type": "string", "description": "Used to identify the non refundable amount.\n\nMinimum accepted value is 0.00\nMax accepted value is the amount set at transaction_amount \n \nThe amount value supports up to eleven digits (e.g. a value of 999,999,999.99) divided by decimal. \n\nThe sum between nonrefundable_amount and refundable_amount must be equal to transaction_amount", "children": [] }, { "name": "refundable_amount", "kind": "required", "type": "string", "description": "Used to identify the refundable amount.\n\nMinimum accepted value is 0.00\nMax accepted value is the amount set at transaction_amount \n \nThe amount value supports up to twelve digits (e.g. a value of 9,999,999,999.99) divided by decimal. \n\nThe sum between nonrefundable_amount and refundable_amount must be equal to transaction_amount", "children": [] }, { "name": "firstnight_amount", "kind": "required", "type": "string", "description": "Used to identify the first night amount.\n\nMinimum accepted value is 0.00\nMax accepted value is the amount set at transaction_amount \n \nThe amount value supports up to twelve digits (e.g. a value of 9,999,999,999.99) divided by decimal. ", "children": [] }, { "name": "cancellation_days", "kind": "required", "type": "Number", "description": "Used to identify the cancellation days for the refundable_amount.\n\nIf the refundable_amount is 0, cancellation_days can be left empty.\n\nIf the refundable_amount is greater than 0, cancellation_days must be specified, with a value between 0 and 365. \n\n", "children": [] }, { "name": "auth_code", "kind": "optional", "type": "string", "description": "The auth_code is required only when the value set in the buyer_id is not empty.\n\nIf the buyer_id has added your account as trusted, the value for auth_code should be set to \"trusted\"\n\nIf your account is not trusted by the buyer_id, a 16-digit auth_code generated by the buyer_id is required to allow your account to perform operations on the buyer_id balances.", "children": [] }, { "name": "pre_auth", "kind": "optional", "type": "Boolean", "description": "The pre_auth setting allows your account to generate tokens and schedule top-ups for the buyer_id account.\n\npre_auth is required only when the buyer_id is not empty.\n\nIf the buyer_id is empty, pre_auth can also be left empty.\n\nIf the buyer_id is not empty, pre_auth must be set to one of the following values:\ntrue\nfalse", "children": [] } ], "formDataParameters": [] }, "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "response": [] } ``` :::