B2C

Активация кассовой ссылки в СБП

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

c2b-sbp

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

application/json

Content-Type
stringrequired

application/json

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

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

qrcId
stringrequired

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

BODY
Атрибут
Описание
amount
integerrequired

Сумма платежа в копейках

currency
stringoptional

Код валюты. Возможные значения:

  • •
    RUR - российский рубль
paymentPurpose
stringoptional

Назначение платежа. Максимальное количество символов - 120

ttl
integeroptional

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

objectoptional

Данные запроса

notificationUrl
stringoptional

Полный URL для получения уведомления о финальном статусе оплаты QR-кода. Если параметр отсутствует, уведомление не производится

Пример запроса
Язык
1curl --location --globoff 'https://baas.alfabank.ru/api/sbp/jp/v1/terminals/{termNo}/cash-qrcs/{qrcId}/activation' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--header 'Accept: application/json' \
5--data '{
6  "amount": 10000,
7  "currency": "RUR",
8  "paymentPurpose": "Капучино 300 мл 1 шт., булочка 1 шт.",
9  "ttl": 5,
10  "queryData": {
11    "notificationUrl": "http://10.8.18.33:9017/sbp-payment/agent/status"
12  }
13}'
Параметры ответа
Пример ответа 201 (Created)
1{
2  "termNo": "9008056701",
3  "paramsId": "AP5GK3L276DN8PDR8ON1LF4RVOL44444",
4  "qrcId": "AS1000038AQ1FG409KGACUQU5QRSH3FM",
5  "amount": 10000,
6  "currency": "RUR",
7  "paymentPurpose": "Назначение платежа",
8  "payrrn": "000000020512"
9}
BODY
атрибут
описание
termNo
stringrequired

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

paramsId
stringrequired

Идентификатор параметров ссылки СБП

qrcId
stringrequired

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

amount
integerrequired

Сумма платежа в копейках

currency
stringrequired

Код валюты. Принимает возможные значения:

  • •
    RUR - российский рубль
paymentPurpose
stringoptional

Назначение платежа

payrrn
stringrequired

Референсный идентификатор запроса в системе Банка

Пример ответа 201 (Created)
1{
2  "termNo": "9008056701",
3  "paramsId": "AP5GK3L276DN8PDR8ON1LF4RVOL44444",
4  "qrcId": "AS1000038AQ1FG409KGACUQU5QRSH3FM",
5  "amount": 10000,
6  "currency": "RUR",
7  "paymentPurpose": "Назначение платежа",
8  "payrrn": "000000020512"
9}
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}
Нет тела ответа