B2C

Регистрация кассовой ссылки в СБП

Песочница
POST https://sandbox.alfabank.ru/api/sbp/jp/v1/terminals/{termNo}/cash-qrcs
Пром
POST https://baas.alfabank.ru/api/sbp/jp/v1/terminals/{termNo}/cash-qrcs
Scope

c2b-sbp

Параметры запроса
HEADERS
Атрибут
Описание
Authorization
stringrequired
Accept
stringrequired

application/json

Content-Type
stringrequired

application/json

PATH
Атрибут
Описание
termNo
stringrequired

Номер терминала

BODY
Атрибут
Описание
mediaType
stringoptional

Формат изображения QR-кода

width
stringoptional

Ширина изображения QR-кода

height
stringoptional

Высота изображения QR-кода

redirectUrl
stringoptional

Ссылка для автоматического возврата в приложение или на сайт торгово-сервисного предприятия (ТСП)

qrcId
stringoptional

Идентификатор QR-кода. Позволяет привязать заранее зарезервированную в НСПК кассовую платёжную ссылку к ТСП

Пример запроса
Язык
1curl --location --globoff 'https://baas.alfabank.ru/api/sbp/jp/v1/terminals/{termNo}/cash-qrcs' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--header 'Accept: application/json' \
5--data '{
6  "mediaType": "image/png",
7  "width": "200",
8  "height": "200",
9  "redirectUrl": "https://exampletsp.io/qwertyui",
10  "qrcId": "AS1R0060MBC2CH7R9S79VP0FT4F37KEB"
11}'
Параметры ответа
Пример ответа 201 (Created)
1{
2  "termNo": "30000600",
3  "qrcId": "AS1R0060MBC2CH7R9S79VP0FT4F37KEB",
4  "payload": "https://qr.nspk.ru/AS1R0060MBC2CH7R9S79VP0FT4F37KEB",
5  "status": "CREATED",
6  "image": {
7    "mediaType": "image/png",
8    "content": "iVBORw0KGgoAAAANSUhEUgAAASwAAAEsCAYAAAB5fY51AAArvElEQVR4Xu2d/bOvVXneB2Pwbvw1OqlrAAAAAElFTkSuQmCC"
9  }
10}
BODY
атрибут
описание
termNo
stringrequired

Номер терминала

qrcId
stringrequired

Идентификатор QR-кода

payload
stringrequired

Платёжная ссылка

status
stringrequired

Статус кассовой ссылки, полученный из НСПК

objectoptional

Изображение QR-кода

mediaType
stringoptional

Формат изображения QR-кода

content
stringoptional

Base64-кодированные данные файла изображения QR-кода

Пример ответа 201 (Created)
1{
2  "termNo": "30000600",
3  "qrcId": "AS1R0060MBC2CH7R9S79VP0FT4F37KEB",
4  "payload": "https://qr.nspk.ru/AS1R0060MBC2CH7R9S79VP0FT4F37KEB",
5  "status": "CREATED",
6  "image": {
7    "mediaType": "image/png",
8    "content": "iVBORw0KGgoAAAANSUhEUgAAASwAAAEsCAYAAAB5fY51AAArvElEQVR4Xu2d/bOvVXneB2Pwbvw1OqlrAAAAAElFTkSuQmCC"
9  }
10}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    invalid_request - неверные входные параметры запроса
error_description
stringoptional

Описание ошибки

Пример ошибки 400 (Bad Request)
1{
2  "error": "invalid_request",
3  "error_description": "Authorization header is not present in request headers"
4}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    invalid_token - предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам. Необходимо получить новый токен доступа
error_description
stringoptional

Описание ошибки

Пример ошибки 401 (Unauthorized)
1{
2  "error": "invalid_token",
3  "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
4}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    insufficient_scope - при запросе токена доступа не были переданы все необходимые scopes. Необходимо повторно отправить запрос на получение токена доступа с указанием всех доступных scopes
error_description
stringoptional

Описание ошибки

Пример ошибки 403 (Forbidden)
1{
2  "error": "insufficient_scope",
3  "error_description": "The request requires higher privileges than provided by the access token"
4}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    unknown_endpoint - эндпоинт не найден или неактивен
error_description
stringoptional

Описание ошибки

Пример ошибки 404 (Not Found)
1{
2  "error": "unknown_endpoint",
3  "error_description": "Endpoint is not found or not active"
4}
Нет тела ответа
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    internal_error - внутренняя ошибка сервиса при выполнении обработки запроса
error_description
stringoptional

Описание ошибки

Пример ошибки 500 (Internal Server Error)
1{
2  "error": "internal_error",
3  "error_description": "Internal server error"
4}
Нет тела ответа