H2H

Получение информации о платеже

Песочница
GET https://sandbox.alfabank.ru/api/na/jp/v1/payoffs/{payoffId}
Пром
GET https://baas.alfabank.ru/api/na/jp/v1/payoffs/{payoffId}
Scope

beneficiary-payments

Описание

Метод позволяет получить информацию о платеже по payoffId.

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

application/json

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

Идентификатор платежа

Пример запроса
Язык 
1curl --location --globoff 'https://baas.alfabank.ru/api/na/jp/v1/payoffs/{payoffId}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'
Параметры ответа
Пример ответа 200 (OK) 
1{
2  "id": "ab9cbb96-360a-4462-a683-955cc29f7f54",
3  "dealId": "cd9cbb96-360a-4462-a683-955cc29f7f55",
4  "stepId": "ef9cbb96-360a-4462-a683-955cc29f7f56",
5  "channel": "EXTERNAL",
6  "payoffType": "REGULAR",
7  "requisiteType": "ACCOUNT",
8  "payer": {
9    "accountNumber": "40817810306050000000",
10    "bankName": "АО Альфа-Банк",
11    "bankAccount": "30101810100000000983",
12    "bankBik": "044525593",
13    "name": "Акционерное общество «Ромашка»",
14    "inn": "1122334455",
15    "kpp": "123456789",
16    "beneficiaryId": "ab9cbb96-360a-4462-a683-955cc29f7f54"
17  },
18  "recipient": {
19    "beneficiaryId": "cd9cbb96-360a-4462-a683-955cc29f7f55",
20    "accountNumber": "40817810306050000000",
21    "bankName": "АО Альфа-Банк",
22    "bankAccount": "30101810100000000983",
23    "bankBik": "044525593",
24    "name": "Иванов Иван Иванович",
25    "inn": "112233445566"
26  },
27  "amount": "10000.00",
28  "purpose": "Оплата по договору №123 от 01.04.2025",
29  "status": "READY"
30}
BODY
атрибут
описание
id
stringoptional

Идентификатор запроса

dealId
stringoptional

Идентификатор сделки

stepId
stringoptional

Идентификатор этапа

channel
stringoptional

Направление платежа. Принимает возможные значения:

  • •
    INTERNAL - внутренний платёж;
  • •
    EXTERNAL - внешний платёж
payoffType
stringoptional

Тип платежа. Принимает возможные значения:

  • •
    REGULAR - обычный платёж (с биллингом и без);
  • •
    DEAL - платёж внутри сделки;
  • •
    TAX_REFUND - возврат налоговых средств;
  • •
    TRANSACTION_REFUND - возврат неидентифицированного пополнения;
  • •
    TAX - налоговый платёж
requisiteType
stringoptional

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

  • •
    ACCOUNT - реквизиты счёта;
  • •
    CARD - номер карты (токен);
  • •
    PHONE - номер телефона;
  • •
    BENEFICIARY_REQUISITE - идентификатор платёжных реквизитов контрагента
objectoptional

Информация о плательщике

accountNumber
stringrequired

Номер счёта

bankName
stringoptional

Наименование банка плательщика

bankAccount
stringoptional

Номер счёта банка плательщика

bankBik
stringoptional

БИК банка

name
stringrequired

Наименование организации

inn
stringrequired

ИНН

kpp
stringrequired

КПП

beneficiaryId
stringoptional

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

objectoptional

Информация о получателе

beneficiaryId
stringoptional

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

accountNumber
stringoptional

Номер счёта

bankName
stringoptional

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

bankAccount
stringoptional

Номер счёта банка получателя

bankBik
stringoptional

БИК банка

name
stringoptional

ФИО реципиента

inn
stringoptional

ИНН

phoneNumber
stringoptional

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

bankId
stringoptional

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

pan
stringoptional

Токен номера карты. Поле обязательно при типе реквизитов CARD

guid
stringoptional

Уникальный идентификатор токена номера карты. Поле заполняется при типе реквизитов CARD

maskedPan
stringoptional

Маскированный номер карты. Поле заполняется при типе реквизитов CARD

objectoptional

Параметры для налогового платежа

uin
stringrequired

Уникальный идентификатор начисления. Поле платежки 22

payerStatus
stringrequired

Статус составителя расчетного документа. Поле платежки 101. При оплате налога за третьих лиц указывается налоговый статус человека, за которого происходит оплата. Принимает возможные значения:

  • •
    01 - налогоплательщик (плательщик сборов) - юрлицо;
  • •
    02 - налоговый агент;
  • •
    08 - плательщик-юрлицо (ИП), осуществляющий уплату страховых взносов и иных платежей в бюджетную систему РФ;
  • •
    13 - физическое лицо, уплачивающее налоги, сборы за совершение налоговыми органами юридически значимых действий, страховые взносы и иные платежи, администрируемые налоговыми органами;
  • •
    14 - указывается плательщиком, который осуществляет транзакции в пользу физлиц;
  • •
    19 - организации и их филиалы, перечисляющие средства, удержанные из заработной платы (дохода) должника - физлица, в счёт погашения задолженности по платежам в бюджет на основании исполнительного документа;
  • •
    24 - плательщик-физлицо, осуществляющий уплату страховых взносов и иных платежей в бюджетную систему РФ
kbk
stringrequired

Код бюджетной классификации. Поле платежки 104

oktmo
stringrequired

Код ОКТМО территории. Поле платежки 105

reason
stringrequired

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

  • •
    ТП - платежи текущего года;
  • •
    ЗД - добровольное погашение задолженности по истекшим налоговым, расчетным (отчетным) периодам при отсутствии требования налогового органа об уплате налогов (сборов);
  • •
    РС - погашение рассроченной задолженности;
  • •
    ОТ - погашение отсроченной задолженности;
  • •
    РТ - погашение реструктурируемой задолженности;
  • •
    ПБ - погашение должником задолженности в ходе процедур, применяемых в деле о банкротстве;
  • •
    ИН - погашение инвестиционного налогового кредита;
  • •
    ТЛ - погашение учредителем (участником) должника или собственником имущества должника - унитарного предприятия, или третьим лицом задолженности в ходе процедур, применяемых в деле о банкротстве;
  • •
    ЗТ - погашение текущей задолженности в ходе процедур, применяемых в деле о банкротстве;
  • •
    00 - иные случаи (для таможенных платежей);
  • •
    0 - основание платежа неизвестно
period
stringrequired

Налоговый период. Поле платежки 107. Формат - ДД.ММ.ГГГГ, первые два символа могут быть буквами или цифрами. В поле можно передать 0

docNumber
stringrequired

Номер налогового документа. Поле платежки 108

docDate
stringrequired

Дата налогового документа. Поле платежки 109. Формат - ДД.ММ.ГГГГ или 0

paymentKind
stringoptional

Код типа налогового платежа. Поле платежки 110. Поле можно оставить пустым или передать 0. Принимает возможные значения:

  • •
    ПЕ - уплата пени;
  • •
    ПЦ - уплата процентов
amount
stringoptional

Сумма в рублях

purpose
stringoptional

Назначение платежа

status
stringoptional

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

  • •
    NEW - принят для последующей обработки;
  • •
    IN_PROGRESS - в процессе обработки;
  • •
    FAILED - платёж завершился неуспешно;
  • •
    AWAIT_EXTERNAL - платёж в процессе обработки во внешней системе;
  • •
    PAYMENT_DEFERRED - отсроченный платёж;
  • •
    READY - успешно завершён
Пример ответа 200 (OK) 
1{
2  "id": "ab9cbb96-360a-4462-a683-955cc29f7f54",
3  "dealId": "cd9cbb96-360a-4462-a683-955cc29f7f55",
4  "stepId": "ef9cbb96-360a-4462-a683-955cc29f7f56",
5  "channel": "EXTERNAL",
6  "payoffType": "REGULAR",
7  "requisiteType": "ACCOUNT",
8  "payer": {
9    "accountNumber": "40817810306050000000",
10    "bankName": "АО Альфа-Банк",
11    "bankAccount": "30101810100000000983",
12    "bankBik": "044525593",
13    "name": "Акционерное общество «Ромашка»",
14    "inn": "1122334455",
15    "kpp": "123456789",
16    "beneficiaryId": "ab9cbb96-360a-4462-a683-955cc29f7f54"
17  },
18  "recipient": {
19    "beneficiaryId": "cd9cbb96-360a-4462-a683-955cc29f7f55",
20    "accountNumber": "40817810306050000000",
21    "bankName": "АО Альфа-Банк",
22    "bankAccount": "30101810100000000983",
23    "bankBik": "044525593",
24    "name": "Иванов Иван Иванович",
25    "inn": "112233445566"
26  },
27  "amount": "10000.00",
28  "purpose": "Оплата по договору №123 от 01.04.2025",
29  "status": "READY"
30}
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 - предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам. При истечении срока жизни токена необходимо обновить его с помощью refresh_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}
Нет тела ответа
Подтверждение или отклонение запроса-дубля на выплатуСоздание запроса на возврат налоговых денежных средств