@portone/server-sdk
    Preparing search index...

    Type Alias TransferClient

    type TransferClient = {
        getPlatformTransfer: (
            options: { id: string },
        ) => Promise<PlatformTransfer>;
        deletePlatformTransfer: (
            options: { id: string },
        ) => Promise<DeletePlatformTransferResponse>;
        getPlatformTransferSummaries: (
            options?: { page?: PageInput; filter?: PlatformTransferFilterInput },
        ) => Promise<GetPlatformTransferSummariesResponse>;
        createPlatformOrderTransfer: (
            options: {
                partnerId: string;
                contractId?: string;
                memo?: string;
                paymentId: string;
                orderDetail: CreatePlatformOrderTransferBodyOrderDetail;
                taxFreeAmount?: number;
                settlementStartDate?: string;
                discounts: CreatePlatformOrderTransferBodyDiscount[];
                additionalFees: CreatePlatformOrderTransferBodyAdditionalFee[];
                externalPaymentDetail?: CreatePlatformOrderTransferBodyExternalPaymentDetail;
                isForTest?: boolean;
                parameters?: TransferParameters;
                userDefinedProperties?: PlatformUserDefinedPropertyKeyValue[];
            },
        ) => Promise<CreateOrderTransferResponse>;
        createPlatformOrderCancelTransfer: (
            options: {
                partnerId?: string;
                paymentId?: string;
                transferId?: string;
                cancellationId: string;
                memo?: string;
                orderDetail?: CreatePlatformOrderCancelTransferBodyOrderDetail;
                taxFreeAmount?: number;
                discounts: CreatePlatformOrderCancelTransferBodyDiscount[];
                settlementStartDate?: string;
                externalCancellationDetail?: CreatePlatformOrderCancelTransferBodyExternalCancellationDetail;
                isForTest?: boolean;
                userDefinedProperties?: PlatformUserDefinedPropertyKeyValue[];
            },
        ) => Promise<CreateOrderCancelTransferResponse>;
        createPlatformManualTransfer: (
            options: {
                partnerId: string;
                memo?: string;
                settlementAmount: number;
                settlementDate: string;
                isForTest?: boolean;
                userDefinedProperties?: PlatformUserDefinedPropertyKeyValue[];
            },
        ) => Promise<CreateManualTransferResponse>;
        downloadPlatformTransferSheet: (
            options?: {
                filter?: PlatformTransferFilterInput;
                fields?: PlatformTransferSheetField[];
                transferUserDefinedPropertyKeys?: string[];
                partnerUserDefinedPropertyKeys?: string[];
            },
        ) => Promise<string>;
    }
    Index

    Properties

    getPlatformTransfer: (options: { id: string }) => Promise<PlatformTransfer>

    정산건 조회

    정산건을 조회합니다.

    GetPlatformTransferError

    deletePlatformTransfer: (
        options: { id: string },
    ) => Promise<DeletePlatformTransferResponse>

    정산건 삭제

    scheduled, in_process 상태의 정산건만 삭제가능합니다.

    DeletePlatformTransferError

    getPlatformTransferSummaries: (
        options?: { page?: PageInput; filter?: PlatformTransferFilterInput },
    ) => Promise<GetPlatformTransferSummariesResponse>

    정산건 다건 조회

    성공 응답으로 조회된 정산건 요약 리스트와 페이지 정보가 반환됩니다.

    GetPlatformTransferSummariesError

    createPlatformOrderTransfer: (
        options: {
            partnerId: string;
            contractId?: string;
            memo?: string;
            paymentId: string;
            orderDetail: CreatePlatformOrderTransferBodyOrderDetail;
            taxFreeAmount?: number;
            settlementStartDate?: string;
            discounts: CreatePlatformOrderTransferBodyDiscount[];
            additionalFees: CreatePlatformOrderTransferBodyAdditionalFee[];
            externalPaymentDetail?: CreatePlatformOrderTransferBodyExternalPaymentDetail;
            isForTest?: boolean;
            parameters?: TransferParameters;
            userDefinedProperties?: PlatformUserDefinedPropertyKeyValue[];
        },
    ) => Promise<CreateOrderTransferResponse>

    주문 정산건 생성

    성공 응답으로 생성된 주문 정산건 객체가 반환됩니다.

    CreatePlatformOrderTransferError

    createPlatformOrderCancelTransfer: (
        options: {
            partnerId?: string;
            paymentId?: string;
            transferId?: string;
            cancellationId: string;
            memo?: string;
            orderDetail?: CreatePlatformOrderCancelTransferBodyOrderDetail;
            taxFreeAmount?: number;
            discounts: CreatePlatformOrderCancelTransferBodyDiscount[];
            settlementStartDate?: string;
            externalCancellationDetail?: CreatePlatformOrderCancelTransferBodyExternalCancellationDetail;
            isForTest?: boolean;
            userDefinedProperties?: PlatformUserDefinedPropertyKeyValue[];
        },
    ) => Promise<CreateOrderCancelTransferResponse>

    주문 취소 정산건 생성

    성공 응답으로 생성된 주문 취소 정산건 객체가 반환됩니다.

    CreatePlatformOrderCancelTransferError

    createPlatformManualTransfer: (
        options: {
            partnerId: string;
            memo?: string;
            settlementAmount: number;
            settlementDate: string;
            isForTest?: boolean;
            userDefinedProperties?: PlatformUserDefinedPropertyKeyValue[];
        },
    ) => Promise<CreateManualTransferResponse>

    수기 정산건 생성

    성공 응답으로 생성된 수기 정산건 객체가 반환됩니다.

    CreatePlatformManualTransferError

    downloadPlatformTransferSheet: (
        options?: {
            filter?: PlatformTransferFilterInput;
            fields?: PlatformTransferSheetField[];
            transferUserDefinedPropertyKeys?: string[];
            partnerUserDefinedPropertyKeys?: string[];
        },
    ) => Promise<string>

    정산 상세 내역 다운로드

    정산 상세 내역을 csv 파일로 다운로드 합니다.

    DownloadPlatformTransferSheetError