Fulfillment Callback

Fulfillment Callback

We will provide a callback to the requested URL once the recharge reaches the final state. Partners need to provide the URL during the integration process. It is advised to provide different URLs for UAT(sandbox) and Production environments.

Example URL from Partner

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

"https://partnerserver.com/recharge/callback" 

Expected Request Body From Nuclei

Request Body Param	Data Type	Mandatory?	Size
referenceId	String	Yes	Min = 10, Max = 40
orderId	String	Yes	Min = 10, Max = 40
status	String	No	SUCCESS/FAILURE

Sample Request

{
  "referenceId": "N-1234-5678",
  "orderId": "N-13K30DD-AJ2L39F-32RM1S6"
  "status": "SUCCESS" or  "FAILURE"
}

Sample Response

Success Status Code: 200

{
  "message": "SUCCESS"
}

Response Body Param	Data Type	Mandatory	Size
message	String	No	Min = 7, Max = 20

Details

1. We will send a callback if a particular recharge reaches its final state
       a. SUCCESS     b. FAILURE

2. The partner has to provide the URL allowing the POST method where we will send the recharge status.

3. Additionally, we are also providing a fulfillment status API where partners can poll for the latest recharge status, explained in the next section.