Rating

Provide feedback on a service.

Overview

The BAP will send the rating for a service to the BPP.

Request

URL

/rating

Method

POST

Request Body Schema

Field Type
context* ContextForRating
message.id string
message.value integer

Request Body Example

{
    "context": {
        "domain": "nic2004:60221",
        "country": "IND",
        "city": "std:080",
        "action": "rating",
        "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": "12341242345",
        "timestamp": "2021-03-23T10:00:40.065Z"
    },
    "message": {
        "id": "trip_1",
        "value": "4"
    }
}

Here the BAP sends a rating of 4 to the BPP for trip_1. The value is an integer between 1 and 5.

Response

Response Body Schema

Field Type
message* { Ack }
error Error

Response Body Example

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

Acknowldegement response

Response Codes

Code Description
200 Acknowledgement of message received
On this page