B2BH2H

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

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

b2b-sbp

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

application/json

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

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

limit
integeroptional

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

offset
integeroptional

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

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

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

Пример запроса
Язык
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'
Параметры ответа
Пример ответа 200 (OK)
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}
BODY
атрибут
описание
objectoptional

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

limit
integeroptional

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

offset
integeroptional

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

totalCount
integeroptional

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

status
stringoptional

Статус регистрации массива платёжных ссылок. Принимает возможные значения:

  • •
    IN_PROGRESS - в обработке;
  • •
    COMPLETE - регистрация выполнена
array of objectsrequired

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

qrcId
stringoptional

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

payload
stringoptional

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

name
stringrequired

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

payeeAccount
stringrequired

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

merchantId
stringoptional

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

amount
integeroptional

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

ttl
integeroptional

Срок жизни одноразовой платёжной ссылки в минутах

qrcType
stringrequired

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

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

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

redirectUrl
stringoptional

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

takeTax
booleanrequired

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

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

Сумма НДС в копейках

image
stringoptional

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

uip
stringoptional

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

payerInn
stringoptional

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

registrationDate
stringoptional

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

expirationDate
stringoptional

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

Срок действия многоразовой ссылки составляет 365 дней с даты регистрации и автоматически продлевается на 365 дней с даты последнего платежа.

registrationStatus
stringrequired

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

  • •
    REGISTERED - платёжная ссылка зарегистрирована;
  • •
    ERROR - ошибка при регистрации платёжной ссылки
errorDescription
stringoptional

Описание ошибки при регистрации платёжной ссылки

Пример ответа 200 (OK)
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}
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}
Нет тела ответа