Получение информации о сделке

Песочница

GET https://sandbox.alfabank.ru/api/na/jp/v1/deals/{dealId}

Пром

GET https://baas.alfabank.ru/api/na/jp/v1/deals/{dealId}

Scope

deals

Описание

Метод позволяет получить детальную информацию о сделке по dealId.

Параметры запроса

HEADERS

Атрибут

Описание

Authorization

stringrequired

Bearer {access_token}, полученный по Authorization Code Flow H2H

stringrequired

application/json

PATH

Атрибут

Описание

dealId

stringrequired

Идентификатор сделки

Пример запроса

Язык

1curl --location --globoff 'https://baas.alfabank.ru/api/na/jp/v1/deals/{dealId}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'

Параметры ответа

Пример ответа 200 (OK)

1{
2  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3  "status": "DRAFT",
4  "accountNumber": "40702810901990035810",
5  "expireDate": "2032-03-02",
6  "createdAt": "2025-03-02",
7  "updatedAt": "2025-03-02",
8  "isValid": false,
9  "steps": [
10    {
11      "id": "f099f9dd-d5e7-4ab3-89f5-24932aa808ad",
12      "description": "Этап 1",
13      "stepNumber": 1,
14      "status": "NEW"
15    }
16  ]
17}

BODY

атрибут

описание

stringrequired

Идентификатор сделки

status

stringrequired

Статус сделки. Возможные значения:

•

DRAFT - принята для последующей обработки;
•

ACTIVE - подтверждена;
•

IN_PROGRESS - в процессе обработки;
•

PAYMENT_FAILED - платёж в этапе сделки завершился неуспешно;
•

BLOCKED - ошибка в процессе обработки;
•

CLOSED - отменена;
•

COMPLETED - успешно завершена

accountNumber

stringoptional

Номер номинального счёта

expireDate

stringrequired

Дата истечения сделки в формате YYYY-MM-DD

createdAt

stringoptional

Дата создания сделки в формате YYYY-MM-DD

updatedAt

stringoptional

Дата обновления сделки в формате YYYY-MM-DD

isValid

booleanrequired

Флаг валидности сделки

array of objectsoptional

Данные об этапах сделки

stringrequired

Идентификатор этапа сделки

description

stringrequired

Описание этапа сделки

stepNumber

integerrequired

Порядковый номер этапа сделки

status

stringrequired

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

•

NEW - принят для последующей обработки;
•

PAYMENT_FAILED - платёж завершился неуспешно;
•

PAYMENT_IN_PROGRESS - платёж в процессе исполнения;
•

CANCELED - отменён;
•

COMPLETED - успешно завершён

Пример ответа 200 (OK)

1{
2  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3  "status": "DRAFT",
4  "accountNumber": "40702810901990035810",
5  "expireDate": "2032-03-02",
6  "createdAt": "2025-03-02",
7  "updatedAt": "2025-03-02",
8  "isValid": false,
9  "steps": [
10    {
11      "id": "f099f9dd-d5e7-4ab3-89f5-24932aa808ad",
12      "description": "Этап 1",
13      "stepNumber": 1,
14      "status": "NEW"
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 - предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам

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}

Нет тела ответа