1. Запрос списка банков-участников СБП

Запрос GetBankList направляется ТСП на ПШ Альфа-Банка для получения списка банков-участников СБП.

Метод GetBankList

a) Описание параметров запроса:

Код ключа	Тип данных	required	Назначение
command	String (an-1..50)	y	Тип запроса. Константа «GetBankList»
messageID	String (ans-1…1024)	o	Уникальный идентификатор сообщения, GUID
BankMemberIdFilter	String (n-11)	o	Фильтр для результатов запроса (указывается идентификатор участника СБП, добавляется в запрос если в ответе нужно получить данные только по одному банку)

b) Примерный формат запроса:

{
  "command": "GetBankList"
}

c) Описание параметров ответа:

Код ключа	Тип данных	required	Назначение
ErrorCode	String (an-20)	y	Код ответа*
message	String (ans-1024)	y	Расшифровка кода ответа**
BankList	Массив	o	Коллекция, содержащая список банков-участников
BankList.BankName	String (an-50)	o	Наименование банка-участника
BankList.BankID	String (an-12)	o	Идентификатор участника СБП в НСПК
BankList.BankBIK	String (n-9)	o	БИК банка-участника СБП. (Присутствует в ответе если был передан из НСПК в данных участника СБП)

*, ** Таблица возможных кодов ответа приведена в приложении 2.

d) Примерный формат ответа:

1{
2  "ErrorCode": 0,
3  "message":"Запрос обработан успешно",
4  "BankList":
5   [ {
6            "BankName":"Наименование банка 1",
7            "BankID":"10000001100",
8            "BankBIK":"044525823"
9        },
10…
11 {
12            "BankName":" Наименование банка N",
13            "BankID":"10000001145",
14            "BankBIK":"044525829"
15        }
16   ]
17}

2. Запрос блокирования QR-кода

Запрос направляется в ПШ банка в целях блокирования сгенерированного QR-кода. Запрос действует для любого вида сгенерированного QR-кода.

Метод BlockQRcId

a) Описание параметров запроса:

Код ключа	Тип данных	required	Назначение
command	String (an-1..50)	y	Тип запроса. Константа «BlockQRcId»
TermNo	String (an-20)	y	Уникальный идентификатор терминала
qrcId	String (an-32)	y	Идентификатор QR-кода
reason	String (ans-1024)	o	Причина блокировки

b) Примерный формат запроса:

{
  "command": "BlockQRcId",
  "TermNo": "90080567",
  "qrcId": "BS1R003FN6RS6HL48QMBFVO5C4K9GQRV",
  "reason": "Заказ 12345 направлен в стоп-лист"
}

c) Описание параметров ответа:

Код ключа	Тип данных	required	Назначение
ErrorCode	String (an-20)	y	Код ответа*
TermNo	String (an-20)	y	Уникальный идентификатор терминала
message	String (ans-1024)	y	Расшифровка кода ответа**

*, ** Таблица возможных кодов ответа приведена в приложении 2.

d) Примерный формат ответа:

• •

  200 OK

{
  "ErrorCode": 0,
  "TermNo": 90080567,
  "message": "OK"
}

• •

  400 Bad Request

{
"ErrorCode": "Код ответа",
"message": "Расшифровка кода ответа"
}

3. Запрос разблокирования QR-кода

Запрос направляется в ПШ банка в целях разблокирования ранее заблокированного QR-кода.

Метод UnblockQRcId

a) Описание параметров запроса:

Код ключа	Тип данных	required	Назначение
command	String (an-1..50)	y	Тип запроса. Константа «UnblockQRcId»
TermNo	String (an-20)	y	Уникальный идентификатор терминала
qrcId	String (an-32)	y	Идентификатор QR-кода

b) Примерный формат запроса:

{
  "command": "UnblockQRcId",
  "TermNo": "90080567",
  "qrcId": "BS1R003FN6RS6HL48QMBFVO5C4K9GQRV"
}

c) Описание параметров ответа:

Код ключа	Тип данных	required	Назначение
ErrorCode	String (an-20)	y	Код ответа*
TermNo	String (an-20)	y	Уникальный идентификатор терминала
message	String (ans-1024)	y	Расшифровка кода ответа**

*, ** Таблица возможных кодов ответа приведена в приложении 2.

d) Примерный формат ответа:

• •

  200 OK

{
  "ErrorCode": 0,
  "TermNo": 90080567,
  "message": "OK"
}

• •

  400 Bad Request

{
"ErrorCode":"Код ответа",
"message": "Расшифровка кода ответа"
}

4. Запрос списка заблокированных QR-кодов

Запрос направляется в ПШ банка для получения списка заблокированных QR-кодов по определенному терминалу или кассе.

Метод GetBlockedQRcIdList

a) Описание параметров запроса:

Код ключа	Тип данных	required	Назначение
command	String (an-1..50)	y	Тип запроса. Константа «GetBlockedQRcIdList»
TermNo	String (an-20)	y	Уникальный идентификатор терминала

b) Примерный формат запроса:

{
  "command": "GetBlockedQRcIdList",
  "TermNo": "90080567",
}

c) Описание параметров ответа:

Код ключа	Тип данных	required	Назначение
ErrorCode	String (an-20)	y	Код ответа*
message	String (ans-1024)	y	Расшифровка кода ответа**
QRcIdList	Коллекция		Список QRcId
QRcIdList.qrcId	String (an-32)	y	Идентификатор QR-кода
QRcIdList.reason	String (ans-1024)	o	Причина блокировки
QRcIdList.date	String (an-20)	y	Дата и время

*, ** Таблица возможных кодов ответа приведена в приложении 2.

d) Примерный формат ответа:

• •

  200 OK

1{
2  "ErrorCode": 0,
3  "QRcIdList":
4    [
5     {
6      "date": "2024-04-18 17:17:45",
7      "qrcId": "BD100000K5II0G369JHR3KBA6SM3FD3V",
8      "reason": "Заказ 12345 направлен в стоп-лист"
9      },
10      {
11       "date": "2024-05-01 19:07:15",
12       "qrcId": "BD100002JN871TSC9SJB7HPVRFD3HQ8T",
13       "reason": "Заказ 96780 направлен в стоп-лист"
14      }
15    ],
16   "TermNo": "90080567",
17   "message": "OK"
18}

• •

  400 Bad Request

{
"ErrorCode":"Код ответа",
"message": "Расшифровка кода ответа"
}