H2H

Создание запроса на возврат налоговых денежных средств

Песочница
POST https://sandbox.alfabank.ru/api/na/jp/v1/tax-refund
Пром
POST https://baas.alfabank.ru/api/na/jp/v1/tax-refund
Scope

beneficiary-payments

Описание

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

  • •
    Если нужно вернуть налоговые средства на основной виртуальный счёт бенефициара без вывода с номинального счёта, то нужно передавать признак keepOnNominalAccount = true.
  • •
    Если нужно вернуть налоговые средства бенефициару с выводом с номинального счёта, то нужно передавать признак keepOnNominalAccount = false.
Параметры запроса
HEADERS
Атрибут
Описание
Authorization
stringrequired
Accept
stringrequired

application/json

Content-Type
stringrequired

application/json

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

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

amount
integerrequired

Сумма

purpose
stringrequired

Назначение платежа. Максимальная длина - 210 символов

keepOnNominalAccount
booleanrequired

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

  • •
    true - оставить в рамках номинального счёта;
  • •
    false - вывести по идентификатору платёжного реквизита бенефициара
requisiteId
stringoptional

Идентификатор платёжного реквизита бенефициара для вывода налоговых средств. Если поле не заполнено, для вывода налоговых средств будут использованы основные платёжные реквизиты бенефициара

array of objectsrequired

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

base64Encoded
stringrequired

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

signatureType
stringrequired

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

  • •
    RSA - RSA;
  • •
    KEP - КЭП
Пример запроса
Язык 
1curl --location 'https://baas.alfabank.ru/api/na/jp/v1/tax-refund' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--header 'Accept: application/json' \
5--data '{
6  "beneficiaryId": "cd9cbb96-360a-4462-a683-955cc29f7f55",
7  "amount": 10000,
8  "purpose": "Возврат излишне уплаченных налоговых средств",
9  "keepOnNominalAccount": false,
10  "requisiteId": "ef9cbb96-360a-4462-a683-955cc29f7f56",
11  "digestSignatures": [
12    {
13      "base64Encoded": "SEwHwYDVQQDExhDUllQVE8tUFJPIFRlc3QgQ2VudGVyIDICExIAVH4YMX0u3fEONSkAAQBUfhgwCgYIKoUDBwEBAQEEQBU0EntPGWz8EfJ5CFL2m10xeBrkAEeWDglGQDZWLKQ0ff4TyBT9X1NhG/+ETj4TcQhExy6k+WZ9w/CpF5FjyyA=",
14      "signatureType": "RSA"
15    }
16  ]
17}'
Параметры ответа
Пример ответа 202 (Accepted) 
1{
2  "taxRefundId": "ab9cbb96-360a-4462-a683-955cc29f7f54",
3  "status": "PENDING"
4}
BODY
атрибут
описание
taxRefundId
stringrequired

Идентификатор возврата налоговых средств

status
stringrequired

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

  • •
    PENDING - запрос в процессе обработки;
  • •
    MANUAL_ACCEPTANCE - ожидание ручного подтверждения отправки запроса-дубля на обработку;
  • •
    AWAIT_EXTERNAL - ожидание исполнения внешнего платежа;
  • •
    FAILED - обработка запроса завершилась ошибкой;
  • •
    PAYMENT_FAILED - платёж завершился неуспешно;
  • •
    FAILED_DUPLICATE - обработка запроса-дубля отклонена;
  • •
    TIMEOUT - превышено время ожидания ответа;
  • •
    COMPLETE - обработка запроса завершилась успешно
Пример ответа 202 (Accepted) 
1{
2  "taxRefundId": "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}
Нет тела ответа
Получение информации о платежеПолучение статуса запроса на возврат налоговых денежных средств