# Cancel booking URL: https://docs.emergingtravel.com/docs/affiliate-api/post-booking/cancel-booking/ Tags: affiliate --- **Sandbox** ``` https://api-sandbox.worldota.net/api/b2b/v3/hotel/order/cancel/ ``` **Production** ``` https://api.worldota.net/api/b2b/v3/hotel/order/cancel/ ``` > [!NOTE] > This call is required for the bookings made for the [test hotel](/docs/fundamentals/authorization/#sandbox-environment). The call allows to cancel only successfully confirmed orders. > [!WARNING] > When canceling a non-refundable booking, penalties will be real. ## Sandbox limitations { #limitations } * Making the call is not required. * When canceling a non-refundable booking, penalties are not actually applied. * For any object containing the `currency_code` field, its value is always set to `EUR`. ## Request example **Sandbox** ```shell curl --user ':' 'https://api-sandbox.worldota.net/api/b2b/v3/hotel/order/cancel/' \ --header 'Content-Type: application/json' \ --data '{ "partner_order_id": "0b370500-5321-4046-92c5-5982f1a64fc6" }' ``` **Production** ```shell curl --user ':' 'https://api.worldota.net/api/b2b/v3/hotel/order/cancel/' \ --header 'Content-Type: application/json' \ --data '{ "partner_order_id": "0b370500-5321-4046-92c5-5982f1a64fc6" }' ``` ## Request body - **partner_order_id** *(String, required)*

The external booking ID in the [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format.

The ID remains the same if you cancel a booking that:

  • Is successful.
  • Is failed.
  • Has the fail status response from the [Check booking process](/docs/affiliate-api/booking/check-booking-process/) call.

Use this field value for the rest of the booking calls.

> [!NOTE] > * The value should be unique for the order within the same contact. > * The minimum length is `3` character. > * The maximum length is `256` characters. ## Response [//]: # (amount_payable) - **amount_payable** *(Object)*

The cancellation fee amount.

  • amount (String)

    The cancellation fee amount.

  • currency_code (String)

    The amount currency code in the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format.

    [!NOTE]

    • The length is 3 characters.
    • The possible values:
      • AED.
      • AFN.
      • ALL.
      • AMD.
      • ANG.
      • AOA.
      • ARS.
      • AUD.
      • AWG.
      • AZN.
      • BAM.
      • BBD.
      • BDT.
      • BGN.
      • BHD.
      • BIF.
      • BMD.
      • BND.
      • BOB.
      • BOV.
      • BRL.
      • BSD.
      • BTN.
      • BWP.
      • BYR.
      • BYN.
      • BZD.
      • CAD.
      • CDF.
      • CHE.
      • CHF.
      • CHW.
      • CLF.
      • CLP.
      • CNY.
      • COP.
      • COU.
      • CRC.
      • CUC.
      • CUP.
      • CVE.
      • CZK.
      • DJF.
      • DKK.
      • DOP.
      • DZD.
      • EGP.
      • ERN.
      • ETB.
      • EUR.
      • FJD.
      • FKP.
      • GBP.
      • GEL.
      • GHS.
      • GIP.
      • GMD.
      • GNF.
      • GTQ.
      • GYD.
      • HKD.
      • HNL.
      • HRK.
      • HTG.
      • HUF.
      • IDR.
      • ILS.
      • INR.
      • IQD.
      • IRR.
      • ISK.
      • JMD.
      • JOD.
      • JPY.
      • KES.
      • KGS.
      • KHR.
      • KMF.
      • KPW.
      • KRW.
      • KWD.
      • KYD.
      • KZT.
      • LAK.
      • LBP.
      • LKR.
      • LRD.
      • LSL.
      • LTL.
      • LVL.
      • LYD.
      • MAD.
      • MDL.
      • MGA.
      • MKD.
      • MMK.
      • MNT.
      • MOP.
      • MRO.
      • MUR.
      • MVR.
      • MWK.
      • MXN.
      • MXV.
      • MYR.
      • MZN.
      • NAD.
      • NGN.
      • NIO.
      • NOK.
      • NPR.
      • NZD.
      • OMR.
      • PAB.
      • PEN.
      • PGK.
      • PHP.
      • PKR.
      • PLN.
      • PYG.
      • QAR.
      • RON.
      • RSD.
      • RUB.
      • RWF.
      • SAR.
      • SBD.
      • SCR.
      • SDG.
      • SEK.
      • SGD.
      • SHP.
      • SLL.
      • SOS.
      • SRD.
      • SSP.
      • STD.
      • SVC.
      • SYP.
      • SZL.
      • THB.
      • TJS.
      • TMT.
      • TND.
      • TOP.
      • TRY.
      • TTD.
      • TWD.
      • TZS.
      • UAH.
      • UGX.
      • USD.
      • USN.
      • USS.
      • UYI.
      • UYU.
      • UZS.
      • VEF.
      • VND.
      • VUV.
      • WST.
      • XAF.
      • XAG.
      • XAU.
      • XBA.
      • XBB.
      • XBC.
      • XBD.
      • XCD.
      • XDR.
      • XFU.
      • XOF.
      • XPD.
      • XPF.
      • XPT.
      • XSU.
      • XTS.
      • XUA.
      • YER.
      • ZAR.
      • ZMW.
      • ZWL.

  • amount_info (Object)

    The cancellation information.

    Has the null value if the commission type has the net or gross value.

    Has the object value if you:

    • Have a net commission model.
    • Have indicated a non-zero commission in your account.

    • amount_commission (String)

      The commission amount.

    • amount_gross (String)

      The gross price.

    • amount_net (String)

      The net price.

[//]: # (amount_refunded) - **amount_refunded** *(Object)*

The cancellation refunded amount.

  • amount (String)

    The cancellation refunded amount.

  • currency_code (String)

    The amount currency code in the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format.

    [!NOTE]

    • The length is 3 characters.
    • The possible values:
      • AED.
      • AFN.
      • ALL.
      • AMD.
      • ANG.
      • AOA.
      • ARS.
      • AUD.
      • AWG.
      • AZN.
      • BAM.
      • BBD.
      • BDT.
      • BGN.
      • BHD.
      • BIF.
      • BMD.
      • BND.
      • BOB.
      • BOV.
      • BRL.
      • BSD.
      • BTN.
      • BWP.
      • BYR.
      • BYN.
      • BZD.
      • CAD.
      • CDF.
      • CHE.
      • CHF.
      • CHW.
      • CLF.
      • CLP.
      • CNY.
      • COP.
      • COU.
      • CRC.
      • CUC.
      • CUP.
      • CVE.
      • CZK.
      • DJF.
      • DKK.
      • DOP.
      • DZD.
      • EGP.
      • ERN.
      • ETB.
      • EUR.
      • FJD.
      • FKP.
      • GBP.
      • GEL.
      • GHS.
      • GIP.
      • GMD.
      • GNF.
      • GTQ.
      • GYD.
      • HKD.
      • HNL.
      • HRK.
      • HTG.
      • HUF.
      • IDR.
      • ILS.
      • INR.
      • IQD.
      • IRR.
      • ISK.
      • JMD.
      • JOD.
      • JPY.
      • KES.
      • KGS.
      • KHR.
      • KMF.
      • KPW.
      • KRW.
      • KWD.
      • KYD.
      • KZT.
      • LAK.
      • LBP.
      • LKR.
      • LRD.
      • LSL.
      • LTL.
      • LVL.
      • LYD.
      • MAD.
      • MDL.
      • MGA.
      • MKD.
      • MMK.
      • MNT.
      • MOP.
      • MRO.
      • MUR.
      • MVR.
      • MWK.
      • MXN.
      • MXV.
      • MYR.
      • MZN.
      • NAD.
      • NGN.
      • NIO.
      • NOK.
      • NPR.
      • NZD.
      • OMR.
      • PAB.
      • PEN.
      • PGK.
      • PHP.
      • PKR.
      • PLN.
      • PYG.
      • QAR.
      • RON.
      • RSD.
      • RUB.
      • RWF.
      • SAR.
      • SBD.
      • SCR.
      • SDG.
      • SEK.
      • SGD.
      • SHP.
      • SLL.
      • SOS.
      • SRD.
      • SSP.
      • STD.
      • SVC.
      • SYP.
      • SZL.
      • THB.
      • TJS.
      • TMT.
      • TND.
      • TOP.
      • TRY.
      • TTD.
      • TWD.
      • TZS.
      • UAH.
      • UGX.
      • USD.
      • USN.
      • USS.
      • UYI.
      • UYU.
      • UZS.
      • VEF.
      • VND.
      • VUV.
      • WST.
      • XAF.
      • XAG.
      • XAU.
      • XBA.
      • XBB.
      • XBC.
      • XBD.
      • XCD.
      • XDR.
      • XFU.
      • XOF.
      • XPD.
      • XPF.
      • XPT.
      • XSU.
      • XTS.
      • XUA.
      • YER.
      • ZAR.
      • ZMW.
      • ZWL.

  • amount_info (Object)

    The cancellation information.

    Has the null value if the commission type has the net or gross value.

    Has the object value if you:

    • Have a net commission model.
    • Have indicated a non-zero commission in your account.

    • amount_commission (String)

      The commission amount.

    • amount_gross (String)

      The gross price.

    • amount_net (String)

      The net price.

[//]: # (amount_sell) - **amount_sell** *(Object)*

The booking amount.

  • amount (String)

    The booking amount.

  • currency_code (String)

    The amount currency code in the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format.

    [!NOTE]

    • The length is 3 characters.
    • The possible values:
      • AED.
      • AFN.
      • ALL.
      • AMD.
      • ANG.
      • AOA.
      • ARS.
      • AUD.
      • AWG.
      • AZN.
      • BAM.
      • BBD.
      • BDT.
      • BGN.
      • BHD.
      • BIF.
      • BMD.
      • BND.
      • BOB.
      • BOV.
      • BRL.
      • BSD.
      • BTN.
      • BWP.
      • BYR.
      • BYN.
      • BZD.
      • CAD.
      • CDF.
      • CHE.
      • CHF.
      • CHW.
      • CLF.
      • CLP.
      • CNY.
      • COP.
      • COU.
      • CRC.
      • CUC.
      • CUP.
      • CVE.
      • CZK.
      • DJF.
      • DKK.
      • DOP.
      • DZD.
      • EGP.
      • ERN.
      • ETB.
      • EUR.
      • FJD.
      • FKP.
      • GBP.
      • GEL.
      • GHS.
      • GIP.
      • GMD.
      • GNF.
      • GTQ.
      • GYD.
      • HKD.
      • HNL.
      • HRK.
      • HTG.
      • HUF.
      • IDR.
      • ILS.
      • INR.
      • IQD.
      • IRR.
      • ISK.
      • JMD.
      • JOD.
      • JPY.
      • KES.
      • KGS.
      • KHR.
      • KMF.
      • KPW.
      • KRW.
      • KWD.
      • KYD.
      • KZT.
      • LAK.
      • LBP.
      • LKR.
      • LRD.
      • LSL.
      • LTL.
      • LVL.
      • LYD.
      • MAD.
      • MDL.
      • MGA.
      • MKD.
      • MMK.
      • MNT.
      • MOP.
      • MRO.
      • MUR.
      • MVR.
      • MWK.
      • MXN.
      • MXV.
      • MYR.
      • MZN.
      • NAD.
      • NGN.
      • NIO.
      • NOK.
      • NPR.
      • NZD.
      • OMR.
      • PAB.
      • PEN.
      • PGK.
      • PHP.
      • PKR.
      • PLN.
      • PYG.
      • QAR.
      • RON.
      • RSD.
      • RUB.
      • RWF.
      • SAR.
      • SBD.
      • SCR.
      • SDG.
      • SEK.
      • SGD.
      • SHP.
      • SLL.
      • SOS.
      • SRD.
      • SSP.
      • STD.
      • SVC.
      • SYP.
      • SZL.
      • THB.
      • TJS.
      • TMT.
      • TND.
      • TOP.
      • TRY.
      • TTD.
      • TWD.
      • TZS.
      • UAH.
      • UGX.
      • USD.
      • USN.
      • USS.
      • UYI.
      • UYU.
      • UZS.
      • VEF.
      • VND.
      • VUV.
      • WST.
      • XAF.
      • XAG.
      • XAU.
      • XBA.
      • XBB.
      • XBC.
      • XBD.
      • XCD.
      • XDR.
      • XFU.
      • XOF.
      • XPD.
      • XPF.
      • XPT.
      • XSU.
      • XTS.
      • XUA.
      • YER.
      • ZAR.
      • ZMW.
      • ZWL.

  • amount_info (Object)

    The cancellation information.

    Has the null value if the commission type has the net or gross value.

    Has the object value if you:

    • Have a net commission model.
    • Have indicated a non-zero commission in your account.

    • amount_commission (String)

      The commission amount.

    • amount_gross (String)

      The gross price.

    • amount_net (String)

      The net price.

## Response example ```json { "data": { "amount_payable": { "amount": "42.73", "currency_code": "EUR" }, "amount_refunded": { "amount": "50.00", "currency_code": "EUR" }, "amount_sell": { "amount": "92.73", "currency_code": "EUR" } }, "error": null, "status": "ok" } ``` ## Errors The `error` field has the value specified in the headers below. ### `order_not_found` * The order is finished with other than the `completed` or `rejected` status. * The order with the `partner_order_id` field value isn’t found. ### `order_not_cancellable` * The stay period has already started. * You don’t have permission to cancel non-refundable bookings. Contact your account manager. ### `sandbox_restriction` An attempt to cancel the real hotel in the [test environment](/docs/glossary/#test-environment). * To cancel the real hotel, use the [production environment](/docs/glossary/#production-environment). * To cancel the test hotel, use the [test environment](/docs/glossary/#test-environment). ### `lock` This error occurs if requests for an endpoint meet both conditions: Several requests use the same partner_order_id field value. One request is sent twice within a short amount of time. ### `unknown` The error occurs if something else has gone wrong.