@muhammedaksam/sipay-node/dist/resources/sub-merchant.d.ts

Node.js TypeScript SDK for Sipay payment gateway

import { SipayResource } from './base';
import { SipayApiResponse, RequestOptions, SubMerchantAddResponse, SubMerchantEditResponse, SubMerchantDeleteResponse, SubMerchantListResponse, SubMerchantPFAddResponse, SubMerchantPFDeleteResponse, SubMerchantPFViewResponse, SubMerchantPFListResponse, SubMerchantPayoutResponse } from '../types';
export interface AddSubMerchantRequest {
    merchant_key: string;
    sub_merchant_name: string;
    sub_merchant_email: string;
    sub_merchant_phone: string;
    identity_number: string;
    sub_merchant_description: string;
    full_company_name: string;
    authorized_person_name: string;
    authorized_person_email: string;
    authorized_person_phone: string;
    contact_person_phone: string;
    business_area: string;
    zip_code: string;
    iban_no: string;
    is_enable_auto_withdrawal: string;
    settlement_id: number;
    auto_approval_days?: number;
    automatic_withdrawal_configuration?: {
        currency_code: string;
        auto_withdrawal_settlement_id: number;
        auto_withdrawal_remain_amount: number;
    };
    currency_code: string;
    auto_withdrawal_settlement_id: number;
    auto_withdrawal_remain_amount: number;
}
export interface EditSubMerchantRequest {
    merchant_key: string;
    sub_merchant_key: string;
    sub_merchant_name?: string;
    sub_merchant_email?: string;
    sub_merchant_phone?: string;
    identity_number?: string;
    sub_merchant_description?: string;
    full_company_name?: string;
    authorized_person_name?: string;
    authorized_person_email?: string;
    authorized_person_phone?: string;
    contact_person_phone?: string;
    business_area?: string;
    zip_code?: string;
    iban_no?: string;
    is_enable_auto_withdrawal?: string;
    settlement_id?: number;
    auto_approval_days?: number;
    automatic_withdrawal_configuration?: {
        currency_code: string;
        auto_withdrawal_settlement_id: number;
        auto_withdrawal_remain_amount: number;
    };
    currency_code?: string;
    auto_withdrawal_settlement_id?: number;
    auto_withdrawal_remain_amount?: number;
}
export interface DeleteSubMerchantRequest {
    merchant_key: string;
    sub_merchant_key: string;
}
export interface ListSubMerchantRequest {
    merchant_key: string;
}
export interface AddSubMerchantPFRequest {
    merchant_key: string;
    sub_merchant_key: string;
    sub_merchant_name: string;
    sub_merchant_email: string;
    sub_merchant_phone: string;
    sub_merchant_address: string;
    sub_merchant_tax_office: string;
    sub_merchant_tax_number: string;
    sub_merchant_identity_number: string;
    sub_merchant_iban: string;
}
export interface DeleteSubMerchantPFRequest {
    merchant_key: string;
    sub_merchant_key: string;
}
export interface ViewSubMerchantPFRequest {
    merchant_key: string;
    sub_merchant_key: string;
}
export interface ListSubMerchantPFRequest {
    merchant_key: string;
}
export interface PayoutRequest {
    merchant_key: string;
    payout_data: Array<{
        sub_merchant_id: string;
        amount: string;
        currency_code: string;
    }>;
    hash_key: string;
}
export declare class SubMerchant extends SipayResource {
    /**
     * Add a new standard sub merchant
     */
    add(subMerchantData: Omit<AddSubMerchantRequest, 'merchant_key'>, options?: RequestOptions): Promise<SipayApiResponse<SubMerchantAddResponse>>;
    /**
     * Edit a standard sub merchant
     */
    edit(editData: Omit<EditSubMerchantRequest, 'merchant_key'>, options?: RequestOptions): Promise<SipayApiResponse<SubMerchantEditResponse>>;
    /**
     * Delete a standard sub merchant
     */
    delete(deleteData: Omit<DeleteSubMerchantRequest, 'merchant_key'>, options?: RequestOptions): Promise<SipayApiResponse<SubMerchantDeleteResponse>>;
    /**
     * List all standard sub merchants
     */
    list(listData?: Omit<ListSubMerchantRequest, 'merchant_key'>, options?: RequestOptions): Promise<SipayApiResponse<SubMerchantListResponse>>;
    /**
     * Add a new sub merchant PF (Physical Person)
     */
    addPF(subMerchantData: Omit<AddSubMerchantPFRequest, 'merchant_key'>, options?: RequestOptions): Promise<SipayApiResponse<SubMerchantPFAddResponse>>;
    /**
     * Delete a sub merchant PF
     */
    deletePF(deleteData: Omit<DeleteSubMerchantPFRequest, 'merchant_key'>, options?: RequestOptions): Promise<SipayApiResponse<SubMerchantPFDeleteResponse>>;
    /**
     * View details of a sub merchant PF
     */
    viewPF(viewData: Omit<ViewSubMerchantPFRequest, 'merchant_key'>, options?: RequestOptions): Promise<SipayApiResponse<SubMerchantPFViewResponse>>;
    /**
     * List all sub merchants PF
     */
    listPF(listData?: Omit<ListSubMerchantPFRequest, 'merchant_key'>, options?: RequestOptions): Promise<SipayApiResponse<SubMerchantPFListResponse>>;
    /**
     * Make payout to sub merchants
     * Hash format: sub_merchant_id|currency_code|amount for each payout item
     */
    payout(payoutData: Omit<PayoutRequest, 'merchant_key' | 'hash_key'>, options?: RequestOptions): Promise<SipayApiResponse<SubMerchantPayoutResponse>>;
}
//# sourceMappingURL=sub-merchant.d.ts.map