Scope
b2b-sbp
Параметры запроса
Bearer {access_token}, полученный по Client Credentials Flow
application/json
Идентификатор клиента, от имени которого выполняется запрос. Банк сообщает партнёру API при подключении
Количество элементов
Смещение в результатах поиска
Идентификатор массива платёжных ссылок
1curl --location --globoff 'https://baas.alfabank.ru/api/sbp/jp/v1/payment-urls/batch/{batchId}?b2bClientId={b2bClientId}&limit={limit}&offset={offset}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'
Параметры ответа
1{
2 "pagination": {
3 "limit": 10,
4 "offset": 0,
5 "totalCount": 1
6 },
7 "status": "COMPLETE",
8 "paymentUrls": [
9 {
10 "qrcId": "AD1000038AQ1FG409KGACUQU5QRSH3FM",
11 "payload": "https://b2b.cbrpay.ru/AD1000038AQ1FG409KGACUQU5QRSH3FM",
12 "name": "Ссылка для оплаты ИП Иванов И.П.",
13 "payeeAccount": "40702810100010000001",
14 "merchantId": "MF0000000001",
15 "amount": 1000000,
16 "ttl": 4320,
17 "qrcType": "ONETIME",
18 "paymentPurpose": "Оплата по договору №123456789 от 01.09.2001",
19 "redirectUrl": "https://exampletsp.io/qwertyui",
20 "takeTax": true,
21 "taxAmount": 200000,
22 "image": "iVBORw0KGgoAAAANSUhEUgAABEoAAARKCAIAAADXJAK3AAAABmJLR0QA/wD...YII=",
23 "uip": "281000670LSS7DN18SJQDNP4B05KLJL2",
24 "payerInn": "3664069397",
25 "registrationDate": "2022-01-10T12:33:25Z",
26 "expirationDate": "2022-01-13T12:33:25Z",
27 "registrationStatus": "REGISTERED"
28 }
29 ]
30}
Параметры пагинации
Количество элементов
Смещение в результатах поиска
Количество элементов, удовлетворяющих запросу
Статус регистрации массива платёжных ссылок. Принимает возможные значения:
-
•
IN_PROGRESS- в обработке; -
•
COMPLETE- регистрация выполнена
Информация о платёжной ссылке
Идентификатор платёжной ссылки
Платёжная ссылка
Наименование платёжной ссылки
Счёт зачисления
Идентификатор ТСП
Сумма к зачислению в копейках
Срок жизни одноразовой платёжной ссылки в минутах
Тип платёжной ссылки. Принимает возможные значения:
-
•
ONETIME- одноразовая платёжная ссылка; -
•
REUSABLE- многоразовая платёжная ссылка
Назначение платежа
Ссылка для перехода после выполнения платежа
Информация о взимании НДС. Принимает возможные значения:
-
•
true- облагается НДС; -
•
false- не облагается НДС
Сумма НДС в копейках
Изображение base64encoded. В формате image/png
Уникальный идентификатор платежа
ИНН плательщика
Дата и время регистрации платёжной ссылки в формате ISO 8601
Дата и время истечения срока жизни платёжной ссылки в формате ISO 8601.
Срок действия многоразовой ссылки составляет 365 дней с даты регистрации и автоматически продлевается на 365 дней с даты последнего платежа.
Статус регистрации платёжной ссылки. Принимает возможные значения:
-
•
REGISTERED- платёжная ссылка зарегистрирована; -
•
ERROR- ошибка при регистрации платёжной ссылки
Описание ошибки при регистрации платёжной ссылки
1{
2 "pagination": {
3 "limit": 10,
4 "offset": 0,
5 "totalCount": 1
6 },
7 "status": "COMPLETE",
8 "paymentUrls": [
9 {
10 "qrcId": "AD1000038AQ1FG409KGACUQU5QRSH3FM",
11 "payload": "https://b2b.cbrpay.ru/AD1000038AQ1FG409KGACUQU5QRSH3FM",
12 "name": "Ссылка для оплаты ИП Иванов И.П.",
13 "payeeAccount": "40702810100010000001",
14 "merchantId": "MF0000000001",
15 "amount": 1000000,
16 "ttl": 4320,
17 "qrcType": "ONETIME",
18 "paymentPurpose": "Оплата по договору №123456789 от 01.09.2001",
19 "redirectUrl": "https://exampletsp.io/qwertyui",
20 "takeTax": true,
21 "taxAmount": 200000,
22 "image": "iVBORw0KGgoAAAANSUhEUgAABEoAAARKCAIAAADXJAK3AAAABmJLR0QA/wD...YII=",
23 "uip": "281000670LSS7DN18SJQDNP4B05KLJL2",
24 "payerInn": "3664069397",
25 "registrationDate": "2022-01-10T12:33:25Z",
26 "expirationDate": "2022-01-13T12:33:25Z",
27 "registrationStatus": "REGISTERED"
28 }
29 ]
30}
Код ошибки. Принимает возможные значения:
-
•
invalid_request- неверные входные параметры запроса
Описание ошибки
1{
2 "error": "invalid_request",
3 "error_description": "Authorization header is not present in request headers"
4}
Код ошибки. Принимает возможные значения:
-
•
invalid_token- предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам. Необходимо получить новый токен доступа
Описание ошибки
1{
2 "error": "invalid_token",
3 "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
4}
Код ошибки. Принимает возможные значения:
-
•
insufficient_scope- при запросе токена доступа не были переданы все необходимые scopes. Необходимо повторно отправить запрос на получение токена доступа с указанием всех доступных scopes
Описание ошибки
1{
2 "error": "insufficient_scope",
3 "error_description": "The request requires higher privileges than provided by the access token"
4}
Код ошибки. Принимает возможные значения:
-
•
unknown_endpoint- эндпоинт не найден или неактивен
Описание ошибки
1{
2 "error": "unknown_endpoint",
3 "error_description": "Endpoint is not found or not active"
4}
Код ошибки. Принимает возможные значения:
-
•
internal_error- внутренняя ошибка сервиса при выполнении обработки запроса
Описание ошибки
1{
2 "error": "internal_error",
3 "error_description": "Internal server error"
4}