> For the complete documentation index, see [llms.txt](https://docs.npck.kz/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.npck.kz/mezhbankovskaya-sistema-mobilnykh-platezhei-msmp/mezhbankovskaya-sistema-mobilnykh-platezhei-msmp/poluchenie-informacii-o-bankakh-i-statuse-api.md).

# Получение информации о банках и статусе API

С помощью метода Платформы `GET /v1/banks` (см. описание в <https://banks-openapi.npck.kz/>) можно получить:

* **Информацию о банках-участниках.** Например, API можно использовать для отображения пользователю списка банков-участников при совершении переводов. В ответе API по каждому банку возвращается его статус активности.
* **Информацию о доступности сервисов банков-участников.** Это позволяет определить возможность осуществления операций с конкретным участником в определенный момент времени. Статус доступности предоставляется по каждому API участника, так как в определенные моменты времени одно API может быть доступно, а другое недоступно по различным причинам.

{% hint style="warning" %}
Важно понимать, что статус участника и статус доступности его API являются разными понятиями: участник может быть активным, однако некоторые из его API могут быть временно недоступны из-за сбоев, технических работ и других причин.
{% endhint %}

## Сервис получения информации о банках участниках

Метод Платформы `GET /v1/banks` позволяет получить информацию о банках, зарегистрированных на Платформе.

> Данный метод предоставляет такие сведения как:&#x20;
>
> * наименование банка, указанное при регистрации на Платформе
> * логотип
> * БИК, указанное при регистрации на Платформе
> * БИН, указанное при регистрации на Платформе
> * (acceptsQrV1/acceptsQrV2)  версионность QR, поддерживаемая эквайером (true/false)
> * qrUrl,
> * (provider\_id) идентификатор, присвоенный при регистрации на Платформе,
> * статус активности участника,
> * (features) список опубликованных API у данного участника,
> * (featuresAvailability) доступность сервисов в разрезе типов операции (true/false).

{% hint style="info" %}
*Примечание:*&#x20;

*Для аутентификации в методе API «Получить список банков» (GET /v1/banks) используется аутентификационный токен банка, который можно получить в личном кабинете участника на Платформе.*

&#x20;*Используется* JSON Web Token (JWT) с ограниченным сроком действия, срок действия токена указывается в поле "exp", входящем в составе JWT.&#x20;

До истечения срока действия токена его необходимо перегенерировать *в личном кабинете участника. Вызов метода с истекшим токеном недоступен (ошибка с HTTP статусом 401).*
{% endhint %}

## Сервис получения статуса API участников

Платформа непрерывно осуществляет мониторинг доступности опубликованных на ней API участников.&#x20;

> Статусы участников: ACTIVE, NOT\_ACTIVE,BLOCK\_DEBIT, BLOCK\_CREDIT и CLOSED.&#x20;
>
> При статусе **ACTIVE** передается список опубликованных API участников  `(features).`

{% hint style="success" %}
В методе `GET /v1/banks` будут передаваться параметры `acceptsQrV1` и `acceptsQrV2` (true/false), которые отражают, какую версию QR эквайер поддерживает для приема операций.&#x20;
{% endhint %}

Метод Платформы `GET /v1/banks` также позволяет получить список активных API участников в блоке **featuresAvailability (true/false)**.

{% code title="Пример:" fullWidth="true" %}

```jsonc
{
            "providerId": "c5e13202-1e8b-4666-a90f-1c9937b6bbff",
            "name": "Mock Bank 3",
            "bic": "EXKAKZKA",
            "bin": "070940006465",
            "acceptsQrV1": true,
            "acceptsQrV2": true,
            "status": "ACTIVE",
            "features": [
                "C2C2_TRANSFERS_SEND",
                "C2C2_TRANSFERS_RECEIVE",
                "C2CR_RETURN_TRANSFERS_SEND",
                "C2CR_RETURN_TRANSFERS_RECEIVE",
                "C2CR_RTP_RETURN_TRANSFERS_SEND",
                "C2CR_RTP_RETURN_TRANSFERS_RECEIVE",
                "M2M_TRANSFERS_SEND",
                "M2M_TRANSFERS_RECEIVE",
                "C2B2_PAYMENTS_SEND",
                "C2B2_PAYMENTS_RECEIVE",
                "C2B2_RTP_PAYMENTS_SEND",
                "C2B2_RTP_PAYMENTS_RECEIVE",
                "C2B2_V2_PAYMENTS_SEND",
                "C2B2_V2_PAYMENTS_RECEIVE",
                "C2B2E_PAYMENTS_SEND",
                "C2B2E_PAYMENTS_RECEIVE",
                "C2BR_RETURN_PAYMENTS_SEND",
                "C2BR_RETURN_PAYMENTS_RECEIVE",
                "C2BR_V2_RETURN_PAYMENTS_SEND",
                "C2BR_V2_RETURN_PAYMENTS_RECEIVE",
                "C2BRE_RETURN_PAYMENTS_SEND",
                "C2BRE_RETURN_PAYMENTS_RECEIVE",
                "C2BRM_V2_RETURN_PAYMENTS_SEND",
                "C2BRM_V2_RETURN_PAYMENTS_RECEIVE",
                "B2C2I_PAYOUTS_SEND",
                "B2C2I_PAYOUTS_RECEIVE",
                "B2C2U_PAYOUTS_SEND",
                "B2C2U_PAYOUTS_RECEIVE"
            ],
            "featuresAvailability": [
                {
                    "feature": "C2C2_TRANSFERS_SEND",
                    "available": true
                },
                {
                    "feature": "C2C2_TRANSFERS_RECEIVE",
                    "available": true
                },
                {
                    "feature": "C2CR_RETURN_TRANSFERS_SEND",
                    "available": true
                },
                {
                    "feature": "C2CR_RETURN_TRANSFERS_RECEIVE",
                    "available": true
                },
                {
                    "feature": "C2CR_RTP_RETURN_TRANSFERS_SEND",
                    "available": true
                },
                {
                    "feature": "C2CR_RTP_RETURN_TRANSFERS_RECEIVE",
                    "available": true
                },
                {
                    "feature": "M2M_TRANSFERS_SEND",
                    "available": true
                },
                {
                    "feature": "M2M_TRANSFERS_RECEIVE",
                    "available": true
                },
                {
                    "feature": "C2B2_PAYMENTS_SEND",
                    "available": true
                },
                {
                    "feature": "C2B2_PAYMENTS_RECEIVE",
                    "available": true
                },
                {
                    "feature": "C2B2_RTP_PAYMENTS_SEND",
                    "available": true
                },
                {
                    "feature": "C2B2_RTP_PAYMENTS_RECEIVE",
                    "available": true
                },
                {
                    "feature": "C2B2_V2_PAYMENTS_SEND",
                    "available": true
                },
                {
                    "feature": "C2B2_V2_PAYMENTS_RECEIVE",
                    "available": true
                },
                {
                    "feature": "C2B2E_PAYMENTS_SEND",
                    "available": true
                },
                {
                    "feature": "C2B2E_PAYMENTS_RECEIVE",
                    "available": false
                },
                {
                    "feature": "C2BR_RETURN_PAYMENTS_SEND",
                    "available": true
                },
                {
                    "feature": "C2BR_RETURN_PAYMENTS_RECEIVE",
                    "available": true
                },
                {
                    "feature": "C2BR_V2_RETURN_PAYMENTS_SEND",
                    "available": true
                },
                {
                    "feature": "C2BR_V2_RETURN_PAYMENTS_RECEIVE",
                    "available": true
                },
                {
                    "feature": "C2BRE_RETURN_PAYMENTS_SEND",
                    "available": true
                },
                {
                    "feature": "C2BRE_RETURN_PAYMENTS_RECEIVE",
                    "available": false
                },
                {
                    "feature": "C2BRM_V2_RETURN_PAYMENTS_SEND",
                    "available": true
                },
                {
                    "feature": "C2BRM_V2_RETURN_PAYMENTS_RECEIVE",
                    "available": true
                },
                {
                    "feature": "B2C2I_PAYOUTS_SEND",
                    "available": false
                },
                {
                    "feature": "B2C2I_PAYOUTS_RECEIVE",
                    "available": true
                },
                {
                    "feature": "B2C2U_PAYOUTS_SEND",
                    "available": false
                },
                {
                    "feature": "B2C2U_PAYOUTS_RECEIVE",
                    "available": true
                }
            ],
            "logoUrl": "https://api.stage.npck.kz/v1/banks-logos?logoId=294afc2d-15eb-424f-9b27-19ad7213e8b8",
            "qrUrl": "https://mock-bank-3.stage.npck.kz",
            "internalLogoUrl": "https://transfers-api.stage.npck.kz/v1/banks-logos?logoId=294afc2d-15eb-424f-9b27-19ad7213e8b8"
        }
```

{% endcode %}

Статус доступности предоставляется по каждому API участника.