@yuju/tosspayments-sdk/dist/core/settlementApi.d.ts

Toss Payments SDK for Node.js

import { HttpClient } from '../httpClient.js';
import { Result } from '../utils/result.js';
import { TossPaymentsError } from '../utils/tossPaymentsError.js';
import { SettlementInquiryErrorCode, SettlementManuallyErrorCode } from '../types/errorTypes.js';
import { SettlementInquiryRequest, SettlementManuallyRequest } from '../types/requestTypes.js';
import { Settlement } from '../types/settlementType.js';
/**
 * 정산 API
 */
export declare class SettlementApi {
    private client;
    constructor(client: HttpClient);
    /**
     * 정산 조회
     * @param settlementInquiryRequest 정산 조회 요청
     * @return 정산 정보
     */
    inquiry(settlementInquiryRequest: SettlementInquiryRequest): Promise<Result<Settlement[], TossPaymentsError<SettlementInquiryErrorCode>>>;
    /**
     * 정산 수동 처리
     * @param settlementManuallyRequest 정산 수동 처리 요청
     * @param idempotencyKey idempotency key
     * @return 정산 수동 처리 결과
     */
    manualConfirm(settlementManuallyRequest: SettlementManuallyRequest, idempotencyKey?: string): Promise<Result<{
        result: true;
    }, TossPaymentsError<SettlementManuallyErrorCode>>>;
}