# checkHealthPayAPI

### Description

This endpoint is used to check the current health of the **PAY-API**. It returns the API health status as either **UP** or **DOWN**.

{% code overflow="wrap" %}

```javascript
public checkHealthPayAPI() : VyPromise<VyPayApiHealthDto>
```

{% endcode %}

{% tabs %}
{% tab title="Details" %}
**Returns**

VyPromise<[VyPayApiHealthDto](https://sdk.venly.io/sdk-reference/ts-js-v3/object-references/pay/vypayapihealthdto)>
{% endtab %}
{% endtabs %}