pluggy-sdk
Version:
Official Node SDK for Pluggy API.
27 lines (26 loc) • 1.13 kB
TypeScript
import { BaseApi } from './baseApi';
import { PageResponse } from './types';
import { AcquirerAnticipation, AcquirerReceivable, AcquirerSale } from './types/acquirerOperations';
/**
* Creates a new client instance for interacting with Pluggy API for the Acquirer API
* @constructor
* @param API_KEY for authenticating to the API
* @returns {PluggyAcquirerClient} a client for making requests
*/
export declare class PluggyAcquirerClient extends BaseApi {
/**
* Fetch acquirer sale operations
* @returns {PageResponse<AcquirerSale>} a paging response of AcquirerSale
*/
fetchSales(itemId: string): Promise<PageResponse<AcquirerSale>>;
/**
* Fetch acquirer sale receivables
* @returns {PageResponse<AcquirerReceivable>} a paging response of AcquirerReceivable
*/
fetchReceivables(itemId: string): Promise<PageResponse<AcquirerReceivable>>;
/**
* Fetch acquirer sale anticipations
* @returns {PageResponse<AcquirerAnticipation>} a paging response of AcquirerAnticipation
*/
fetchAnticipations(itemId: string): Promise<PageResponse<AcquirerAnticipation>>;
}