Получение списка выплат по самозанятому

Песочница

GET https://sandbox.alfabank.ru/api/semp/v1/payouts/selfemployed/{vatin}

Пром

GET https://baas.alfabank.ru/api/semp/v1/payouts/selfemployed/{vatin}

Scope

as-receipt-and-payout, as-receipt, as-payout-with-check-status, as-payout

Параметры запроса

HEADERS

Атрибут

Описание

Authorization

stringrequired

Bearer {access_token}, полученный по Authorization Code Flow / Authorization Code Flow H2H

stringrequired

application/json

Content-Type

stringoptional

application/json

PATH

Атрибут

Описание

vatin

stringrequired

ИНН самозанятого

QUERY

Атрибут

Описание

limit

integerrequired

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

offset

integeroptional

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

Пример запроса

1curl -X GET https://baas.alfabank.ru/api/semp/v1/payouts/selfemployed/533817905781?offset=0&limit=100 \
2  -H 'Accept: application/json' \
3  -H 'Authorization: Bearer {access-token}' \
4  -H 'Content-Type: application/json'

Параметры ответа

Пример ответа 200 (OK)

1{
2    "pagination": {
3        "limit": 100,
4        "offset": 0,
5        "totalCount": 5000
6    },
7    "payoutsList": [
8        {
9            "payoutId": "c7bae81e-6387-11ee-8c99-0242ac120002",
10            "vatin": "0483685159",
11            "requestId": "de638b6e-d69c-4e10-8efa-dbdbca264357",
12            "externalId": "821fefdc-5a7a-4e02-b239-18d947d7e4e3",
13            "payerAccountNumber": "40702810901100000350",
14            "createdDate": "2023-10-12T12:06:12.148576+03:00",
15            "payoutRequisite": {
16                "payoutType": "ACCOUNT",
17                "payoutTotalAmount": "2.00",
18                "fee": "2.00",
19                "byAccount": {
20                    "purpose": "Курьерские услуги за период с 1.12.2020-20",
21                    "comment": "Курьерские услуги за период с 1.12.2020-20.12.2020Курьерские услуги за",
22                    "accountNumber": "40817810704100002673",
23                    "bic": "044525593"
24                }
25            },
26            "receiptRequisite": {
27                "customerVatin": "0483685159",
28                "customerName": "Полное наименование Орг № 89727",
29                "incomeType": "FROM_LEGAL_ENTITY",
30                "operateDate": "2023-07-26T12:43:20+03:00",
31                "requestDate": "2023-10-06T08:34:24+03:00",
32                "services": [
33                    {
34                        "amount": "2.00",
35                        "name": "Курьерс",
36                        "quantity": "1"
37                    }
38                ],
39                "receiptTotalAmount": "2.00"
40            },
41            "receiptLink": {},
42            "receiptStatus": {},
43            "payoutStatus": {
44                "status": "INCOME_REGISTRATION_REQUESTED",
45                "updatedDate": "2023-10-12T12:44:37.003522+03:00"
46            }
47        },
48        {
49            "payoutId": "c7bae81e-6387-11ee-8c99-0242ac120002",
50            "vatin": "0483685159",
51            "requestId": "de638b6e-d69c-4e10-8efa-dbdbca264357",
52            "externalId": "821fefdc-5a7a-4e02-b239-18d947d7e4e3",
53            "payerAccountNumber": "40702810901100000350",
54            "createdDate": "2023-10-12T12:06:12.148598+03:00",
55            "payoutRequisite": {
56                "payoutType": "ACCOUNT",
57                "payoutTotalAmount": "2.00",
58                "byAccount": {
59                    "purpose": "Курьерские услуги за период с 1.12.2020-20",
60                    "comment": "Курьерские услуги за период с 1.12.2020-20.12.2020Курьерские услуги за",
61                    "accountNumber": "40817810704100002673",
62                    "bic": "044525593"
63                }
64            },
65            "receiptRequisite": {
66                "customerVatin": "0483685159",
67                "customerName": "Полное наименование Орг № 89727",
68                "incomeType": "FROM_LEGAL_ENTITY",
69                "operateDate": "2023-07-25T15:55:03+03:00",
70                "requestDate": "2023-10-06T08:34:24+03:00",
71                "services": [
72                    {
73                        "amount": "2.00",
74                        "name": "Курьерс",
75                        "quantity": "1"
76                    }
77                ],
78                "receiptTotalAmount": "2.00"
79            },
80            "receiptLink": {},
81            "receiptStatus": {},
82            "payoutStatus": {
83                "status": "INCOME_REGISTRATION_REQUESTED",
84                "updatedDate": "2023-10-12T12:44:37.3016+03:00"
85            }
86        },
87        {
88            "payoutId": "c7bae81e-6387-11ee-8c99-0242ac120002",
89            "vatin": "0483685159",
90            "requestId": "de638b6e-d69c-4e10-8efa-dbdbca264357",
91            "externalId": "821fefdc-5a7a-4e02-b239-18d947d7e4e3",
92            "payerAccountNumber": "40702810901100000350",
93            "createdDate": "2023-10-12T12:06:12.148665+03:00",
94            "payoutRequisite": {
95                "payoutType": "ACCOUNT",
96                "payoutTotalAmount": "2.00",
97                "fee": "2.00",
98                "byAccount": {
99                    "purpose": "Курьерские услуги за период с 1.12.2020-20",
100                    "comment": "Курьерские услуги за период с 1.12.2020-20.12.2020Курьерские услуги за",
101                    "accountNumber": "40817810704100002673",
102                    "bic": "044525593"
103                }
104            },
105            "receiptRequisite": {
106                "customerVatin": "0483685159",
107                "customerName": "Полное наименование Орг № 89727",
108                "incomeType": "FROM_LEGAL_ENTITY",
109                "operateDate": "2023-09-17T13:10:10+03:00",
110                "requestDate": "2023-10-06T08:34:24+03:00",
111                "services": [
112                    {
113                        "amount": "2.00",
114                        "name": "Курьерс",
115                        "quantity": "1"
116                    }
117                ],
118                "receiptTotalAmount": "2.00"
119            },
120            "receiptLink": {},
121            "receiptStatus": {},
122            "payoutStatus": {
123                "status": "INCOME_REGISTRATION_REQUESTED",
124                "updatedDate": "2023-10-12T12:44:38.79556+03:00"
125            }
126        }
127    ]
128}

objectoptional

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

limit

integeroptional

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

offset

integeroptional

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

totalCount

integeroptional

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

array of objectoptional

Выплаты

payoutId

stringoptional

Уникальный идентификатор

vatin

stringoptional

ИНН самозанятого

requestlId

stringoptional

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

externalId

stringoptional

Внешний идентификатор запроса, переданный Клиентом

createdDate

stringoptional

Дата и время создания запроса в системе

payerAccountNumber

stringoptional

Номер счёта компании

objectoptional

Платёжные реквизиты получателя

payoutType

stringoptional

Тип выплаты. Принимает возможные значения: ACCOUNT - выплата по реквизитам счёта получателя; CARD - выплата на банковскую карту получателя; PHONE - выплата через СБП по номеру телефона

objectoptional

Реквизиты для проведения выплаты на счёт получателя

accountNumber

stringoptional

Номер счёта

bic

stringoptional

БИК банка получателя

purpose

stringoptional

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

comment

stringoptional

Комментарий к платежу

objectoptional

Реквизиты для проведения выплаты на карту получателя

pan

stringoptional

Номер карты получателя в зашифрованном виде

comment

stringoptional

Комментарий к платежу

objectoptional

Реквизиты для проведения выплаты по номеру телефона получателя

phone

stringoptional

Телефон

bankId

stringoptional

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

comment

stringoptional

Комментарий к платежу

payoutTotalAmount

stringoptional

Сумма выплаты

fee

stringoptional

Размер комиссии

objectoptional

Реквизиты чека

customerVatin

stringoptional

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

customerName

stringoptional

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

incomeType

stringoptional

Тип дохода. Принимает возможные значения: FROM_INDIVIDUAL - доход от физического лица; FROM_LEGAL_ENTITY - доход от юридического лица или ИП; FROM_FOREIGN_AGENCY - доход от иностранной организации

operateDate

stringoptional

Дата расчёта с самозанятым, которая будет указана в чеке

requestDate

stringoptional

Дата запроса на формирование чека

array of objectoptional

Список услуг

amount

stringoptional

Цена услуги

name

stringoptional

Наименование услуги для регистрации дохода

quantity

integeroptional

Количество услуг. Согласно текущей спецификации ФНС всегда должно быть равно 1

receiptTotalAmount

stringoptional

Сумма чека

objectoptional

Референс чека

receiptId

stringoptional

Идентификатор чека в ФНС

link

stringoptional

Ссылка на чек с сайта ФНС

objectoptional

Статусы чека

status

stringoptional

Статус чека в системе. Принимает возможные значения: 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 - чек уже был отменён

updatedDate

stringoptional

Дата и время обновления статуса чека в системе

objectoptional

Статусы выплаты

status

stringoptional

Статус выплаты в системе. Принимает возможные значения: 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 - подпись проверена

updatedDate

stringoptional

Дата и время обновления статуса выплаты в системе

objectoptional

Ошибки обработки записей списка

field

stringoptional

Наименование поля, в котором возникла ошибка

message

stringoptional

Описание ошибки

Пример ответа 200 (OK)

1{
2    "pagination": {
3        "limit": 100,
4        "offset": 0,
5        "totalCount": 5000
6    },
7    "payoutsList": [
8        {
9            "payoutId": "c7bae81e-6387-11ee-8c99-0242ac120002",
10            "vatin": "0483685159",
11            "requestId": "de638b6e-d69c-4e10-8efa-dbdbca264357",
12            "externalId": "821fefdc-5a7a-4e02-b239-18d947d7e4e3",
13            "payerAccountNumber": "40702810901100000350",
14            "createdDate": "2023-10-12T12:06:12.148576+03:00",
15            "payoutRequisite": {
16                "payoutType": "ACCOUNT",
17                "payoutTotalAmount": "2.00",
18                "fee": "2.00",
19                "byAccount": {
20                    "purpose": "Курьерские услуги за период с 1.12.2020-20",
21                    "comment": "Курьерские услуги за период с 1.12.2020-20.12.2020Курьерские услуги за",
22                    "accountNumber": "40817810704100002673",
23                    "bic": "044525593"
24                }
25            },
26            "receiptRequisite": {
27                "customerVatin": "0483685159",
28                "customerName": "Полное наименование Орг № 89727",
29                "incomeType": "FROM_LEGAL_ENTITY",
30                "operateDate": "2023-07-26T12:43:20+03:00",
31                "requestDate": "2023-10-06T08:34:24+03:00",
32                "services": [
33                    {
34                        "amount": "2.00",
35                        "name": "Курьерс",
36                        "quantity": "1"
37                    }
38                ],
39                "receiptTotalAmount": "2.00"
40            },
41            "receiptLink": {},
42            "receiptStatus": {},
43            "payoutStatus": {
44                "status": "INCOME_REGISTRATION_REQUESTED",
45                "updatedDate": "2023-10-12T12:44:37.003522+03:00"
46            }
47        },
48        {
49            "payoutId": "c7bae81e-6387-11ee-8c99-0242ac120002",
50            "vatin": "0483685159",
51            "requestId": "de638b6e-d69c-4e10-8efa-dbdbca264357",
52            "externalId": "821fefdc-5a7a-4e02-b239-18d947d7e4e3",
53            "payerAccountNumber": "40702810901100000350",
54            "createdDate": "2023-10-12T12:06:12.148598+03:00",
55            "payoutRequisite": {
56                "payoutType": "ACCOUNT",
57                "payoutTotalAmount": "2.00",
58                "byAccount": {
59                    "purpose": "Курьерские услуги за период с 1.12.2020-20",
60                    "comment": "Курьерские услуги за период с 1.12.2020-20.12.2020Курьерские услуги за",
61                    "accountNumber": "40817810704100002673",
62                    "bic": "044525593"
63                }
64            },
65            "receiptRequisite": {
66                "customerVatin": "0483685159",
67                "customerName": "Полное наименование Орг № 89727",
68                "incomeType": "FROM_LEGAL_ENTITY",
69                "operateDate": "2023-07-25T15:55:03+03:00",
70                "requestDate": "2023-10-06T08:34:24+03:00",
71                "services": [
72                    {
73                        "amount": "2.00",
74                        "name": "Курьерс",
75                        "quantity": "1"
76                    }
77                ],
78                "receiptTotalAmount": "2.00"
79            },
80            "receiptLink": {},
81            "receiptStatus": {},
82            "payoutStatus": {
83                "status": "INCOME_REGISTRATION_REQUESTED",
84                "updatedDate": "2023-10-12T12:44:37.3016+03:00"
85            }
86        },
87        {
88            "payoutId": "c7bae81e-6387-11ee-8c99-0242ac120002",
89            "vatin": "0483685159",
90            "requestId": "de638b6e-d69c-4e10-8efa-dbdbca264357",
91            "externalId": "821fefdc-5a7a-4e02-b239-18d947d7e4e3",
92            "payerAccountNumber": "40702810901100000350",
93            "createdDate": "2023-10-12T12:06:12.148665+03:00",
94            "payoutRequisite": {
95                "payoutType": "ACCOUNT",
96                "payoutTotalAmount": "2.00",
97                "fee": "2.00",
98                "byAccount": {
99                    "purpose": "Курьерские услуги за период с 1.12.2020-20",
100                    "comment": "Курьерские услуги за период с 1.12.2020-20.12.2020Курьерские услуги за",
101                    "accountNumber": "40817810704100002673",
102                    "bic": "044525593"
103                }
104            },
105            "receiptRequisite": {
106                "customerVatin": "0483685159",
107                "customerName": "Полное наименование Орг № 89727",
108                "incomeType": "FROM_LEGAL_ENTITY",
109                "operateDate": "2023-09-17T13:10:10+03:00",
110                "requestDate": "2023-10-06T08:34:24+03:00",
111                "services": [
112                    {
113                        "amount": "2.00",
114                        "name": "Курьерс",
115                        "quantity": "1"
116                    }
117                ],
118                "receiptTotalAmount": "2.00"
119            },
120            "receiptLink": {},
121            "receiptStatus": {},
122            "payoutStatus": {
123                "status": "INCOME_REGISTRATION_REQUESTED",
124                "updatedDate": "2023-10-12T12:44:38.79556+03:00"
125            }
126        }
127    ]
128}

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}

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}

error

stringrequired

Код ошибки. Принимает возможные значения: insufficient_scope - при запросе кода авторизации не были переданы все необходимые scopes. Необходимо переподписать договор согласия, повторно отправив запрос на получение кода авторизации с указанием всех доступных scopes и параметра prompt=consent; access_denied - доступ к счёту запрещён

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}

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}

Нет тела ответа

error

stringrequired

Код ошибки. Принимает возможные значения: internal_error - внутренняя ошибка сервиса при выполнении обработки запроса

error_description

stringoptional

Описание ошибки

Пример ошибки 500 (Internal Server Error)

1{
2  "error": "internal_error",
3  "error_description": "Internal server error"
4}

Нет тела ответа

Значения параметров ошибок могут изменяться. Рекомендуем предусмотреть стандартную обработку ошибок, не описанных в текущей версии документации.