Scope
payment-registries
Текущий метод больше не будет поддерживаться в связи с развитием функционала сервиса. Для продолжения работы с методом необходимо перейти на новый метод для получения списка платежей в реестре.
Параметры запроса
Bearer {access_token}, полученный по Authorization Code Flow / Authorization Code Flow H2H
application/json
Статусы платежей для фильтрации. Возможные значения:
-
•
DRAFT- черновик; -
•
ON_SIGNING- на подпись; -
•
TO_BE_SEND- к отправке; -
•
PROCESSING- на исполнении; -
•
DONE- исполнен; -
•
REJECTED- не исполнен; -
•
DECLINED- отклонён; -
•
DELETED- удалён
Дата начала периода
Дата окончания периода
Сортировка результатов поиска. Возможные значения: number, date, amount
Количество элементов
Смещение в результатах поиска
Идентификатор реестра
1curl --location --globoff 'https://baas.alfabank.ru/api/jp/v2/payments/registries/{registryId}?status={status}&fromDate={fromDate}&toDate={toDate}&sort={sort}&limit={limit}&offset={offset}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'Параметры ответа
1{
2 "pagination": {
3 "limit": 10,
4 "offset": 0,
5 "totalCount": 1
6 },
7 "payments": [
8 {
9 "id": "U031308240002351",
10 "number": "1",
11 "status": "DRAFT",
12 "info": "Сумма платежа должна состоять из цифр и быть больше 0",
13 "date": "2023-12-31",
14 "amount": 1.01,
15 "payerAccount": "40702810600010800068",
16 "payeeName": "Общество с ограниченной ответственностью \"Центр \"ИННОВАЦИЯ\"",
17 "payeeInn": "7723870785",
18 "payeeKpp": "553453453",
19 "payeeAccount": "40702810564564564531",
20 "payeeBankBic": "040173745",
21 "purpose": "Оплата заказа №1. НДС не облагается"
22 }
23 ]
24}Параметры пагинации
Количество элементов
Смещение в результатах поиска
Количество элементов, удовлетворяющих запросу
Данные рублёвого платёжного поручения
Идентификатор платежа
Номер документа
Статус платежа. Принимает возможные значения:
-
•
DRAFT- черновик; -
•
ON_SIGNING- на подпись; -
•
TO_BE_SEND- к отправке; -
•
PROCESSING- на исполнении; -
•
DONE- исполнен; -
•
REJECTED- не исполнен; -
•
DECLINED- отклонён; -
•
DELETED- удалён
Информационное сообщение для пользователя
Дата составления документа
Сумма платежа
Счёт плательщика
Полное наименование получателя платежа
ИНН получателя платежа
КПП получателя платежа
Счёт получателя платежа
БИК банка получателя платежа
Назначение платежа
1{
2 "pagination": {
3 "limit": 10,
4 "offset": 0,
5 "totalCount": 1
6 },
7 "payments": [
8 {
9 "id": "U031308240002351",
10 "number": "1",
11 "status": "DRAFT",
12 "info": "Сумма платежа должна состоять из цифр и быть больше 0",
13 "date": "2023-12-31",
14 "amount": 1.01,
15 "payerAccount": "40702810600010800068",
16 "payeeName": "Общество с ограниченной ответственностью \"Центр \"ИННОВАЦИЯ\"",
17 "payeeInn": "7723870785",
18 "payeeKpp": "553453453",
19 "payeeAccount": "40702810564564564531",
20 "payeeBankBic": "040173745",
21 "purpose": "Оплата заказа №1. НДС не облагается"
22 }
23 ]
24}Код ошибки. Принимает возможные значения:
-
•
invalid_request- неверные входные параметры запроса
Описание ошибки
1{
2 "error": "invalid_request",
3 "error_description": "Authorization header is not present in request headers"
4}Код ошибки. Принимает возможные значения:
-
•
invalid_token- предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам. При истечении срока жизни токена необходимо обновить его с помощьюrefresh_token. При отзыве токена необходимо заново пройти авторизацию
Описание ошибки
1{
2 "error": "invalid_token",
3 "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
4}Код ошибки. Принимает возможные значения:
-
•
insufficient_scope- при запросе кода авторизации не были переданы все необходимые scopes. Необходимо переподписать договор согласия, повторно отправив запрос на получение кода авторизации с указанием всех доступных scopes и параметраprompt=consent
Описание ошибки
1{
2 "error": "insufficient_scope",
3 "error_description": "The request requires higher privileges than provided by the access token"
4}Код ошибки. Принимает возможные значения:
-
•
unknown_endpoint- эндпоинт не найден или неактивен
Описание ошибки
1{
2 "error": "unknown_endpoint",
3 "error_description": "Endpoint is not found or not active"
4}Код ошибки. Принимает возможные значения:
-
•
internal_error- внутренняя ошибка сервиса при выполнении обработки запроса
Описание ошибки
1{
2 "error": "internal_error",
3 "error_description": "Internal server error"
4}