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- удалён
Дата документа в формате YYYY-MM-DD, с
Дата документа в формате YYYY-MM-DD, по
Сортировка результатов поиска в формате <поле,asc|desc>. Возможные поля для сортировки: number, date, amount
Количество элементов. Значение по умолчанию: 100
Смещение в результатах поиска. Значение по умолчанию: 0
Идентификатор реестра, полученный в ответе метода «Создание реестра рублёвых платежей»
1curl --location --globoff 'https://baas.alfabank.ru/api/jp/v1/registries/{registryId}/payments?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": 2
6 },
7 "payments": [
8 {
9 "id": "U030909240000449",
10 "number": "28732",
11 "status": "ON_SIGNING",
12 "date": "2024-09-09",
13 "amount": 5.16,
14 "payerAccount": "40702810102300000001",
15 "payeeName": "Общество с ограниченной ответственностью \"Центр \"ИННОВАЦИЯ\"",
16 "payeeInn": "7723870785",
17 "payeeKpp": "553453453",
18 "payeeAccount": "40702810501890001904",
19 "payeeBankBic": "044525593",
20 "purpose": "Очень важный платеж №28732 на сумму 5,16 рублей"
21 },
22 {
23 "id": "U030909240000475",
24 "number": "57835",
25 "status": "DECLINED",
26 "date": "2024-09-09",
27 "amount": 5.16,
28 "payerAccount": "40702810102300000001",
29 "payeeName": "Общество с ограниченной ответственностью \"Центр \"ИННОВАЦИЯ\"",
30 "payeeInn": "7723870785",
31 "payeeKpp": "553453453",
32 "payeeAccount": "40702810501890001904",
33 "payeeBankBic": "044525593",
34 "purpose": "Очень важный платеж №28732 на сумму 19,10 рублей"
35 }
36 ]
37}Параметры пагинации
Количество элементов
Смещение в результатах поиска
Количество элементов, удовлетворяющих запросу
Данные рублёвого платёжного поручения
Идентификатор платежа
Номер документа
Статус платежа. Принимает возможные значения:
-
•
DRAFT- черновик; -
•
ON_SIGNING- на подпись; -
•
TO_BE_SEND- к отправке; -
•
PROCESSING- на исполнении; -
•
DONE- исполнен; -
•
REJECTED- не исполнен; -
•
DECLINED- отклонён; -
•
DELETED- удалён; -
•
WITH_ERRORS- с ошибками
Информационное сообщение для пользователя
Дата составления документа в формате YYYY-MM-DD
Сумма платежа
Счёт плательщика
Полное наименование получателя платежа
ИНН получателя платежа
КПП получателя платежа
Счёт получателя платежа
БИК банка получателя платежа
Назначение платежа
1{
2 "pagination": {
3 "limit": 10,
4 "offset": 0,
5 "totalCount": 2
6 },
7 "payments": [
8 {
9 "id": "U030909240000449",
10 "number": "28732",
11 "status": "ON_SIGNING",
12 "date": "2024-09-09",
13 "amount": 5.16,
14 "payerAccount": "40702810102300000001",
15 "payeeName": "Общество с ограниченной ответственностью \"Центр \"ИННОВАЦИЯ\"",
16 "payeeInn": "7723870785",
17 "payeeKpp": "553453453",
18 "payeeAccount": "40702810501890001904",
19 "payeeBankBic": "044525593",
20 "purpose": "Очень важный платеж №28732 на сумму 5,16 рублей"
21 },
22 {
23 "id": "U030909240000475",
24 "number": "57835",
25 "status": "DECLINED",
26 "date": "2024-09-09",
27 "amount": 5.16,
28 "payerAccount": "40702810102300000001",
29 "payeeName": "Общество с ограниченной ответственностью \"Центр \"ИННОВАЦИЯ\"",
30 "payeeInn": "7723870785",
31 "payeeKpp": "553453453",
32 "payeeAccount": "40702810501890001904",
33 "payeeBankBic": "044525593",
34 "purpose": "Очень важный платеж №28732 на сумму 19,10 рублей"
35 }
36 ]
37}Код ошибки. Принимает возможные значения:
-
•
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}