Applying an offer on a mobility service and sending discounted fare (Java)
In this use case, the user applies an offer on a mobility service and receives a discounted fare
Code snippets
BPP receives protocol select
/*
Example Request JSON:
{
"context": {
"domain": "nic2004:60221",
"country": "IND",
"city": "std:080",
"action": "select",
"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": "12341242343",
"timestamp": "2021-03-23T10:00:40.065Z"
},
"message": {
"order": {
"offers":[
{
"id": "offer_10"
}
]
}
}
}
*/
// BPP Select endpoint
@PostMapping("/bpp/select")
public ResponseEntity select(
@RequestHeader HttpHeaders headers,
@RequestBody SelectRequest request) {
var response = bppApplicationService.select(request, headers);
return ResponseEntity.ok(response);
}
BPP processes the select
public Response select(SelectRequest request, HttpHeaders headers) {
var selectResponse = new OnSelectRequest();
// Validate the headers
var isHeadersValid = validateHeaders(headers);
// Construct and return error
if (!isHeadersValid) return null;
// Fetch the data based on the request
var requestIntent = request.getMessage().getOrder();
// Execute business logic here
// Generate the response
selectResponse = generateSelectResponse(selectResult);
//invoke on_select api
return invokeOnSelect(selectResponse, headers);
}
}
BPP generates response
/*
Example Response JSON:
{
"context": {
"domain": "nic2004:60221",
"country": "IND",
"city": "std:080",
"action": "on_select",
"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": "12341242343",
"timestamp": "2021-03-23T10:00:40.065Z"
},
"message": {
"order": {
"provider": {
"id": "yellow-cabs",
"locations": [
{
"id": "closest-sedan-spot",
"gps": "12.9349377,77.6055586"
}
]
},
"items": [
{
"id": "sedan_spot",
"price" : {
"currency": "INR",
"value": "170"
},
"time": {
"label": "ETA",
"duration": "P13M"
},
"location_id": "closest-sedan-spot",
"quantity": {
"selected": {
"count": 1
},
"available": {
"count": 4
}
}
}
],
"offers":[
{
"id": "offer_10"
}
],
"quote": {
"price": {
"currency": "INR",
"value": "160"
},
"breakup": [
{
"title": "Sedan Spot Booking",
"price": {
"currency": "INR",
"value": "170"
}
},
{
"title": "Service Charge",
"price": {
"currency": "INR",
"value": "10"
}
},
{
"title": "20 rupees off",
"price": {
"currency": "INR",
"value": "-20"
}
}
]
}
}
}
}
*/
public OnSelectRequest generateSelectResponse(List selectedResults) {
var selectResult = SelectResponseBuilder.builder.result(selectedResults).build();
// Convert response into protocol object similar to example above
return selectResult;
}
BPP calls protocol on_select
public Response invokeOnSelect(OnSelectRequest selectResponse, HttpHeaders headers) {
if(selectResponse.getError() == null) {
// Call BAP on_select api with the select response
// Call to look up function which returns the the public key and BAP/BG Endpoint to be called
var url = lookUp(headers);
var response = apiClient.post(url[0] + Context.ActionEnum.on_select,
constructResponseHeaders(),
selectResponse,
OnSelectRequest.class);
return Response.of("ACK", null);
} else {
return Response.of("NACK", null);
}
}