H2H

Изменение платёжных реквизитов бенефициара

Песочница
PATCH https://sandbox.alfabank.ru/api/na/jp/v1/beneficiaries/{beneficiaryId}/requisites/{requisiteId}
Пром
PATCH https://baas.alfabank.ru/api/na/jp/v1/beneficiaries/{beneficiaryId}/requisites/{requisiteId}
Scope

beneficiaries

Описание

Метод позволяет изменить платёжные реквизиты бенефициара по beneficiaryId и requisiteId.

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

application/json

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

Идентификатор бенефициара

requisiteId
stringrequired

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

BODY
Атрибут
Описание
pan
stringoptional
keyId
stringoptional

Идентификатор публичного ключа для расшифровки токена номера карты

phoneNumber
stringoptional

Номер телефона контрагента

bankId
stringoptional

Идентификатор банка контрагента

accountNumber
stringoptional

Номер счёта контрагента

bik
stringoptional

БИК банка контрагента

isMain
booleanoptional

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

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

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

  • •
    true - активен;
  • •
    false - деактивирован
array of objectsrequired

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

base64Encoded
stringrequired

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

signatureType
stringrequired

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

  • •
    RSA - RSA;
  • •
    KEP - КЭП
Пример запроса
Язык
1curl --location --globoff --request PATCH 'https://baas.alfabank.ru/api/na/jp/v1/beneficiaries/{beneficiaryId}/requisites/{requisiteId}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--data '{
5  "pan": "wS7fElYo8VWeJ8KelaJ0XA==",
6  "keyId": "1",
7  "phoneNumber": "79130000011",
8  "bankId": "012345678910",
9  "accountNumber": "40817810306050000000",
10  "bik": "044525593",
11  "isMain": true,
12  "isActive": true,
13  "digestSignatures": [
14    {
15      "base64Encoded": "SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA=",
16      "signatureType": "RSA"
17    }
18  ]
19}'
Параметры ответа
1Нет тела ответа
Нет тела ответа
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}
Нет тела ответа