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

A NestJS library for integrating with YooKassa API

import type { LocaleEnum } from '../../../../common/enums';
import type { Amount } from '../../../../common/interfaces';
import type { Receipt, Recipient } from '../../../payment/interfaces';
import type { DeliveryMethodEnum } from '../../enums';
import type { YookassaMetadata } from '../../../../common/types/metadata.type';
/**
 * Элемент корзины
 */
export interface CartItem {
    /** Название товара/услуги (1–128 символов) */
    description: string;
    /** Цена единицы */
    price: Amount;
    /** Итоговая цена с учетом скидки */
    discount_price?: Amount;
    /** Количество */
    quantity: number;
}
/**
 * Способ доставки счета
 */
export interface DeliveryMethodData {
    /** Значение способа доставки */
    type: DeliveryMethodEnum;
}
/**
 * Основной объект для создания счета
 */
export interface CreateInvoiceRequest<T extends YookassaMetadata = YookassaMetadata> {
    /**
     * Данные для проведения платежа по выставленному счету.
     */
    payment_data: {
        /** Данные о сумме платежа */
        amount: Amount;
        /** Данные для формирования чека */
        receipt?: Receipt;
        /** Информация о получателе платежа */
        recipient?: Recipient;
        /** Сохранение платежного метода для автоплатежей */
        save_payment_method?: boolean;
        /** Автоматический прием платежа */
        capture?: boolean;
        /** IP-адрес пользователя */
        client_ip?: string;
        /** Описание счета */
        description?: string;
        /** Дополнительные метаданные */
        metadata?: T;
    };
    /** Корзина заказа */
    cart: CartItem[];
    /** Данные о способе доставки счета */
    delivery_method_data?: DeliveryMethodData;
    /** Срок действия счета (ISO 8601) */
    expires_at: string;
    /** Язык интерфейса и уведомлений */
    locale?: LocaleEnum;
}