B2BH2H

Регистрация пакета платёжных ссылок

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

b2b-sbp

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

application/json

Content-Type
stringrequired

application/json

BODY
Атрибут
Описание
objectrequired

Контекст клиента

b2bClientId
stringrequired

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

partnerId
integerrequired

Идентификатор партнёра. Банк сообщает партнёру API при подключении

array of objectsrequired

Данные платёжной ссылки, регистрируемой в массиве

name
stringrequired

Наименование платёжной ссылки, уникальное в рамках одного массива

payeeAccount
stringrequired

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

merchantId
stringrequired

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

amount
integeroptional

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

qrcType
stringrequired

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

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

Срок жизни одноразовой платёжной ссылки в минутах. Значение по умолчанию: 4320

paymentPurpose
stringoptional

Назначение платежа. Ограничения:

  • •
    максимальное количество символов - 210;
  • •
    допустимые символы: А-Я, а-я, A-Z, a-z, 0-9, пробел (U+0020) и .,;:'"()!?+-_@/\. Использование типографских кавычек («»), длинных тире (-, -), эмодзи и других нестандартных символов Unicode приведёт к ошибке
redirectUrl
stringoptional

Ссылка для перехода после выполнения платежа в соответствии со спецификацией RFC 3986:

  • •
    формат URL: scheme://host[:port][/path][?query];
  • •
    допустимы только символы в кодировке ASCII, не ASCII-символы должны быть закодированы:
    • •
      host - через Punycode (RFC-3492);
    • •
      path и query - через percent-encoding (RFC 3986)
takeTax
booleanrequired

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

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

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

uip
stringoptional

Уникальный идентификатор платежа для одноразовой платёжной ссылки

payerInn
stringoptional

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

Пример запроса
Язык
1curl --location 'https://baas.alfabank.ru/api/sbp/jp/v1/payment-urls/batch' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--header 'Accept: application/json' \
5--data '{
6  "client": {
7    "b2bClientId": "021be5ed-6312-4982-a4e9-2a2cc44bc88c",
8    "partnerId": 214
9  },
10  "paymentUrls": [
11    {
12      "name": "Ссылка для оплаты ИП Иванов И.П.",
13      "payeeAccount": "40702810100010000001",
14      "merchantId": "MF0000000001",
15      "amount": 1000000,
16      "qrcType": "ONETIME",
17      "ttl": 4320,
18      "paymentPurpose": "Оплата по договору №123456789 от 01.09.2001",
19      "redirectUrl": "https://exampletsp.io/qwertyui",
20      "takeTax": true,
21      "taxAmount": 200000,
22      "uip": "281000670LSS7DN18SJQDNP4B05KLJL2",
23      "payerInn": "3664069397"
24    }
25  ]
26}'
Параметры ответа
Пример ответа 201 (Created)
1{
2  "batchId": "a7631fbb-f94f-4c17-1e13-626b4e25585c"
3}
BODY
атрибут
описание
batchId
stringoptional

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

Пример ответа 201 (Created)
1{
2  "batchId": "a7631fbb-f94f-4c17-1e13-626b4e25585c"
3}
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

Код ошибки. Принимает возможные значения:

  • •
    internal_error - внутренняя ошибка сервиса при выполнении обработки запроса
error_description
stringoptional

Описание ошибки

Пример ошибки 500 (Internal Server Error)
1{
2  "error": "internal_error",
3  "error_description": "Internal server error"
4}
Нет тела ответа