Modify Booking

1 min

Modify Booking

This API allow to Modify previous created booking in your PayDocker account

PATCH

https://api.paydocker.com/{version}/booking/{partnerid}/{randomkey}

Body Parameters

share_secretstringrequired
Description
Test mode secret keys and live mode secret keys are available in your PayDocker account under Integration menu. Don't share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
booking_eventstringrequired
Description
Used to identify the action connected to the booking and the allowed action for this request would be "modify".
source_idstringrequired
Description
Your PayDocker Account ID assigned upon account creation (e.g. PDR1). It is case sensitive.
buyer_idstring
Description
Buyer ID (e.g. ID 001) generated in your platform. It represents the account that has performed the purchase in your platform.
booking_idstringrequired
Description
The unique identifier associated with the booking for which the user is requesting a modification (e.g., 4255435435435435).
booking_datestringrequired
Description
The format is DD-MM- YYYY e.g. 25-12-2023 Allowed date range is same or lower than import date E.g. Import Date - 18 Oct 2023, Booking Date could be 18 Oct 2023 or lower
booking_categorystringrequired
Description
Used to identify the category connected to the booking and the allowed categories are Payable Receivable
supplier_idstringrequired
Description
Supplier ID (e.g. ID 001) generated in your platform Maximum 150 characters allowed.
property_namestringrequired
Description
Used to identify the property name associated within the booking . Maximum 80 characters allowed.
property_countryStringrequired
Description
Country ID ISO 3166-1 alpha-3 codes standard format associated within the token value. Country ID ISO 3166-1 alpha-3 codes are available in API Reference --> Standard Codes --> Country Code
guests_countNumberrequired
Description
Used to identify the number of guests associated within the booking . Only number accepted Min. value is 1 Max value is 99
room_countNumberrequired
Description
Used to identify the number of room associated within the booking. Only number accepted Min. value is 1 Max value is 99
check_instringrequired
Description
The format is DD-MM- YYYY e.g. 25-12-2023 Selectable 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.
check_outstringrequired
Description
The format is DD-MM- YYYY e.g. 25-12-2023 Selectable 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.
transaction_currencystringrequired
Description
Currency ID ISO 4217 standard format associated within the token value. Supported currency and ISO code are available in API Reference --> Standard Codes --> Currency Code
transaction_amountstringrequired
Description
Used to identify the total booking amount. Minimum accepted value is 0.00 Max accepted value is 9,999,999,999.00 The amount value supports up to twelve digits (e.g. a value of 9,999,999,999.99) divided by decimal.
margin_categorystringrequired
Description
Used to identify the margin category connected to the booking and the allowed categories are $ %
transaction_marginstringrequired
Description
Used to identify the transaction margin value connected to the booking. If margin_category is $ Minimum accepted value is 1.00 Max accepted value is 9,999,999,999.00 The amount value supports up to twelve digits (e.g. a value of 9,999,999,999.99) divided by decimal. --------- If margin_category is % Minimum accepted value is 0.01 Max accepted value is 99.99 The amount value supports up to four digits (e.g. a value of 99.99)
nonrefundable_amountstringrequired
Description
Used to identify the non refundable amount. Minimum accepted value is 0.00 Max accepted value is the amount set at transaction_amount The amount value supports up to twelve digits (e.g. a value of 9,999,999,999.99) divided by decimal. The sum between nonrefundable_amount and refundable_amount must be equal to transaction_amount
refundable_amountstringrequired
Description
Used to identify the refundable amount. Minimum accepted value is 0.00 Max accepted value is the amount set at transaction_amount The amount value supports up to twelve digits (e.g. a value of 9,999,999,999.99) divided by decimal. The sum between nonrefundable_amount and refundable_amount must be equal to transaction_amount
firstnight_amountstringrequired
Description
Used to identify the first night amount. Minimum accepted value is 0.00 Max accepted value is the amount set at transaction_amount The amount value supports up to twelve digits (e.g. a value of 9,999,999,999.99) divided by decimal.
cancellation_daysNumberrequired
Description
Used to identify the cancellation days for the refundable_amount. If the refundable_amount is 0, cancellation_days can be left empty. If the refundable_amount is greater than 0, cancellation_days must be specified, with a value between 0 and 365.
auth_codestring
Description
The auth_code is required only when the value set in the buyer_id is not empty. If the buyer_id has added your account as trusted, the value for auth_code should be set to "trusted" If 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.
pre_authBoolean
Description
The pre_auth setting allows your account to generate tokens and schedule top-ups for the buyer_id account. pre_auth is required only when the buyer_id is not empty. If the buyer_id is empty, pre_auth can also be left empty. If the buyer_id is not empty, pre_auth must be set to one of the following values: true false

json

{
  "share_secret": "EVBZIHZhKqsPoopQ4GW7uceHQz4yIEdGB1JjNJyUJmvp77xj1lInlilZc5LkZgA8IllRRDLZTaaftmUwT3WapIRHP67VAskyJOjybSH03RdDXVXPhAcCH00l3dKYqCJjsqikrnpsy0B7WonvWWpK5mz",
  "booking_event": "modify",
  "source_id": "PDR28",
  "buyer_id": "",
  "booking_id": "1396",
  "booking_date": "21-01-2024",
  "booking_category": "Payable",
  "supplier_id": "PD01",
  "property_name": "Roy",
  "property_country": "IN",
  "guests_count": "45",
  "room_count": "12",
  "check_in": "20-01-2024",
  "check_out": "22-01-2024",
  "transaction_currency": "INR",
  "transaction_amount": "100.00",
  "margin_category": "%",
  "transaction_margin": "1",
  "nonrefundable_amount": "0.00",
  "refundable_amount": "0.00",
  "firstnight_amount": "10.00",
  "cancellation_days": "0",
  "auth_code":"trusted",
  "pre_auth":"true"
}

javascript

var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
  "share_secret": "EVBZIHZhKqsPoopQ4GW7uceHQz4yIEdGB1JjNJyUJmvp77xj1lInlilZc5LkZgA8IllRRDLZTaaftmUwT3WapIRHP67VAskyJOjybSH03RdDXVXPhAcCH00l3dKYqCJjsqikrnpsy0B7WonvWWpK5mz",
  "booking_event": "modify",
  "source_id": "PDR28",
  "buyer_id": "",
  "booking_id": "1396",
  "booking_date": "21-01-2024",
  "booking_category": "Payable",
  "supplier_id": "PD01",
  "property_name": "Roy",
  "property_country": "IN",
  "guests_count": "45",
  "room_count": "12",
  "check_in": "20-01-2024",
  "check_out": "22-01-2024",
  "transaction_currency": "INR",
  "transaction_amount": "100.00",
  "margin_category": "%",
  "transaction_margin": "1",
  "nonrefundable_amount": "0.00",
  "refundable_amount": "0.00",
  "firstnight_amount": "10.00",
  "cancellation_days": "0",
  "auth_code":"trusted",
  "pre_auth":"true"
});

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.cakes.com", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

curl

curl --location --globoff --request PATCH 'https://api.paydocker.com/{version}/booking/{partnerid}/{randomkey}/modify' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{"id":"string","Parameter name":"string"}'

nodejs

var request = require('request');
var options = {
   'method': 'PATCH',
   'url': 'https://api.paydocker.com/{version}/booking/{partnerid}/{randomkey}/modify',
   'headers': {
      'Accept': 'application/json',
      'Content-Type': 'application/json'
   },
   body: JSON.stringify({
  "share_secret": "EVBZIHZhKqsPoopQ4GW7uceHQz4yIEdGB1JjNJyUJmvp77xj1lInlilZc5LkZgA8IllRRDLZTaaftmUwT3WapIRHP67VAskyJOjybSH03RdDXVXPhAcCH00l3dKYqCJjsqikrnpsy0B7WonvWWpK5mz",
  "booking_event": "modify",
  "source_id": "PDR28",
  "buyer_id": "",
  "booking_id": "1396",
  "booking_date": "21-01-2024",
  "booking_category": "Payable",
  "supplier_id": "PD01",
  "property_name": "Roy",
  "property_country": "IN",
  "guests_count": "45",
  "room_count": "12",
  "check_in": "20-01-2024",
  "check_out": "22-01-2024",
  "transaction_currency": "INR",
  "transaction_amount": "100.00",
  "margin_category": "%",
  "transaction_margin": "1",
  "nonrefundable_amount": "0.00",
  "refundable_amount": "0.00",
  "firstnight_amount": "10.00",
  "cancellation_days": "0",
  "auth_code":"trusted",
  "pre_auth":"true"
})

};
request(options, function (error, response) {
   if (error) throw new Error(error);
   console.log(response.body);
});

200

{
  "success": true,
  "message": "Booking Modify Success",
  "booking_id": "4255435435435435",

}

400

{
  "success": "false",
  "errors": {
    "code": "400",
    "message": "Booking ID Not Found"
  }
}

402

{
  "success": "false",
  "errors": {
    "code": "402",
    "message": "Source Not Allowed"
  }
}

405

{
  "success": "false",
  "errors": {
    "code": "405",
    "message": "Method Not Allowed"
  }
}

407

{
  "success": "false",
  "errors": {
    "code": "407",
    "message": "Partner Inactive"
  }
}

413

{
  "success": "false",
  "errors": {
    "code": "413",
    "message": "Destination ID Unknown"
  }
}

414

{
  "success": "false",
  "errors": {
    "code": "414",
    "message": "Destination ID Inactive"
  }
}

403

{
  "success": "false",
  "errors": {
    "code": "403",
    "message": "IP Not Allowed"
  }
}

404

{
  "success": "false",
  "errors": {
    "code": "404",
    "message": "Booking ID Quota Exceeded"
  }
}

406

{
  "success": "false",
  "errors": {
    "code": "406",
    "message": "Endpoint Bad Format"
  }
}

408

{
  "success": "false",
  "errors": {
    "code": "408",
    "message": "Endpoint Suspended"
  }
}

409

{
  "success": "false",
  "errors": {
    "code": "409",
    "message": "Event Not Allowed"
  }
}

410

{
  "success": "false",
  "errors": {
    "code": "410",
    "message": "Invalid Secret Key"
  }
}

411

{
  "success": "false",
  "errors": {
    "code": "411",
    "message": "Duplicated Booking ID"
  }
}

412

{
  "success": "false",
  "errors": {
    "code": "412",
    "message": "Missing Booking ID"
  }
}

415

{
  "success": "false",
  "errors": {
    "code": "415",
    "message": "Booking Date Bad Format"
  }
}

416

{
  "success": "false",
  "errors": {
    "code": "416",
    "message": "Booking Date Not Allowed"
  }
}

417

{
  "success": "false",
  "errors": {
    "code": "417",
    "message": "Missing Booking Category"
  }
}

418

{
  "success": "false",
  "errors": {
    "code": "418",
    "message": "Booking Category Bad Format"
  }
}

421

{
  "success": "false",
  "errors": {
    "code": "421",
    "message": "Missing Destination Name"
  }
}

422

{
  "success": "false",
  "errors": {
    "code": "422",
    "message": "Destination Name Quota Exceeded"
  }
}

423

{
  "success": "false",
  "errors": {
    "code": "423",
    "message": "Missing Guests Count"
  }
}

424

{
  "success": "false",
  "errors": {
    "code": "424",
    "message": "Guests Count Bad Format"
  }
}

425

{
  "success": "false",
  "errors": {
    "code": "425",
    "message": "Missing Check-in Date"
  }
}

426

{
  "success": "false",
  "errors": {
    "code": "426",
    "message": "Check-in Date Bad Format"
  }
}

428

{
  "success": "false",
  "errors": {
    "code": "428",
    "message": "Check-in Date Quota Exceeded"
  }
}

429

{
  "success": "false",
  "errors": {
    "code": "429",
    "message": "Missing Check-out Date"
  }
}

431

{
  "success": "false",
  "errors": {
    "code": "431",
    "message": "Check-out Date Not Allowed"
  }
}

451

{
  "success": "false",
  "errors": {
    "code": "451",
    "message": "Refundable Amount Bad Format"
  }
}

500

{
  "success": "false",
  "errors": {
    "code": "500",
    "message": "Internal Server Error"
  }
}

502

{
  "success": "false",
  "errors": {
    "code": "502",
    "message": "Bad Gateway"
  }
}

503

{
  "success": "false",
  "errors": {
    "code": "503",
    "message": "Service Unavailable"
  }
}

504

{
  "success": "false",
  "errors": {
    "code": "504",
    "message": "Gateway Timeout"
  }
}