Песочница
POST https://sandbox.alfabank.ru/api/na/jp/v1/universal-recipients
Пром
POST https://baas.alfabank.ru/api/na/jp/v1/universal-recipients
Scope
beneficiaries
Описание
Метод позволяет зарегистрировать универсального реципиента (контрагента с признаком isBeneficiary = FALSE) в системе.
Параметры запроса
HEADERS
Атрибут
Описание
Authorization
stringrequired
Bearer {access_token}, полученный по Authorization Code Flow H2H
Accept
stringrequired
application/json
Content-Type
stringrequired
application/json
BODY
Атрибут
Описание
accountNumber
stringrequired
Номер номинального счёта
type
stringrequired
Тип универсального реципиента. Возможные значения:
-
•
FL_RESIDENT- физ. лицо, резидент; -
•
UL_RESIDENT- юр. лицо, резидент; -
•
IP_RESIDENT- ИП, резидент; -
•
FL_NONRESIDENT- физ. лицо, нерезидент; -
•
UL_NONRESIDENT- юр. лицо, нерезидент; -
•
IP_NONRESIDENT- ИП, нерезидент
array of objectsrequired
Электронная подпись УЛ клиента
base64Encoded
stringrequired
Значение электронной подписи, закодированное в Base64
signatureType
stringrequired
Тип электронной подписи. Возможные значения:
-
•
RSA- RSA; -
•
KEP- КЭП
Пример запроса
Язык
1curl --location 'https://baas.alfabank.ru/api/na/jp/v1/universal-recipients' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--header 'Accept: application/json' \
5--data '{
6 "accountNumber": "40817810306050000000",
7 "type": "UL_RESIDENT",
8 "digestSignatures": [
9 {
10 "base64Encoded": "SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA=",
11 "signatureType": "KEP"
12 }
13 ]
14}'Параметры ответа
Пример ответа 202 (Accepted)
1{
2 "requestId": "ab9cbb96-360a-4462-a683-955cc29f7f54",
3 "status": "COMPLETE"
4}
BODY
атрибут
описание
requestId
stringrequired
Идентификатор запроса
status
stringrequired
Статус запроса. Принимает возможные значения:
-
•
PENDING- запрос в процессе обработки; -
•
FAILED- обработка запроса завершилась ошибкой; -
•
COMPLETE- обработка запроса завершилась успешно
Пример ответа 202 (Accepted)
1{
2 "requestId": "ab9cbb96-360a-4462-a683-955cc29f7f54",
3 "status": "COMPLETE"
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}
Нет тела ответа