B2BH2H

Создание запроса на подписание реестра платежей

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

payment-registries

Описание

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

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

application/json

Content-Type
stringrequired

application/json

PATH
Атрибут
Описание
registryId
stringrequired
BODY
Атрибут
Описание
array of objectsrequired

Электронные подписи по дайджесту документа

base64Encoded
stringrequired

Значение электронной подписи, закодированное в Base64

certificateUuid
stringoptional
signatureType
stringrequired

Тип электронной подписи. Возможные значения:

  • •
    QES - квалифицированная электронная подпись (КЭП);
  • •
    RSA - подписание с помощью RSA-сертификата
Пример запроса
Язык
1curl --location --globoff 'https://baas.alfabank.ru/api/jp/v1/registries/{registryId}/signatures' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--header 'Accept: application/json' \
5--data '{
6  "digestSignatures": [
7    {
8      "base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
9      "certificateUuid": "61000366d11e143acbc03a56d70001000366d1",
10      "signatureType": "RSA"
11    }
12  ]
13}'
Параметры ответа
Пример ответа 202 (Accepted)
1{
2  "signatureId": "0937b8b1-b226-45f3-b93e-7ba9008db79a"
3}
BODY
атрибут
описание
signatureId
stringrequired

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

Пример ответа 202 (Accepted)
1{
2  "signatureId": "0937b8b1-b226-45f3-b93e-7ba9008db79a"
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 - предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам. При истечении срока жизни токена необходимо обновить его с помощью 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}
Нет тела ответа