Перейти к содержанию

Реестр платежей

"Реестр платежей" отображает список всех входящих и исходящих платежей в кооперативе. Они включают в себя приём паевых взносов и их возврат по целевой потребительской программе "Цифровой Кошелек", которые отображаются пайщикам в главном кошельке, но не ограничиваются ими.

реестр документов

Кроме паевых взносов и возврата, которые отображаются как движения по главному кошельку пайщиков, реестр платежей позволяет управлять и прочими платежами, например, выдачей займов, оплатой хозрасходов, и т.д. Таким образом, реестр платежей - это центральный пункт управления входящими и исходящими платежами кооператива.

Реестром платежей управляет кассир. На данный момент кассиром может быть только действующий член совета.

Входящие платежи, на данный момент, бывают в реестре только паевым взносами пайщиков по целевой потребительской программе "Цифровой Кошелек", которые при подтверждении кассиром зачисляются им в главный кошелек и позволяют принимать участие в прочих приложениях экосистемы.

Исходящие платежи создаются в процессе бизнес-логики, которая предусмотрена стандартами платформы. Так, исходящий платеж на возврат паевого взноса создаётся только после того, как заявление на возврат паевого взноса, сформированное в главном кошельке пайщика получит положительное решение совета. В момент автоматического исполнения протокола стандартизированного решения, кассир получит поручение на оплату, которое отобразится в реестре платежей.

Для управления входящими и исходящими платежами есть две кнопки: "подтвердить платеж" и "отклонить платеж":

реестр документов

При нажатии на подтверждение платежа появится окно запроса подтверждения действия. Если действие будет подтверждено, то система получит команду на изменение статуса платежа "в обработке", после чего, автоматически обработает его, запустив или продолжив цепочку бизнес-действий и изменив статус платежа на "обработано". Например, после подтверждения приёма регистрационного платежа (вступительного и мин. паевого взносов), совет получит документы в пункт повестки собрания совета.

В случае отклонения входящего в кооператив платежа - кассиру необходимо произвести обратную операцию по расчетному счету, если это требуется. При отклонении исходящего платежа система автоматически запустит соответствующую цепочку действий согласно стандартам смарт-контрактов. После отклонения от кассира обычно дополнительных действий не требуется.

Разработчикам

Канонические имена полей и типов — в файле components/controller/schema.gql монорепозитория; интерактивно — в документации GraphQL-API.

Список платежей

🛠️ SDK: Queries.Gateway.GetPayments | Query.getPayments

Получить список платежей с возможностью фильтрации по типу, статусу и направлению. Требуемые роли: chairman, member. Исключение: доступ разрешен, если

data.username

совпадает с

username

текущего пользователя.

import { Queries } from '@coopenomics/sdk';

const variables: Queries.Gateway.GetPayments.IInput = {
  data?: {
    coopname?: <null | string>; // Название кооператива
    direction?: <null | PaymentDirection>; // Направление платежа
    hash?: <null | string>; // Хэш платежа
    provider?: <null | string>; // Провайдер платежа
    status?: <null | PaymentStatus>; // Статус платежа
    type?: <null | PaymentType>; // Тип платежа
    username?: <null | string>; // Имя пользователя
  };
  options?: {
    limit: <number>; // Количество элементов на странице
    page: <number>; // Номер страницы
    sortBy?: <null | string>; // Ключ сортировки (например, "name")
    sortOrder: <string>; // Направление сортировки ("ASC" или "DESC")
  };
};

const { [Queries.Gateway.GetPayments.name]: result } = await client.Query(
  Queries.Gateway.GetPayments.query,
  { variables }
);

Результат:

interface IOutput {
  getPayments: {
    currentPage: <number>; // Текущая страница
    items: <{
        blockchain_data?: <unknown>; // Данные из блокчейна
        can_change_status: <boolean>; // Можно ли изменить статус
        coopname: <string>; // Название кооператива
        created_at: <unknown>; // Дата создания
        direction: <PaymentDirection>; // Направление платежа
        direction_label: <string>; // Человекочитаемое направление платежа
        expired_at?: <unknown>; // Дата истечения
        formatted_amount: <string>; // Форматированная сумма
        hash?: <null | string>; // Хеш платежа
        id?: <unknown>; // Уникальный идентификатор платежа
        income_hash?: <null | string>; // Хеш входящего платежа (устарело)
        is_final: <boolean>; // Завершен ли платеж окончательно
        memo?: <null | string>; // Дополнительная информация
        message?: <null | string>; // Сообщение
        outcome_hash?: <null | string>; // Хеш исходящего платежа (устарело)
        payment_details?: {
          amount_plus_fee: <string>; // Сумма платежа с учетом комиссии
          amount_without_fee: <string>; // Сумма платежа без учета комиссии
          data: <unknown>; // Данные платежа (QR-код, токен, реквизиты и т.д.)
          fact_fee_percent: <number>; // Фактический процент комиссии
          fee_amount: <string>; // Размер комиссии в абсолютных значениях
          fee_percent: <number>; // Процент комиссии
          tolerance_percent: <number>; // Допустимый процент отклонения
        };
        payment_method_id?: <null | string>; // ID платежного метода
        provider?: <null | string>; // Провайдер платежа
        quantity: <number>; // Количество/сумма
        statement?: <unknown>; // Подписанный документ заявления
        status: <PaymentStatus>; // Статус платежа
        status_label: <string>; // Человекочитаемый статус
        symbol: <string>; // Символ валюты
        type: <PaymentType>; // Тип платежа
        type_label: <string>; // Человекочитаемый тип платежа
        updated_at?: <unknown>; // Дата обновления
        username: <string>; // Имя пользователя
        username_certificate?: <({ username: string; type: AccountType; first_name: string; last_name: string; middle_name?: string | null | undefined; inn: string; } | { username: string; type: AccountType; first_name: string; last_name: string; middle_name?: string | ... 1 more ... | undefined; } | { ...; }) & {}>; // Сертификат пользователя, создавшего платеж
      }[]>; // Элементы текущей страницы
    totalCount: <number>; // Общее количество элементов
    totalPages: <number>; // Общее количество страниц
  };
}

Изменить статус платежа

🛠️ SDK: Mutations.Gateway.SetPaymentStatus | Mutation.setPaymentStatus

Управление статусом платежа осущствляется мутацией setPaymentStatus. При переходе платежа в статус PAID вызывается эффект в блокчейне, который завершает операцию автоматическим переводом платежа в статус COMPLETED. При установке статуса REFUNDED запускается процесс отмены платежа в блокчейне. Остальные статусы не приводят к эффектам в блокчейне. Требуемые роли: chairman, member.

import { Mutations } from '@coopenomics/sdk';

const variables: Mutations.Gateway.SetPaymentStatus.IInput = {
  data: {
    id: <string>; // Идентификатор платежа, для которого устанавливается статус
    status: <PaymentStatus>; // Новый статус платежа
  };
};

const { [Mutations.Gateway.SetPaymentStatus.name]: result } = await client.Mutation(
  Mutations.Gateway.SetPaymentStatus.mutation,
  { variables }
);

Результат:

interface IOutput {
  setPaymentStatus: <ModelTypes["GatewayPayment"]>;
}

Создать платёж (депозит)

🛠️ SDK: Mutations.Gateway.CreateDepositPayment | Mutation.createDepositPayment

Создание объекта паевого платежа производится мутацией createDepositPayment. Выполнение мутации возвращает идентификатор платежа и данные для его совершения в зависимости от выбранного платежного провайдера. Требуемые роли: chairman, member.

import { Mutations } from '@coopenomics/sdk';

const variables: Mutations.Gateway.CreateDepositPayment.IInput = {
  data: {
    quantity: <number>; // Сумма взноса
    symbol: <string>; // Символ валюты
    username: <string>; // Имя аккаунта пользователя
  };
};

const { [Mutations.Gateway.CreateDepositPayment.name]: result } = await client.Mutation(
  Mutations.Gateway.CreateDepositPayment.mutation,
  { variables }
);

Результат:

interface IOutput {
  createDepositPayment: {
    blockchain_data?: <unknown>; // Данные из блокчейна
    can_change_status: <boolean>; // Можно ли изменить статус
    coopname: <string>; // Название кооператива
    created_at: <unknown>; // Дата создания
    direction: <PaymentDirection>; // Направление платежа
    direction_label: <string>; // Человекочитаемое направление платежа
    expired_at?: <unknown>; // Дата истечения
    formatted_amount: <string>; // Форматированная сумма
    hash?: <null | string>; // Хеш платежа
    id?: <unknown>; // Уникальный идентификатор платежа
    income_hash?: <null | string>; // Хеш входящего платежа (устарело)
    is_final: <boolean>; // Завершен ли платеж окончательно
    memo?: <null | string>; // Дополнительная информация
    message?: <null | string>; // Сообщение
    outcome_hash?: <null | string>; // Хеш исходящего платежа (устарело)
    payment_details?: {
      amount_plus_fee: <string>; // Сумма платежа с учетом комиссии
      amount_without_fee: <string>; // Сумма платежа без учета комиссии
      data: <unknown>; // Данные платежа (QR-код, токен, реквизиты и т.д.)
      fact_fee_percent: <number>; // Фактический процент комиссии
      fee_amount: <string>; // Размер комиссии в абсолютных значениях
      fee_percent: <number>; // Процент комиссии
      tolerance_percent: <number>; // Допустимый процент отклонения
    };
    payment_method_id?: <null | string>; // ID платежного метода
    provider?: <null | string>; // Провайдер платежа
    quantity: <number>; // Количество/сумма
    statement?: <unknown>; // Подписанный документ заявления
    status: <PaymentStatus>; // Статус платежа
    status_label: <string>; // Человекочитаемый статус
    symbol: <string>; // Символ валюты
    type: <PaymentType>; // Тип платежа
    type_label: <string>; // Человекочитаемый тип платежа
    updated_at?: <unknown>; // Дата обновления
    username: <string>; // Имя пользователя
    username_certificate?: <({ username: string; type: AccountType; first_name: string; last_name: string; middle_name?: string | null | undefined; inn: string; } | { username: string; type: AccountType; first_name: string; last_name: string; middle_name?: string | ... 1 more ... | undefined; } | { ...; }) & {}>; // Сертификат пользователя, создавшего платеж
  };
}

Создать начальный платёж

🛠️ SDK: Mutations.Gateway.CreateInitialPayment | Mutation.createInitialPayment

Создание объекта регистрационного платежа производится мутацией createInitialPayment. Выполнение мутации возвращает идентификатор платежа и данные для его совершения в зависимости от выбранного платежного провайдера. Требуемые роли: chairman, member.

import { Mutations } from '@coopenomics/sdk';

const variables: Mutations.Gateway.CreateInitialPayment.IInput = {
  data: {
    username: <string>; // Имя аккаунта пользователя
  };
};

const { [Mutations.Gateway.CreateInitialPayment.name]: result } = await client.Mutation(
  Mutations.Gateway.CreateInitialPayment.mutation,
  { variables }
);

Результат:

interface IOutput {
  createInitialPayment: {
    blockchain_data?: <unknown>; // Данные из блокчейна
    can_change_status: <boolean>; // Можно ли изменить статус
    coopname: <string>; // Название кооператива
    created_at: <unknown>; // Дата создания
    direction: <PaymentDirection>; // Направление платежа
    direction_label: <string>; // Человекочитаемое направление платежа
    expired_at?: <unknown>; // Дата истечения
    formatted_amount: <string>; // Форматированная сумма
    hash?: <null | string>; // Хеш платежа
    id?: <unknown>; // Уникальный идентификатор платежа
    income_hash?: <null | string>; // Хеш входящего платежа (устарело)
    is_final: <boolean>; // Завершен ли платеж окончательно
    memo?: <null | string>; // Дополнительная информация
    message?: <null | string>; // Сообщение
    outcome_hash?: <null | string>; // Хеш исходящего платежа (устарело)
    payment_details?: {
      amount_plus_fee: <string>; // Сумма платежа с учетом комиссии
      amount_without_fee: <string>; // Сумма платежа без учета комиссии
      data: <unknown>; // Данные платежа (QR-код, токен, реквизиты и т.д.)
      fact_fee_percent: <number>; // Фактический процент комиссии
      fee_amount: <string>; // Размер комиссии в абсолютных значениях
      fee_percent: <number>; // Процент комиссии
      tolerance_percent: <number>; // Допустимый процент отклонения
    };
    payment_method_id?: <null | string>; // ID платежного метода
    provider?: <null | string>; // Провайдер платежа
    quantity: <number>; // Количество/сумма
    statement?: <unknown>; // Подписанный документ заявления
    status: <PaymentStatus>; // Статус платежа
    status_label: <string>; // Человекочитаемый статус
    symbol: <string>; // Символ валюты
    type: <PaymentType>; // Тип платежа
    type_label: <string>; // Человекочитаемый тип платежа
    updated_at?: <unknown>; // Дата обновления
    username: <string>; // Имя пользователя
    username_certificate?: <({ username: string; type: AccountType; first_name: string; last_name: string; middle_name?: string | null | undefined; inn: string; } | { username: string; type: AccountType; first_name: string; last_name: string; middle_name?: string | ... 1 more ... | undefined; } | { ...; }) & {}>; // Сертификат пользователя, создавшего платеж
  };
}