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

Assembly Payments API Typescript/Javascript Bindings

import { Client } from '../client';
import { Fees, FeeRequestBody, SingleFee } from '../types';
declare const _default: (client: Client) => {
    /**
     * @description Retrieve an ordered and paginated list of existing **Fees**.
     *
     * @tags Fees
     * @name ListFees
     * @summary List Fees
     * @request GET:/fees
     * @secure
     */
    listFees: (params?: {
        limit?: number | undefined;
        offset?: number | undefined;
    } | undefined) => Promise<Fees>;
    /**
     * @description Create a **Fee** to be associated with an **Item**. **Fees** will add or subtract from the **Item** amount based on the **User**, payment type or Disbursement account type. **Fees** can be `Fixed` or `Percentage` based. **Fees** can be capped, have a maximum amount and/or a minimum amount.
     *
     * @tags Fees
     * @name CreateFee
     * @summary Create fee
     * @request POST:/fees
     * @secure
     */
    createFee: (data: FeeRequestBody) => Promise<SingleFee>;
    /**
     * @description Show details of a specific **Fee** using a given `:id`. If the `item_amount` is specified, the response also shows the `calculated_fee` based on a percentage of the `item_amount`.
     *
     * @tags Fees
     * @name ShowFee
     * @summary Show Fee
     * @request GET:/fees/{id}
     * @secure
     */
    showFee: (id: string, params: {
        item_amount: number;
    }) => Promise<SingleFee>;
};
export default _default;