assembly-payments/lib/resources/transactions.d.ts

Assembly Payments API Typescript/Javascript Bindings

import { Client } from '../client';
import { Transactions, WalletAccount, SingleUser, BankAccount, SingleTransaction, Fees, CardAccount } from '../types';
declare const _default: (client: Client) => {
    /**
     * @description Retrieve an ordered and paginated list of **Transactions**.
     *
     * @tags Transactions
     * @name ListTransactions
     * @summary List Transactions
     * @request GET:/transactions
     * @secure
     */
    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<Transactions>;
    /**
     * @description Show the **Bank Account** associated with the **Transaction** using a given `:id`.
     *
     * @tags Transactions
     * @name ShowTransactionBankAccount
     * @summary Show Transaction Bank Account
     * @request GET:/transactions/{id}/bank_accounts
     * @secure
     */
    showTransactionBankAccount: (id: string) => Promise<BankAccount>;
    /**
     * @description Show details of a specific **Transaction** using a given `:id`.
     *
     * @tags Transactions
     * @name ShowTransaction
     * @summary Show Transaction
     * @request GET:/transactions/{id}
     * @secure
     */
    showTransaction: (id: string) => Promise<SingleTransaction>;
    /**
     * @description Show the **Card Account** associated with the **Transaction** using a given `:id`.
     *
     * @tags Transactions
     * @name ShowTransactionCardAccount
     * @summary Show Transaction Card Account
     * @request GET:/transactions/{id}/card_accounts
     * @secure
     */
    showTransactionCardAccount: (id: string) => Promise<CardAccount>;
    /**
     * @description Show the **Fees** associated with the **Transaction** using a given `:id`.
     *
     * @tags Transactions
     * @name ShowTransactionFees
     * @summary Show Transaction Fees
     * @request GET:/transactions/{id}/fees
     * @secure
     */
    showTransactionFees: (id: string) => Promise<Fees>;
    /**
     * @description Show the **Wallet Account** associated with the **Transaction** using a given `:id`.
     *
     * @tags Transactions
     * @name ShowTransactionWalletAccount
     * @summary Show Transaction Wallet Account
     * @request GET:/transactions/{id}/wallet_accounts
     * @secure
     */
    showTransactionWalletAccount: (id: string) => Promise<WalletAccount>;
    /**
     * @description Show the **User** associated with the **Transaction** using a given `:id`.
     *
     * @tags Transactions
     * @name ShowTransactionUser
     * @summary Show Transaction User
     * @request GET:/transactions/{id}/users
     * @secure
     */
    showTransactionUser: (id: string) => Promise<SingleUser>;
};
export default _default;