ebay-api/dist/api/restful/sell/finances/index.js

eBay API for Node and Browser

import Restful from '../../index.js';
/**
 * The Finances API is used by sellers in eBay's managed payments program to retrieve seller payout information.
 *
 * https://api.ebay.com/oauth/api_scope/sell.finances
 *
 */
export default class Finances extends Restful {
    get basePath() {
        return '/sell/finances/v1';
    }
    get subdomain() {
        return 'apiz';
    }
    /**
     * Use this call to retrieve the details of a specific seller payout.
     *
     * @param payoutId The unique identifier of the payout.
     */
    getPayout(payoutId) {
        payoutId = encodeURIComponent(payoutId);
        return this.get(`/payout/${payoutId}`);
    }
    /**
     * Use this call to search for and retrieve one or more payout based on their payout date,
     * or payout status using the filter parameter.
     *
     * @param filter One or more comma-separated criteria for narrowing down the collection of payout returned by this
     *     call.
     * @param limit The number of payouts to return per page of the result set.
     * @param offset Specifies the number of payouts to skip in the result set before returning the first payout in the
     *     paginated response.
     * @param sort Allows sorting by payouts date in descending order with '-payoutDate' (default) and ascending with 'payoutDate'
     */
    getPayouts({ filter, limit, offset, sort, } = {}) {
        return this.get(`/payout`, {
            params: {
                filter,
                limit,
                offset,
                sort,
            },
        });
    }
    /**
     *  Search for and retrieve the details of multiple payouts.
     *  *
     * @param filter One or more comma-separated criteria for narrowing down the collection of payout returned by this
     *     call.
     */
    getPayoutSummary({ filter, } = {}) {
        return this.get(`/payout_summary`, { params: { filter } });
    }
    /**
     * Retrieve details of one or more monetary transactions.
     * @param filter One or more comma-separated criteria for narrowing down the collection of transaction returned by this
     *     call.
     * @param limit The number of transaction to return per page of the result set.
     * @param offset Specifies the number of payouts to skip in the result set before returning the first transaction in the
     *     paginated response.
     * @param sort Allows sorting by transaction date in descending order with '-transactionDate' (default) and ascending with 'transactionDate'
     */
    getTransactions({ filter, limit, offset, sort } = {}) {
        return this.get(`/transaction`, {
            params: {
                filter,
                limit,
                offset,
                sort,
            },
        });
    }
    /**
     * Retrieve total counts and values of the seller's order sales, seller credits, buyer refunds, and payment holds.
     * @param filter One or more comma-separated criteria for narrowing down the collection of transaction returned by this
     *     call.
     * @param limit The number of transaction to return per page of the result set.
     */
    getTransactionSummary({ filter, } = {}) {
        return this.get(`/transaction_summary`, {
            params: {
                filter,
            },
        });
    }
    /**
     * Retrieve detailed information on a TRANSFER transaction type.
     *
     * @param transferId The unique identifier of the transfer.
     */
    getTransfer(transferId) {
        transferId = encodeURIComponent(transferId);
        return this.get(`/transfer/${transferId}`);
    }
    /**
     *  Retrieve all pending funds that have not yet been distributed through a seller payout.
     */
    getSellerFundsSummary() {
        return this.get(`/seller_funds_summary`);
    }
}
Finances.id = 'Finances';