Scope
as-receipt
Параметры запроса
Bearer {access_token}, полученный по Authorization Code Flow / Authorization Code Flow H2H
application/json
application/json
Уникальный идентификатор запроса
Количество объектов на одной странице
Количество объектов в списке, которые необходимо пропустить
1curl -X GET https://baas.alfabank.ru/api/semp/v1/payouts/registries/cancel-receipts/4e817e78-5876-4608-a873-bcc141454045?limit=1000&offset=0 \
2 -H 'Accept: application/json' \
3 -H 'Authorization: Bearer {access-token}' \
4 -H 'Content-Type: application/json'Параметры ответа
1{
2 "pagination": {
3 "limit": 1000,
4 "offset": 0,
5 "totalCount": 10000
6 },
7 "requestId": "e82331bd-28ac-481b-b7c3-e03673abc20b",
8 "externalId": "e82331bd-28ac-481b-b7c3-e03673abc20b",
9 "createdDate": "2023-03-28T08:46:23.462Z",
10 "listStatus": "NEW",
11 "error": {
12 "code": "Код ошибки",
13 "message": "Описание ошибки"
14 },
15 "statementList": [
16 {
17 "payoutId": "e82331bd-28ac-481b-b7c3-e03673abc20b",
18 "selfemployed": {
19 "vatin": "112233445566",
20 "surname": "Иванов",
21 "name": "Иван",
22 "patronymic": "Иванoвич"
23 },
24 "payoutRequisite": {
25 "payoutType": "ACCOUNT",
26 "byAccount": {
27 "accountNumber": "40817810306050000000",
28 "bic": "044525593",
29 "purpose": "Курьерские услуги за период с 1.12.2020-20.12.2020",
30 "comment": "Курьерские услуги за период с 1.12.2020-20.12.2020"
31 },
32 "byPan": {
33 "pan": "wS7fElYo8VWeJ8KelaJ0XA==",
34 "comment": "Курьерские услуги за период с 1.12.2020-20.12.2020"
35 },
36 "byPhone": {
37 "phone": "79998887766",
38 "bankId": "100000000001",
39 "clientId": "E6ec9146-A851-3b0f-FF5C-D9137EEDacc2",
40 "checkFIO": true,
41 "comment": "Курьерские услуги за период с 1.12.2020-20.12.2020"
42 },
43 "payoutTotalAmount": "10.00"
44 },
45 "receiptRequisite": {
46 "customerVatin": "5566778899",
47 "customerName": "ООО Петуния",
48 "incomeType": "FROM_LEGAL_ENTITY",
49 "operateDate": "2023-03-28T08:46:23.463Z",
50 "requestDate": "2023-03-28T08:46:23.463Z",
51 "services": [
52 {
53 "amount": "10.00",
54 "name": "Курьерские услуги за период с 1.12.2020-20.12.2020",
55 "quantity": 1
56 }
57 ],
58 "receiptTotalAmount": "10.00"
59 },
60 "receiptLink": {
61 "receiptId": "200wr5cn4s",
62 "link": "https://lknpd-adp.gnivc.ru/api/v1/receipt/252530829203/200wr5cn4s/print"
63 },
64 "receiptStatus": {
65 "status": "READY",
66 "updatedDate": "2023-03-28T08:46:23.463Z"
67 },
68 "payoutStatus": {
69 "status": "READY",
70 "updatedDate": "2023-03-28T08:46:23.463Z"
71 },
72 "errorRecord": [
73 {
74 "field": "Наименование поля, в котором возникла ошибка",
75 "message": "Описание ошибки"
76 }
77 ]
78 }
79 ]
80}Данные пагинации
Количество записей на одной странице
Количество записей в списке, которые были пропущены
Общее количество записей
Уникальный идентификатор запроса
Внешний идентификатор запроса, переданный Клиентом
Дата и время создания запроса в системе
Статус исполнения загруженного списка выплат. Принимает возможные значения: 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 - подпись проверена
Дата и время обновления статуса выплаты в системе
Ошибки обработки записей списка
Наименование поля, в котором возникла ошибка
Описание ошибки
1{
2 "pagination": {
3 "limit": 1000,
4 "offset": 0,
5 "totalCount": 10000
6 },
7 "requestId": "e82331bd-28ac-481b-b7c3-e03673abc20b",
8 "externalId": "e82331bd-28ac-481b-b7c3-e03673abc20b",
9 "createdDate": "2023-03-28T08:46:23.462Z",
10 "listStatus": "NEW",
11 "error": {
12 "code": "Код ошибки",
13 "message": "Описание ошибки"
14 },
15 "statementList": [
16 {
17 "payoutId": "e82331bd-28ac-481b-b7c3-e03673abc20b",
18 "selfemployed": {
19 "vatin": "112233445566",
20 "surname": "Иванов",
21 "name": "Иван",
22 "patronymic": "Иванoвич"
23 },
24 "payoutRequisite": {
25 "payoutType": "ACCOUNT",
26 "byAccount": {
27 "accountNumber": "40817810306050000000",
28 "bic": "044525593",
29 "purpose": "Курьерские услуги за период с 1.12.2020-20.12.2020",
30 "comment": "Курьерские услуги за период с 1.12.2020-20.12.2020"
31 },
32 "byPan": {
33 "pan": "wS7fElYo8VWeJ8KelaJ0XA==",
34 "comment": "Курьерские услуги за период с 1.12.2020-20.12.2020"
35 },
36 "byPhone": {
37 "phone": "79998887766",
38 "bankId": "100000000001",
39 "clientId": "E6ec9146-A851-3b0f-FF5C-D9137EEDacc2",
40 "checkFIO": true,
41 "comment": "Курьерские услуги за период с 1.12.2020-20.12.2020"
42 },
43 "payoutTotalAmount": "10.00"
44 },
45 "receiptRequisite": {
46 "customerVatin": "5566778899",
47 "customerName": "ООО Петуния",
48 "incomeType": "FROM_LEGAL_ENTITY",
49 "operateDate": "2023-03-28T08:46:23.463Z",
50 "requestDate": "2023-03-28T08:46:23.463Z",
51 "services": [
52 {
53 "amount": "10.00",
54 "name": "Курьерские услуги за период с 1.12.2020-20.12.2020",
55 "quantity": 1
56 }
57 ],
58 "receiptTotalAmount": "10.00"
59 },
60 "receiptLink": {
61 "receiptId": "200wr5cn4s",
62 "link": "https://lknpd-adp.gnivc.ru/api/v1/receipt/252530829203/200wr5cn4s/print"
63 },
64 "receiptStatus": {
65 "status": "READY",
66 "updatedDate": "2023-03-28T08:46:23.463Z"
67 },
68 "payoutStatus": {
69 "status": "READY",
70 "updatedDate": "2023-03-28T08:46:23.463Z"
71 },
72 "errorRecord": [
73 {
74 "field": "Наименование поля, в котором возникла ошибка",
75 "message": "Описание ошибки"
76 }
77 ]
78 }
79 ]
80}Код ошибки. Принимает возможные значения: invalid_request - неверные входные параметры запроса
Описание ошибки
1{
2 "error": "invalid_request",
3 "error_description": "Authorization header is not present in request headers"
4}Код ошибки. Принимает возможные значения: invalid_token - предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам
Описание ошибки
1{
2 "error": "invalid_token",
3 "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
4}Код ошибки. Принимает возможные значения: insufficient_scope - при запросе кода авторизации не были переданы все необходимые scopes. Необходимо переподписать договор согласия, повторно отправив запрос на получение кода авторизации с указанием всех доступных scopes и параметра prompt=consent; access_denied - доступ к счёту запрещён
Описание ошибки
1{
2 "error": "insufficient_scope",
3 "error_description": "The request requires higher privileges than provided by the access token"
4}Код ошибки. Принимает возможные значения: unknown_endpoint - эндпоинт не найден или неактивен
Описание ошибки
1{
2 "error": "unknown_endpoint",
3 "error_description": "Endpoint is not found or not active"
4}Код ошибки. Принимает возможные значения: internal_error - внутренняя ошибка сервиса при выполнении обработки запроса
Описание ошибки
1{
2 "error": "internal_error",
3 "error_description": "Internal server error"
4}Значения параметров ошибок могут изменяться. Рекомендуем предусмотреть стандартную обработку ошибок, не описанных в текущей версии документации.