B2B

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

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

Песочница GET https://sandbox.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

Accept
stringrequired

application/json

Content-Type
stringoptional

application/json

PATH
Атрибут
Описание
vatin
stringrequired

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

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

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

offset
integeroptional

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

Пример запроса
curl -X GET https://baas.alfabank.ru/api/semp/v1/payouts/selfemployed/533817905781?offset=0&limit=100 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token} \
  -H 'Content-Type: application/json' 

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

Пример ответа 200 (OK)
{
    "pagination": {
        "limit": 100,
        "offset": 0,
        "totalCount": 5000
    },
    "payoutsList": [
        {
            "payoutId": "c7bae81e-6387-11ee-8c99-0242ac120002",
            "vatin": "0483685159",
            "requestId": "de638b6e-d69c-4e10-8efa-dbdbca264357",
            "externalId": "821fefdc-5a7a-4e02-b239-18d947d7e4e3",
            "payerAccountNumber": "40702810901100000350",
            "createdDate": "2023-10-12T12:06:12.148576+03:00",
            "payoutRequisite": {
                "payoutType": "ACCOUNT",
                "payoutTotalAmount": "2.00",
                "byAccount": {
                    "purpose": "Курьерские услуги за период с 1.12.2020-20",
                    "comment": "Курьерские услуги за период с 1.12.2020-20.12.2020Курьерские услуги за",
                    "accountNumber": "40817810704100002673",
                    "bic": "044525593"
                }
            },
            "receiptRequisite": {
                "customerVatin": "0483685159",
                "customerName": "Полное наименование Орг № 89727",
                "incomeType": "FROM_LEGAL_ENTITY",
                "operateDate": "2023-07-26T12:43:20+03:00",
                "requestDate": "2023-10-06T08:34:24+03:00",
                "services": [
                    {
                        "amount": "2.00",
                        "name": "Курьерс",
                        "quantity": "1"
                    }
                ],
                "receiptTotalAmount": "2.00"
            },
            "receiptLink": {},
            "receiptStatus": {},
            "payoutStatus": {
                "status": "INCOME_REGISTRATION_REQUESTED",
                "updatedDate": "2023-10-12T12:44:37.003522+03:00"
            }
        },
        {
            "payoutId": "c7bae81e-6387-11ee-8c99-0242ac120002",
            "vatin": "0483685159",
            "requestId": "de638b6e-d69c-4e10-8efa-dbdbca264357",
            "externalId": "821fefdc-5a7a-4e02-b239-18d947d7e4e3",
            "payerAccountNumber": "40702810901100000350",
            "createdDate": "2023-10-12T12:06:12.148598+03:00",
            "payoutRequisite": {
                "payoutType": "ACCOUNT",
                "payoutTotalAmount": "2.00",
                "byAccount": {
                    "purpose": "Курьерские услуги за период с 1.12.2020-20",
                    "comment": "Курьерские услуги за период с 1.12.2020-20.12.2020Курьерские услуги за",
                    "accountNumber": "40817810704100002673",
                    "bic": "044525593"
                }
            },
            "receiptRequisite": {
                "customerVatin": "0483685159",
                "customerName": "Полное наименование Орг № 89727",
                "incomeType": "FROM_LEGAL_ENTITY",
                "operateDate": "2023-07-25T15:55:03+03:00",
                "requestDate": "2023-10-06T08:34:24+03:00",
                "services": [
                    {
                        "amount": "2.00",
                        "name": "Курьерс",
                        "quantity": "1"
                    }
                ],
                "receiptTotalAmount": "2.00"
            },
            "receiptLink": {},
            "receiptStatus": {},
            "payoutStatus": {
                "status": "INCOME_REGISTRATION_REQUESTED",
                "updatedDate": "2023-10-12T12:44:37.3016+03:00"
            }
        },
        {
            "payoutId": "c7bae81e-6387-11ee-8c99-0242ac120002",
            "vatin": "0483685159",
            "requestId": "de638b6e-d69c-4e10-8efa-dbdbca264357",
            "externalId": "821fefdc-5a7a-4e02-b239-18d947d7e4e3",
            "payerAccountNumber": "40702810901100000350",
            "createdDate": "2023-10-12T12:06:12.148665+03:00",
            "payoutRequisite": {
                "payoutType": "ACCOUNT",
                "payoutTotalAmount": "2.00",
                "byAccount": {
                    "purpose": "Курьерские услуги за период с 1.12.2020-20",
                    "comment": "Курьерские услуги за период с 1.12.2020-20.12.2020Курьерские услуги за",
                    "accountNumber": "40817810704100002673",
                    "bic": "044525593"
                }
            },
            "receiptRequisite": {
                "customerVatin": "0483685159",
                "customerName": "Полное наименование Орг № 89727",
                "incomeType": "FROM_LEGAL_ENTITY",
                "operateDate": "2023-09-17T13:10:10+03:00",
                "requestDate": "2023-10-06T08:34:24+03:00",
                "services": [
                    {
                        "amount": "2.00",
                        "name": "Курьерс",
                        "quantity": "1"
                    }
                ],
                "receiptTotalAmount": "2.00"
            },
            "receiptLink": {},
            "receiptStatus": {},
            "payoutStatus": {
                "status": "INCOME_REGISTRATION_REQUESTED",
                "updatedDate": "2023-10-12T12:44:38.79556+03:00"
            }
        }
    ]
}

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

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

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 - Ошибка в процессе регистрации или сторнирования; CANCEL_REQUESTED - Запрос на аннулирование чека отправлен в ФНС; IN_PROGRESS - В процессе обработки; CANCEL_INCOME_REQUESTED_AUTOMATICALLY - Отправлен запрос в ФНС на аннулирование чека; CANCELED_AUTOMATICALLY - Аннулирован автоматически системой; FAILED_CANCEL - Ошибка аннулирования чека в ФНС; CHECK_REFUND - Проконтролируйте возврат суммы сторнирования дохода на счет; PARTNER_INFO - Чек был передан клиентом

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 - Внешний платеж ожидает исполнения

updatedDate
stringoptional

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

objectoptional

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

field
stringoptional

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

message
stringoptional

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

Пример ответа 200 (OK)
{
    "pagination": {
        "limit": 100,
        "offset": 0,
        "totalCount": 5000
    },
    "payoutsList": [
        {
            "payoutId": "c7bae81e-6387-11ee-8c99-0242ac120002",
            "vatin": "0483685159",
            "requestId": "de638b6e-d69c-4e10-8efa-dbdbca264357",
            "externalId": "821fefdc-5a7a-4e02-b239-18d947d7e4e3",
            "payerAccountNumber": "40702810901100000350",
            "createdDate": "2023-10-12T12:06:12.148576+03:00",
            "payoutRequisite": {
                "payoutType": "ACCOUNT",
                "payoutTotalAmount": "2.00",
                "byAccount": {
                    "purpose": "Курьерские услуги за период с 1.12.2020-20",
                    "comment": "Курьерские услуги за период с 1.12.2020-20.12.2020Курьерские услуги за",
                    "accountNumber": "40817810704100002673",
                    "bic": "044525593"
                }
            },
            "receiptRequisite": {
                "customerVatin": "0483685159",
                "customerName": "Полное наименование Орг № 89727",
                "incomeType": "FROM_LEGAL_ENTITY",
                "operateDate": "2023-07-26T12:43:20+03:00",
                "requestDate": "2023-10-06T08:34:24+03:00",
                "services": [
                    {
                        "amount": "2.00",
                        "name": "Курьерс",
                        "quantity": "1"
                    }
                ],
                "receiptTotalAmount": "2.00"
            },
            "receiptLink": {},
            "receiptStatus": {},
            "payoutStatus": {
                "status": "INCOME_REGISTRATION_REQUESTED",
                "updatedDate": "2023-10-12T12:44:37.003522+03:00"
            }
        },
        {
            "payoutId": "c7bae81e-6387-11ee-8c99-0242ac120002",
            "vatin": "0483685159",
            "requestId": "de638b6e-d69c-4e10-8efa-dbdbca264357",
            "externalId": "821fefdc-5a7a-4e02-b239-18d947d7e4e3",
            "payerAccountNumber": "40702810901100000350",
            "createdDate": "2023-10-12T12:06:12.148598+03:00",
            "payoutRequisite": {
                "payoutType": "ACCOUNT",
                "payoutTotalAmount": "2.00",
                "byAccount": {
                    "purpose": "Курьерские услуги за период с 1.12.2020-20",
                    "comment": "Курьерские услуги за период с 1.12.2020-20.12.2020Курьерские услуги за",
                    "accountNumber": "40817810704100002673",
                    "bic": "044525593"
                }
            },
            "receiptRequisite": {
                "customerVatin": "0483685159",
                "customerName": "Полное наименование Орг № 89727",
                "incomeType": "FROM_LEGAL_ENTITY",
                "operateDate": "2023-07-25T15:55:03+03:00",
                "requestDate": "2023-10-06T08:34:24+03:00",
                "services": [
                    {
                        "amount": "2.00",
                        "name": "Курьерс",
                        "quantity": "1"
                    }
                ],
                "receiptTotalAmount": "2.00"
            },
            "receiptLink": {},
            "receiptStatus": {},
            "payoutStatus": {
                "status": "INCOME_REGISTRATION_REQUESTED",
                "updatedDate": "2023-10-12T12:44:37.3016+03:00"
            }
        },
        {
            "payoutId": "c7bae81e-6387-11ee-8c99-0242ac120002",
            "vatin": "0483685159",
            "requestId": "de638b6e-d69c-4e10-8efa-dbdbca264357",
            "externalId": "821fefdc-5a7a-4e02-b239-18d947d7e4e3",
            "payerAccountNumber": "40702810901100000350",
            "createdDate": "2023-10-12T12:06:12.148665+03:00",
            "payoutRequisite": {
                "payoutType": "ACCOUNT",
                "payoutTotalAmount": "2.00",
                "byAccount": {
                    "purpose": "Курьерские услуги за период с 1.12.2020-20",
                    "comment": "Курьерские услуги за период с 1.12.2020-20.12.2020Курьерские услуги за",
                    "accountNumber": "40817810704100002673",
                    "bic": "044525593"
                }
            },
            "receiptRequisite": {
                "customerVatin": "0483685159",
                "customerName": "Полное наименование Орг № 89727",
                "incomeType": "FROM_LEGAL_ENTITY",
                "operateDate": "2023-09-17T13:10:10+03:00",
                "requestDate": "2023-10-06T08:34:24+03:00",
                "services": [
                    {
                        "amount": "2.00",
                        "name": "Курьерс",
                        "quantity": "1"
                    }
                ],
                "receiptTotalAmount": "2.00"
            },
            "receiptLink": {},
            "receiptStatus": {},
            "payoutStatus": {
                "status": "INCOME_REGISTRATION_REQUESTED",
                "updatedDate": "2023-10-12T12:44:38.79556+03:00"
            }
        }
    ]
}

error
stringrequired

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

error_description
stringoptional

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

Пример ошибки 400 (Bad Request)
{
  "error": "invalid_request",
  "error_description": "Authorization header is not present in request headers"
}
error
stringrequired

Код ошибки. Принимает возможные значения: invalid_token - Предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам

error_description
stringoptional

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

Пример ошибки 401 (Unauthorized)
{
  "error": "invalid_token",
  "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
}
error
stringrequired

Код ошибки. Принимает возможные значения: insufficient_scope - У пользователя нет прав на использование запрашиваемого сервиса, доступ к которому не предусмотрен настройками scope; access_denied - Доступ к счету запрещен

error_description
stringoptional

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

Пример ошибки 403 (Forbidden)
{
  "error": "insufficient_scope",
  "error_description": "The request requires higher privileges than provided by the access token"
}
error
stringrequired

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

error_description
stringoptional

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

Пример ошибки 404 (Not Found)
{
  "error": "unknown_endpoint",
  "error_description": "Endpoint is not found or not active"
}
Нет тела ответа
error
stringrequired

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

error_description
stringoptional

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

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

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