data-and-reporting-sdk/dist/types/models/payerRequest.d.ts

Data And Reporting product consists of API's which provides details of transaction and invoice informations about shell cards. The Shell Card Transaction and Invoice API is REST-based and employs Basic authentication in Version 1 and Oauth authentication

/**
 * Shell Data & Reporting APIsLib
 *
 * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
 */
import { Schema } from '../schema';
import { Payers } from './payers';
export interface PayerRequest {
    /**
     * List of Payer entity.
     * Optional.
     * Note:
     * •    Max number of payers allowed in the input is 10, if it exceeds in the input it will throw an error.
     * •    This value is configurable. Initial configuration will be 1000 and will change to 10 once SFH changes are integrated.
     */
    payers?: Payers[];
    /** Returns only the high-level basic details of payers. Set this field to ‘true’ when only the basic details are required to get the result quicker. */
    returnBasicDetailsOnly?: boolean;
    /** Include address related fields on the response. Set this field to ‘False’ when Address fields are not required to get the result quicker. */
    includeAddresses?: boolean;
    /** Include the Finance Currency, used for Finance Widget, in the response */
    includeBonusParameters?: boolean;
    /** Page Number */
    currentPage?: number;
    /**
     * Page Size – Number of records to show on a page
     * Default value 50
     * Return 250 rows only in the response if -1 is supplied as page size.
     * Note:
     * •    Max page size is 250, if the user provided value is more than 250 then it will throw error.
     * •    This value is configurable.
     */
    pageSize?: number;
}
export declare const payerRequestSchema: Schema<PayerRequest>;