Создание реестра поручений

Песочница

POST https://sandbox.alfabank.ru/api/aff/jp/v1/registers

Пром

POST https://baas.alfabank.ru/api/aff/jp/v1/registers

Scope

factoring

Описание

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

Важно

В одном реестре можно передавать не более 1000 платёжных поручений.

Параметры запроса

HEADERS

Атрибут

Описание

Authorization

stringrequired

Bearer {access_token}, полученный по Authorization Code Flow H2H

stringrequired

application/json

Content-Type

stringrequired

application/json

BODY

Атрибут

Описание

totalSum

numberrequired

Сумма всех платёжных поручений

plannedExecutionDate

daterequired

Планируемая дата финансирования

array of objectsrequired

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

paymentId

stringrequired

Идентификатор платёжного поручения в формате UUID

Пример запроса

Язык

1curl --location 'https://baas.alfabank.ru/api/aff/jp/v1/registers' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--header 'Accept: application/json' \
5--data '{
6  "totalSum": 100000000.2,
7  "plannedExecutionDate": "2000-01-01",
8  "paymentIds": [
9    {
10      "paymentId": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
11    }
12  ]
13}'

Параметры ответа

Пример ответа 201 (Created)

1{
2  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
3  "registerNumber": 12345,
4  "file": "MIItPgYJKoZIhvcN...(truncated)"
5}

BODY

атрибут

описание

stringrequired

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

registerNumber

integerrequired

Номер реестра

file

stringrequired

Файл реестра, закодированный в Base64

Пример ответа 201 (Created)

1{
2  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
3  "registerNumber": 12345,
4  "file": "MIItPgYJKoZIhvcN...(truncated)"
5}

BODY

атрибут

описание

error

stringrequired

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

•

invalid_request - неверные входные параметры запроса

error_description

stringrequired

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

Пример ошибки 400 (Bad Request)

1{
2  "error": "invalid_request",
3  "error_description": "The date should be today"
4}

BODY

атрибут

описание

error

stringrequired

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

•

invalid_token - предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам

error_description

stringrequired

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

Пример ошибки 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

stringrequired

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

Пример ошибки 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

stringrequired

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

Пример ошибки 500 (Internal Server Error)

1{
2  "error": "internal_error",
3  "error_description": "Internal server error"
4}

Нет тела ответа