Сервис «Единый совокупный платеж-ЕСП»: различия между версиями

Версия от 12:37, 29 августа 2023

В данной статье описывается принцип работы сервиса по получению сведений о едином совокупном платеже (ЕСП) физических лиц (далее - Сервис) посредством информационной системы АО «Государственное кредитное бюро» (далее - ГКБ), методы запроса данных, примеры входных и выходных SOAP-запросов, возможные ошибки.

Описание сервиса ЕСП (SingleAggregatePaymentImplService)

Адреса web сервисов:
Тестовый сервис	https://testscbws.mkb.kz/mtsznServices/SingleAggregatePaymentImplService?wsdl
Продуктивный сервис	https://scbws.mkb.kz/mtsznServices/SingleAggregatePaymentImplService?wsdl
Метод сервиса	getSingleAggregatePayment

При вызове веб-сервиса обязательно указываются следующие параметры:

1. ID и пароль клиента (организации) в HTTP Header, необходимые для базовой аутентификации. Так как коммуникация с веб-сервисами системы идет по защищенному протоколу HTTPS, то базовая аутентификация представляется безопасным решением.

2. ID пользователя, от имени которого будет выполнена запрашиваемая операция в SOAP Header:

Http Headers: {Authorization=[Basic jUnB0U3lzdGVtQWNjb3VudDpBbzZVRkdyVTZ2]}

SOAP Message: [Показать ответ]

1.	<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:data="http://data.mtszn.scb.kz">  
2.	    <soapenv:Header>  
3.	        <userId>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</userId>  
4.	    </soapenv:Header>  
5.	    <soapenv:Body>  
6.	        <data:getSingleAggregatePayment/>  
7.	    </soapenv:Body>  
8.	</soapenv:Envelope>

где c3ZjUnB0U3lzdGVtQWNjb3VudDpBbzZVRkdyVTZ2 - есть значение HTTP Header, представляющее собой ID клиента и его пароль в формате «clientId:password» и кодировке Base64 как того требует механизм Basic Authentication.

Метод getSingleAggregatePayment

Метод getSingleAggregatePayment сервиса SingleAggregatePaymentImplService предназначен для получения сведений о факте уплаты физическим лицом единого совокупного платежа (ЕСП).

Таблица 1. Состав данных запроса на получение информации [Показать ответ]

№	Наименование	Поле	Формат	Обязательность	Примечание
1	ИИН субъекта	iin	xs:string	Да	Значение должно содержать 12 цифр
2	Номер запроса	requestNumber	xs:string	Да
3	Токен КДП	token	xs:string	Да	Наличие согласия субъекта на предоставление информации из ГБД

Таблица 2. Состав данных ответа на запрос получения информации [Показать ответ]

№	Наименование	Поле	Формат	Обязательность	Примечание
1	Ответ на запрос	response	SyncsendMessageresponse	Да
2	Информация об ответе	responseInfo	SyncMessageInfoResponse	Да
3	Идентификатор сообщения в системе получателя	messageId	xs:string	Да
4	Идентификатор цепочки сообщения в системе получателя запроса	correlationId	xs:string	Нет
5	Дата ответа в системе получателя запроса	responseDate	xs:dateTime	Да
6	Объект «Информация о статусе»	status	StatusInfo	Да
7	Код статуса	code	xs:string	Да
8	Сообщение о статусе	message	xs:string	Да
9	Идентификатор сессии на ШЭП	sessionId	guid	Нет
10	Объект «Данные ответа»	responseData	responseData	Да
11	Объект «Данные сообщения»	data	xs:Anytype	Нет
12	Признак плательщика	isEspPayer	xs:boolean	Да	True/False
13	Период последнего платежа^*	periods/period	xs:string	Да/Нет	Формат: ММГГГГ В случае если является плательщиком ЕСП
14	Сумма^*	periods/amount	xs:double	Да/Нет	В случае если является плательщиком ЕСП
15	Уникальный идентификатор	requestGUID	xs:char	Да

- при наличии нескольких значений данные передаются в массиве

Пример вызова метода getSingleAggregatePayment

Пример вызова метода getSingleAggregatePayment с помощью SOAP запроса имеет следующий вид: [Показать ответ]

1.	<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:data="http://data.mtszn.scb.kz/">  
2.	    <soapenv:Header>  
3.	        <userId>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</userId>  
4.	    </soapenv:Header>  
5.	    <soapenv:Body>  
6.	        <data:getSingleAggregatePayment>  
7.	            <iin>ИИН_субъекта</iin>  
8.	        </data:getSingleAggregatePayment>  
9.	    </soapenv:Body>  
10.	</soapenv:Envelope>

Пример ответа на вызов метода getSingleAggregatePayment

Пример ответа на вызов метода getSingleAggregatePayment с помощью SOAP запроса имеет следующий вид: [Показать ответ]

1.	<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">  
2.	    <soap:Body>  
3.	        <ns2:getSingleAggregatePaymentResponse xmlns:ns2="http://data.mtszn.scb.kz/" xmlns:ns3="http://bip.bee.kz/SyncChannel/v10/Types">  
4.	            <return>  
5.	                <response>  
6.	                    <responseInfo>  
7.	                        <messageId>f44d3a23-29a2-41e9-9717-8c0f206d1f7a</messageId>  
8.	                        <correlationId/>  
9.	                        <responseDate>2019-12-12T17:09:53.916+06:00</responseDate>  
10.	                        <status>  
11.	                            <code>0</code>  
12.	                            <message>OK</message>  
13.	                        </status>  
14.	                        <sessionId/>  
15.	                    </responseInfo>  
16.	                    <responseData>  
17.	                        <data xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">  
18.	                            <![CDATA[<?xml version="1.0" encoding="UTF-8" standalone="no"?> 
19.	                                <response xmlns="http://www.mtszn.kz/services/PersonCotracts/schemas"> 
20.	                                    <isEspPayer>true</isEspPayer> 
21.	                                    <periods> 
22.	                                        <period>122019</period> 
23.	                                        <amount>1262.5</amount> 
24.	                                        <period>112019</period> 
25.	                                        <amount>1262.5</amount> 
26.	                                        <period>102019</period> 
27.	                                        <amount>1262.5</amount> 
28.	                                        <period>092019</period> 
29.	                                        <amount>1262.5</amount> 
30.	                                        <period>082019</period> 
31.	                                        <amount>1262.5</amount> 
32.	                                        <period>072019</period> 
33.	                                        <amount>1262.5</amount> 
34.	                                        <period>062019</period> 
35.	                                        <amount>1262.5</amount> 
36.	                                        <period>052019</period> 
37.	                                        <amount>1262.5</amount> 
38.	                                        <period>042019</period> 
39.	                                        <amount>1262.5</amount> 
40.	                                        <period>032019</period> 
41.	                                        <amount>1262.5</amount> 
42.	                                        <period>022019</period> 
43.	                                        <amount>1262.5</amount> 
44.	                                        <period>012019</period> 
45.	                                        <amount>1262.5</amount> 
46.	                                    </periods> 
47.	                                    <requestGUID>9953aaa7-9df1-2c21-e054-001b782a74a6</requestGUID> 
48.	                                    <ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#">Информация_о_ЭЦП</ds:Signature> 
49.	                                </response> 
50.	                            ]]>  
51.	                        </data>  
52.	                    </responseData>  
53.	                </response>  
54.	            </return>  
55.	        </ns2:getSingleAggregatePaymentResponse>  
56.	    </soap:Body>  
57.	</soap:Envelope>

Обработка исключений метода getSingleAggregatePayment

Код/Текст ошибки/сообщения	Описание ошибки/сообщения	Примечание
SBF-VE-8	Номер "ИИН" должен содержать 12 цифр
VAL-JSR-001	Обязательное поле "%s" отсутствует
SBF-AD-1	Пользователь «%s» не имеет прав для выполнения действия
	Обязательное поле UserId отсутствует
FAULT-015	Сервис на стороне ГБД не доступен
IIN NOT FOUND	ИИН не найден
SIGNATURE_NOT_VALID	Отсутствует ЭЦП или ЭЦП не валидна
ACCESS_DENIED	Доступ запрещен

Главная страница

Предыдущая страница

@@ Строка 86: / Строка 86: @@
 | style="text-align: left;" | Да
 |
+|-
+|3
+|Токен КДП
+|token
+|xs:string
+|Да
+|Наличие согласия субъекта на предоставление информации из ГБД
 |}
@@ Строка 215: / Строка 222: @@
 </div>
 </div>
 ===Пример вызова метода getSingleAggregatePayment===