B2BH2H

Получение результата наложения подписей

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

payment-registries

Описание

Метод позволяет получить результат наложения подписей с помощью метода «Создание запроса на подписание реестра платежей» по идентификатору запроса на подписание.

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

application/json

PATH
Атрибут
Описание
registryId
stringrequired
signatureId
stringrequired
Пример запроса
Язык 
1curl --location --globoff 'https://baas.alfabank.ru/api/jp/v1/registries/{registryId}/signatures/{signatureId}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'
Параметры ответа
Пример ответа 200 (OK) 
1{
2  "status": "PARTIALLY_SIGNED",
3  "digestSignatures": [
4    {
5      "certificateUuid": "51999366d11e143acbc03a56d70001000866c1",
6      "signatureType": "RSA",
7      "status": "SIGNED"
8    },
9    {
10      "certificateUuid": "61000366d11e143acbc03a56d70001000366d1",
11      "signatureType": "RSA",
12      "status": "FAILED",
13      "errorCode": "signature_error",
14      "errorMessage": "Mathematical verification of the signature has failed."
15    }
16  ]
17}
BODY
атрибут
описание
status
stringrequired

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

  • •
    ACCEPTED - запрос принят и поставлен в очередь на обработку;
  • •
    IN_PROGRESS - запрос находится в обработке;
  • •
    PARTIALLY_SIGNED - часть подписей успешно наложена, либо переданной(-ых) подписи(-ей) недостаточно;
  • •
    SIGNED - реестр платежей успешно подписан;
  • •
    ERROR - произошла ошибка при обработке запроса
objectoptional

Информация об ошибке

code
stringoptional

Код ошибки

message
stringoptional

Сообщение об ошибке

array of objectsoptional

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

certificateUuid
stringoptional

Серийный номер RSA-сертификата

signatureType
stringrequired

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

  • •
    QES - квалифицированная электронная подпись (КЭП);
  • •
    RSA - подписание с помощью RSA-сертификата
status
stringrequired

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

  • •
    SIGNED - подпись успешно наложена;
  • •
    FAILED - попытка наложения подписи завершилась ошибкой
errorCode
stringoptional

Код ошибки при подписании

errorMessage
stringoptional

Сообщение об ошибке при подписании

Пример ответа 200 (OK) 
1{
2  "status": "PARTIALLY_SIGNED",
3  "digestSignatures": [
4    {
5      "certificateUuid": "51999366d11e143acbc03a56d70001000866c1",
6      "signatureType": "RSA",
7      "status": "SIGNED"
8    },
9    {
10      "certificateUuid": "61000366d11e143acbc03a56d70001000366d1",
11      "signatureType": "RSA",
12      "status": "FAILED",
13      "errorCode": "signature_error",
14      "errorMessage": "Mathematical verification of the signature has failed."
15    }
16  ]
17}
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}
Нет тела ответа
Создание запроса на подписание реестра платежейПолучение данных реестра платежей