# Get Status of Inbound API and PIS Connectors
source: https://developer.mastercard.com/open-banking-connect/documentation/pisfeatures/get-status-inbound-api-pis-connectors/index.md

## Request overview {#request-overview}

The goal of this request is to check the status and availability of the Open Banking Connect Payment Information Service (PIS) APIs.

### Endpoint details {#endpoint-details}

| **Endpoints/Resources** | **Method** | **API Profiles** |                 **Description**                 |
|-------------------------|------------|------------------|-------------------------------------------------|
| /payments/health        | `GET`      | N/A              | Returns the status and availability of the APIs |

The following sequence diagram shows the flow used check the status of an inbound API request with the PIS connector.
Diagram get_status_inbound_API-PIS_Connector

## Request scenario {#request-scenario}


API Reference: `GET /payments/health`

#### Request header {#request-header}

N/A

#### Request body {#request-body}

N/A

### Response -- Success {#response--success}

HTTP Response Code = 200, OK
Tip: For a list of general response codes and error code structure see [Response and Error Codes](https://developer.mastercard.com/open-banking-connect/documentation/response-and-error-codes/index.md). For specific error codes for this feature see **Feature specific error codes** below.

#### Response header {#response-header}

N/A

#### Response body {#response-body}

|    **Name**     |                                    **Purpose**                                    | **Required by** |    **How it can be used**     | **Condition** | **Multiplicity** | **Type** |                                         **Description**                                         |      **Limitations/Parameters**      |
|-----------------|-----------------------------------------------------------------------------------|-----------------|-------------------------------|---------------|------------------|----------|-------------------------------------------------------------------------------------------------|--------------------------------------|
| `status`        | Returns health status of inbound API                                              | MC              | Status of inbound API         | M             | 1..1             | Enum     | Inbound API status. Status values: `UP`, `DOWN`, `DEGRADED`                                     | 1-256 Enum: `UP`, `DOWN`, `DEGRADED` |
| `statusMessage` | Returns status message of inbound API                                             | MC              | Status Message of inbound API | O             | 0..1             | String   | Additional details of the status (for example, if Down, what is down). Currently not populated. | 1-256                                |
| `connectors`    | Contains the list of OB connectors used to connect to partners and their statuses | MC              | List of connectors            | O             | 0..\*            | Array    | Array that contains the connector of OB Connect and the status of each                          | N/A                                  |
| `name`          | Name of connector for partner connection                                          | MC              | Name of connector             | M             | 1..1             | String   | Connector name                                                                                  | 1-256                                |
| `status`        | Returns health status of connector                                                | MC              | Status of connector           | M             | 1..1             | Enum     | Connector status. Status values: `UP`, `DOWN`, `DEGRADED`                                       | 1-256 Enum: `UP`, `DOWN`, `DEGRADED` |
| `statusMessage` | Returns status message of connector                                               | MC              | Status Message of connector   | O             | 0..1             | String   | Additional details of the status (for example, if Down, what is down). Currently not populated. | 1-256                                |

Tip: For an explanation of notations used, refer to **Open Banking General FAQ** in our [Frequently Asked Questions](https://developer.mastercard.com/open-banking-connect/documentation/frequently-asked-questions/index.md) section.

## Feature specific error codes {#feature-specific-error-codes}

Tip: For a list of general response codes and error code structure see [Response and Error Codes](https://developer.mastercard.com/open-banking-connect/documentation/response-and-error-codes/index.md).

There are no specific error codes for this feature.
For a list of general response codes and error code structure, see [Response and Error Codes](https://developer.mastercard.com/open-banking-connect/documentation/response-and-error-codes/index.md).