H2H

Выполнение действия по сделке

Песочница
PATCH https://sandbox.alfabank.ru/api/na/jp/v1/deals/action
Пром
PATCH https://baas.alfabank.ru/api/na/jp/v1/deals/action
Scope

deals

Описание

Метод позволяет подтвердить, отменить или завершить сделку.

Подтверждение сделки

При успешном подтверждении сделки денежные средства депонентов холдируются в сумме, необходимой для проведения расчётов в рамках текущей сделки для каждого этапа сделки, и сделка переходит из статуса DRAFT в статус ACTIVE.

Отмена сделки

При успешной отмене сделки ранее захолдированные денежные средства депонентов расхолдируются и становятся доступны для использования в расчётах (если сделка была ранее подтверждена), и сделка переходит в статус CLOSED.

Завершение сделки

При успешном завершении сделка переходит в статус COMPLETED.

Параметры запроса
HEADERS
Атрибут
Описание
Authorization
stringrequired
Accept
stringrequired

application/json

Content-Type
stringrequired

application/json

BODY
Атрибут
Описание
dealId
stringrequired

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

action
stringrequired

Действие по сделке. Возможные значения:

  • •
    ACCEPT - подтвердить сделку;
  • •
    COMPLETE - завершить сделку;
  • •
    CANCEL - отменить сделку
array of objectsrequired

Электронная подпись УЛ клиента

base64Encoded
stringrequired

Значение электронной подписи, закодированное в Base64

signatureType
stringrequired

Тип электронной подписи. Возможные значения:

  • •
    RSA - RSA;
  • •
    KEP - КЭП
Пример запроса
Язык
1curl --location --request PATCH 'https://baas.alfabank.ru/api/na/jp/v1/deals/action' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--header 'Accept: application/json' \
5--data '{
6  "dealId": "ab9cbb96-360a-4462-a683-955cc29f7f54",
7  "action": "ACCEPT",
8  "digestSignatures": [
9    {
10      "base64Encoded": "SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA=",
11      "signatureType": "RSA"
12    }
13  ]
14}'
Параметры ответа
Пример ответа 200 (OK)
1{
2  "dealId": "ab9cbb96-360a-4462-a683-955cc29f7f54",
3  "action": "ACCEPT"
4}
BODY
атрибут
описание
dealId
stringoptional

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

action
stringoptional

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

  • •
    ACCEPT - подтвердить сделку;
  • •
    COMPLETE - завершить сделку;
  • •
    CANCEL - отменить сделку
Пример ответа 200 (OK)
1{
2  "dealId": "ab9cbb96-360a-4462-a683-955cc29f7f54",
3  "action": "ACCEPT"
4}
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}
Нет тела ответа