B2BH2H

Получение данных реестра платежей

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

payment-registries

Описание

Метод позволяет получить общие данные реестра рублёвых платёжных поручений по его идентификатору. В ответе также возвращается информация о статусах платежей реестра. Для получения детальной информации по платежам реестра необходимо использовать метод «Получение списка рублёвых платежей в реестре»

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

application/json

PATH
Атрибут
Описание
registryId
stringrequired
Пример запроса
Язык 
1curl --location --globoff 'https://baas.alfabank.ru/api/jp/v1/registries/{registryId}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'
Параметры ответа
Пример ответа 200 (OK) 
1{
2  "status": "UPLOADED",
3  "description": "Описание реестра",
4  "payerName": "Общество с ограниченной ответственностью \"Клиент\"",
5  "payerAccount": "40702810102300000001",
6  "urgencyCode": "NORMAL",
7  "registryActualState": {
8    "paymentsCount": 2,
9    "totalAmount": 69.51
10  },
11  "states": [
12    {
13      "count": 2,
14      "amount": 69.51,
15      "status": "ON_SIGNING"
16    }
17  ],
18  "isValidForSign": true
19}
BODY
атрибут
описание
status
stringoptional

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

  • •
    UPLOADING - загружается;
  • •
    UPLOADED - черновик;
  • •
    ON_SIGNING - на подпись;
  • •
    SIGNED - подписан;
  • •
    PROCESSING - на обработке;
  • •
    DONE - исполнен;
  • •
    PARTIALLY_DONE - исполнен частично;
  • •
    UPLOAD_ERROR - ошибка загрузки;
  • •
    ERROR - отклонён банком;
  • •
    DELETED - удалён;
  • •
    URGENCY_CHANGE - идёт обновление данных реестра;
  • •
    EDIT_PAYMENTS - промежуточный статус во время копирования платежей в реестрах
description
stringoptional

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

payerName
stringoptional

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

payerAccount
stringoptional

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

urgencyCode
stringoptional

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

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

Информация о количестве и сумме платежей реестра

paymentsCount
integeroptional

Текущее количество платежей в реестре

totalAmount
numberoptional

Текущая сумма платежей в реестре

array of objectsoptional

Информация о статусах платежей

count
integerrequired

Количество платежей в указанном статусе

amount
numberrequired

Сумма платежей в указанном статусе

status
stringrequired

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

  • •
    DRAFT - черновик;
  • •
    ON_SIGNING - на подпись;
  • •
    TO_BE_SEND - к отправке;
  • •
    PROCESSING - на исполнении;
  • •
    DONE - исполнен;
  • •
    REJECTED - не исполнен;
  • •
    DECLINED - отклонён;
  • •
    DELETED - удалён;
  • •
    WITH_ERRORS - с ошибками
isValidForSign
booleanoptional

Признак готовности реестра к подписанию

Пример ответа 200 (OK) 
1{
2  "status": "UPLOADED",
3  "description": "Описание реестра",
4  "payerName": "Общество с ограниченной ответственностью \"Клиент\"",
5  "payerAccount": "40702810102300000001",
6  "urgencyCode": "NORMAL",
7  "registryActualState": {
8    "paymentsCount": 2,
9    "totalAmount": 69.51
10  },
11  "states": [
12    {
13      "count": 2,
14      "amount": 69.51,
15      "status": "ON_SIGNING"
16    }
17  ],
18  "isValidForSign": true
19}
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}
Нет тела ответа
Получение результата наложения подписейПолучение списка платежей в реестре