squarefi-bff-api-module 1.0.0

package/dist/api/types.d.ts

@@ -0,0 +1,945 @@
+import { APIKeyRole, CardFormFactor, CardStatus, CardTransactionType, CardType, CurrencyType, KYCStatuses, OrderStatuses, OrderType, SubAccountType, WalletTransactionMethod, WalletTransactionRecordType, WalletTransactionType } from '../constants';
+import { WalletType } from '../';
+export declare namespace API {
+    namespace Auth {
+        namespace Telegram {
+            interface Signin {
+                tg_id: number;
+                hash: string;
+                init_data_raw: string;
+            }
+            interface Signup {
+                phone: string;
+                tg_id: number;
+                first_name: string;
+                last_name?: string;
+                hash: string;
+                init_data_raw: string;
+                referrer?: string;
+                invite_code?: string;
+                username: string;
+            }
+        }
+        interface Tokens {
+            access_token: string;
+            refresh_token: string;
+        }
+        namespace UserData {
+            namespace Update {
+                interface Request {
+                    default_currency: string;
+                }
+            }
+            interface UserData {
+                id: number;
+                created_at: string;
+                user_id: string;
+                kyc_status: KYCStatuses | string;
+                kyc_date: string;
+                turnover_limit?: number;
+                default_currency: string;
+                tenant_id: string;
+                user_group_id: string;
+                is_developer: boolean;
+                can_invite: boolean;
+                total_turnover: {
+                    onramp: number;
+                    offramp: number;
+                    total: number;
+                };
+            }
+        }
+        namespace Update {
+            namespace Phone {
+                interface Request {
+                    phone: string;
+                }
+            }
+        }
+        namespace SignIn {
+            namespace Email {
+                namespace OTP {
+                    interface Request {
+                        email: string;
+                        invite_code?: string;
+                        referrer?: string;
+                        redirect_url?: string;
+                    }
+                }
+            }
+            namespace Phone {
+                namespace OTP {
+                    interface Request {
+                        phone: string;
+                        invite_code?: string;
+                        referrer?: string;
+                    }
+                }
+            }
+        }
+        namespace SignUp {
+            namespace Password {
+                interface Request {
+                    email: string;
+                    password: string;
+                    invite_code?: string;
+                    referrer?: string;
+                }
+            }
+        }
+        interface SupabaseGetSessionResponse {
+            session?: Tokens;
+            error?: string;
+        }
+        namespace VerifyOtp {
+            type Response = {
+                access_token: string;
+                refresh_token: string;
+                error?: string;
+            };
+        }
+    }
+    namespace Cards {
+        namespace Config {
+            interface Program {
+                id: string;
+                account_currency: string;
+                brand: string;
+                card_issuing_fee: number | null;
+                card_monthly_fee: number | null;
+                initial_topup: number | null;
+                form_factor: CardFormFactor | string;
+                name: string;
+                card_limit: number;
+                realtime_auth: boolean;
+                tokenizable: boolean;
+                vendor_id: string;
+                purposes: string[] | null;
+                type: CardType | string;
+                sub_account_type: SubAccountType | string;
+                description: string | null;
+                icon: string | null;
+            }
+        }
+        interface User {
+            email: string;
+            whitelabel: string;
+            id: string;
+            nickname: string;
+            role: string;
+            status: string;
+            user_type: string;
+            invite_accept: boolean;
+            is_new_client: boolean;
+            account: {
+                first_name: string;
+                middle_name: string;
+                last_name: string;
+                date_of_birth: string;
+                phone: string;
+                type: string;
+                id: string;
+                user_id: number;
+                tg_account: string;
+                company: {
+                    name: string;
+                    registration_number: string;
+                    phone: string;
+                    primary_contact_email: string;
+                    id: string;
+                };
+            };
+        }
+        interface Limit {
+            interval?: string;
+            amount: number;
+        }
+        interface Limits {
+            single: Limit;
+            daily: Limit;
+            weekly: Limit;
+            monthly: Limit;
+            lifetime: Limit;
+        }
+        interface CardDetailItem {
+            brand: string;
+            card_id: string;
+            last4: string;
+            card_status: CardStatus | string;
+            form_factor: string;
+            name_on_card: string;
+            nick_name: string;
+            program_id: string;
+            wallet_id: string;
+            type: CardType | string;
+            transaction_limits: {
+                amount: number;
+                interval: string;
+            }[];
+            authorization_controls: {
+                id: string;
+                card_id: string;
+                allowed_transaction_count: string;
+                allowed_merchant_categories: string | null;
+            };
+            fiat_account: {
+                id: string;
+                currency: API.Currencies.FiatCurrency;
+                type: SubAccountType | string;
+                balance: number;
+                nick_name: string;
+                wallet_id: string;
+                created_at: string;
+                payment_types: Array<{
+                    order_type: OrderType;
+                }>;
+                account_details?: API.FiatAccounts.FiatAccountDetails;
+            };
+        }
+        interface IssuingCardListItem {
+            brand: string;
+            card_id: string;
+            card_status: string;
+            created_at: string;
+            nick_name: string | null;
+            wallet_id: string;
+            program_id: string;
+            fiat_account: API.FiatAccounts.FiatAccount;
+            last4: string;
+            request_id: string;
+            name_on_card: string | null;
+            type: CardType | string;
+            form_factor: CardFormFactor | string;
+            tokenizable: boolean;
+        }
+        interface FiatAccountCardListItem {
+            type: string;
+            brand: string;
+            last4: string;
+            card_id: string;
+            nick_name: string;
+            vendor_id: string;
+            wallet_id: string;
+            created_at: string;
+            program_id: string;
+            request_id: string;
+            card_status: string;
+            expiry_year: number;
+            form_factor: string;
+            tokenizable: boolean;
+            expiry_month: number;
+            fiat_account: string;
+            name_on_card: string;
+        }
+        namespace CardsList {
+            namespace Request {
+                type ByWalletUuid = {
+                    wallet_uuid: string;
+                    limit: number;
+                    offset: number;
+                };
+                type ByFiatAccountAndWalletId = ByWalletUuid & {
+                    fiat_account_id: string;
+                };
+            }
+            type Response = {
+                count: number;
+                data: IssuingCardListItem[];
+            };
+        }
+        interface TransactionItem {
+            vendor_transaction_id: string;
+            created_at: string;
+            cleared_at: string;
+            merchant: {
+                name: string;
+                category_code: string;
+                city: string;
+                country: string;
+            };
+            last4: string;
+            title: string;
+            billing_amount: number;
+            billing_currency: string;
+            transaction_amount: number;
+            transaction_currency: string;
+            vendor_sub_account_id: string;
+            failure_reason: string;
+            status: string;
+            transaction_type: CardTransactionType | string;
+            is_credit: boolean;
+            has_receipt: boolean;
+            adjustment_type: string;
+            review_status: string;
+            group: string;
+            total_amount: number;
+        }
+        interface TransactionsList {
+            data: TransactionItem[];
+            has_more: boolean;
+        }
+        interface SensitiveData {
+            card_number: string;
+            cvv: string;
+            expiry_month: number;
+            expiry_year: number;
+            security_code?: string | null;
+        }
+        interface OTP {
+            created_at: number;
+            internal_card_id: string;
+            otp: string;
+            valid_to: number;
+        }
+        type AuthorizationControls = {
+            allowed_merchant_categories: string[];
+            allowed_transaction_count: string;
+        };
+        type TransactionLimit = {
+            amount: number;
+            interval: string;
+        };
+        namespace Create {
+            interface CommonRequest {
+                program_id: string;
+                request_id: string;
+                nick_name: string;
+                wallet_id: string;
+                initial_topup?: number;
+                currency_id?: string;
+            }
+            interface StandAloneRequest extends CommonRequest {
+                authorization_controls: AuthorizationControls;
+                transaction_limits: TransactionLimit[];
+                purpose?: string;
+            }
+            interface FiatAccountRequest extends CommonRequest {
+                sub_account_id: string;
+            }
+            type StandAloneResponse = CardDetailItem;
+            type FiatAccountResponse = CardDetailItem;
+        }
+        namespace Update {
+            interface DeprecatedRequest {
+                status: string;
+                cardName: string;
+                limits: Limits;
+                autoTopUp: {
+                    thresholdAmount: number;
+                    topUpAmount: number;
+                };
+            }
+        }
+    }
+    namespace Developer {
+        namespace ApiCode {
+            interface ApiCode {
+                role: APIKeyRole | string;
+                name: string;
+                id: string;
+                created_at: string;
+                updated_at: string;
+            }
+            namespace Create {
+                interface Request {
+                    name: string;
+                    role: APIKeyRole;
+                }
+                interface Response extends ApiCode {
+                    apiKey: string;
+                    key_hash: string;
+                }
+            }
+            namespace Update {
+                interface Request {
+                    uuid: string;
+                    role: APIKeyRole;
+                }
+            }
+            namespace Rotate {
+                interface Request {
+                    uuid: string;
+                }
+                interface Response {
+                    apiKey: string;
+                }
+            }
+        }
+        namespace Vendors {
+            interface Vendor {
+                id: string;
+                name: string;
+                type: string;
+                currency: string;
+                currency_id: string;
+            }
+        }
+    }
+    namespace Exchange {
+        interface Exchange {
+            updated_at: string;
+            from: string;
+            to: string;
+            rate: number;
+            inverted_rate: number;
+            rate_source: string;
+            from_uuid: string;
+            to_uuid: string;
+            min_amount: string;
+            offramp_enabled: boolean;
+            onramp_enabled: boolean;
+        }
+    }
+    namespace FiatAccounts {
+        type Transaction = API.Cards.TransactionItem;
+        type FiatAccountDetails = {
+            iban: string;
+            bank_name: string;
+            swift_code: string;
+            bank_address: string;
+            receiver_name: string;
+            payment_details: string;
+            reference_number: string;
+            registration_number: string;
+        };
+        type TransactionList = {
+            count: number;
+            data: Transaction[];
+            has_more: boolean;
+        };
+        interface FiatAccount {
+            balance: number;
+            cards_count: number;
+            created_at: string;
+            currency: API.Currencies.FiatCurrency;
+            fiat_balance: number;
+            id: string;
+            issuing_program: API.Cards.Config.Program;
+            nick_name: string;
+            program_id: string;
+            payment_types: Array<{
+                order_type: OrderType;
+            }>;
+            realtime_auth: [
+                {
+                    crypto_token: string;
+                    fiat_account: string;
+                    id: string;
+                    priority: number;
+                }
+            ];
+            realtimeauth_balance: number;
+            status: string;
+            total_balance: number;
+            wallet_id: string;
+            account_details?: FiatAccountDetails;
+        }
+        interface FiatAccountWithCards extends FiatAccount {
+            cards: API.Cards.IssuingCardListItem[];
+        }
+    }
+    namespace FiatAccountsV2 {
+        type FiatAccountDetails = {
+            iban: string;
+            bank_name: string;
+            swift_code: string;
+            bank_address: string;
+            receiver_name: string;
+            payment_details: string;
+            reference_number: string;
+            registration_number: string;
+        };
+        interface FiatAccount {
+            balance: number;
+            cards_count: number;
+            created_at: string;
+            currency: API.Currencies.FiatCurrency;
+            fiat_balance: number;
+            id: string;
+            issuing_program: API.Cards.Config.Program;
+            nick_name: string;
+            program_id: string;
+            realtimeauth_balance: number;
+            status: string;
+            total_balance: number;
+            wallet_id: string;
+        }
+        namespace ExtendedFiatAccount {
+            interface ExtendedFiatAccount extends FiatAccount {
+                account_details?: FiatAccountDetails;
+                payment_types: Array<{
+                    order_type: OrderType;
+                }>;
+                realtime_auth: [
+                    {
+                        crypto_token: string;
+                        fiat_account: string;
+                        id: string;
+                        priority: number;
+                    }
+                ];
+            }
+            interface Request {
+                wallet_uuid: string;
+                fiat_account_id: string;
+            }
+            type Response = ExtendedFiatAccount;
+        }
+        interface FiatAccountWithCards extends FiatAccount {
+            cards: API.Cards.IssuingCardListItem[];
+        }
+        interface FiatAccountsList<T extends FiatAccount | FiatAccountWithCards> {
+            count: number;
+            data: T[];
+        }
+        type FiatAccountsListWithCards = FiatAccountsList<FiatAccountWithCards>;
+        type FiatAccountsListWithoutCards = FiatAccountsList<FiatAccount>;
+        namespace CreateFiatAccount {
+            interface Request {
+                wallet_id: string;
+                program_id: string;
+            }
+            type Response = {
+                id: string;
+                balance: number;
+                nick_name: string;
+                wallet_id: string;
+                created_at: string;
+                account_currency: string;
+                type: SubAccountType | string;
+                program_id: string;
+                status: 'ACTIVE';
+                fiat: {
+                    code: string;
+                    uuid: string;
+                    symbol: string;
+                    enabled: boolean;
+                    coingecko: string;
+                };
+                issuing_program: {
+                    id: string;
+                    form_factor: CardFormFactor | string;
+                    brand: string;
+                    tokenizable: boolean;
+                    type: CardType | string;
+                };
+            };
+        }
+        namespace Transactions {
+            type Transaction = {
+                vendor_transaction_id: string;
+                created_at: string;
+                cleared_at: string;
+                merchant: {
+                    name: string;
+                    category_code: string;
+                    city: string;
+                    country: string;
+                };
+                last4: string;
+                title: string;
+                billing_amount: number;
+                billing_currency: string;
+                transaction_amount: number;
+                transaction_currency: string;
+                vendor_sub_account_id: string;
+                failure_reason: string;
+                status: string;
+                transaction_type: string;
+                is_credit: boolean;
+                has_receipt: boolean;
+                adjustment_type: string;
+                review_status: string;
+                group: string;
+                total_amount: number;
+            };
+            namespace TransactionList {
+                interface Request {
+                    fiat_account_id: string;
+                    wallet_uuid: string;
+                    limit?: number;
+                    offset?: number;
+                }
+                interface Response {
+                    count: number;
+                    data: Transaction[];
+                    has_more: boolean;
+                }
+            }
+        }
+    }
+    namespace Issuing {
+        namespace Programs {
+            type Response = {
+                count: number;
+                data: API.Cards.Config.Program[];
+            };
+        }
+    }
+    namespace KYC {
+        namespace Sumsub {
+            namespace GenerateToken {
+                interface Request {
+                    user_data_id: number;
+                }
+                interface Response extends Request {
+                    token: string;
+                }
+            }
+        }
+    }
+    namespace Currencies {
+        interface CommonCurrencyFields {
+            uuid: string;
+            decimal: number | null;
+            is_memo: boolean | null;
+            is_stablecoin: boolean;
+            is_enabled: boolean;
+            render_decimal: number;
+            meta: {
+                icon: string;
+                name: string;
+                symbol: string;
+                description: string;
+            };
+            type: CurrencyType;
+        }
+        export interface CryptoCurrency extends CommonCurrencyFields {
+            is_crypto: true;
+            meta: CommonCurrencyFields['meta'] & {
+                chain_id: number;
+                contract: string;
+                chain_name: string;
+            };
+        }
+        export interface FiatCurrency extends CommonCurrencyFields {
+            is_crypto: false;
+            meta: CommonCurrencyFields['meta'] & {
+                code: string;
+                iso_code: number;
+                sign: string;
+            };
+        }
+        export type Currency = CryptoCurrency | FiatCurrency;
+        export type CurrencyList = {
+            count: number;
+            data: Currency[];
+        };
+        export {};
+    }
+    namespace Chains {
+        interface Chain {
+            id: number;
+            name: string;
+            symbol: string;
+            is_beta: boolean | null;
+        }
+        type ChainList = {
+            count: number;
+            data: Chain[];
+        };
+    }
+    namespace Wallets {
+        interface WallletBalanceCryptoDetails {
+            uuid: string;
+            amount: number;
+            fiat_amount: number;
+            currency: API.Currencies.Currency;
+        }
+        interface WalletBalanceItem {
+            symbol: string;
+            icon: string;
+            name: string;
+            is_crypto: boolean;
+            decimal?: number | null;
+            amount: number;
+            fiat_amount: number;
+            details: WallletBalanceCryptoDetails[];
+        }
+        type WalletBalance = WalletBalanceItem[];
+        namespace WalletChain {
+            interface WalletChain {
+                uuid: string;
+                created_ad: string;
+                address: string;
+                wallet_uuid: string;
+                chain: number;
+            }
+            namespace Create {
+                interface Request {
+                    wallet_uuid: string;
+                    chain: number;
+                    label: string;
+                }
+                type Response = WalletChain;
+            }
+        }
+        interface Wallet {
+            uuid: string;
+            type: WalletType | string;
+            created_at: string;
+            fiat_total: number;
+            crypto_total: number;
+            total_amount: number;
+            balance: WalletBalance;
+        }
+        namespace WalletsList {
+            interface WalletsListItem {
+                type: WalletType | string;
+                uuid: string;
+                created_at: string;
+            }
+            type Response = {
+                total: number;
+                data: WalletsListItem[];
+            };
+        }
+        namespace WalletTransactions {
+            interface WalletTransactionMeta {
+                transaction_hash?: string;
+                fee?: number;
+                order_id?: string;
+                from_address?: string;
+                to_address?: string;
+                network_fee?: number;
+                network_fee_currency?: string;
+                fee_currency?: string;
+                billing_amount?: number;
+                utila_transaction?: string;
+                transcation_amount?: number;
+                transaction_amount?: number;
+                billing_amount_currency?: string;
+                transcation_amount_currency?: string;
+                transaction_amount_currency?: string;
+                exchange_rate?: number;
+                fiat_account_id?: string;
+                txid?: string;
+                chain_id?: number;
+                from_user_data?: number;
+                to_user_data?: number;
+                to_card_id?: string;
+                to_card_last4?: string;
+                to_fiat_account_id?: string;
+                to_vendor_id?: string;
+            }
+            interface Transaction {
+                id: number;
+                created_at: string;
+                type: WalletTransactionType | string;
+                method: WalletTransactionMethod | string;
+                status: string;
+                amount: number;
+                from: string | null;
+                to: string | null;
+                wallet_id: string;
+                txid: string;
+                info: string;
+                currency: API.Currencies.Currency;
+                record_type: WalletTransactionRecordType | string;
+                meta?: WalletTransactionMeta;
+            }
+            namespace TransactionList {
+                type Response = {
+                    total: number;
+                    data: Transaction[];
+                };
+            }
+        }
+    }
+    namespace Orders {
+        namespace Create {
+            namespace ByOrderType {
+                namespace TRANSFER_CARD_SUBACCOUNT {
+                    type Request = {
+                        amount: number;
+                        wallet_uuid: string;
+                        from_uuid: string;
+                        sub_account_id: string;
+                    };
+                    type Response = {
+                        id: number;
+                        created_at: string;
+                        order_uuid: string;
+                        wallet_uuid: string;
+                        fiat_uuid: string;
+                        crypto_uuid: string;
+                        amount_fiat: number;
+                        payment_method: string;
+                        redirect_url: string;
+                        status: string;
+                        provider_uuid: string;
+                    };
+                }
+                namespace WITHDRAWAL_CRYPTO {
+                    type Request = {
+                        amount: number;
+                        is_subsctract: boolean;
+                        wallet_uuid: string;
+                        crypto_uuid: string;
+                        to_address: string;
+                        memo?: string;
+                    };
+                    type Response = {
+                        id: number;
+                        created_at: string;
+                        order_uuid: string;
+                        wallet_uuid: string;
+                        crypto_uuid: string;
+                        amount: number;
+                        status: string;
+                        network: string;
+                        to_address: string;
+                        txid: string;
+                    };
+                }
+                namespace EXCHANGE_CRYPTO_INTERNAL {
+                    type Request = {
+                        amount: number;
+                        wallet_uuid: string;
+                        from_uuid: string;
+                        to_uuid: string;
+                    };
+                    type Response = {
+                        id: number;
+                    };
+                }
+                namespace TRANSFER_CARD_WHOLESALE {
+                    type Request = {
+                        amount: number;
+                        wallet_id: string;
+                        currency_id: string;
+                        vendor_id: string;
+                    };
+                }
+            }
+        }
+        namespace Calc {
+            interface CommonRequestParams {
+                from_currency: string;
+                to_currency: string;
+                amount: number;
+                is_reverse?: boolean;
+                signal?: AbortSignal;
+            }
+            export interface WithdrawCryptoRequest extends CommonRequestParams {
+                order_type: OrderType.WITHDRAWAL_CRYPTO;
+                to_address?: string;
+            }
+            export interface NonWithdrawCryptoRequest extends CommonRequestParams {
+                order_type: Exclude<OrderType, OrderType.WITHDRAWAL_CRYPTO>;
+                to_address?: never;
+            }
+            export type Request = NonWithdrawCryptoRequest | WithdrawCryptoRequest;
+            export interface Response {
+                from_currency: string;
+                to_currency: string;
+                from_symbol: string;
+                to_symbol: string;
+                from_amount: number;
+                net_amount: number;
+                result_amount: number;
+                fees: number;
+                comission: number;
+                base_markup: number;
+                network_fee: number;
+                transaction_fee: number;
+                rate: number;
+                direction: 'c2f' | 'f2c' | 'c2c';
+            }
+            export {};
+        }
+        namespace Status {
+            interface Response {
+                id: number;
+                created_at: string;
+                order_uuid: string;
+                wallet_uuid: string;
+                crypto_uuid: string;
+                status: OrderStatuses | string;
+                amount: number;
+                comission: number;
+                net_amount: number;
+                type: OrderType | string;
+            }
+        }
+    }
+    namespace User {
+        interface User {
+            id: string;
+            aud: string;
+            confirmation_sent_at: string;
+            recovery_sent_at: string;
+            email_change_sent_at: string;
+            new_email: string;
+            new_phone: string;
+            invited_at: string;
+            action_link: string;
+            email: string;
+            phone: string;
+            created_at: string;
+            confirmed_at: string;
+            email_confirmed_at: string;
+            phone_confirmed_at: string;
+            last_sign_in_at: string;
+            role: string;
+            updated_at: string;
+            identities: string[];
+            is_anonymous: boolean;
+            factors: string[];
+        }
+        namespace UpdateUser {
+            namespace Phone {
+                namespace RequestOTP {
+                    type Request = {
+                        phone: string;
+                        access_token: string;
+                        refresh_token: string;
+                    };
+                }
+                namespace Confirm {
+                    type Request = {
+                        phone: string;
+                        token: string;
+                    };
+                }
+            }
+            namespace Email {
+                namespace RequestOTP {
+                    type Request = {
+                        email: string;
+                        access_token: string;
+                        refresh_token: string;
+                    };
+                }
+                namespace Confirm {
+                    type Request = {
+                        email: string;
+                        token: string;
+                    };
+                }
+            }
+        }
+        namespace UserData {
+            interface UserData {
+                can_invite: boolean;
+                created_at: string;
+                id: number;
+                kyc_date: string;
+                kyc_status: KYCStatuses | string;
+                referral_name: string;
+                tenant_id: string;
+                turnover_limit: number;
+                user_id: string;
+                default_currency: string;
+                is_developer: boolean;
+                user_group_id: string | null;
+            }
+            namespace UpdateUserData {
+                type Request = {
+                    default_currency: string;
+                };
+                type Response = API.User.UserData.UserData;
+            }
+        }
+    }
+}