Scope
deals
Описание
Метод позволяет получить информацию об участниках этапа сделки по dealId и stepId.
Параметры запроса
Bearer {access_token}, полученный по Authorization Code Flow H2H
application/json
Идентификатор участника сделки
Роль участника этапа сделки. Возможные значения:
-
•
DEPONENT- плательщик; -
•
RECIPIENT- получатель
Идентификатор сделки
Идентификатор этапа сделки
1curl --location --globoff 'https://baas.alfabank.ru/api/na/jp/v1/deals/{dealId}/steps/{stepId}/contractors?contractorId={contractorId}&role={role}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'
Параметры ответа
1[
2 {
3 "beneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4 "role": "DEPONENT",
5 "amount": 10,
6 "purpose": "Назначение платежа",
7 "keepOnNominalAccount": true,
8 "amounts": [
9 {
10 "walletType": "MAIN",
11 "amount": 10
12 }
13 ]
14 }
15]
Идентификатор бенефициара или универсального реципиента
Роль участника этапа сделки. Принимает возможные значения:
-
•
DEPONENT- плательщик; -
•
RECIPIENT- получатель
Сумма депонирования в рублях
Назначение платежа реципиента
Признак вывода денег на виртуальный счёт. Принимает возможные значения:
-
•
true- оставить в рамках номинального счёта; -
•
false- вывести по идентификатору платёжного реквизита контрагента
Суммы реципиента
Тип суммы. Принимает возможные значения:
-
•
MAIN- основная сумма; -
•
TAX- налоговая сумма
Сумма в рублях
1[
2 {
3 "beneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4 "role": "DEPONENT",
5 "amount": 10,
6 "purpose": "Назначение платежа",
7 "keepOnNominalAccount": true,
8 "amounts": [
9 {
10 "walletType": "MAIN",
11 "amount": 10
12 }
13 ]
14 }
15]
Код ошибки. Принимает возможные значения:
-
•
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}