Пром GET https://baas.alfabank.ru/api/semp/v1/payouts/registries/{requestId}
Песочница GET https://sandbox.alfabank.ru/api/semp/v1/payouts/registries/{requestId}
Scope
as-receipt-and-payout, as-receipt, as-payout-with-check-status, as-payout
Параметры запроса
Bearer {access_token}, полученный по Authorization Code Flow
application/json
application/json
Уникальный идентификатор запроса
Количество объектов на одной странице
Количество объектов в списке, которые необходимо пропустить
curl -X GET https://baas.alfabank.ru/api/semp/v1/payouts/registries/4e817e78-5876-4608-a873-bcc141454045?limit=1000&offset=0 \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token} \
-H 'Content-Type: application/json'
Параметры ответа
{
"pagination": {
"limit": 1000,
"offset": 0,
"totalCount": 10000
},
"requestId": "e82331bd-28ac-481b-b7c3-e03673abc20b",
"externalId": "e82331bd-28ac-481b-b7c3-e03673abc20b",
"createdDate": "2023-03-28T08:46:23.462Z",
"listStatus": "NEW",
"error": {
"code": "Код ошибки",
"message": "Описание ошибки"
},
"statementList": [
{
"payoutId": "e82331bd-28ac-481b-b7c3-e03673abc20b",
"selfemployed": {
"vatin": "112233445566",
"surname": "Иванов",
"name": "Иван",
"patronymic": "Иванoвич"
},
"payoutRequisite": {
"payoutType": "ACCOUNT",
"byAccount": {
"accountNumber": "40817810306050000000",
"bic": "044525593",
"purpose": "Курьерские услуги за период с 1.12.2020-20.12.2020",
"comment": "Курьерские услуги за период с 1.12.2020-20.12.2020"
},
"byPan": {
"pan": "wS7fElYo8VWeJ8KelaJ0XA==",
"comment": "Курьерские услуги за период с 1.12.2020-20.12.2020"
},
"byPhone": {
"phone": "79998887766",
"bankId": "100000000001",
"clientId": "E6ec9146-A851-3b0f-FF5C-D9137EEDacc2",
"checkFIO": true,
"comment": "Курьерские услуги за период с 1.12.2020-20.12.2020"
},
"payoutTotalAmount": "10.00"
},
"receiptRequisite": {
"customerVatin": "5566778899",
"customerName": "ООО Петуния",
"incomeType": "FROM_LEGAL_ENTITY",
"operateDate": "2023-03-28T08:46:23.463Z",
"requestDate": "2023-03-28T08:46:23.463Z",
"services": [
{
"amount": "10.00",
"name": "Курьерские услуги за период с 1.12.2020-20.12.2020",
"quantity": 1
}
],
"receiptTotalAmount": "10.00"
},
"receiptLink": {
"receiptId": "200wr5cn4s",
"link": "https://lknpd-adp.gnivc.ru/api/v1/receipt/252530829203/200wr5cn4s/print"
},
"receiptStatus": {
"status": "READY",
"updatedDate": "2023-03-28T08:46:23.463Z"
},
"payoutStatus": {
"status": "READY",
"updatedDate": "2023-03-28T08:46:23.463Z"
},
"errorRecord": [
{
"field": "Наименование поля в котором возникла ошибка",
"message": "Описание ошибки"
}
]
}
]
}
Количество записей на одной странице
Количество записей в списке, которые были пропущены
Общее количество записей
Уникальный идентификатор запроса
Внешний идентификатор запроса, переданный Клиентом
Дата и время создания запроса в системе
Статус исполнения загруженного списка выплат. Принимает возможные значения: PREPARED - Реестр получен и сохранен, но еще не взят в обработку; NEW - Принят для последующей обработки; TOTAL_AMOUNT_CALCULATED - Общая сумма подсчитана; FAILED_SIGNATURE - Подпись не прошла проверку; OUT_OF_DATE - Реестр отправлен после окончания операционного дня; SUCCESS - Реестр обработан успешно; IN_PROGRESS - В обработке; WAITING - Ожидает поступления средств; BALANCE_CHECKED - Баланса достаточно для выплат; SIGNATURE_CHECKED - Подпись проверена; WAITING_FOR_ACCEPT - Реестр ожидает подтверждения; ACCEPTED - Реестр подтвержден; UNCONFIRMED - Реестр не был подтвержден; FAILED_COMPLIANCE - Комплаенс проверка не была пройдена; CLIENT_ACCOUNT_CHECKED - Счет Клиента проверен в админ-модуле; FAILED_ACCOUNT_CHECK - Счет Клиента не прошел проверку в админ-модуле; CLIENT_ACCOUNT_EQ_CHECKED - Счет Клиента прошел проверку в Банке; FAILED_ACCOUNT_EQ_CHECK - Счет Клиента не прошел проверку в Банке; TECHNICAL_ERROR - Непредвиденная ошибка; FAILED_BALANCE - Недостаточно средств на счету для выполнения выплат; ERROR - Ошибка при обработке; PAYOUT_TIME_CHECKED - Проверка времени загрузки реестра выполнена
Код ошибки
Описание ошибки
Внешний идентификатор выплаты, переданный Клиентом
ИНН самозанятого
Фамилия
Имя
Отчество
Тип выплаты. Принимает возможные значения: ACCOUNT - Выплата по реквизитам счета получателя; CARD - Выплата на банковскую карту получателя; PHONE - Выплата через СБП по номеру телефона
Номер счета получателя
БИК банка получателя
Назначение платежа
Комментарий к платежу
Номер карты получателя в зашифрованном виде
Комментарий к платежу
Номер телефона
Идентификатор банка получателя
Идентификатор клиента в системе B2CPay
Флаг проверки совпадения ФИО получателя. Принимает возможные значения: true – выполнять, если совпадения по ФИО нет, не проводить платеж, иначе – выполнять проверку, при несовпадении ФИО проводить платеж
Комментарий к платежу
Сумма выплаты
ИНН покупателя
Наименование компании покупателя
Тип дохода. Принимает возможные значения: FROM_INDIVIDUAL - Доход от физического лица; FROM_LEGAL_ENTITY - Доход от юридического лица или ИП; FROM_FOREIGN_AGENCY - Доход от иностранной организации
Дата расчета с самозанятым, которая будет указана в чеке
Дата запроса на формирование чека
Цена услуги
Наименование услуги для регистрации дохода
Количество услуг. Согласно текущей спецификации ФНС всегда должно быть равно 1
Сумма чека
Идентификатор чека в ФНС
Ссылка на чек с сайта ФНС
Статус чека в системе. Принимает возможные значения: NEW - Принят для последующей обработки; READY - Успешно зарегистрирован; FAILED - Ошибка в процессе регистрации или сторнирования; IN_PROGRESS - В процессе регистрации; CANCELED_BY_CLIENT - Аннулирован Клиентом; CANCELED_AUTOMATICALLY - Аннулирован автоматически системой; FAILED_CANCEL - Ошибка в процессе аннулирования; CANCELED_IN_PROGRESS - В процессе аннулирования; CANCEL_REQUESTED - Запрос на аннулирование чека отправлен в ФНС; CANCEL_INCOME_REQUESTED_AUTOMATICALLY - Отправлен запрос в ФНС на аннулирование чека; CHECK_REFUND - Проконтролируйте возврат суммы сторнированного дохода на счет; PARTNER_INFO - Чек был передан клиентом; ALREADY_CANCELED - Чек уже был отменен
Дата и время обновления статуса чека в системе
Статус выплаты в системе. Принимает возможные значения: NEW - Принята для последующей обработки; READY - Успешно исполнена; FAILED - Ошибка в процессе исполнения; IN_PROGRESS - В процессе исполнения; WAITING - Ожидает поступления средств; BIND_CHECKED - Проверка привязки самозанятого к компании успешна; SELFEMPLOYED_CHECKED - Проверка самозанятого успешна; BALANCE_CHECKED - Баланса достаточно; SELFEMPLOYED_TAXPAYER_CHECK - Статус самозанятого проверяется в ФНС; PAYMENT_IN_PROGRESS - Выплата в обработке; INCOME_REGISTRATION_REQUESTED - Отправлен запрос в ФНС на регистрацию чека; TECHNICAL_ERROR - Техническая ошибка; FAILED_SELFEMPLOYED_CHECK - Самозанятый не имеет статус; READY- Успешно исполнена; FAILED_SELFEMPLOYED_TAXPAYER_CHECK - Самозанятый не прошел проверку статуса в ФНС; FAILED_BIND_CHECK - Самозанятый не привязан к компании; FAILED_EQ_ACCOUNT_PAY - Внутренняя ошибка выплаты в Банке; REGISTRATION_RESTRICTIONS_IN_PROGRESS - Статус самозанятого в процессе проверки в ФНС; FULL_NAME_CHECKED - ФИО проверено; FAILED_FULL_NAME_CHECK - Проверка ФИО неуспешна; PAYMENT_DEFERRED - Проведение выплаты отложена; AWAIT_EXTERNAL - Внешний платеж ожидает исполнения; COMPLIANCE_CHECKED - Комплаенс проверка пройдена; FAILED_COMPLIANCE - Комплаенс проверка не была пройдена; FAILED_SIGNATURE - Подпись не прошла проверку; SIGNATURE_CHECKED - Подпись проверена
Дата и время обновления статуса выплаты в системе
Наименование поля в котором возникла ошибка
Описание ошибки
{
"pagination": {
"limit": 1000,
"offset": 0,
"totalCount": 10000
},
"requestId": "e82331bd-28ac-481b-b7c3-e03673abc20b",
"externalId": "e82331bd-28ac-481b-b7c3-e03673abc20b",
"createdDate": "2023-03-28T08:46:23.462Z",
"listStatus": "NEW",
"error": {
"code": "Код ошибки",
"message": "Описание ошибки"
},
"statementList": [
{
"payoutId": "e82331bd-28ac-481b-b7c3-e03673abc20b",
"selfemployed": {
"vatin": "112233445566",
"surname": "Иванов",
"name": "Иван",
"patronymic": "Иванoвич"
},
"payoutRequisite": {
"payoutType": "ACCOUNT",
"byAccount": {
"accountNumber": "40817810306050000000",
"bic": "044525593",
"purpose": "Курьерские услуги за период с 1.12.2020-20.12.2020",
"comment": "Курьерские услуги за период с 1.12.2020-20.12.2020"
},
"byPan": {
"pan": "wS7fElYo8VWeJ8KelaJ0XA==",
"comment": "Курьерские услуги за период с 1.12.2020-20.12.2020"
},
"byPhone": {
"phone": "79998887766",
"bankId": "100000000001",
"clientId": "E6ec9146-A851-3b0f-FF5C-D9137EEDacc2",
"checkFIO": true,
"comment": "Курьерские услуги за период с 1.12.2020-20.12.2020"
},
"payoutTotalAmount": "10.00"
},
"receiptRequisite": {
"customerVatin": "5566778899",
"customerName": "ООО Петуния",
"incomeType": "FROM_LEGAL_ENTITY",
"operateDate": "2023-03-28T08:46:23.463Z",
"requestDate": "2023-03-28T08:46:23.463Z",
"services": [
{
"amount": "10.00",
"name": "Курьерские услуги за период с 1.12.2020-20.12.2020",
"quantity": 1
}
],
"receiptTotalAmount": "10.00"
},
"receiptLink": {
"receiptId": "200wr5cn4s",
"link": "https://lknpd-adp.gnivc.ru/api/v1/receipt/252530829203/200wr5cn4s/print"
},
"receiptStatus": {
"status": "READY",
"updatedDate": "2023-03-28T08:46:23.463Z"
},
"payoutStatus": {
"status": "READY",
"updatedDate": "2023-03-28T08:46:23.463Z"
},
"errorRecord": [
{
"field": "Наименование поля в котором возникла ошибка",
"message": "Описание ошибки"
}
]
}
]
}
Код ошибки. Принимает возможные значения: invalid_request - Неверные входные параметры запроса
Описание ошибки
{
"error": "invalid_request",
"error_description": "Authorization header is not present in request headers"
}
Код ошибки. Принимает возможные значения: invalid_token - Предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам
Описание ошибки
{
"error": "invalid_token",
"error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
}
Код ошибки. Принимает возможные значения: insufficient_scope - У пользователя нет прав на использование запрашиваемого сервиса, доступ к которому не предусмотрен настройками scope; access_denied - Доступ к счету запрещен
Описание ошибки
{
"error": "insufficient_scope",
"error_description": "The request requires higher privileges than provided by the access token"
}
Код ошибки. Принимает возможные значения: unknown_endpoint - Эндпоинт не найден или неактивен
Описание ошибки
{
"error": "unknown_endpoint",
"error_description": "Endpoint is not found or not active"
}
Код ошибки. Принимает возможные значения: internal_error - Внутренняя ошибка сервиса при выполнении обработки запроса
Описание ошибки
{
"error": "internal_error",
"error_description": "Internal server error"
}
Значения параметров ошибок могут изменяться. Рекомендуем предусмотреть стандартную обработку ошибок, не описанных в текущей версии документации.