Cancel

Cancel an order

Overview

The BAP will send the order id to cancel the order

Request

URL

/cancel

Method

POST

Request Body Schema

Request Body Example

{
    "context": {
        "domain": "nic2004:55204",
        "country": "IND",
        "city": "std:080",
        "action": "cancel",
        "core_version": "0.9.1",
        "bap_id": "https://mock_bap.com/",
        "bap_uri": "https://mock_bap.com/beckn/",
        "bpp_id": "https://mock_bpp.com/",
        "bpp_uri": "https://mock_bpp.com/beckn/",
        "transaction_id": "1209849124",
        "message_id": "1234124234237",
        "timestamp": "2021-03-23T10:00:40.065Z"
    },
    "message": {
        "order_id": "order_1",
        "cancellation_reason_id": "reason_3"
    }
}

Here the BAP is sending the order id order_1 and a cancellation_reason_id reason_3 to the BPP to cancel the order.

Response

Response Body Schema

Response Body Example

{
  "message": {
    "ack": {
      "status": "ACK"
    }
  }
}

Acknowledgement response

Response Codes