B2B

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

Пром GET https://baas.alfabank.ru/api/semp/v1/payouts/registries/cancel-receipts/{requestId}

Песочница GET https://sandbox.alfabank.ru/api/semp/v1/payouts/registries/cancel-receipts/{requestId}

Scope

as-receipt

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

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

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

Accept
stringrequired

application/json

Content-Type
stringoptional

application/json

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

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

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

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

offset
integeroptional

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

Пример запроса
curl -X GET https://baas.alfabank.ru/api/semp/v1/payouts/registries/cancel-receipts/4e817e78-5876-4608-a873-bcc141454045?limit=1000&offset=0 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token} \
  -H 'Content-Type: application/json'

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

Пример ответа 200 (ОК)
{
  "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": "Описание ошибки"
        }
      ]
    }
  ]
}
objectoptional

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

limit
integeroptional

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

offset
integeroptional

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

totalCount
integeroptional

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

requestId
stringoptional

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

externalId
stringoptional

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

createdDate
stringoptional

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

listStatus
stringoptional

Статус исполнения загруженного списка выплат. Принимает возможные значения: NEW - Принят для последующей обработки; SUCCESS - Успешно исполнен; ERROR - Ошибка в процессе исполнения; IN_PROGRESS - В процессе исполнения; WAITING - Запрос принят. Для исполнения необходимо пополнить баланс счета-плательщика

objectoptional

Ошибки обработки загруженного списка

code
stringoptional

Код ошибки

message
stringoptional

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

array of objectoptional

Список чеков и выплат в системе

payoutId
stringoptional

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

objectoptional

Персональные данные самозанятого

vatin
stringoptional

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

surname
stringoptional

Фамилия

name
stringoptional

Имя

patronymic
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

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

clientId
stringoptional

Идентификатор клиента в системе B2CPay

checkFIO
stringoptional

Флаг проверки совпадения ФИО получателя. Принимает возможные значения: true – выполнять, если совпадения по ФИО нет, не проводить платеж, иначе – выполнять проверку, при несовпадении ФИО проводить платеж

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

Статус чека в системе. Принимает возможные значения: READY - Успешно зарегистрирован; FAILED - Ошибка в процессе регистрации или сторнирования; IN_PROGRESS - В процессе регистрации; WAITING - Недостаточно денежных средств для исполнения, необходимо пополнить баланс счета-плательщика; CANCELED_BY_CLIENT - Аннулирован Клиентом; CANCELED_BY_SELFEMPLOYED - Аннулирован самозанятым; CANCELED_AUTOMATICALLY - Аннулирован автоматически системой; FAILED_CANCEL - Ошибка в процессе аннулирования; CANCELED_IN_PROGRESS - В процессе аннулирования

updatedDate
stringoptional

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

objectoptional

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

status
stringoptional

Статус выплаты в системе. Принимает возможные значения: READY - Успешно исполнена; FAILED - Ошибка в процессе исполнения; IN_PROGRESS - В процессе исполнения; WAITING - Недостаточно денежных средств для исполнения, необходимо пополнить баланс счета-плательщика; CHECK_REFUND - Проконтролируйте возврат суммы сторнированного дохода на счет

updatedDate
stringoptional

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

objectoptional

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

field
stringoptional

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

message
stringoptional

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

Пример ответа 200 (ОК)
{
  "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": "Описание ошибки"
        }
      ]
    }
  ]
}
Нет тела ответа
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"
}
Нет тела ответа

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