API QR Pay (PortalAPI/SBP)

Режим песочницы недоступен для методов QR Pay. Рекомендуется проводить тестирование на бою малыми суммами. По динамическим QR-кодам возможен возврат платежа.

Базовый адрес

https://api.modulbank.ru/v1/

Авторизация

https://api.modulbank.ru/data.html

Требуемые права токена

operation-upload

Методы

Получение данных

Описание операций описано по ссылке:

https://api.modulbank.ru/data.html#transactionHistory

Описание колбэков расположено в разделе:

https://api.modulbank.ru/data.html#webHooks

Получение списка точек продаж

Получение списка точек продаж, зарегистрированных в Системе Быстрых платежей. ID компании можно получить через запрос, который описан по ссылке:

https://api.modulbank.ru/data.html#userCompaniesInfo

Метод в API

GET https://api.modulbank.ru/v1/sbp/retail-points?companyId={companyId}

Пример вызова

GET /v1/sbp/retail-points?companyId=2906db8c-fc96-4473-9698-58d3d7b15501 HTTP/1.1
Host: api.modulbank.ru
Authorization: Bearer
aWQwMDAwMDAwMC0wMDAwLTAwMDArMDAwMC0wMDAwMDAwMDAwMDA3MTQ5M2FhYy1lZTFjLTQ1ZWMtYTZkNC1kNTk4ZTQzM2

Входные параметры

Источник	Название	Тип	Описание
query string	companyId	guid	ID компании

Возвращает

В случае успеха возвращает JSON-документ со следующим содержимым:

Параметры	Тип	Описание
id	guid	ID торговой точки СБП (ТСП)
name	string	Название ТСП
phone	string	Телефон
сity	string	Город регистрации ТСП
zip	string	Индекс адреса регистрации ТСП
address	string	Адрес регистрации ТСП
type	enum string	Тип ТСП
created	datetime	Дата регистрации ТСП
hasStaticQrCode	bool	Зарегистрирован статический QR-код
binded	bool	Привязан к приложению QRPay
activationCode	string	Код активации ТСП
merchantCategoryCode.code	string	Код MCC
merchantCategoryCode.name	string	Наименовании области деятельности
merchantCategoryCode.category	string	Категория деятельности
bankAccount	string	Счет, на который перечисляются средства от оплаты через СБП
status	enum string	Статус регистрации ТСП

Пример ответа (JSON)

 [
	{
		"id": "51d693fb-c7f7-48c4-911f-65055203a533",
		"name": "Торговая точка СБП",
		"phone": "3221110189",
		"сity": "Уфа",
		"zip": "450076",
		"address": "г. Уфа, ул. ул Аксакова, 4",
		"type": "QRPay",
		"created": "2021-03-18T03:37:27.036396",
		"hasStaticQrCode": true,
		"binded": false,
		"activationCode": "A79EC1DE",
		"merchantCategoryCode": {
			"code": "5411",
			"name": "Бакалейные магазины, Супермаркеты",
			"category": "Супермаркеты"
		},
		"bankAccount": "40802810570010294158",
		"status": "Registered"
	}
]

Создание нового динамического QR-кода

Метод в API

POST https://api.modulbank.ru/v1/sbp/qr-codes/dynamic

Пример вызова

POST /v1/sbp/qr-codes/dynamic
Host: api.modulbank.ru
Content-Type: application/json
Authorization: Bearer 
aWQwMDAwMDAwMC0wMDAwLTAwMDArMDAwMC0wMDAwMDAwMDAwMDA3MTQ5M2FhYy1lZTFjLTQ1ZWMtYTZkNC1kNTk4ZTQzM2

{
	"retailPointId": "bbdf834b-d68a-443d-ad5b-9cc00a0e07e9",
	"sum": 50,
	"extraInfo": "инфа"
}

Входные параметры

Источник	Название	Тип	Описание
body	retailPointId	guid	ID ТСП из предыдущего запроса
body	sum	decimal	Сумма платежа (0 < сумма < 1000000000)
body	extraInfo	string	Назначение платежа/описание/и т.п. (обязательное, макс. 140 символов)

Возвращает

В случае успеха возвращает JSON-документ со следующим содержимым:

Параметры	Тип	Описание
qrcId	guid	ID QR-кода (далее QrcId)
payload	string	Ссылка на платеж СБП (содержимое QR-кода)

Пример ответа (JSON)

{
	"qrcId": "AD10002AO71M5BPV96LOCN7B315SBFAG",
	"payload": "https://qr.nspk.ru/AD10002AO71M5BPV96LOCN7B315SBFAG?type=02&bank=100000000099&sum=5000&cur=RUB&crc=565A"
}

Получение QR-кода

Получение QR-кода, его статуса и свойств по QrcId

Метод в API

GET https://api.modulbank.ru/v1/sbp/qr-codes/{qrcId}

Пример вызова

GET /v1/sbp/qr-codes/AD10002AO71M5BPV96LOCN7B315SBFAG
Host: api.modulbank.ru
Authorization: Bearer
aWQwMDAwMDAwMC0wMDAwLTAwMDArMDAwMC0wMDAwMDAwMDAwMDA3MTQ5M2FhYy1lZTFjLTQ1ZWMtYTZkNC1kNTk4ZTQzM2

Входные параметры

Источник	Название	Тип	Описание
path	qrcId	string	QrcId (ID QR-кода)

Возвращает

В случае успеха возвращает JSON-документ со следующим содержимым:

Параметры	Тип	Описание
qrcId	string	ID QR-кода (далее QrcId)
localQrcId	string	Внутренний ID (однозначно связан с QrcId), предназначен для операций возврата, где UI с клиентом не позволяет ввести исходный длинный QrcId (например, только цифровая клавиатура)
amount	decimal	Сумма платежа
payload	string	Ссылка на платеж СБП (содержимое QR-кода)
created	datetime	Дата создания QR-кода
type	enum string	Тип QR-кода
status	enum string	Статус платежа
paymentPurpose	string	Назначение платежа/описание/и т.п.

Пример ответа (JSON)

 {
	"qrcId": "AD10002AO71M5BPV96LOCN7B315SBFAG",
	"localQrcId": "9976",
	"amount": 50.0,
	"payload": "https://qr.nspk.ru/AD10002AO71M5BPV96LOCN7B315SBFAG?type=02&bank=100000000099&sum=5000&cur=RUB&crc=565A",
	"created": "2021-03-18T12:24:38.604538",
	"type": "QRD",
	"status": "Accepted",
	"paymentPurpose": "Тестовый платеж"
}

Получение изображения QR-кода

Получение изображения QR-кода по QrcId в формате PNG

Метод в API

GET https://api.modulbank.ru/v1/sbp/qr-codes/{qrcId}

Пример вызова

GET /v1/sbp/qr-codes/AD10002AO71M5BPV96LOCN7B315SBFAG/image
Host: api.modulbank.ru
Authorization: Bearer
aWQwMDAwMDAwMC0wMDAwLTAwMDArMDAwMC0wMDAwMDAwMDAwMDA3MTQ5M2FhYy1lZTFjLTQ1ZWMtYTZkNC1kNTk4ZTQzM2

Входные параметры

Источник	Название	Тип	Описание
path	qrcId	string	QrcId (ID QR-кода)

Возвращает

В случае успеха возвращает изображение QR-кода в формате PNG

Пример ответа

Типы перечислений

Тип ТСП

Значение	Описание
QRPay	Стандартная точка продаж СБП
InternetAcquiring	Интернет-эквайринг
ModulKassa	МодульКасса

Статус регистрации ТСП

Значение	Описание
New	Новый запрос
Processing	В обработке
Registered	Зарегестрирован в СБП
Rejected	Отклонен
Blocked	Заблокирован (приостановка от фрод-мониторинга)
Error	Ошибка при регистрации
RejectedFBR	Отклонен фрод-мониторингом
NotRegistered	Заявка не зарегистрирована, ожидает начала регистрации

Тип QR-кода

Значение	Описание
QRS	Статический (QR наклейка)
QRD	Динамический (QR на кассе)

Статусы QR-кода

Значение	Описание
NotStarted	Операции по QR коду не существует
Received	Операция в обработке
InProgress	Операция в обработке
Accepted	Операция завершена успешно
Rejected	Операция отклонена
TimedOut	Время ожидания операции превышено

Возвраты

Осуществление возврата платежа по QrcId

Метод в API

POST https://api.modulbank.ru/v1/sbp/qr-codes/refund

Пример вызова

POST /v1/sbp/qr-codes/refund
Host: api.modulbank.ru
Authorization: Bearer
aWQwMDAwMDAwMC0wMDAwLTAwMDArMDAwMC0wMDAwMDAwMDAwMDA3MTQ5M2FhYy1lZTFjLTQ1ZWMtYTZkNC1kNTk4ZTQzM2

{
	"sbpOperId": "A44616542132165465",
	"type": "full"
}

Входные параметры

Источник	Название	Тип	Описание
body	sbpOperId	string	Номер операции СБП, по которой необходимо выполнить возврат средств
body	type	string	Тип возврата «full». Частичный возврат не реализован
body	amount	number	Необязательный. Будет использоваться для частичного возврата

Возвращает

В случае успеха возвращает идентификатор запроса requestId.

API QR Pay (PortalAPI/SBP)

Базовый адрес

Авторизация

Требуемые права токена

Методы

Получение данных

Получение списка точек продаж

Метод в API

Пример вызова

Входные параметры

Возвращает

Пример ответа (JSON)

Создание нового динамического QR-кода

Метод в API

Пример вызова

Входные параметры

Возвращает

Пример ответа (JSON)

Получение QR-кода

Метод в API

Пример вызова

Входные параметры

Возвращает

Пример ответа (JSON)

Получение изображения QR-кода

Метод в API

Пример вызова

Входные параметры

Возвращает

Пример ответа

Типы перечислений

Тип ТСП

Статус регистрации ТСП

Тип QR-кода

Статусы QR-кода

Возвраты

Метод в API

Пример вызова

Входные параметры

Возвращает

Не хватило возможностей?