assembly-payments/lib/index.d.ts

Assembly Payments API Typescript/Javascript Bindings

import Client, { ClientOptions } from './client';
export * from './types';
export declare function createClient({ baseURL, authBaseURL, clientId, clientSecret, scope, logger, }: ClientOptions): {
    client: Client;
    accounts: {
        showAddress: (id: string) => Promise<import("./types").Address>;
    };
    bankAccounts: {
        showBankAccount: (id: string) => Promise<import("./types").BankAccount>;
        redactBankAccount: (id: string) => Promise<import("./types").BankAccountDeletion>;
        sendPennyAmount: (id: string) => Promise<import("./types").BankAccount>;
        createBankAccount: (data: import("./types").BankAccountRequestBody) => Promise<import("./types").BankAccount>;
        verifyPennyAmount: (id: string, data: import("./types").PennyVerifyRequestBody) => Promise<import("./types").BankAccount>;
        showBankAccountUser: (id: string) => Promise<import("./types").SingleUser>;
    };
    batchTransactions: {
        listBatchTransactions: (params?: {
            limit?: number | undefined;
            offset?: number | undefined;
            account_id?: string | undefined;
            batch_id?: string | undefined;
            item_id?: string | undefined;
            transaction_type?: "payment" | "refund" | "disbursement" | "fee" | "deposit" | "withdrawal" | undefined;
            transaction_type_method?: "direct_debit" | "credit_card" | "npp" | "bpay" | "wallet_account_transfer" | "direct_credit" | "wire_transfer" | "misc" | undefined;
            direction?: "debit" | "credit" | undefined;
            created_before?: string | undefined;
            created_after?: string | undefined;
            disbursement_bank?: string | undefined;
        } | undefined) => Promise<import("./types").ListBatchTransactions>;
        showBatchTransaction: (id: string) => Promise<import("./types").SingleBatchTransaction>;
    };
    bpayAccounts: {
        showBPayAccount: (id: string) => Promise<import("./types").BpayAccount>;
        redactBPayAccount: (id: string) => Promise<import("./types").BpayAccountDeletion>;
        createBPayAccount: (data: import("./types").BpayAccountRequestBody) => Promise<import("./types").BpayAccount>;
        showBPayAccountUser: (id: string) => Promise<import("./types").SingleUser>;
    };
    callbacks: {
        showCallback: (id: string) => Promise<import("./types").SingleCallback>;
        deleteCallback: (id: string) => Promise<import("./types").CallbackDeletion>;
        updateCallback: (id: string, data: import("./types").CallbackRequestBody) => Promise<import("./types").SingleCallback>;
        listCallbackResponse: (id: string, params?: {
            limit?: number | undefined;
            offset?: number | undefined;
        } | undefined) => Promise<import("./types").ListCallbackResponses>;
        showCallbackResponse: (callbackId: string, id: string) => Promise<import("./types").SingleCallbackResponse>;
        listCallbacks: (params?: {
            limit?: number | undefined;
            offset?: number | undefined;
            filter?: string | undefined;
        } | undefined) => Promise<import("./types").Callbacks>;
        createCallback: (data: import("./types").CallbackRequestBody) => Promise<import("./types").SingleCallback>;
    };
    companies: {
        listCompanies: (params?: {
            limit?: number | undefined;
            offset?: number | undefined;
        } | undefined) => Promise<import("./types").SimpleCompanies>;
        createCompany: (data: import("./types").CompanyRequestBody) => Promise<import("./types").SingleCompany>;
        showCompany: (id: string) => Promise<import("./types").SingleCompany>;
        updateCompany: (id: string, data: import("./types").CompanyRequestBody) => Promise<import("./types").SingleCompany>;
    };
    cardAccounts: {
        createCardAccount: (data: import("./types").CardAccountRequestBody) => Promise<import("./types").CardAccount>;
        showCardAccountUser: (id: string) => Promise<import("./types").SingleUser>;
        verifyCard: (id: string, data: import("./types").CardAccountVerifyRequestBody) => Promise<import("./types").CardAccount>;
        showCardAccount: (id: string) => Promise<import("./types").CardAccount>;
        redactCardAccount: (id: string) => Promise<import("./types").CardAccountDeletion>;
    };
    charges: {
        listCharges: (params?: {
            limit?: number | undefined;
            offset?: number | undefined;
        } | undefined) => Promise<import("./types").Charges>;
        createCharge: (data: import("./types").ChargeRequestBody) => Promise<import("./types").SingleCharge>;
        showCharge: (id: string) => Promise<import("./types").SingleCharge>;
        showChargeStatus: (id: string) => Promise<import("./types").SingleChargeStatus>;
        showChargeBuyer: (id: string) => Promise<import("./types").SingleUser>;
    };
    directDebitAuthorities: {
        listDirectDebitAuthorities: (params: {
            account_id: string;
            limit?: number | undefined;
            offset?: number | undefined;
        }) => Promise<import("./types").ListDirectDebitAuthorities>;
        createDirectDebitAuthority: (data: import("./types").DirectDebitAuthorityRequestBody) => Promise<import("./types").SingleDirectDebitAuthority>;
        showDirectDebitAuthority: (id: string) => Promise<import("./types").SingleDirectDebitAuthority>;
    };
    disbursements: {
        listDisbursement: (params?: {
            limit?: number | undefined;
            offset?: number | undefined;
            batch_id?: string | undefined;
        } | undefined) => Promise<import("./types").Disbursements>;
        showDisbursement: (id: string) => Promise<import("./types").SingleDisbursement>;
        showDisbursementTransactions: (id: string, params?: {
            limit?: number | undefined;
            offset?: number | undefined;
        } | undefined) => Promise<import("./types").Transactions>;
        showDisbursementWalletAccounts: (id: string) => Promise<import("./types").WalletAccount>;
        showDisbursementBankAccounts: (id: string) => Promise<import("./types").BankAccount>;
        showDisbursementUsers: (id: string) => Promise<import("./types").SingleUser>;
        showDisbursementItems: (id: string) => Promise<import("./types").Items>;
    };
    fees: {
        listFees: (params?: {
            limit?: number | undefined;
            offset?: number | undefined;
        } | undefined) => Promise<import("./types").Fees>;
        createFee: (data: import("./types").FeeRequestBody) => Promise<import("./types").SingleFee>;
        showFee: (id: string, params: {
            item_amount: number;
        }) => Promise<import("./types").SingleFee>;
    };
    items: {
        listItems: (params: {
            offset?: number | undefined;
            limit?: number | undefined;
            search: string;
            created_before?: string | undefined;
            created_after?: string | undefined;
        }) => Promise<import("./types").Items>;
        createItem: (data: import("./types").ItemRequestBody) => Promise<import("./types").SingleItem>;
        showItem: (id: string) => Promise<import("./types").SingleItem>;
        deleteItem: (id: string) => Promise<import("./types").SingleItem>;
        updateItem: (id: string, data: import("./types").UpdateItemRequestBody) => Promise<import("./types").SingleItem>;
        showItemSeller: (id: string) => Promise<import("./types").SingleUser>;
        showItemBuyer: (id: string) => Promise<import("./types").SingleUser>;
        showItemFees: (id: string) => Promise<import("./types").Fees>;
        showItemWireDetails: (id: string) => Promise<import("./types").SingleWireDetailsWithId>;
        listItemTransactions: (id: string) => Promise<import("./types").Transactions>;
        listItemBatchTransactions: (id: string) => Promise<import("./types").ListBatchTransactions>;
        showItemStatus: (id: string) => Promise<import("./types").SingleStatus>;
        makePayment: (id: string, data: import("./types").AccountIdRequestBody) => Promise<import("./types").SingleItem>;
        cancelItem: (id: string) => Promise<import("./types").SingleItem>;
        refund: (id: string, data: import("./types").RefundRequestBody) => Promise<import("./types").SingleItem>;
        authorizePayment: (id: string, data: import("./types").CardAccountIdRequestBody) => Promise<import("./types").SingleItem>;
        capturePayment: (id: string) => Promise<import("./types").SingleItem>;
        voidPayment: (id: string) => Promise<import("./types").SingleItem>;
        releasePayment: (id: string, data: import("./types").ReleasePaymentRequestBody) => Promise<import("./types").SingleItem>;
    };
    marketplace: {
        showMarketplace: () => Promise<import("./types").Marketplace>;
    };
    tokens: {
        token: (data: import("./types").TokensRequestBody) => Promise<import("./types").TokensResponse>;
    };
    tools: {
        validateRoutingNumber: (params: {
            routing_number: string;
        }) => Promise<import("./types").SingleRoutingNumber>;
        healthCheck: () => Promise<import("./types").ToolsStatus>;
    };
    users: {
        listUserBPayAccounts: (id: string) => Promise<import("./types").ListBpayAccounts>;
        showUserCardAccount: (id: string) => Promise<import("./types").CardAccount>;
        showUser: (id: string) => Promise<import("./types").SingleUser>;
        updateUser: (id: string, data: import("./types").UpdateUserRequestBody) => Promise<import("./types").SingleUser>;
        verifyUser: (id: string) => Promise<import("./types").SingleUser>;
        showUserBankAccount: (id: string) => Promise<import("./types").BankAccount>;
        setUserDisbursementAccount: (id: string, data: import("./types").BankAccountIdRequestBody) => Promise<import("./types").SingleUser>;
        listUsers: (params: {
            limit?: number | undefined;
            offset?: number | undefined;
            search: string;
        }) => Promise<import("./types").Users>;
        createUser: (data: import("./types").UserRequestBody) => Promise<import("./types").SingleUser>;
        listUserItems: (id: string, params?: {
            offset?: number | undefined;
            limit?: number | undefined;
        } | undefined) => Promise<import("./types").Items>;
        showUserWalletAccounts: (id: string) => Promise<import("./types").WalletAccount>;
    };
    walletAccounts: {
        billPayment: (id: string, data: import("./types").BillPaymentRequestBody) => Promise<import("./types").SingleDisbursement>;
        showWalletAccountUser: (id: string) => Promise<import("./types").SingleUser>;
        withdrawFunds: (id: string, data: import("./types").WithdrawRequestBody) => Promise<import("./types").SingleDisbursement>;
        depositFunds: (id: string, data: import("./types").DepositRequestBody) => Promise<import("./types").SingleDisbursement>;
        showWalletAccount: (id: string) => Promise<import("./types").WalletAccount>;
        showWalletAccountNppDetails: (id: string) => Promise<import("./types").WalletAccountNppDetails>;
        showWalletAccountNbpayDetails: (id: string) => Promise<import("./types").WalletAccountBpayDetails>;
    };
    transactions: {
        listTransactions: (params?: {
            limit?: number | undefined;
            offset?: number | undefined;
            account_id?: string | undefined;
            item_id?: string | undefined;
            transaction_type?: "payment" | "refund" | "disbursement" | "fee" | "deposit" | "withdrawal" | undefined;
            transaction_type_method?: "direct_debit" | "credit_card" | "npp" | "bpay" | "wallet_account_transfer" | "direct_credit" | "wire_transfer" | "misc" | undefined;
            direction?: "debit" | "credit" | undefined;
            user_id?: string | undefined;
        } | undefined) => Promise<import("./types").Transactions>;
        showTransactionBankAccount: (id: string) => Promise<import("./types").BankAccount>;
        showTransaction: (id: string) => Promise<import("./types").SingleTransaction>;
        showTransactionCardAccount: (id: string) => Promise<import("./types").CardAccount>;
        showTransactionFees: (id: string) => Promise<import("./types").Fees>;
        showTransactionWalletAccount: (id: string) => Promise<import("./types").WalletAccount>;
        showTransactionUser: (id: string) => Promise<import("./types").SingleUser>;
    };
    tokenAuths: {
        generateToken: (data: import("./types").TokenAuthRequestBody) => Promise<{
            token_auth?: {
                token_type?: string | undefined;
                token?: string | undefined;
                user_id?: string | undefined;
            } | undefined;
        }>;
    };
};
export default createClient;