Проверка возможности осуществления выплат по сделке

Песочница

PATCH https://sandbox.alfabank.ru/api/na/jp/v1/deals/{dealId}/is-valid

Пром

PATCH https://baas.alfabank.ru/api/na/jp/v1/deals/{dealId}/is-valid

Scope

deals

Описание

Метод позволяет проверить возможность осуществления платежей по сделке по dealId:

•

проверяет правильность формирования сделки;
•

проверяет балансы бенефициаров;
•

сверяет суммы участников сделки.

Важно

Проверка доступна только для сделок в статусе DRAFT.

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

HEADERS

Атрибут

Описание

Authorization

stringrequired

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

stringrequired

application/json

PATH

Атрибут

Описание

dealId

stringrequired

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

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

Язык

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

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

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

1{
2  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3  "isValid": true,
4  "description": [
5    "Неверная сумма депонированных средств по этапу сделки ab9cbb96-360a-4462-a683-955cc29f7f54;"
6  ]
7}

BODY

атрибут

описание

stringrequired

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

isValid

booleanrequired

Результат прохождения проверки. Принимает возможные значения:

•

true - сделка прошла валидацию;
•

false - сделка не прошла валидацию

description

array of stringsoptional

Описание ошибок. Возвращается при неудачном прохождении валидации

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

1{
2  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3  "isValid": true,
4  "description": [
5    "Неверная сумма депонированных средств по этапу сделки ab9cbb96-360a-4462-a683-955cc29f7f54;"
6  ]
7}

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}

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