B2C

Получение статуса оплаты QR-кода или кассовой платёжной ссылки

Песочница
GET https://sandbox.alfabank.ru/api/sbp/jp/v1/qrc-status
Пром
GET https://baas.alfabank.ru/api/sbp/jp/v1/qrc-status
Scope

c2b-sbp

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

application/json

messageId
stringoptional

Уникальный идентификатор сообщения

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

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

qrcId
stringoptional

Идентификатор QR-кода. Передавать для операций по динамическому QR-коду

payrrn
stringoptional

Референсный идентификатор запроса в системе Банка. Передавать для операций по кассовой платёжной ссылке

Пример запроса
Язык
1curl --location --globoff 'https://baas.alfabank.ru/api/sbp/jp/v1/qrc-status?termNo={termNo}&qrcId={qrcId}&payrrn={payrrn}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json' \
4--header 'messageId: 123Rersal_Num567'
Параметры ответа
Пример ответа 200 (OK)
1{
2  "creditDatePos": "2022-12-19",
3  "termNo": "30000600",
4  "amount": 12300,
5  "currency": "RUR",
6  "qrcId": "AS1000670LSS7DN18SJQDNP4B05KLJL2",
7  "status": "ACWP",
8  "trxId": "X1A2S3D5F6G7H8J9K0C4S5C6D7V5D1K2",
9  "trxDT": "2022-12-19T07:40:28Z",
10  "payrrn": "000000020972"
11}
BODY
атрибут
описание
creditDatePos
stringrequired

Дата операции, установленная Банком

termNo
stringrequired

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

amount
integerrequired

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

currency
stringoptional

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

  • •
    RUR - российский рубль
qrcId
stringrequired

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

status
stringrequired

Статус оплаты QR-кода в НСПК. Принимает возможные значения:

  • •
    NTST - операции по QR-коду не существует (NOT_STARTED);
  • •
    RCVD - операция в обработке (RECEIVED);
  • •
    ACWP - операция завершена успешно (ACCEPTED);
  • •
    RJCT - операция отклонена (REJECTED)
trxId
stringrequired

Уникальный идентификатор платежа в НСПК

trxDT
stringrequired

Дата и время отменяемого платежа

payrrn
stringrequired

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

Пример ответа 200 (OK)
1{
2  "creditDatePos": "2022-12-19",
3  "termNo": "30000600",
4  "amount": 12300,
5  "currency": "RUR",
6  "qrcId": "AS1000670LSS7DN18SJQDNP4B05KLJL2",
7  "status": "ACWP",
8  "trxId": "X1A2S3D5F6G7H8J9K0C4S5C6D7V5D1K2",
9  "trxDT": "2022-12-19T07:40:28Z",
10  "payrrn": "000000020972"
11}
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}
Нет тела ответа