Scope
deals
Описание
Действия с участниками сделки возможны только для сделки в статусе DRAFT.
Метод позволяет добавить, изменить или удалить участника сделки.
Добавление участника сделки
Каждый этап сделки должен содержать участников.
При добавлении участников сделки необходимо учитывать:
-
•В рамках одного этапа может быть добавлен только один депонент, реципиентов может быть несколько.
-
•В качестве депонента может выступать только бенефициар, в качестве реципиента - бенефициар или универсальный реципиент.
-
•При добавлении универсального реципиента в качестве реципиента необходимо передавать его идентификатор
universalRecipientIdв параметрbeneficiaryId. -
•Если при добавлении реципиента не будет указан идентификатор платёжного реквизита
requisiteId, то система будет использовать ранее зарегистрированный платёжный реквизит, который считается основным (isMain = true).
Изменение участника сделки
При необходимости вы можете изменять данные о депоненте и реципиентах этапа сделки:
-
•Для депонента можно изменить сумму депонированных средств.
-
•Для реципиента возможно изменить суммы, назначение платежа, признак вывода денег на виртуальный счёт и идентификатор платёжных реквизитов.
Удаление участника сделки
При необходимости вы можете удалить депонента и реципиентов из этапа сделки.
Параметры запроса
Bearer {access_token}, полученный по Authorization Code Flow H2H
application/json
application/json
Тип действия. Возможные значения:
-
•
ADD_DEPONENT- добавить депонента; -
•
ADD_RECIPIENT- добавить реципиента; -
•
DELETE_DEPONENT- удалить депонента; -
•
DELETE_RECIPIENT- удалить реципиента; -
•
UPDATE_DEPONENT- обновить депонента; -
•
UPDATE_RECIPIENT- обновить реципиента
Идентификатор сделки
Идентификатор этапа сделки
Идентификатор бенефициара или универсального реципиента
Сумма депонирования в рублях. Доступно только для депонента
Назначение платежа, которое будет отображено в выписке. Доступно только для реципиента. Максимальная длина:
-
•в случае выплат по реквизитам счёта - 210 символов;
-
•в случае выплат по номеру карты - 200 символов;
-
•в случае выплат по СБП резидентам - 110 символов;
-
•в случае выплат по СБП нерезидентам - 92 символа
Суммы реципиента. Доступно только для реципиента
Тип кошелька. Возможные значения:
-
•
MAIN- основной кошелёк; -
•
TAX- налоговый кошелёк
Суммы реципиента в рублях
Признак вывода денег на виртуальный счёт. Возможные значения:
-
•
true- оставить в рамках номинального счёта; -
•
false- вывести на реальные реквизиты
Идентификатор платёжного реквизита контрагента. Доступно только для реципиента
Электронная подпись УЛ Клиента
Значение электронной подписи, закодированное в Base64
Тип электронной подписи. Возможные значения:
-
•
RSA- RSA; -
•
KEP- КЭП
1curl --location --request PATCH 'https://baas.alfabank.ru/api/na/jp/v1/deals/steps/contractors' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--header 'Accept: application/json' \
5--data '{
6 "action": "ADD_DEPONENT",
7 "dealId": "ab9cbb96-360a-4462-a683-955cc29f7f54",
8 "stepId": "ab9cbb96-360a-4462-a683-955cc29f7f54",
9 "beneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
10 "amount": "10.01",
11 "purpose": "Назначение платежа",
12 "amounts": [
13 {
14 "walletType": "MAIN",
15 "amount": "10.01"
16 }
17 ],
18 "keepOnNominalAccount": true,
19 "requisiteId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
20 "digestSignatures": [
21 {
22 "base64Encoded": "SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA=",
23 "signatureType": "rsa"
24 }
25 ]
26}'Параметры ответа
1Нет тела ответаКод ошибки. Принимает возможные значения:
-
•
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}