H2H

Добавление платёжных реквизитов универсального реципиента

Песочница
POST https://sandbox.alfabank.ru/api/na/jp/v1/universal-recipients/{universalRecipientId}/requisites
Пром
POST https://baas.alfabank.ru/api/na/jp/v1/universal-recipients/{universalRecipientId}/requisites
Scope

beneficiaries

Описание

Метод позволяет добавить платёжные реквизиты универсального реципиента по universalRecipientId.

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

application/json

Content-Type
stringrequired

application/json

PATH
Атрибут
Описание
universalRecipientId
stringrequired

Идентификатор универсального реципиента

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

Тип платёжного реквизита. Возможные значения:

  • •
    ACCOUNT - реквизиты счёта;
  • •
    CARD - номер карты (токен);
  • •
    PHONE - номер телефона
pan
stringoptional
phoneNumber
stringoptional

Номер телефона. Поле обязательно при типе реквизитов PHONE

bankId
stringoptional

Идентификатор банка контрагента-получателя. Поле обязательно при типе реквизитов PHONE

accountNumber
stringoptional

Номер счёта. Поле обязательно при типе реквизитов ACCOUNT

bik
stringoptional

БИК банка. Поле обязательно при типе реквизитов ACCOUNT

name
stringrequired

Наименование получателя. Наименование организации (для юридических лиц), либо ФИО (для физических лиц и индивидуальных предпринимателей)

inn
stringrequired

ИНН получателя. Состоит из 10 цифр - для юр.лиц, из 12 цифр - для физ.лиц и ИП

kpp
stringoptional

КПП получателя. Поле обязательно, если тип универсального реципиента UL_RESIDENT или UL_NONRESIDENT

isMain
booleanoptional

Признак основных платежных реквизитов универсального реципиента. По умолчанию для первых добавленных реквизитов - true, для следующих - false

array of objectsrequired

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

base64Encoded
stringrequired

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

signatureType
stringrequired

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

  • •
    RSA - RSA;
  • •
    KEP - КЭП
Пример запроса
Язык 
1curl --location --globoff 'https://baas.alfabank.ru/api/na/jp/v1/universal-recipients/{universalRecipientId}/requisites' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--header 'Accept: application/json' \
5--data '{
6  "type": "ACCOUNT",
7  "pan": "wS7fElYo8VWeJ8KelaJ0XA==",
8  "phoneNumber": "79130000011",
9  "bankId": "012345678910",
10  "accountNumber": "40817810306050000000",
11  "bik": "044525593",
12  "name": "Иванов Иван Иванович",
13  "inn": "112233445566",
14  "kpp": "123456789",
15  "isMain": true,
16  "digestSignatures": [
17    {
18      "base64Encoded": "SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA=",
19      "signatureType": "KEP"
20    }
21  ]
22}'
Параметры ответа
Пример ответа 200 (OK) 
1{
2  "id": "ab9cbb96-360a-4462-a683-955cc29f7f54",
3  "isMain": true,
4  "isActive": true
5}
BODY
атрибут
описание
id
stringrequired

Идентификатор платёжного реквизита

isMain
booleanrequired

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

  • •
    true - основной;
  • •
    false - неосновной
isActive
booleanrequired

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

  • •
    true - активен;
  • •
    false - деактивирован
Пример ответа 200 (OK) 
1{
2  "id": "ab9cbb96-360a-4462-a683-955cc29f7f54",
3  "isMain": true,
4  "isActive": true
5}
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}
Нет тела ответа
Получение информации об универсальном реципиентеПолучение платёжных реквизитов универсального реципиента