Check Health Status API

The Check Health Status API can be used to check the working status of the PayU server.

Environment

Test Environmenthttps://bbps-sb.payu.in .
Production EnvironmentContact your Account Manager to get access to the production environment

📘

Note:

Send the scope of the GET Token API as check_health_status to obtain the access_token for this request.

Sample request
curl --location --request POST 'https://<hostName>/payu-nbc/v1/nbc/heartBeat?agentId={agentId}&refId={refId}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>'
Response parameters
Field NameDescription
codeThe global response code and can be any of the following:

- 0: If web service call failed
- 1: if web service call succeeded
statusThe status of the API command and can be any of the following:

- SUCCESS
- FAILURE
payloadIt will contain a list of biller categories. For more information, refer to the payload table.
If the transaction had failed, it will contain:

- additional data related to transactions
- List of errors which caused failure transactions

payload

ParamaterDescription
statusThis parameter can contain any of the following:

- UP
- DOWN
typeThis field contains the the type of request.
refIdThis field contains the reference ID received in request from the agent.
payuIdIt will be payU system ID and it will be unique every time.
messageFor failure scenario, this field contains the message as heart_beat_failure.
errorsFor failure scenario, the errors are displayed in an array format.
Sample response

Success scenario

{
  "code": 200,
  "status": "SUCCESS",
  "payload": {
    "refId": "<refId>",
    "status": "UP",
    "payuId": "<payUSytemId>"
  }
}

Failure scenario

{
  "code": 600,
  "status": "FAILURE",
  "payload": {
    "errors": [
      {
        "reason": "<error reason>",
        "errorCode": "<error code>"
      }
    ],
    "refId": "<refId>",
    "type": "heart_beat",
    "message": "heart_beat_failed",
    "additionalParams": null
  }
}

Request parameters

Language
Authorization
Bearer
Click Try It! to start a request and see the response here!