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

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

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

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

Scope

b2b-sbp

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

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

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

Accept
stringrequired

application/json

Content-Type
stringoptional

application/json

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

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

qrcId
stringoptional

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

onlyActive
booleanoptional

Вернуть только действующие ссылки (Да/Нет). Действующими считаются неоплаченные и с неистекшим сроком действия ( expirationDate в будущем). Значение по умолчанию false

sort
array of stringoptional

Сортировка результатов поиска (не более трёх параметров). Если параметры сортировки не заданы, записи сортируются по убыванию registrationDate . Возможные значения:

  • name - Наименование платёжной ссылки;
  • merchantId - Идентификатор торгово-сервисного предприятия (ТСП);
  • payeeAccount - Счёт зачисления;
  • amount - Сумма к зачислению в копейках;
  • qrcType - Тип платёжной ссылки;
  • takeTax - Информация о взимании НДС;
  • registrationDate - Дата и время регистрации платёжной ссылки;
  • expirationDate - Дата и время истечения срока жизни платёжной ссылки
limit
integeroptional

Количество элементов. Максимальное значение - 100.

offset
integeroptional

Смещение в результатах поиска

Пример запроса
curl -X GET https://baas.alfabank.ru/api/sbp/jp/v1/payment-urls?b2bClientId=021be5ed-6312-4982-a4e9-2a2cc44bc88c&qrcId=AD1000038AQ1FG409KGACUQU5QRSH3FM&onlyActive=true&sort=account,asc&sort=type,asc&sort=registrationDate,desc&limit=10 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

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

Пример ответа 200 (ОК)
{
    "pagination": {
        "limit": 10,
        "offset": 0,
        "totalCount": 1
    },
    "paymentUrls": [
        {
            "qrcId": "AD1000038AQ1FG409KGACUQU5QRSH3FM",
            "payload": "https://b2b.cbrpay.ru/AD1000038AQ1FG409KGACUQU5QRSH3FM",
            "name": "Ссылка для оплаты ИП Иванов И.П.",
            "payeeAccount": "40702810100010000001",
            "merchantId": "MF0000000001",
            "amount": 1000000,
            "qrcType": "ONETIME",
            "paymentPurpose": "Оплата по договору №123456789 от 01.09.2001",
            "takeTax": true,
            "taxAmount": 200000,
            "image": "iVBORw0KGgoAAAANSUhEUgAABEoAAARKCAIAAADXJAK3AAAABmJLR0QA/wD...YII=",
            "lastPayment": {
                "amount": 1000000,
                "taxAmount": 200000,
                "paymentPurpose": "Оплата по договору №123456789 от 01.09.2001",
                "payerAccount": "40702810901400001130",
                "currency": "RUR",
                "timestamp": "2022-05-26T09:09:32Z",
                "payerInfo": {
                    "name": "OOO Ромашка",
                    "inn": "3664069397",
                    "bik": "044525593"
                }
            },
            "uip": "281000670LSS7DN18SJQDNP4B05KLJL2",
            "registrationDate": "2022-01-10T12:33:25Z",
            "expirationDate": "2022-01-13T12:33:25Z"
        }
    ]
}
objectoptional

Параметры пагинации

limit
integeroptional

Количество элементов

offset
integeroptional

Смещение в результатах поиска

totalCount
integeroptional

Количество элементов, удовлетворяющих запросу

array of objectrequired

Платёжные ссылки

qrcId
stringrequired

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

payload
stringoptional

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

name
stringrequired

Наименование платёжной ссылки

payeeAccount
stringrequired

Счёт зачисления

merchantId
stringrequired

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

amount
integeroptional

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

qrcType
stringrequired

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

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

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

takeTax
booleanrequired

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

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

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

image
stringrequired

Изображение в формате image/png

objectoptional

Информация о последнем входящем платеже

amount
integeroptional

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

taxAmount
integeroptional

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

paymentPurpose
stringoptional

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

payerAccount
stringoptional

Счет списания платежа

currency
stringoptional

Код валюты платежа

timestamp
stringoptional

Дата и время выполнения Операции СБП в формате ISO 8601

objectoptional

Информация о плательщике

name
stringoptional

Наименование ЮЛ

amount
stringoptional

ИНН плательщика

amount
stringoptional

БИК банка плательщика

uip
stringoptional

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

registrationDate
stringrequired

Дата и время регистрации платёжной ссылки в формате ISO 8601

expirationDate
stringoptional

Дата и время истечения срока жизни платёжной ссылки в формате ISO 8601

Пример ответа 200 (ОК)
{
    "pagination": {
        "limit": 10,
        "offset": 0,
        "totalCount": 1
    },
    "paymentUrls": [
        {
            "qrcId": "AD1000038AQ1FG409KGACUQU5QRSH3FM",
            "payload": "https://b2b.cbrpay.ru/AD1000038AQ1FG409KGACUQU5QRSH3FM",
            "name": "Ссылка для оплаты ИП Иванов И.П.",
            "payeeAccount": "40702810100010000001",
            "merchantId": "MF0000000001",
            "amount": 1000000,
            "qrcType": "ONETIME",
            "paymentPurpose": "Оплата по договору №123456789 от 01.09.2001",
            "takeTax": true,
            "taxAmount": 200000,
            "image": "iVBORw0KGgoAAAANSUhEUgAABEoAAARKCAIAAADXJAK3AAAABmJLR0QA/wD...YII=",
            "lastPayment": {
                "amount": 1000000,
                "taxAmount": 200000,
                "paymentPurpose": "Оплата по договору №123456789 от 01.09.2001",
                "payerAccount": "40702810901400001130",
                "currency": "RUR",
                "timestamp": "2022-05-26T09:09:32Z",
                "payerInfo": {
                    "name": "OOO Ромашка",
                    "inn": "3664069397",
                    "bik": "044525593"
                }
            },
            "uip": "281000670LSS7DN18SJQDNP4B05KLJL2",
            "registrationDate": "2022-01-10T12:33:25Z",
            "expirationDate": "2022-01-13T12:33:25Z"
        }
    ]
}
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)
Нет тела ответа

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