B2BH2H

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

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

b2b-sbp

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

application/json

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

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

Пример запроса
Язык
1curl --location --globoff 'https://baas.alfabank.ru/api/sbp/jp/v1/payment-urls/{qrcId}/data' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'
Параметры ответа
Пример ответа 200 (OK)
1{
2  "qrcId": "AD1000038AQ1FG409KGACUQU5QRSH3FM",
3  "qrcType": "REUSABLE",
4  "legalId": "LF0000000001",
5  "legalName": "ООО \"Кофейня у Артёма\"",
6  "memberId": "100000000001",
7  "brandName": "Кофейня у Артёма",
8  "payeeAccount": "40702810100010000001",
9  "merchantId": "MF0000000001",
10  "amount": 1000000,
11  "paymentPurpose": "Оплата по договору №123456789 от 01.09.2001",
12  "address": "г. Воронеж, ул. Лисюкова, д.5, стр.1",
13  "mcc": "4122",
14  "fraudScore": "DDDDDDDDDDDDDDDD",
15  "inn": "4285733785",
16  "redirectUrl": "https://exampletsp.io/qwertyui",
17  "agentId": "A00000000001",
18  "takeTax": true,
19  "taxAmount": 200000,
20  "uip": "281000670LSS7DN18SJQDNP4B05KLJL2"
21}
BODY
атрибут
описание
qrcId
stringrequired

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

qrcType
stringrequired

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

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

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

legalName
stringrequired

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

memberId
stringrequired

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

brandName
stringrequired

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

payeeAccount
stringoptional

Номер счёта получателя платежа

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 (OK)
1{
2  "qrcId": "AD1000038AQ1FG409KGACUQU5QRSH3FM",
3  "qrcType": "REUSABLE",
4  "legalId": "LF0000000001",
5  "legalName": "ООО \"Кофейня у Артёма\"",
6  "memberId": "100000000001",
7  "brandName": "Кофейня у Артёма",
8  "payeeAccount": "40702810100010000001",
9  "merchantId": "MF0000000001",
10  "amount": 1000000,
11  "paymentPurpose": "Оплата по договору №123456789 от 01.09.2001",
12  "address": "г. Воронеж, ул. Лисюкова, д.5, стр.1",
13  "mcc": "4122",
14  "fraudScore": "DDDDDDDDDDDDDDDD",
15  "inn": "4285733785",
16  "redirectUrl": "https://exampletsp.io/qwertyui",
17  "agentId": "A00000000001",
18  "takeTax": true,
19  "taxAmount": 200000,
20  "uip": "281000670LSS7DN18SJQDNP4B05KLJL2"
21}
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}
Нет тела ответа