This endpoint is used to get the health status of the fintech. Once this request comes back with a 200 http status code, it is assumed that the financial institution is up and available to process transactions
Response atrributes
Attribute | Type | Description | Required |
---|---|---|---|
status | String | The status of the financial institution. | True |
Sample requests
The sample requests for the enquiry only covers for 3 scenarios. It should be noted that the difference with a response from the other is just the response code. The response code table in section 4.0 can be used to know the response code that can be used for other scenarios that might not be covered in the sample requests.
Successful
Request
GET /health |
Response
{ "status" : "up" } |