nestjs-monobank 1.2.8

package/dist/modules/invoice/interfaces/requests/create-cancel.request.d.ts

@@ -0,0 +1,22 @@
+import type { BasketItem } from "../../../../common/interfaces";
+/**
+ * Тіло запиту на скасування інвойсу.
+ */
+export interface CreateCancelRequest {
+    /**
+     * Унікальний ідентифікатор інвойсу, який необхідно скасувати.
+     */
+    invoiceId: string;
+    /**
+     * Унікальний зовнішній ідентифікатор запиту на скасування, визначений продавцем (необов’язковий).
+     */
+    extRef?: string;
+    /**
+     * Сума повернення у мінімальних одиницях валюти (необов’язкова, використовується при частковому поверненні).
+     */
+    amount?: number;
+    /**
+     * Список товарів, які необхідно скасувати, обов'язковий при активованій фіскалізації.
+     */
+    items?: BasketItem[];
+}

package/dist/modules/invoice/interfaces/requests/create-cancel.request.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/modules/invoice/interfaces/requests/create-charge.request.d.ts

@@ -0,0 +1,42 @@
+import type { MerchantPaymInfoItem } from "../../../../common/interfaces";
+import type { InvoiceSaveCardData } from "./create-invoice.request";
+/**
+ * Дані картки для проведення оплати
+ */
+export interface CardData {
+    /** PAN картки (номер) без пробілів */
+    pan: string;
+    /** Термін дії картки у форматі MMYY */
+    exp: string;
+    /** CVV/CVC код картки */
+    cvv: number;
+}
+/**
+ * Дані для проведення прямого платежу (Charge) через Monobank
+ */
+export interface CreateChargeRequest {
+    /** Сума оплати у мінімальних одиницях (копійки для гривні) */
+    amount: number;
+    /** Валюта у форматі ISO 4217 (за замовчуванням 980 — гривня) */
+    ccy?: number;
+    /** Дані картки */
+    cardData: CardData;
+    /** Інформація про замовлення/мерчанта */
+    merchantPaymInfo?: MerchantPaymInfoItem;
+    /** URL для отримання сповіщень про зміну статусу платежу */
+    webhookUrl?: string;
+    /** URL для повернення користувача після завершення оплати */
+    redirectUrl?: string;
+    /** Тип операції:
+     * - "debit" — списання коштів одразу
+     * - "hold" — утримання коштів (9 днів)
+     */
+    paymentType?: "debit" | "hold";
+    /** Дані для збереження картки (токенізація), якщо підключено */
+    saveCardData?: InvoiceSaveCardData;
+    /** Ініціатор платежу:
+     * - "merchant" — ініційовано мерчантом (регулярні платежі)
+     * - "client" — ініційовано клієнтом (за запитом користувача)
+     */
+    initiationKind: "merchant" | "client";
+}

package/dist/modules/invoice/interfaces/requests/create-charge.request.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/modules/invoice/interfaces/requests/create-finalize.request.d.ts

@@ -0,0 +1,19 @@
+import type { BasketItem } from "../../../../common/interfaces";
+/**
+ * Запит на підтвердження (списання) коштів із раніше створеного холду.
+ */
+export interface CreateFinalizeRequest {
+    /**
+     * Ідентифікатор рахунку (invoice), який потрібно підтвердити.
+     */
+    invoiceId: string;
+    /**
+     * (Необов'язково) Сума для списання в мінімальних одиницях.
+     * Якщо не вказано — буде списано повну суму холду.
+     */
+    amount?: number;
+    /**
+     * (Необов'язково) Список товарів для фіскалізації або звітності.
+     */
+    items?: BasketItem[];
+}

package/dist/modules/invoice/interfaces/requests/create-finalize.request.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/modules/invoice/interfaces/requests/create-invoice.request.d.ts

@@ -0,0 +1,88 @@
+import { type MerchantPaymInfoItem } from "../../../../common/interfaces";
+/**
+ * Дані для збереження картки (токенізації).
+ */
+export interface InvoiceSaveCardData {
+    /**
+     * Ознака збереження картки після оплати.
+     * Обов’язкове поле.
+     */
+    saveCard: boolean;
+    /**
+     * Ідентифікатор гаманця користувача.
+     * Необов’язкове поле.
+     */
+    walletId?: string;
+}
+/**
+ * Тип, що представляє запит на створення інвойсу (рахунку).
+ */
+export interface CreateInvoiceRequest {
+    /**
+     * Сума оплати у мінімальних одиницях (наприклад, копійки для гривні).
+     * Обов’язкове поле.
+     */
+    amount: number;
+    /**
+     * Код валюти за стандартом ISO 4217. За замовчуванням — 980 (гривня).
+     * Необов’язкове поле.
+     */
+    ccy?: number;
+    /**
+     * Адреса для повернення (GET) після завершення оплати (успішно або з помилкою).
+     * Необов’язкове поле.
+     */
+    redirectUrl?: string;
+    /**
+     * Адреса для зворотного виклику (webhook, POST), на яку надсилатиметься інформація про зміну статусу рахунку.
+     * Необов’язкове поле.
+     */
+    webHookUrl?: string;
+    /**
+     * Строк дії рахунку в секундах. За замовчуванням — 24 години.
+     * Необов’язкове поле.
+     */
+    validity?: number;
+    /**
+     * Тип операції.
+     * 'debit' — списання,
+     * 'hold' — холд коштів на 9 днів.
+     * Необов’язкове поле.
+     */
+    paymentType?: "debit" | "hold";
+    /**
+     * Ідентифікатор QR-каси для встановлення суми на існуючих касах.
+     * Необов’язкове поле.
+     */
+    qrId?: string;
+    /**
+     * Код терміналу субмерчанта. Доступний лише окремим мерчантам.
+     * Необов’язкове поле.
+     */
+    code?: string;
+    /**
+     * Відсоток комісії, який агент встановлює для себе.
+     * Необов’язкове поле.
+     */
+    agentFeePercent?: number;
+    /**
+     * Ідентифікатор працівника, який може отримати чайові.
+     * Необов’язкове поле.
+     */
+    tipsEmployeeId?: string;
+    /**
+     * Тип відображення платіжної форми. Якщо не вказано — буде звичайне посилання.
+     * Необов’язкове поле.
+     */
+    displayType?: "iframe";
+    /**
+     * Інформація про платіж, яка може використовуватись для фіскалізації (checkbox).
+     * Необов’язкове поле.
+     */
+    merchantPaymInfo?: MerchantPaymInfoItem;
+    /**
+     * Дані для збереження (токенізації) картки після оплати.
+     * Необов’язкове поле.
+     */
+    saveCardData?: InvoiceSaveCardData;
+}

package/dist/modules/invoice/interfaces/requests/create-invoice.request.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/modules/invoice/interfaces/requests/index.d.ts

@@ -0,0 +1,4 @@
+export * from './create-invoice.request';
+export * from './create-finalize.request';
+export * from './create-cancel.request';
+export * from './create-charge.request';

package/dist/modules/invoice/interfaces/requests/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./create-invoice.request"), exports);
+__exportStar(require("./create-finalize.request"), exports);
+__exportStar(require("./create-cancel.request"), exports);
+__exportStar(require("./create-charge.request"), exports);

package/dist/modules/invoice/interfaces/responses/cancel.response.d.ts

@@ -0,0 +1,18 @@
+import type { CancelStatusEnum } from "../../enums";
+/**
+ * Відповідь на запит про скасування інвойсу.
+ */
+export interface Cancel {
+    /**
+     * Статус операції скасування.
+     */
+    status: CancelStatusEnum;
+    /**
+     * Дата створення операції скасування.
+     */
+    createdDate: string;
+    /**
+     * Дата останньої модифікації операції.
+     */
+    modifiedDate: string;
+}

package/dist/modules/invoice/interfaces/responses/cancel.response.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/modules/invoice/interfaces/responses/charge.response.d.ts

@@ -0,0 +1,35 @@
+import type { ChargeStatusEnum } from "../../enums";
+export interface ChargeResponse {
+    /**
+     * Ідентифікатор інвойсу, за яким здійснювалась оплата
+     */
+    invoiceId: string;
+    /**
+     * Посилання на проходження 3DS підтвердження платежу (якщо потрібне)
+     */
+    tdsUrl?: string;
+    /**
+     * Статус оплати
+     */
+    status: ChargeStatusEnum;
+    /**
+     * Причина відмови в оплаті
+     */
+    failureReason?: string;
+    /**
+     * Сума у мінімальних одиницях валюти (наприклад, копійки)
+     */
+    amount: number;
+    /**
+     * ISO 4217 код валюти
+     */
+    ccy: number;
+    /**
+     * Дата і час створення заяви на оплату
+     */
+    createdDate: string;
+    /**
+     * Дата і час останньої модифікації операції оплати
+     */
+    modifiedDate: string;
+}

package/dist/modules/invoice/interfaces/responses/charge.response.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/modules/invoice/interfaces/responses/create-cancel.response.d.ts

@@ -0,0 +1,7 @@
+import type { Cancel } from "./cancel.response";
+/**
+ * Відповідь API при створенні запиту на скасування інвойсу.
+ * Наслідує базову структуру Cancel.
+ */
+export interface CreateCancelResponse extends Cancel {
+}

package/dist/modules/invoice/interfaces/responses/create-cancel.response.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/modules/invoice/interfaces/responses/create-charge.response.d.ts

@@ -0,0 +1,7 @@
+import type { ChargeResponse } from "./charge.response";
+/**
+ * Відповідь API при створенні заяви на оплату.
+ * Наслідує базову структуру Charge.
+ */
+export interface CreateChargeResponse extends ChargeResponse {
+}

package/dist/modules/invoice/interfaces/responses/create-charge.response.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/modules/invoice/interfaces/responses/create-finalize.response.d.ts

@@ -0,0 +1,7 @@
+import type { FinalizeResponse } from "./finalize.response";
+/**
+ * Відповідь API при підтвердженні холду.
+ * Наслідує базову структуру CaptureHold.
+ */
+export interface CreateFinalizeResponse extends FinalizeResponse {
+}

package/dist/modules/invoice/interfaces/responses/create-finalize.response.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/modules/invoice/interfaces/responses/create-invoice.response.d.ts

@@ -0,0 +1,7 @@
+import type { Invoice } from "./invoice.response";
+/**
+ * Відповідь API при створенні рахунку (invoice).
+ * Наслідує базову структуру Invoice.
+ */
+export interface CreateInvoiceResponse extends Invoice {
+}

package/dist/modules/invoice/interfaces/responses/create-invoice.response.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/modules/invoice/interfaces/responses/finalize.response.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Результат підтвердження холду.
+ */
+export interface FinalizeResponse {
+    /**
+     * Статус операції: наприклад, "success", "failure" або null, якщо статус невідомий.
+     */
+    status: string | null;
+}

package/dist/modules/invoice/interfaces/responses/finalize.response.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/modules/invoice/interfaces/responses/fiscal-checks.response.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Інформація про чек.
+ */
+export interface FiscalCheckItem {
+    /**
+     * Унікальний ідентифікатор чеку.
+     */
+    id: string;
+    /**
+     * Тип транзакції (наприклад, sale — продаж).
+     */
+    type: string;
+    /**
+     * Поточний статус чеку.
+     */
+    status: string;
+    /**
+     * Опис статусу чеку, якщо є.
+     */
+    statusDescription: string;
+    /**
+     * URL для перегляду або перевірки чеку.
+     */
+    taxUrl: string;
+    /**
+     * Посилання на файл, пов'язаний з чеком.
+     */
+    file: string;
+    /**
+     * Джерело фіскалізації (наприклад, monopay).
+     */
+    fiscalizationSource: string;
+}
+/**
+ * Список чеків.
+ */
+export interface FiscalChecksResponse {
+    /**
+     * Масив об'єктів типу `CheckItem`.
+     */
+    checks: FiscalCheckItem[];
+}

package/dist/modules/invoice/interfaces/responses/fiscal-checks.response.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/modules/invoice/interfaces/responses/index.d.ts

@@ -0,0 +1,9 @@
+export * from './create-invoice.response';
+export * from './create-finalize.response';
+export * from './create-cancel.response';
+export * from './cancel.response';
+export * from './finalize.response';
+export * from './invoice-status.response';
+export * from './invoice.response';
+export * from './fiscal-checks.response';
+export * from './receipt.response';

package/dist/modules/invoice/interfaces/responses/index.js

@@ -0,0 +1,25 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./create-invoice.response"), exports);
+__exportStar(require("./create-finalize.response"), exports);
+__exportStar(require("./create-cancel.response"), exports);
+__exportStar(require("./cancel.response"), exports);
+__exportStar(require("./finalize.response"), exports);
+__exportStar(require("./invoice-status.response"), exports);
+__exportStar(require("./invoice.response"), exports);
+__exportStar(require("./fiscal-checks.response"), exports);
+__exportStar(require("./receipt.response"), exports);

package/dist/modules/invoice/interfaces/responses/invoice-status.response.d.ts

@@ -0,0 +1,116 @@
+import type { InvoiceCancelItem, TipsInfo, WalletData } from "../../../../common/interfaces";
+import type { InvoiceStatusEnum } from "../../enums";
+/**
+ * Інформація про здійснений платіж за рахунком.
+ */
+export interface InvoiceStatusPaymentInfo {
+    /**
+     * Маскований номер картки, з якої здійснено платіж.
+     */
+    maskedPan: string;
+    /**
+     * Код авторизації транзакції.
+     */
+    approvalCode: string;
+    /**
+     * RRN (Retrieval Reference Number) — унікальний ідентифікатор транзакції.
+     */
+    rrn: string;
+    /**
+     * Унікальний ідентифікатор транзакції в системі банку.
+     */
+    tranId: string;
+    /**
+     * Ідентифікатор терміналу, через який проведено оплату.
+     */
+    terminal: string;
+    /**
+     * Назва банку, що обробив платіж.
+     */
+    bank: string;
+    /**
+     * Платіжна система (наприклад, Visa, Mastercard).
+     */
+    paymentSystem: string;
+    /**
+     * Метод оплати (наприклад, картка, Google Pay, Apple Pay).
+     */
+    paymentMethod: string;
+    /**
+     * Комісія, стягнена банком, у мінімальних одиницях валюти.
+     */
+    fee: number;
+    /**
+     * Код країни у форматі ISO 3166-1 numeric (наприклад, 804 — Україна).
+     */
+    country: 804;
+    /**
+     * Комісія агента, якщо застосовується (у мінімальних одиницях).
+     */
+    agentFee: number;
+}
+/**
+ * Інформація про статус рахунку.
+ */
+export interface InvoiceStatus {
+    /**
+     * Ідентифікатор інвойсу.
+     */
+    invoiceId: string;
+    /**
+     * Поточний статус інвойсу.
+     */
+    status: InvoiceStatusEnum;
+    /**
+     * Причина відмови, якщо оплата неуспішна.
+     */
+    failureReason?: string;
+    /**
+     * Код помилки, яка виникла під час обробки платежу.
+     */
+    errCode?: string;
+    /**
+     * Сума у мінімальних одиницях валюти.
+     */
+    amount: number;
+    /**
+     * Валюта операції.
+     */
+    ccy: number;
+    /**
+     * Підсумкова сума після оплати та повернень.
+     */
+    finalAmount: number;
+    /**
+     * Дата і час фінансової операції.
+     */
+    createdDate: string;
+    /**
+     * Дата і час останньої модифікації операції.
+     */
+    modifiedDate: string;
+    /**
+     * Референс платежу, який визначається продавцем.
+     */
+    reference: string;
+    /**
+     * Призначення платежу, визначається продавцем.
+     */
+    destination: string;
+    /**
+     * Список прийнятих заявок на скасування.
+     */
+    cancelList: InvoiceCancelItem[];
+    /**
+     * Інформація про платіж, що включає деталі транзакції.
+     */
+    paymentInfo: InvoiceStatusPaymentInfo;
+    /**
+     * Дані про гаманця користувача, що зберігає токенізовану картку.
+     */
+    walletData: WalletData;
+    /**
+     * Інформація про чайові, якщо вони були сплачені.
+     */
+    tipsInfo: TipsInfo;
+}

package/dist/modules/invoice/interfaces/responses/invoice-status.response.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/modules/invoice/interfaces/responses/invoice.response.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Відповідь після створення інвойсу.
+ */
+export interface Invoice {
+    /**
+     * Ідентифікатор інвойсу.
+     */
+    invoiceId: string;
+    /**
+     * Посилання на сторінку оплати.
+     */
+    pageUrl: string;
+}

package/dist/modules/invoice/interfaces/responses/invoice.response.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/modules/invoice/interfaces/responses/receipt.response.d.ts

@@ -0,0 +1,6 @@
+export interface ReceiptResponse {
+    /**
+     * Base64-закодований PDF-файл квитанції
+     */
+    file: string;
+}

package/dist/modules/invoice/interfaces/responses/receipt.response.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/modules/invoice/invoice.module.d.ts

@@ -0,0 +1,2 @@
+export declare class InvoiceModule {
+}

package/dist/modules/invoice/invoice.module.js

@@ -0,0 +1,20 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InvoiceModule = void 0;
+const common_1 = require("@nestjs/common");
+const invoice_service_1 = require("./invoice.service");
+let InvoiceModule = class InvoiceModule {
+};
+exports.InvoiceModule = InvoiceModule;
+exports.InvoiceModule = InvoiceModule = __decorate([
+    (0, common_1.Module)({
+        providers: [invoice_service_1.InvoiceService],
+        exports: [invoice_service_1.InvoiceService]
+    })
+], InvoiceModule);