@yuno-payments/dashboard-api-mfe 2.5.0 → 2.7.0

package/build/types/reconciliation/reconciliation-agenda.d.ts

@@ -0,0 +1,84 @@
+export declare namespace ReconciliationAgenda {
+    interface Agenda {
+        ur_key: string;
+        country: string;
+        type_transaction: string;
+        payment_method_category: string;
+        payment_method_type: string;
+        provider_id: string;
+        customer_id: string;
+        payment_id: string;
+        merchant_order_id: string;
+        merchant_transaction_id: string;
+        transaction_id: string;
+        provider_transaction_id: string;
+        third_party_transaction_id: string;
+        status_payment: string;
+        response_code: string;
+        provider_status: string;
+        transaction_amount: number;
+        currency: string;
+        card_type: string;
+        card_brand: string;
+        card_iin: string;
+        card_lfd: string;
+        authorization_code: string;
+        installments: number;
+        installment_number: number;
+        installment_amount: number;
+        pnr: string;
+        created_at: string;
+        updated_at: string;
+        agenda_status: string;
+        agenda_sub_status: string;
+        sales_reconciliation_date: string;
+        provider_intended_settlement_date: string;
+        provider_confirmation_date: string;
+        bank_account: string;
+        bank_agency: string;
+        bank: string;
+        advancement_amount: number;
+        provider_fees: number;
+        provider_taxes: number;
+        pending_amount: number;
+        acquirer: string;
+    }
+    interface InsightValue {
+        key: string;
+        value: number;
+        color?: string;
+        percentage?: number;
+    }
+    interface FiltersRequestParams {
+        page_number: number;
+        page_size: number;
+    }
+    interface InsightRequestParams {
+        insight_type: ReconciliationAgendaInsight;
+    }
+    interface FiltersRequestBody {
+        acquirers?: string[];
+        accounts?: string[];
+        countries?: string[];
+        providers?: string[];
+    }
+    interface GetAllReconciliationsAgendaResponse extends FiltersRequestParams {
+        agenda: Agenda[];
+    }
+    interface AmountToBeSettled {
+        amount_to_be_settled: number;
+        currency: string;
+    }
+    interface InsightDistribution {
+        items: InsightValue[];
+        total: number;
+        average: number;
+    }
+    type GetReconciliationsAgendaInsightsResponse = InsightDistribution | AmountToBeSettled;
+}
+export declare enum ReconciliationAgendaInsight {
+    TOTAL_AMOUNT = "AGENDA_TOTAL_AMOUNT",
+    DAILY = "AGENDA_DAILY_DISTRIBUTION",
+    PAYMENT_METHOD = "AGENDA_PAYMENT_METHOD_DISTRIBUTION",
+    CARD_BRAND = "AGENDA_CARD_BRAND_DISTRIBUTION"
+}

package/build/types/reconciliation/reconciliation-alerts.d.ts

@@ -0,0 +1,38 @@
+export declare namespace ReconciliationAlerts {
+    interface Alert {
+        alert_id?: string;
+        name: string;
+        description: string;
+        provider: string;
+        country: string;
+        alert_type: string;
+        emails: string[];
+        accounts: string[];
+        conditions: string;
+        created_at: string;
+        updated_at: string;
+    }
+    interface ReconciliationAlertFiltersParams {
+        page_number: number;
+        page_size: number;
+    }
+    interface ReconciliationAlertFiltersBody {
+        start_date: string;
+        end_date: string;
+        accounts?: string[];
+        countries?: string[];
+        providers?: string[];
+        search?: string;
+    }
+    type ReconciliationAlertToSave = Omit<Alert, 'alert_id' | 'created_at' | 'updated_at'>;
+    type ReconciliationAlertToUpdate = Omit<Alert, 'created_at' | 'updated_at'>;
+    type GetAllReconciliationsAlertsResponse = {
+        page: number;
+        page_size: number;
+        total_pages: number;
+        total: number;
+        alerts: Alert[];
+    };
+    type PostReconciliationAlertRespose = Alert;
+    type DeleteReconciliationAlertResponse = Pick<Alert, 'alert_id'>;
+}

package/build/types/reconciliation/reconciliation-fees.d.ts

@@ -0,0 +1,45 @@
+export declare namespace ReconciliationFees {
+    interface Fees {
+        transaction_id: string;
+        provider_transaction_id: string;
+        card_iin: string;
+        card_lfd: string;
+        authorization_code: string;
+        acquirer_type: string;
+        acquirer_gross_amount: number;
+        acquirer_real_amount: number;
+        acquirer_fees: number;
+        acquirer_taxes: number;
+        country: string;
+        type: string;
+        gross_field: string;
+        percentage_cost: number;
+        fix_cost: number;
+        calculated_fix_costed_fee: number;
+        calculated_percentage_cost: number;
+        acquirer_net_amount: number;
+        calculated_net_amount: number;
+        fee_taxes_diff: number;
+        fee_status: string;
+        fee_sub_status: string;
+        currency: string;
+        acquirer: string;
+        settlement_date: string;
+    }
+    interface FiltersRequestParams {
+        page_number: number;
+        page_size: number;
+    }
+    interface FiltersRequestBody {
+        accounts?: string[];
+        acquirers?: string[];
+        countries?: string[];
+        start_date: string;
+        end_date: string;
+        fee_status?: string;
+        fee_sub_status?: string;
+    }
+    interface GetAllReconciliationsFeesResponse extends FiltersRequestParams {
+        items: Fees[];
+    }
+}

package/build/types/reconciliation/reconciliation-insights.d.ts

@@ -0,0 +1,238 @@
+export declare namespace ReconciliationInsights {
+    interface BaseFilters {
+        accounts: string[];
+        start_date: string;
+        end_date: string;
+        countries?: string[];
+        currency_codes?: string[];
+    }
+    export interface BaseFiltersWithProvider extends BaseFilters {
+        providers?: string[];
+    }
+    export interface BaseFiltersWithAcquirer extends BaseFilters {
+        acquirers?: string[];
+    }
+    export interface ListFiltersWithProvider extends BaseFiltersWithProvider {
+        page?: number;
+        page_size?: number;
+    }
+    export interface ListFiltersWithAcquirer extends BaseFiltersWithAcquirer {
+        page?: number;
+        page_size?: number;
+    }
+    export type DateFilterType = 'by_settlement_date' | 'by_transaction_date';
+    export interface SummaryTotal {
+        transactions: number;
+        amount_local: number;
+        amount_usd: number;
+        currency_code_local: string;
+    }
+    export interface GenericSummaryItem extends SummaryTotal {
+        id: string;
+    }
+    export interface NotReconciledSummaryItem extends GenericSummaryItem {
+        total_transactions: number;
+    }
+    export interface ReconciledSummaryItem extends GenericSummaryItem {
+        transaction_type: string;
+    }
+    export interface GenericChartSummary<T = GenericSummaryItem> {
+        data: T[];
+        total: SummaryTotal;
+    }
+    export interface ChartWithGraph {
+        total_amount_usd: number;
+        chart_data: Array<{
+            date: string;
+            amount_usd: number;
+        }>;
+    }
+    export interface AggregatorByCurrency extends SummaryTotal {
+        currency_code: string;
+    }
+    export interface AggregatorByConnection extends SummaryTotal {
+        connection_name: string;
+    }
+    export interface AggregatorByBrand extends SummaryTotal {
+        brand: string;
+    }
+    export interface AggregatorByPaymentMethod extends SummaryTotal {
+        payment_method: string;
+    }
+    export interface Aggregators {
+        by_currency: AggregatorByCurrency[];
+        by_connection: AggregatorByConnection[];
+        by_brand: AggregatorByBrand[];
+        by_payment_method: AggregatorByPaymentMethod[];
+        total: SummaryTotal;
+    }
+    export interface PaginationInfo {
+        total: number;
+        page: number;
+        page_size: number;
+        total_pages: number;
+    }
+    export interface ReconciliationOverviewItem {
+        authorization_code: string;
+        card_category: string;
+        country: string;
+        created_at: string;
+        currency: string;
+        payment_method_category: string;
+        provider_id: string;
+        reconciliation_status: string;
+        reconciliation_sub_status: string;
+    }
+    export interface ReconciliationOverviewList {
+        data: ReconciliationOverviewItem[];
+        pagination: PaginationInfo;
+    }
+    export interface SettlementAndFeeItem {
+        transaction_id: string;
+        transaction_date: string;
+        acquirer: string;
+        authorization_code: string;
+        card_brand: string;
+        card_iin: string;
+        card_lfd: string;
+        card_type: string;
+        country: string;
+        currency: string;
+        fee_status: string;
+        fee_sub_status: string;
+        fee_taxes_diff: number;
+        calculated_fix_costed_fee: number;
+        calculated_percentage_cost: number;
+        percentage_cost: number;
+        merchant_order_id: string;
+        provider_transaction_id: string;
+        reconciliation_status: string;
+        reconciliation_sub_status: string;
+        type: string;
+    }
+    export interface SettlementAndFeeList {
+        data: SettlementAndFeeItem[];
+        pagination: PaginationInfo;
+    }
+    export interface ProcessedTransactionItem {
+        transaction_id: string;
+        acquirer: string;
+        amount: number;
+        authorization_code: string;
+        card_brand: string;
+        card_iin: string;
+        card_lfd: string;
+        card_type: string;
+        confirmation_status: string;
+        country: string;
+        created_at: string;
+        currency: string;
+        merchant_order_id: string;
+        merchant_transaction_id: string;
+        payment_id: string;
+        provider_status: string;
+        provider_transaction_id: string;
+        response_code: string;
+        status: string;
+        type: string;
+    }
+    export interface ProcessedTransactionList {
+        data: ProcessedTransactionItem[];
+        pagination: PaginationInfo;
+    }
+    export interface ConflictsSummary {
+        not_reconciled: GenericChartSummary<NotReconciledSummaryItem>;
+        status_conflict: GenericChartSummary;
+        amount_conflict: GenericChartSummary;
+    }
+    export interface ReconciliationRateTotal {
+        total_transactions: number;
+        transactions_percentage: number;
+    }
+    export interface ReconciliationRateByProviderDay {
+        transaction_date: string;
+        total_transactions: number;
+        reconciled_transactions: number;
+    }
+    export interface ReconciliationRateItem {
+        code: string;
+        total_transactions: number;
+        transactions_percentage: number;
+    }
+    export interface ReconciliationRateByProvider extends ReconciliationRateItem {
+        metrics: ReconciliationRateByProviderDay[];
+    }
+    export interface ReconciliationRateByProviderResponse {
+        total: ReconciliationRateTotal;
+        data: ReconciliationRateByProvider[];
+    }
+    export interface UseInsightsQueryProps<T> {
+        body: T;
+        enabled?: boolean;
+    }
+    export interface UseInsightsQueryWithDateFilterProps<T> {
+        body: T;
+        dateFilter?: DateFilterType;
+        transactionType?: string;
+        enabled?: boolean;
+    }
+    export interface UseInsightsListQueryProps<T> {
+        body: T;
+        enabled?: boolean;
+    }
+    export interface Error {
+        code?: string;
+        message?: string;
+    }
+    export type SettlementLookupKey = 'payment_id' | 'transaction_id' | 'provider_transaction_id' | 'third_party_transaction_id_transaction';
+    export interface SettlementLookupBody {
+        accounts?: string[];
+        key: SettlementLookupKey;
+        value: string;
+    }
+    export interface SettlementDetail {
+        primary_key: string;
+        organization_code: string;
+        account_id: string;
+        provider_merchant_id: string;
+        provider_id: string;
+        acquirer: string;
+        country: string;
+        payment_method_category: string;
+        payment_method_type: string;
+        settlement_batch_id: string;
+        payment_id: string;
+        transaction_id: string;
+        provider_transaction_id: string;
+        third_party_transaction_id_transaction: string;
+        merchant_order_id: string;
+        merchant_reference: string;
+        transaction_date: string;
+        settlement_date: string;
+        type: string;
+        reconciliation_status: string;
+        reconciliation_sub_status: string;
+        reconciliation_id: string;
+        amount: number;
+        gross_currency: string;
+        gross_credit: number;
+        gross_debit: number;
+        settlement_currency: string;
+        fx_rate: number;
+        settlement_gross_amount: number;
+        fee_rate: number;
+        settlement_fees: number;
+        settlement_fee_taxes: number;
+        settlement_taxes: number;
+        settlement_net_credit: number;
+        settlement_net_debit: number;
+        card_brand: string;
+        card_type: string;
+        card_iin: string;
+        card_lfd: string;
+        authorization_code: string;
+        installments: number;
+        installment_number: number;
+    }
+    export {};
+}

package/build/types/reconciliation/reconciliation-sales.d.ts

@@ -0,0 +1,56 @@
+export declare namespace ReconciliationSales {
+    interface Sales {
+        transaction_id: string;
+        payment_method_category: string;
+        type: string;
+        payment_method_type: string;
+        provider_id: string;
+        status: string;
+        response_code: string;
+        amount: number;
+        created_at: string;
+        updated_at: string;
+        provider_status: string;
+        merchant_transaction_id: string;
+        provider_transaction_id: string;
+        country: string;
+        customer_id: string;
+        description: string;
+        merchant_order_id: string;
+        payment_id: string;
+        currency: string;
+        card_issuer_name: string;
+        card_issuer_country: string;
+        card_category: string;
+        card_expiration_month: number;
+        card_expiration_year: number;
+        pnr: string;
+        retrieval_reference_number: string;
+        card_iin: string;
+        card_lfd: string;
+        authorization_code: string;
+        installments: number;
+        card_type: string;
+        card_brand: string;
+        provider_card_brand: string;
+        confirmation_status: string;
+        provider_confirmation_date: string;
+        acquirer: string;
+    }
+    interface FiltersRequestParams {
+        page_number: number;
+        page_size: number;
+    }
+    interface FiltersRequestBody {
+        accounts?: string[];
+        providers?: string[];
+        acquirers?: string[];
+        countries?: string[];
+        types?: string[];
+        start_date: string;
+        end_date: string;
+    }
+    interface GetAllReconciliationsSalesResponse extends FiltersRequestParams {
+        items: Sales[];
+    }
+}