Fulfillment API

Fulfillment API

Method: POST
Headers:
    Content-Type: application/json
    API-Key: (api key shared with the partner)

Request

Request Body Param	Data Type	Mandatory?	Size
mobileNumber	String	Yes	Min = 10, Max = 10
operatorCode	String	Yes	Max = 5
circleCode	String	Yes	Max = 5
amount	Number	Yes	Positive: Max = 10000 Rs
referenceId	String	Yes	Min = 10, Max = 50
userUid	String	Yes	Min = 25, Max = 35
channelId	String	Yes	Max = 10

Sample Request

{
  "mobileNumber": "9663042234",
  "operatorCode": "1",
  "circleCode": "10",
  "amount": 719,
  "referenceId": "N-1234-5678",
  "userUid": "15WWejw5pc2sdfnV",
  "channelId": "CIB/RIB",
}

Sample Response

Success Status Code : 200

{
  "orderId": "N-13K30DD-AJ2L39F-32RM1S6"
}

Response Body Param	Data Type	Size
orderId	String	Min = 10, Max = 40

Details

1. ReferenceId will be used in order to uniquely identify a request. This will be stored at our end and will filter out duplicate requests using the same referenceId.
2. OrderId is the unique Id generated at Nuclei’s end. This can be stored by partners for future reference.
3. This API will only give confirmation that the fulfillment process started successfully. For the latest status, partner needs to call the fulfillment status API
4. This API will validate that the given plan amount belongs to the given operator, else it will throw the proper errors.