B2BH2H

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

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

payment-registries

Описание

Метод позволяет создать реестр рублёвых платёжных поручений.

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

application/json

Content-Type
stringrequired

application/json

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

Срочность платежей в реестре. Возможные значения:

  • •
    OFFHOURS - продлённый операционный день;
  • •
    BESP - срочный платёж;
  • •
    NORMAL - стандартный операционный день
description
stringoptional

Описание реестра

array of objectsrequired

Данные рублёвого платёжного поручения

number
stringoptional

Номер документа. Если поле не заполнено, то номер присваивается автоматически

date
stringrequired

Дата составления документа в формате YYYY-MM-DD

deliveryKind
stringoptional

Вид платежа. Возможные значения: электронно. Если не заполнено, то будет присвоено значение электронно

amount
numberrequired

Сумма платежа

payerName
stringoptional

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

payerInn
stringrequired

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

payerKpp
stringoptional

КПП плательщика

payerAccount
stringrequired

Счёт плательщика

payerBankBic
stringoptional

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

payerBankCorrAccount
stringoptional

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

payeeName
stringrequired

Полное наименование получателя платежа

payeeInn
stringrequired

ИНН получателя платежа

payeeKpp
stringoptional

КПП получателя платежа

payeeAccount
stringrequired

Счёт получателя платежа

payeeBankBic
stringrequired

БИК банка получателя платежа

payeeBankCorrAccount
stringoptional

Корсчёт банка получателя платежа

objectoptional

Реквизиты налогового, таможенного или иного бюджетного платежа

uip
stringoptional

Уникальный идентификатор платежа/начисления. Обязательное поле для бюджетных платежей

drawerStatus101
stringoptional

Статус плательщика. Обязательное поле для бюджетных платежей

kbk
stringoptional

Код бюджетной классификации. Обязательное поле для бюджетных платежей

oktmo
stringoptional

Код OKTMO. Обязательное поле для бюджетных платежей

reasonCode106
stringoptional

Показатель основания платежа. Обязательное поле для бюджетных платежей

taxPeriod107
stringoptional

Налоговый период или код таможенного органа. Обязательное поле для бюджетных платежей

docNumber108
stringoptional

Номер налогового документа. Обязательное поле для бюджетных платежей

docDate109
stringoptional

Дата налогового документа в формате YYYY-MM-DD. Обязательное поле для бюджетных платежей

paymentKind110
stringoptional

Код выплат

incomeTypeCode
stringoptional

Код вида дохода получателей выплаты по 229-ФЗ. При значениях 1, 3, 5 в назначении платежа следует указать сумму взыскания в формате //ВЗС//сумма-копейки//, где сумма-копейки - это сумма взыскания. Пример при сумме взыскания в пять тысяч рублей: //ВЗС//5000-00//

priority
stringoptional

Очерёдность платежа. Возможные значения:

  • •
    1 - алиментные удержания из заработной платы, компенсации вреда жизни и здоровью;
  • •
    2 - погашение задолженностей по зарплатам сотрудникам, выплаты выходных пособий и авторских вознаграждений;
  • •
    3 - выплаты зарплат сотрудникам по трудовым соглашениям, принудительная уплата налогов и отчислений во внебюджетные фонды;
  • •
    4 - принудительные выплаты, которые не вошли в первую, вторую и третью очередь, например, задолженности по договорам, штрафы, неустойки, коммунальные платежи;
  • •
    5 - все остальные, не вошедшие в первую, вторую, третью и четвёртую категории, например, добровольная уплата долгов, пеней, штрафов

Значение по умолчанию: 5

purpose
stringrequired

Назначение платежа. Максимальное количество символов - 210.

В случае оплаты за третье лицо в начале строки необходимо указать:

  • •
    ИНН и КПП (при наличии) владельца счёта (плательщика);
  • •
    Наименование налогоплательщика, плательщика сборов, страховых взносов и иных платежей (третьего лица).

Для разделения информации об ИНН, КПП клиента и о налогоплательщике от иной информации, указываемой в реквизите, используйте символы //

Пример запроса
Язык
1curl --location 'https://baas.alfabank.ru/api/jp/v1/registries' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--header 'Accept: application/json' \
5--data '{
6  "urgencyCode": "NORMAL",
7  "description": "Описание реестра",
8  "payments": [
9    {
10      "number": "1",
11      "date": "2023-12-31",
12      "deliveryKind": "электронно",
13      "amount": 41.04,
14      "payerName": "Общество с ограниченной ответственностью \"Клиент\"",
15      "payerInn": "7736576798",
16      "payerKpp": "772201001",
17      "payerAccount": "40702810102300000001",
18      "payerBankBic": "044525593",
19      "payerBankCorrAccount": "30101810200000000593",
20      "payeeName": "Общество с ограниченной ответственностью \"Центр \"ИННОВАЦИЯ\"",
21      "payeeInn": "7723870785",
22      "payeeKpp": "553453453",
23      "payeeAccount": "40702810564564564531",
24      "payeeBankBic": "040173745",
25      "payeeBankCorrAccount": "30101810800000000745",
26      "departmentalInfo": {
27        "uip": "0",
28        "drawerStatus101": "01",
29        "kbk": "18210102010011000110",
30        "oktmo": "45902000",
31        "reasonCode106": "ТП",
32        "taxPeriod107": "ГД.00.2021",
33        "docNumber108": "000000000000001",
34        "docDate109": "2021-12-14",
35        "paymentKind110": "0"
36      },
37      "incomeTypeCode": "2",
38      "priority": "5",
39      "purpose": "1234567890//123456789//Иванов Иван Иванович оплата по договору 1. НДС не облагается"
40    }
41  ]
42}'
Параметры ответа
Пример ответа 201 (Created)
1{
2  "registryId": "U102702240001208",
3  "description": "Описание реестра",
4  "payerAccount": "40702810102300000001",
5  "urgencyCode": "NORMAL",
6  "paymentsCount": 2,
7  "totalAmount": 92.93
8}
BODY
атрибут
описание
registryId
stringrequired

Идентификатор реестра

description
stringoptional

Описание реестра

payerAccount
stringoptional

Счёт списания

urgencyCode
stringoptional

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

  • •
    OFFHOURS - продлённый операционный день;
  • •
    BESP - срочный платёж;
  • •
    NORMAL - стандартный операционный день
paymentsCount
integeroptional

Количество платежей реестра

totalAmount
numberoptional

Общая сумма платежей в реестре

Пример ответа 201 (Created)
1{
2  "registryId": "U102702240001208",
3  "description": "Описание реестра",
4  "payerAccount": "40702810102300000001",
5  "urgencyCode": "NORMAL",
6  "paymentsCount": 2,
7  "totalAmount": 92.93
8}
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 - предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам. При истечении срока жизни токена необходимо обновить его с помощью refresh_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 и параметра prompt=consent
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}
Нет тела ответа