B2BH2H

Получение списка выплат, загруженных в систему

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

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

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

HEADERS
Атрибут
Описание
Authorization
stringrequired
Accept
stringrequired

application/json

Content-Type
stringrequired

application/json

QUERY
Атрибут
Описание
creationDate
stringoptional

Дата создания выплаты

limit
integeroptional

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

offset
integeroptional

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

Пример запроса 
1curl -X GET https://baas.alfabank.ru/api/semp/v1/payouts?creationDate=2023-10-12&limit=1 \
2  -H 'Accept: application/json' \
3  -H 'Authorization: Bearer {access-token}' \
4  -H 'Content-Type: application/json'

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

Пример ответа 200 (OK) 
1{
2    "pagination": {
3        "limit": 1,
4        "offset": 0,
5        "totalCount": 1
6    },
7    "payoutsList": [
8    {
9            "payoutId": "79df707d-cf78-4144-bc5c-43d2c9d3e71e",
10            "vatin": "0483685159",
11            "requestId": "8f9a2207-2114-4cc0-a832-9549749522af",
12            "externalId": "f8c1ffe6-696b-4e35-994f-904a9187806d",
13            "payerAccountNumber": "40702810301100003245",
14            "createdDate": "2024-04-24T11:23:16.419521Z",
15            "payoutRequisite": {
16                "payoutType": "ACCOUNT",
17                "fee": "15.00",
18                "payoutTotalAmount": "10.00",
19                "byAccount": {
20                    "purpose": "Курьерские услуги за период с 1.12.2020-20",
21                    "comment": "Курьерские услуги за период с 1.12.2020-20.12.2020Курьерские услуги за",
22                    "accountNumber": "40817810010210029719",
23                    "bic": "044525593",
24                    "incomeTypeCode": "1"
25                }
26            },
27            "receiptRequisite": {
28                "customerVatin": "0483685159",
29                "customerName": "Полное наименование Орг № 89727",
30                "incomeType": "FROM_LEGAL_ENTITY",
31                "operateDate": "2024-04-11T10:36:42.855Z",
32                "requestDate": "2024-04-12T15:36:30.763Z",
33                "services": [
34                    {
35                        "amount": "23.00",
36                        "name": "Курьерс",
37                        "quantity": "1"
38                    }
39                ],
40                "receiptTotalAmount": "23.00"
41            },
42            "receiptLink": {
43                "receiptId": "207wvndu2q",
44                "link": "https://lknpd-adp.gnivc.ru/api/v1/receipt/089469330539/207wvndu2q/print"
45            },
46            "receiptStatus": {
47                "status": "READY"
48            },
49            "payoutStatus": {
50                "status": "PAYMENT_IN_PROGRESS",
51                "updatedDate": "2024-04-24T11:24:01.0401Z"
52        }
53    ]
54}
objectoptional

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

limit
integeroptional

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

offset
integeroptional

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

totalCount
integeroptional

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

objectoptional

Выплаты

externalId
stringoptional

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

payoutId
stringoptional

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

vatin
stringoptional

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

payerAccountNumber
stringoptional

Номер счёта

createdDate
stringoptional

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

objectoptional

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

payoutType
stringoptional

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

fee
stringoptional

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

objectoptional

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

accountNumber
stringoptional

Номер счёта

bic
stringoptional

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

purpose
stringoptional

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

incomeTypeCode
stringoptional

Код вида дохода получателей выплаты по 229-ФЗ

comment
stringoptional

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

objectoptional

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

pan
stringoptional

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

comment
stringoptional

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

objectoptional

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

phone
stringoptional

Телефон

bankId
stringoptional

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

comment
stringoptional

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

payoutTotalAmount
stringoptional

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

objectoptional

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

customerVatin
stringoptional

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

customerName
stringoptional

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

incomeType
stringoptional

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

operateDate
stringoptional

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

requestDate
stringoptional

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

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": 1,
4        "offset": 0,
5        "totalCount": 1
6    },
7    "payoutsList": [
8    {
9            "payoutId": "79df707d-cf78-4144-bc5c-43d2c9d3e71e",
10            "vatin": "0483685159",
11            "requestId": "8f9a2207-2114-4cc0-a832-9549749522af",
12            "externalId": "f8c1ffe6-696b-4e35-994f-904a9187806d",
13            "payerAccountNumber": "40702810301100003245",
14            "createdDate": "2024-04-24T11:23:16.419521Z",
15            "payoutRequisite": {
16                "payoutType": "ACCOUNT",
17                "fee": "15.00",
18                "payoutTotalAmount": "10.00",
19                "byAccount": {
20                    "purpose": "Курьерские услуги за период с 1.12.2020-20",
21                    "comment": "Курьерские услуги за период с 1.12.2020-20.12.2020Курьерские услуги за",
22                    "accountNumber": "40817810010210029719",
23                    "bic": "044525593",
24                    "incomeTypeCode": "1"
25                }
26            },
27            "receiptRequisite": {
28                "customerVatin": "0483685159",
29                "customerName": "Полное наименование Орг № 89727",
30                "incomeType": "FROM_LEGAL_ENTITY",
31                "operateDate": "2024-04-11T10:36:42.855Z",
32                "requestDate": "2024-04-12T15:36:30.763Z",
33                "services": [
34                    {
35                        "amount": "23.00",
36                        "name": "Курьерс",
37                        "quantity": "1"
38                    }
39                ],
40                "receiptTotalAmount": "23.00"
41            },
42            "receiptLink": {
43                "receiptId": "207wvndu2q",
44                "link": "https://lknpd-adp.gnivc.ru/api/v1/receipt/089469330539/207wvndu2q/print"
45            },
46            "receiptStatus": {
47                "status": "READY"
48            },
49            "payoutStatus": {
50                "status": "PAYMENT_IN_PROGRESS",
51                "updatedDate": "2024-04-24T11:24:01.0401Z"
52        }
53    ]
54}
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

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

error_description
stringoptional

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

Пример ошибки 500 (Internal Server Error) 
1{
2  "error": "internal_error",
3  "error_description": "Internal server error"
4}
Нет тела ответа

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

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