СКОРО В РЕЛИЗЕB2BH2H

Получение данных по зарегистрированной платёжной ссылке

Пром GET https://baas.alfabank.ru/api/sbp/jp/v1/payment-urls/{qrcId}/data

Песочница GET https://sandbox.alfabank.ru/api/sbp/jp/v1/payment-urls/{qrcId}/data

Scope

b2b-sbp

Параметры запроса

HEADER
Атрибут
Описание
Authorization
stringrequired

Bearer {access_token}, полученный по Client Credentials Flow

Accept
stringrequired

application/json

Content-Type
stringoptional

application/json

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

Идентификатор платёжной ссылки

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

Идентификатор клиента, от имени которого выполняется запрос

partnerId
integerrequired

Идентификатор партнера

Пример запроса
curl -X GET https://baas.alfabank.ru/api/sbp/jp/v1/payment-urls/AO1000670LSS7DN18SJQDNP4B05KLJL2/data?b2bClientId=021be5ed-6312-4982-a4e9-2a2cc44bc88c&partnerId=214 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

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

Пример ответа 200 (ОК)
{
  "qrcId": "AD1000038AQ1FG409KGACUQU5QRSH3FM",
  "qrcType": "ONETIME",
  "legalId": "00000000000",
  "legalName": "ООО \"Кофейня у Артёма\"",
  "memberId": "100000000001",
  "brandName": "Кофейня у Артёма",
  "merchantId": "MF0000000001",
  "amount": 1000000,
  "paymentPurpose": "Оплата по договору №123456789 от 01.09.2001",
  "address": "г. Воронеж, ул. Лисюкова, д.5, стр.1",
  "mcc": "4122",
  "fraudScore": "0000000000000000",
  "inn": "4285733785",
  "redirectUrl": "https://exampletsp.io/qwertyui",
  "agentId": "A00000000001",
  "takeTax": true,
  "taxAmount": 200000,
  "uip": "281000670LSS7DN18SJQDNP4B05KLJL2"
}
qrcId
stringrequired

Идентификатор платёжной ссылки

qrcType
stringrequired

Тип платёжной ссылки. Принимает возможные значения:

  • ONETIME - Одноразовая платёжная ссылка;
  • REUSABLE - Многоразовая платёжная ссылка
legalId
stringrequired

Регистрационный номер ЮЛ или ИП (Получателя)

legalName
stringrequired

Сокращенное наименование ЮЛ или ИП

memberId
stringrequired

Идентификатор Банка Получателя

brandName
stringrequired

Торговое наименование торгово-сервисного предприятия (ТСП)

merchantId
stringrequired

Идентификатор ТСП

amount
integeroptional

Сумма к зачислению в копейках

paymentPurpose
stringoptional

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

address
stringrequired

Фактический адрес ТСП

mcc
stringrequired

MCC-код

fraudScore
stringoptional

Идентификатор подозрительной операции Агента ТСП

inn
stringoptional

ИНН Получателя (ЮЛ или ИП)

redirectUrl
stringoptional

Ссылка для перехода после выполнения платежа

agentId
stringoptional

Идентификатор Агента ТСП, который зарегистрировал платежную ссылку СБП (Банк Получателя)

takeTax
booleanrequired

Информация о взимании НДС. Принимает возможные значения:

  • true - Облагается НДС;
  • false - Не облагается НДС
taxAmount
integeroptional

Сумма налога Операции СБП в копейках

uip
stringoptional

Уникальный идентификатор платежа

Пример ответа 200 (ОК)
{
  "qrcId": "AD1000038AQ1FG409KGACUQU5QRSH3FM",
  "qrcType": "ONETIME",
  "legalId": "00000000000",
  "legalName": "ООО \"Кофейня у Артёма\"",
  "memberId": "100000000001",
  "brandName": "Кофейня у Артёма",
  "merchantId": "MF0000000001",
  "amount": 1000000,
  "paymentPurpose": "Оплата по договору №123456789 от 01.09.2001",
  "address": "г. Воронеж, ул. Лисюкова, д.5, стр.1",
  "mcc": "4122",
  "fraudScore": "0000000000000000",
  "inn": "4285733785",
  "redirectUrl": "https://exampletsp.io/qwertyui",
  "agentId": "A00000000001",
  "takeTax": true,
  "taxAmount": 200000,
  "uip": "281000670LSS7DN18SJQDNP4B05KLJL2"
}
error
stringrequired

Код ошибки. Принимает возможные значения: invalid_request - Неверные входные параметры запроса

error_description
stringoptional

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

Пример ошибки 400 (Bad Request)
{
  "error": "invalid_request",
  "error_description": "Authorization header is not present in request headers"
}
error
stringrequired

Код ошибки. Принимает возможные значения: invalid_token - Предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам

error_description
stringoptional

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

Пример ошибки 401 (Unauthorized)
{
  "error": "invalid_token",
  "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
}
error
stringrequired

Код ошибки. Принимает возможные значения: insufficient_scope - У пользователя нет прав на использование запрашиваемого сервиса, доступ к которому не предусмотрен настройками scope

error_description
stringoptional

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

Пример ошибки 403 (Forbidden)
{
  "error": "insufficient_scope",
  "error_description": "The request requires higher privileges than provided by the access token"
}
error
stringrequired

Код ошибки. Принимает возможные значения: unknown_endpoint - Эндпоинт не найден или неактивен

error_description
stringoptional

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

Пример ошибки 404 (Not Found)
{
  "error": "unknown_endpoint",
  "error_description": "Endpoint is not found or not active"
}
Пример ответа 429 (Too Many Requests)
Нет тела ответа
error
stringrequired

Код ошибки. Принимает возможные значения: internal_error - Внутренняя ошибка сервиса при выполнении обработки запроса

error_description
stringoptional

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

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

Значения параметров ошибок могут изменяться. Рекомендуем предусмотреть стандартную обработку ошибок, не описанных в текущей версии документации.