B2BH2H

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

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

b2b-sbp

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

application/json

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

Идентификатор клиента, от имени которого выполняется запрос. Банк сообщает партнёру API при подключении

qrcId
stringoptional

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

onlyActive
booleanoptional

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

sort
arrayoptional

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

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

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

offset
integeroptional

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

Пример запроса
Язык 
1curl --location --globoff 'https://baas.alfabank.ru/api/sbp/jp/v1/payment-urls?b2bClientId={b2bClientId}&qrcId={qrcId}&onlyActive={onlyActive}&sort={sort}&limit={limit}&offset={offset}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'
Параметры ответа
Пример ответа 200 (OK) 
1{
2  "pagination": {
3    "limit": 10,
4    "offset": 0,
5    "totalCount": 1
6  },
7  "paymentUrls": [
8    {
9      "qrcId": "AD1000038AQ1FG409KGACUQU5QRSH3FM",
10      "payload": "https://b2b.cbrpay.ru/AD1000038AQ1FG409KGACUQU5QRSH3FM",
11      "name": "Ссылка для оплаты ИП Иванов И.П.",
12      "payeeAccount": "40702810100010000001",
13      "merchantId": "MF0000000001",
14      "amount": 1000000,
15      "qrcType": "ONETIME",
16      "paymentPurpose": "Оплата по договору №123456789 от 01.09.2001",
17      "takeTax": true,
18      "taxAmount": 200000,
19      "image": "iVBORw0KGgoAAAANSUhEUgAABEoAAARKCAIAAADXJAK3AAAABmJLR0QA/wD...YII=",
20      "lastPayment": {
21        "amount": 1000000,
22        "taxAmount": 200000,
23        "paymentPurpose": "Оплата по договору №123456789 от 01.09.2001",
24        "payerAccount": "40702810901400001130",
25        "currency": "RUR",
26        "timestamp": "2022-05-26T09:09:32Z",
27        "payerInfo": {
28          "name": "OOO Ромашка",
29          "inn": "3664069397",
30          "bik": "044525593",
31          "accountType": "BBAN",
32          "bankName": "АО \"АЛЬФА-БАНК\"",
33          "bankCorrAccount": "30101810200000000593"
34        }
35      },
36      "uip": "281000670LSS7DN18SJQDNP4B05KLJL2",
37      "registrationDate": "2022-08-17T14:26:55Z",
38      "expirationDate": "2022-08-20T14:26:55Z"
39    }
40  ]
41}
BODY
атрибут
описание
objectoptional

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

limit
integeroptional

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

offset
integeroptional

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

totalCount
integeroptional

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

array of objectsrequired

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

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

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

objectoptional

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

amount
integerrequired

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

taxAmount
integerrequired

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

paymentPurpose
stringrequired

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

payerAccount
stringrequired

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

currency
stringrequired

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

timestamp
stringrequired

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

objectrequired

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

name
stringrequired

Наименование ЮЛ плательщика

inn
stringrequired

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

bik
stringrequired

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

accountType
stringoptional

Тип идентификатора номера счёта плательщика

bankName
stringrequired

Наименование банка плательщика

bankCorrAccount
stringrequired

Корреспондентский счёт банка плательщика

uip
stringoptional

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

registrationDate
stringrequired

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

expirationDate
stringoptional

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

Пример ответа 200 (OK) 
1{
2  "pagination": {
3    "limit": 10,
4    "offset": 0,
5    "totalCount": 1
6  },
7  "paymentUrls": [
8    {
9      "qrcId": "AD1000038AQ1FG409KGACUQU5QRSH3FM",
10      "payload": "https://b2b.cbrpay.ru/AD1000038AQ1FG409KGACUQU5QRSH3FM",
11      "name": "Ссылка для оплаты ИП Иванов И.П.",
12      "payeeAccount": "40702810100010000001",
13      "merchantId": "MF0000000001",
14      "amount": 1000000,
15      "qrcType": "ONETIME",
16      "paymentPurpose": "Оплата по договору №123456789 от 01.09.2001",
17      "takeTax": true,
18      "taxAmount": 200000,
19      "image": "iVBORw0KGgoAAAANSUhEUgAABEoAAARKCAIAAADXJAK3AAAABmJLR0QA/wD...YII=",
20      "lastPayment": {
21        "amount": 1000000,
22        "taxAmount": 200000,
23        "paymentPurpose": "Оплата по договору №123456789 от 01.09.2001",
24        "payerAccount": "40702810901400001130",
25        "currency": "RUR",
26        "timestamp": "2022-05-26T09:09:32Z",
27        "payerInfo": {
28          "name": "OOO Ромашка",
29          "inn": "3664069397",
30          "bik": "044525593",
31          "accountType": "BBAN",
32          "bankName": "АО \"АЛЬФА-БАНК\"",
33          "bankCorrAccount": "30101810200000000593"
34        }
35      },
36      "uip": "281000670LSS7DN18SJQDNP4B05KLJL2",
37      "registrationDate": "2022-08-17T14:26:55Z",
38      "expirationDate": "2022-08-20T14:26:55Z"
39    }
40  ]
41}
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}
Нет тела ответа
Регистрация многоразовой платёжной ссылкиПолучение данных по зарегистрированной платёжной ссылке