H2H

Создание запроса на возврат неидентифицированного пополнения

Песочница
POST https://sandbox.alfabank.ru/api/na/jp/v1/unidentified-transactions/{id}/refunds
Пром
POST https://baas.alfabank.ru/api/na/jp/v1/unidentified-transactions/{id}/refunds
Scope

beneficiary-payments

Описание

Метод позволяет создать запрос на возврат неидентифицированного пополнения.

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

application/json

Content-Type
stringrequired

application/json

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

Идентификатор операции пополнения, по которой необходимо вернуть денежные средства

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

Номер номинального счета

id
stringrequired

Идентификатор операции пополнения, по которой необходимо вернуть денежные средства

array of objectsrequired

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

base64Encoded
stringrequired

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

certificateUuid
stringoptional

Идентификатор сертификата, использованного при создании электронной подписи

signatureType
stringrequired

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

  • •
    RSA - RSA;
  • •
    KEP - КЭП
poaNumber
stringoptional

Номер машиночитаемой доверенности

Пример запроса
Язык
1curl --location --globoff 'https://baas.alfabank.ru/api/na/jp/v1/unidentified-transactions/{id}/refunds' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--header 'Accept: application/json' \
5--data '{
6  "id": "ab9cbb96-360a-4462-a683-955cc29f7f54",
7  "accountNumber": "40817810306050000000",
8  "digestSignatures": [
9    {
10      "base64Encoded": "SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA=",
11      "signatureType": "RSA",
12      "poaNumber": "DOVER_CBR_7702235133_20211102_1"
13    }
14  ]
15}'
Параметры ответа
Пример ответа 202 (Accepted)
1{
2  "refundId": "ab9cbb96-360a-4462-a683-955cc29f7f54",
3  "status": "PENDING"
4}
BODY
атрибут
описание
refundId
stringrequired

Уникальный идентификатор запроса на возврат неидентифицированного пополнения

status
stringrequired

Статус запроса. Принимает возможные значения:

  • •
    PENDING - запрос в процессе обработки;
  • •
    AWAIT_EXTERNAL - ожидание исполнения внешнего платежа;
  • •
    FAILED - обработка запроса завершилась ошибкой;
  • •
    PAYMENT_FAILED - платёж завершился неуспешно;
  • •
    COMPLETE - обработка запроса завершилась успешно
Пример ответа 202 (Accepted)
1{
2  "refundId": "ab9cbb96-360a-4462-a683-955cc29f7f54",
3  "status": "PENDING"
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}
Нет тела ответа