Scope
deals
Описание
Метод позволяет получить список всех сделок по номинальному счёту с момента его открытия с фильтрацией по статусу, дате создания и обновления сделки.
Параметры запроса
Bearer {access_token}, полученный по Authorization Code Flow H2H
application/json
Номер номинального счёта
Статус сделки. Принимает возможные значения:
-
•
DRAFT- принята для последующей обработки; -
•
ACTIVE- подтверждена; -
•
IN_PROGRESS- в процессе обработки; -
•
PAYMENT_FAILED- платёж в этапе сделки завершился неуспешно; -
•
BLOCKED- ошибка в процессе обработки; -
•
CLOSED- отменена; -
•
COMPLETED- успешно завершена
Дата начала выборки по времени создания сделки в формате YYYY-MM-DD
Дата конца выборки по времени создания сделки в формате YYYY-MM-DD
Дата начала выборки по времени обновления сделки в формате YYYY-MM-DD
Дата конца выборки по времени обновления сделки в формате YYYY-MM-DD
Количество объектов на одной странице
Количество объектов в списке, которые необходимо пропустить
1curl --location --globoff 'https://baas.alfabank.ru/api/na/jp/v1/deals?accountNumber=40817810306050000000&status=DRAFT&createdDateFrom=2025-02-21&createdDateTo=2025-02-21&updatedDateFrom=2025-03-01&updatedDateTo=2025-03-02&limit=100&offset={offset}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'Параметры ответа
1{
2 "pagination": {
3 "limit": 100,
4 "offset": 0,
5 "totalCount": 1
6 },
7 "deals": [
8 {
9 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
10 "accountNumber": "40817810306050000000",
11 "status": "DRAFT",
12 "expireDate": "2032-03-02",
13 "isValid": false,
14 "steps": [
15 {
16 "id": "f099f9dd-d5e7-4ab3-89f5-24932aa808ad",
17 "description": "Этап 1",
18 "stepNumber": 1,
19 "status": "NEW",
20 "isValid": false
21 }
22 ]
23 }
24 ]
25}Данные пагинации
Количество записей на одной странице
Количество записей в списке, которые были пропущены
Общее количество записей
Данные сделки
Идентификатор сделки
Номер номинального счёта
Статус сделки. Принимает возможные значения:
-
•
DRAFT- принята для последующей обработки; -
•
ACTIVE- подтверждена; -
•
IN_PROGRESS- в процессе обработки; -
•
PAYMENT_FAILED- платёж в этапе сделки завершился неуспешно; -
•
BLOCKED- ошибка в процессе обработки; -
•
CLOSED- отменена; -
•
COMPLETED- успешно завершена
Дата истечения сделки в формате YYYY-MM-DD
Флаг валидности сделки
Данные об этапах сделки
Идентификатор этапа сделки
Описание этапа сделки
Порядковый номер этапа сделки
Статус этапа сделки. Принимает возможные значения:
-
•
NEW- принят для последующей обработки; -
•
PAYMENT_FAILED- платёж завершился неуспешно; -
•
PAYMENT_IN_PROGRESS- платёж в процессе исполнения; -
•
CANCELED- отменён; -
•
COMPLETED- успешно завершён
Флаг валидности этапа сделки
1{
2 "pagination": {
3 "limit": 100,
4 "offset": 0,
5 "totalCount": 1
6 },
7 "deals": [
8 {
9 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
10 "accountNumber": "40817810306050000000",
11 "status": "DRAFT",
12 "expireDate": "2032-03-02",
13 "isValid": false,
14 "steps": [
15 {
16 "id": "f099f9dd-d5e7-4ab3-89f5-24932aa808ad",
17 "description": "Этап 1",
18 "stepNumber": 1,
19 "status": "NEW",
20 "isValid": false
21 }
22 ]
23 }
24 ]
25}Код ошибки. Принимает возможные значения:
-
•
invalid_request- неверные входные параметры запроса
Описание ошибки
1{
2 "error": "invalid_request",
3 "error_description": "Authorization header is not present in request headers"
4}Код ошибки. Принимает возможные значения:
-
•
invalid_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}