@yuno-payments/dashboard-api-mfe 1.10.6 → 1.10.8

package/build/types/payouts/payouts.d.ts

@@ -0,0 +1,125 @@
+export declare namespace Payouts {
+    interface Filters {
+        organization_code: string;
+        account_codes: string[];
+        statuses: string[];
+        sub_statuses: string[];
+        currency_codes: string[];
+        providers: string[];
+        withdrawal_method_types: string[];
+        country_codes: string[];
+        purposes: string[];
+    }
+    interface List {
+        content: ItemList[];
+        number: number;
+        size: number;
+        total_elements: number;
+        total_pages: number;
+        last_page: boolean;
+    }
+    interface ItemList {
+        payout_code: string;
+        transaction_code: string;
+        merchant_reference: string;
+        status: string;
+        sub_status: string;
+        amount: number;
+        currency_code: string;
+        provider_id: string;
+        withdrawal_method_type: string;
+        created_at: string;
+        updated_at: string;
+        country: string;
+        account_code: string;
+        organization_code: string;
+        beneficiary_email: string;
+    }
+    interface Details {
+        code: string;
+        status: string;
+        sub_status: string;
+        merchant_reference: string;
+        trace_id?: string;
+        purpose: string;
+        account_code: string;
+        organization_code: string;
+        country: string;
+        description: string;
+        amount: {
+            currency: string;
+            value: number;
+        };
+        beneficiary: Beneficiary;
+        metadata: {
+            key: string;
+            value: string;
+        }[];
+        created_at: string;
+        updated_at: string;
+        withdrawal_method: WithdrawlMethod;
+    }
+    interface Beneficiary {
+        merchant_beneficiary_id: string;
+        national_entity: string;
+        first_name: string;
+        last_name: string;
+        legal_name: string;
+        email: string;
+        date_of_birth: string;
+        country: string;
+        document: Document;
+        phone: {
+            country_code: string;
+            number: string;
+        };
+        address: {
+            address_line_1: string;
+            address_line_2: string;
+            city: string;
+            country: string;
+            state: string;
+            zip_code: string;
+        };
+    }
+    interface WithdrawlMethod {
+        type: string;
+        provider_id: string;
+        detail: {
+            bank_transfer?: string;
+            wallet: {
+                code?: string;
+                email: string;
+                country: string;
+                document: Document;
+                phone: {
+                    country_code: string;
+                    number: string;
+                };
+            };
+        };
+    }
+    interface Document {
+        document_number: string;
+        document_type: string;
+    }
+    interface TimelineEvent {
+        id: number;
+        payout_id?: string;
+        transaction_id?: string;
+        category?: string;
+        code: string;
+        description?: string;
+        status?: string;
+        amount?: number;
+        provider_data?: Record<string, unknown>;
+        withdrawal_method_type?: string;
+        type?: string;
+        metadata?: Record<string, unknown>;
+        created_at: string;
+        updated_at?: string;
+    }
+    interface Timeline {
+        events: TimelineEvent[];
+    }
+}

package/build/types/recipients/index.d.ts

@@ -0,0 +1,2 @@
+export * from './recipients';
+export * from './recipients-mutations';

package/build/types/recipients/recipients.d.ts

@@ -0,0 +1,223 @@
+export declare namespace Recipients {
+    interface Document {
+        number: string | null;
+        type: string | null;
+    }
+    interface Phone {
+        country_code: string | null;
+        number: string | null;
+    }
+    interface Address {
+        address_line_1: string | null;
+        address_line_2: string | null;
+        country: string | null;
+        city: string | null;
+        state: string | null;
+        zip_code: string | null;
+    }
+    interface Bank {
+        code: string | null;
+        branch: string | null;
+        branch_digit: string | null;
+        account: string | null;
+        account_digit: string | null;
+        account_type: string | null;
+        routing: string | null;
+        country: string | null;
+        currency: string | null;
+        payout_schedule?: string | null;
+    }
+    interface WithdrawalMethod {
+        bank: Bank | null;
+    }
+    interface Documentation {
+        file_name: string;
+        content_type: string;
+        content_category: string;
+        content: string | null;
+    }
+    interface OnboardingSummary {
+        id: string;
+        provider_id: string;
+        status: string;
+        created_at: string;
+    }
+    interface RecipientListItem {
+        id: string;
+        merchant_recipient_id: string | null;
+        national_entity: string;
+        entity_type: string | null;
+        country: string;
+        first_name: string | null;
+        last_name: string | null;
+        legal_name: string | null;
+        email: string | null;
+        account_id: string;
+        date_of_birth: string | null;
+        website: string | null;
+        industry: string | null;
+        merchant_category_code: string | null;
+        created_at: string;
+        updated_at: string;
+    }
+    interface Pagination {
+        page: number;
+        page_size: number;
+        total_items: number;
+        total_pages: number;
+        has_next: boolean;
+        has_previous: boolean;
+    }
+    interface RecipientListResponse {
+        data: RecipientListItem[];
+        pagination: Pagination;
+    }
+    interface RecipientDetail {
+        id: string;
+        merchant_recipient_id: string | null;
+        national_entity: string;
+        entity_type: string | null;
+        country: string;
+        first_name: string | null;
+        last_name: string | null;
+        legal_name: string | null;
+        email: string | null;
+        account_id: string;
+        created_at: string;
+        updated_at: string;
+        document: Document | null;
+        phone: Phone | null;
+        address: Address | null;
+        withdrawal_method: WithdrawalMethod | null;
+        documentation: Documentation[];
+        legal_representatives: LegalRepresentative[];
+        onboardings: OnboardingSummary[];
+    }
+    interface OnboardingProvider {
+        id: string | null;
+        connection_id: string | null;
+        redirect_url: string | null;
+        recipient_id: string | null;
+        recipient_additional_id: string | null;
+        onboarding_url: string | null;
+        legal_entity: string | null;
+        balance_account_id: string | null;
+        recipient_type: string | null;
+        raw_notification: string | null;
+        raw_response: string | null;
+        response_code: string | null;
+        response_message: string | null;
+    }
+    interface LegalRepresentativeDocument {
+        type: string | null;
+        number: string | null;
+    }
+    interface LegalRepresentative {
+        merchant_reference: string | null;
+        first_name: string | null;
+        last_name: string | null;
+        email: string | null;
+        document: LegalRepresentativeDocument | null;
+        phone: Phone | null;
+        address: Address | null;
+        date_of_birth: string | null;
+        country: string | null;
+        nationality: string | null;
+        title: string | null;
+        publicly_exposed_person: boolean | null;
+        ultimate_beneficial_owner: boolean | null;
+    }
+    interface Requirement {
+        field: string | null;
+        message: string | null;
+        status: string | null;
+    }
+    interface CapabilityRequirement {
+        provider_response_code: string | null;
+        provider_response_message: string | null;
+        provider_response_field: string | null;
+        message: string | null;
+        status: string | null;
+    }
+    interface Capability {
+        status: string | null;
+        requirements: CapabilityRequirement[];
+    }
+    interface Capabilities {
+        payouts: Capability | null;
+        send_transfers: Capability | null;
+        receive_transfers: Capability | null;
+        payments: Capability | null;
+    }
+    interface TermsOfService {
+        acceptance: boolean | null;
+        date: string | null;
+        ip: string | null;
+    }
+    interface Metadata {
+        key: string;
+        value: string;
+    }
+    interface OnboardingDetail {
+        id: string;
+        type: string;
+        workflow: string;
+        description: string | null;
+        status: string;
+        response_message: string | null;
+        callback_url: string | null;
+        provider: OnboardingProvider | null;
+        documentation: Documentation[];
+        legal_representatives: LegalRepresentative[];
+        withdrawal_methods: WithdrawalMethod | null;
+        requirements: Requirement[];
+        capabilities: Capabilities | null;
+        terms_of_service: TermsOfService | null;
+        metadata: Metadata[];
+        created_at: string;
+        updated_at: string;
+        expires_at: string | null;
+    }
+    interface TimelineEventData {
+        provider_id?: string | null;
+        provider_status?: string | null;
+        provider_response_code?: string | null;
+        provider_response_message?: string | null;
+        provider_recipient_id?: string | null;
+        provider_redirect_url?: string | null;
+        requirements?: Requirement[];
+        capabilities?: Capabilities | null;
+        change_type?: string | null;
+    }
+    interface TimelineEvent {
+        timestamp: string;
+        event_type: string;
+        status: string | null;
+        event_data: TimelineEventData | null;
+    }
+    type OnboardingTimeline = TimelineEvent[];
+}
+export interface GetRecipientsParams {
+    account_ids?: string;
+    countries?: string;
+    national_entities?: string;
+    entity_types?: string;
+    start_date?: string;
+    end_date?: string;
+    search_type?: string;
+    search_value?: string;
+    page?: number;
+    page_size?: number;
+    sort_by?: string;
+    sort_order?: string;
+}
+export interface GetRecipientByIdParams {
+    recipient_id: string;
+}
+export interface GetOnboardingDetailParams {
+    recipient_id: string;
+    onboarding_id: string;
+}
+export interface GetOnboardingTimelineParams {
+    onboarding_id: string;
+}

package/build/types/reconciliation/index.d.ts

@@ -0,0 +1,7 @@
+export * from './reconciliation';
+export * from './reconciliation-alerts';
+export * from './reconciliation-agenda';
+export * from './reconciliation-sales';
+export * from './reconciliation-advancements';
+export * from './reconciliation-fees';
+export * from './reconciliation-insights';

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

@@ -0,0 +1,40 @@
+export declare namespace ReconciliationAdvancements {
+    interface Advancements {
+        operation_id: string;
+        merchant_id: string;
+        product_id: string;
+        ur_key: string;
+        operation_type: string;
+        movement_type: string;
+        operation_date: string;
+        operation_settlement_date: string;
+        ur_operation_date: string;
+        ur_original_settlement_date: string;
+        negotiation_gross_amount: number;
+        negotiation_fees: number;
+        negotiation_net_amount: number;
+        ur_gross_amount: number;
+        ur_fees: number;
+        ur_net_amount: number;
+        bank: string;
+        bank_agency: string;
+        bank_account: string;
+        country: string;
+        acquirer: string;
+        ur_currency: string;
+    }
+    interface FiltersRequestParams {
+        page_number: number;
+        page_size: number;
+    }
+    interface FiltersRequestBody {
+        accounts?: string[];
+        acquirers?: string[];
+        countries?: string[];
+        start_date?: string;
+        end_date?: string;
+    }
+    interface GetAllReconciliationsAdvancementsResponse extends FiltersRequestParams {
+        items: Advancements[];
+    }
+}

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[];
+    }
+}