СКОРО В РЕЛИЗЕH2H

Получение списка платежей по номинальному счёту

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

beneficiary-payments

Описание

Метод позволяет получить список всех платежей по номинальному счёту, созданных с помощью Alfa API, с фильтрацией по статусу, направлению и дате.

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

application/json

QUERY
Атрибут
Описание
limit
integeroptional

Количество объектов на одной странице

offset
integeroptional

Количество объектов в списке, которые необходимо пропустить

accountNumber
stringrequired

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

channel
stringoptional

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

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

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

  • •
    IN_PROGRESS - в процессе обработки;
  • •
    FAILED - платёж завершился неуспешно;
  • •
    AWAIT_EXTERNAL - запрос в процессе обработки во внешней системе;
  • •
    READY - успешно завершён
createdDateFrom
stringoptional

Дата начала выборки по времени создания выплаты в формате YYYY-MM-DD

createdDateTo
stringoptional

Дата конца выборки по времени создания выплаты в формате YYYY-MM-DD

updatedDateFrom
stringoptional

Дата начала выборки по времени обновления выплаты в формате YYYY-MM-DD

updatedDateTo
stringoptional

Дата конца выборки по времени обновления выплаты в формате YYYY-MM-DD

Пример запроса
Язык 
1curl --location --globoff 'https://baas.alfabank.ru/api/na/jp/v1/payoffs?limit={limit}&offset={offset}&accountNumber=40817810306050000000&channel={channel}&status=READY&createdDateFrom={createdDateFrom}&createdDateTo={createdDateTo}&updatedDateFrom={updatedDateFrom}&updatedDateTo={updatedDateTo}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'
Параметры ответа
Пример ответа 200 (OK) 
1{
2  "pagination": {
3    "limit": 100,
4    "offset": 0,
5    "totalCount": 2
6  },
7  "accountNumber": "40817810306050000000",
8  "payoffs": [
9    {
10      "id": "ab9cbb96-360a-4462-a683-955cc29f7f54",
11      "dealId": "cd9cbb96-360a-4462-a683-955cc29f7f55",
12      "stepId": "ef9cbb96-360a-4462-a683-955cc29f7f56",
13      "payoffType": "REGULAR",
14      "type": "REGULAR",
15      "channel": "EXTERNAL",
16      "requisiteType": "ACCOUNT",
17      "amount": 10000,
18      "purpose": "Оплата по договору №123 от 01.04.2025",
19      "payer": {
20        "beneficiaryId": "ab9cbb96-360a-4462-a683-955cc29f7f54",
21        "name": "Акционерное общество «Ромашка»",
22        "inn": "1122334455",
23        "kpp": "123456789",
24        "bankName": "АО Альфа-Банк",
25        "bankAccount": "40817810306050000000",
26        "bankBik": "044525593"
27      },
28      "recipient": {
29        "beneficiaryId": "cd9cbb96-360a-4462-a683-955cc29f7f55",
30        "accountNumber": "40817810306050000000",
31        "name": "Иванов Иван Иванович",
32        "inn": "112233445566",
33        "bankName": "АО Альфа-Банк",
34        "bankAccount": "40817810306050000000",
35        "bankBik": "044525593"
36      },
37      "status": "READY",
38      "createdAt": "2024-01-15",
39      "updatedAt": "2024-01-16"
40    }
41  ]
42}
BODY
атрибут
описание
objectoptional

Данные пагинации

limit
numberoptional

Количество записей на одной странице

offset
numberoptional

Количество записей в списке, которые были пропущены

totalCount
numberoptional

Общее количество записей

accountNumber
stringoptional

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

array of objectsoptional

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

id
stringoptional

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

dealId
stringoptional

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

stepId
stringoptional

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

payoffType
stringoptional

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

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

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

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

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

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

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

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

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

purpose
stringoptional

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

objectoptional

Плательщик

beneficiaryId
stringoptional

Идентификатор контрагента-плательщика

name
stringoptional

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

inn
stringoptional

ИНН плательщика

kpp
stringoptional

КПП плательщика

bankName
stringoptional

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

bankAccount
stringoptional

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

bankBik
stringoptional

БИК банка

objectoptional

Получатель

beneficiaryId
stringoptional

Идентификатор контрагента-получателя

accountNumber
stringoptional

Номер счёта

name
stringoptional

Наименование получателя

inn
stringoptional

ИНН получателя

kpp
stringoptional

КПП получателя

bankName
stringoptional

Наименование банка получателя

bankAccount
stringoptional

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

bankBik
stringoptional

БИК банка

pan
stringoptional

Токен номера карты

guid
stringoptional

Идентификатор токена номера карты

maskedPan
stringoptional

Маскированный номер карты

phoneNumber
stringoptional

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

bankId
stringoptional

Идентификатор банка контрагента-получателя

objectoptional

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

uin
stringoptional

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

payerStatus
stringoptional

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

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

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

oktmo
stringoptional

Код ОКТМО территории, на которой мобилизуются денежные средства от уплаты налога, сбора и иного платежа. Поле платежки 105

reason
stringoptional

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

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

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

docNumber
stringoptional

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

docDate
stringoptional

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

paymentKind
stringoptional

Код типа налогового платежа (поле платёжки - 110). Принимает возможные значения:

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

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

  • •
    NEW - принят для последующей обработки;
  • •
    IN_PROGRESS - в процессе обработки;
  • •
    FAILED - платёж завершился неуспешно;
  • •
    AWAIT_EXTERNAL - платёж в процессе обработки во внешней системе;
  • •
    PAYMENT_DEFERRED - отсроченный платёж;
  • •
    READY - успешно завершён
createdAt
stringoptional

Дата создания платежа в формате YYYY-MM-DD

updatedAt
stringoptional

Дата обновления платежа в формате YYYY-MM-DD

Пример ответа 200 (OK) 
1{
2  "pagination": {
3    "limit": 100,
4    "offset": 0,
5    "totalCount": 2
6  },
7  "accountNumber": "40817810306050000000",
8  "payoffs": [
9    {
10      "id": "ab9cbb96-360a-4462-a683-955cc29f7f54",
11      "dealId": "cd9cbb96-360a-4462-a683-955cc29f7f55",
12      "stepId": "ef9cbb96-360a-4462-a683-955cc29f7f56",
13      "payoffType": "REGULAR",
14      "type": "REGULAR",
15      "channel": "EXTERNAL",
16      "requisiteType": "ACCOUNT",
17      "amount": 10000,
18      "purpose": "Оплата по договору №123 от 01.04.2025",
19      "payer": {
20        "beneficiaryId": "ab9cbb96-360a-4462-a683-955cc29f7f54",
21        "name": "Акционерное общество «Ромашка»",
22        "inn": "1122334455",
23        "kpp": "123456789",
24        "bankName": "АО Альфа-Банк",
25        "bankAccount": "40817810306050000000",
26        "bankBik": "044525593"
27      },
28      "recipient": {
29        "beneficiaryId": "cd9cbb96-360a-4462-a683-955cc29f7f55",
30        "accountNumber": "40817810306050000000",
31        "name": "Иванов Иван Иванович",
32        "inn": "112233445566",
33        "bankName": "АО Альфа-Банк",
34        "bankAccount": "40817810306050000000",
35        "bankBik": "044525593"
36      },
37      "status": "READY",
38      "createdAt": "2024-01-15",
39      "updatedAt": "2024-01-16"
40    }
41  ]
42}
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}
Нет тела ответа
Подтверждение или отклонение запроса-дубля на возврат налоговых денежных средствКак это работает