Type AliasAnalyticsClient

AnalyticsClient: {
    getAnalyticsPaymentChart: ((from: string, until: string, currency: Currency, timeGranularity: AnalyticsTimeGranularity, excludeCancelled?: boolean) => Promise<AnalyticsPaymentChart>);
    getAnalyticsPaymentChartInsight: ((from: string, until: string, currency: Currency, timezoneHourOffset: number, excludeCancelled?: boolean) => Promise<AnalyticsPaymentChartInsight>);
    getAverageAmountChart: ((from: string, until: string, currency: Currency, excludeCancelled: boolean, timeGranularity: AnalyticsTimeGranularity) => Promise<AnalyticsAverageAmountChart>);
    getPaymentMethodChart: ((from: string, until: string, currency: Currency, excludeCancelled: boolean) => Promise<AnalyticsPaymentMethodChart>);
    getPaymentMethodTrendChart: ((from: string, until: string, currency: Currency, excludeCancelled: boolean, timeGranularity: AnalyticsTimeGranularity) => Promise<AnalyticsPaymentMethodTrendChart>);
    getAnalyticsCardChart: ((from: string, until: string, currency: Currency, excludeCancelled: boolean, timeGranularity: AnalyticsTimeGranularity) => Promise<AnalyticsCardChart>);
    getAnalyticsCardCompanyChart: ((from: string, until: string, currency: Currency, excludeCancelled: boolean, timeGranularity: AnalyticsTimeGranularity, cardCompanies: CardCompany[], excludesFromRemainders: CardCompany[]) => Promise<AnalyticsCardCompanyChart>);
    getAnalyticsEasyPayChart: ((from: string, until: string, currency: Currency, excludeCancelled: boolean, timeGranularity: AnalyticsTimeGranularity) => Promise<AnalyticsEasyPayChart>);
    getAnalyticsEasyPayProviderChart: ((from: string, until: string, currency: Currency, excludeCancelled: boolean, timeGranularity: AnalyticsTimeGranularity, easyPayProviders: EasyPayProvider[], excludesFromRemainders: EasyPayProvider[]) => Promise<AnalyticsEasyPayProviderChart>);
    getPgCompanyChart: ((from: string, until: string, currency: Currency, excludeCancelled: boolean) => Promise<AnalyticsPgCompanyChart>);
    getPgCompanyTrendChart: ((from: string, until: string, currency: Currency, excludeCancelled: boolean, timeGranularity: AnalyticsTimeGranularity, pgCompanies: PgCompany[]) => Promise<AnalyticsPgCompanyTrendChart>);
    getAnalyticsOverseasPaymentUsage: (() => Promise<AnalyticsOverseasPaymentUsage>);
    getAnalyticsCancellationRate: ((from: string, until: string, currency: Currency) => Promise<AnalyticsCancellationRate>);
    getPaymentStatusChart: ((from: string, until: string, currency: Currency) => Promise<AnalyticsPaymentStatusChart>);
    getPaymentStatusByPaymentMethodChart: ((from: string, until: string, currency: Currency) => Promise<AnalyticsPaymentStatusByPaymentMethodChart>);
    getPaymentStatusByPgCompanyChart: ((from: string, until: string, currency: Currency) => Promise<AnalyticsPaymentStatusByPgCompanyChart>);
    getPaymentStatusByPaymentClientChart: ((from: string, until: string, currency: Currency) => Promise<AnalyticsPaymentStatusByPaymentClientChart>);
}

Type declaration

  • getAnalyticsPaymentChart: ((from: string, until: string, currency: Currency, timeGranularity: AnalyticsTimeGranularity, excludeCancelled?: boolean) => Promise<AnalyticsPaymentChart>)

    고객사의 결제 현황을 조회합니다.

    Throws

    Errors.ForbiddenError 요청이 거절된 경우

    Throws

    Errors.InvalidRequestError 요청된 입력 정보가 유효하지 않은 경우

    Throws

    Errors.UnauthorizedError 인증 정보가 올바르지 않은 경우

    Throws

    Errors.UnknownError API 응답이 알 수 없는 형식인 경우

      • (from, until, currency, timeGranularity, excludeCancelled?): Promise<AnalyticsPaymentChart>

      • Parameters

        • from: string

          조회할 결제 현황의 시작 시간

        • until: string

          조회할 결제 현황의 끝 시간

        • currency: Currency

          조회할 결제 통화

          입력된 통화로 발생한 결제내역만 응답에 포함됩니다.

        • timeGranularity: AnalyticsTimeGranularity

          결제 현황 조회 단위

          시간별, 월별 단위만 지원됩니다.

        • OptionalexcludeCancelled: boolean

          결제취소건 제외 여부

          true 이면 결제취소내역은 응답에 포함 및 반영되지 않습니다. false 또는 값을 명시하지 않은 경우 결제취소내역이 응답에 반영됩니다.

        Returns Promise<AnalyticsPaymentChart>

  • getAnalyticsPaymentChartInsight: ((from: string, until: string, currency: Currency, timezoneHourOffset: number, excludeCancelled?: boolean) => Promise<AnalyticsPaymentChartInsight>)

    고객사의 결제 현황 인사이트를 조회합니다.

    Throws

    Errors.ForbiddenError 요청이 거절된 경우

    Throws

    Errors.InvalidRequestError 요청된 입력 정보가 유효하지 않은 경우

    Throws

    Errors.UnauthorizedError 인증 정보가 올바르지 않은 경우

    Throws

    Errors.UnknownError API 응답이 알 수 없는 형식인 경우

      • (from, until, currency, timezoneHourOffset, excludeCancelled?): Promise<AnalyticsPaymentChartInsight>

      • Parameters

        • from: string

          조회할 결제 현황의 시작 시간

        • until: string

          조회할 결제 현황의 끝 시간

        • currency: Currency

          조회할 결제 통화

          입력된 통화로 발생한 결제내역만 응답에 포함됩니다.

        • timezoneHourOffset: number

          타임존 시간 오프셋

          입력된 시간 오프셋 기준으로 일, 주, 월이 집계 됩니다.

        • OptionalexcludeCancelled: boolean

          결제취소건 제외 여부

          true 이면 결제취소내역은 응답에 포함 및 반영되지 않습니다. false 또는 값을 명시하지 않은 경우 결제취소내역이 응답에 반영됩니다.

        Returns Promise<AnalyticsPaymentChartInsight>

  • getAverageAmountChart: ((from: string, until: string, currency: Currency, excludeCancelled: boolean, timeGranularity: AnalyticsTimeGranularity) => Promise<AnalyticsAverageAmountChart>)

    고객사의 평균 거래액 현황을 조회합니다.

    Throws

    Errors.ForbiddenError 요청이 거절된 경우

    Throws

    Errors.InvalidRequestError 요청된 입력 정보가 유효하지 않은 경우

    Throws

    Errors.UnauthorizedError 인증 정보가 올바르지 않은 경우

    Throws

    Errors.UnknownError API 응답이 알 수 없는 형식인 경우

      • (from, until, currency, excludeCancelled, timeGranularity): Promise<AnalyticsAverageAmountChart>

      • Parameters

        • from: string

          조회할 평균 거래액 현황의 시작 시간

        • until: string

          조회할 평균 거래액 현황의 끝 시간

        • currency: Currency

          조회할 결제 통화

          입력된 통화로 발생한 결제내역만 응답에 포함됩니다.

        • excludeCancelled: boolean

          결제취소건 제외 여부

          true 이면 결제취소내역은 응답에 포함 및 반영되지 않습니다. false 또는 값을 명시하지 않은 경우 결제취소내역이 응답에 반영됩니다.

        • timeGranularity: AnalyticsTimeGranularity

          평균 거래액 현황 조회 단위

          시간별, 월별 단위만 지원됩니다.

        Returns Promise<AnalyticsAverageAmountChart>

  • getPaymentMethodChart: ((from: string, until: string, currency: Currency, excludeCancelled: boolean) => Promise<AnalyticsPaymentMethodChart>)

    고객사의 결제수단 현황을 조회합니다.

    Throws

    Errors.ForbiddenError 요청이 거절된 경우

    Throws

    Errors.InvalidRequestError 요청된 입력 정보가 유효하지 않은 경우

    Throws

    Errors.UnauthorizedError 인증 정보가 올바르지 않은 경우

    Throws

    Errors.UnknownError API 응답이 알 수 없는 형식인 경우

      • (from, until, currency, excludeCancelled): Promise<AnalyticsPaymentMethodChart>

      • Parameters

        • from: string

          조회할 결제수단 현황의 시작 시간

        • until: string

          조회할 결제수단 현황의 끝 시간

        • currency: Currency

          조회할 결제 통화

          입력된 통화로 발생한 결제내역만 응답에 포함됩니다.

        • excludeCancelled: boolean

          결제취소건 제외 여부

          true 이면 결제취소내역은 응답에 포함 및 반영되지 않습니다. false 또는 값을 명시하지 않은 경우 결제취소내역이 응답에 반영됩니다.

        Returns Promise<AnalyticsPaymentMethodChart>

  • getPaymentMethodTrendChart: ((from: string, until: string, currency: Currency, excludeCancelled: boolean, timeGranularity: AnalyticsTimeGranularity) => Promise<AnalyticsPaymentMethodTrendChart>)

    고객사의 결제수단 트렌드를 조회합니다.

    Throws

    Errors.ForbiddenError 요청이 거절된 경우

    Throws

    Errors.InvalidRequestError 요청된 입력 정보가 유효하지 않은 경우

    Throws

    Errors.UnauthorizedError 인증 정보가 올바르지 않은 경우

    Throws

    Errors.UnknownError API 응답이 알 수 없는 형식인 경우

      • (from, until, currency, excludeCancelled, timeGranularity): Promise<AnalyticsPaymentMethodTrendChart>

      • Parameters

        • from: string

          조회할 결제수단 트렌드의 시작 시간

        • until: string

          조회할 결제수단 트렌드의 끝 시간

        • currency: Currency

          조회할 결제 통화

          입력된 통화로 발생한 결제내역만 응답에 포함됩니다.

        • excludeCancelled: boolean

          결제취소건 제외 여부

          true 이면 결제취소내역은 응답에 포함 및 반영되지 않습니다. false 또는 값을 명시하지 않은 경우 결제취소내역이 응답에 반영됩니다.

        • timeGranularity: AnalyticsTimeGranularity

          결제 결제수단 트렌드 조회 단위

          시간별, 월별 단위만 지원됩니다.

        Returns Promise<AnalyticsPaymentMethodTrendChart>

  • getAnalyticsCardChart: ((from: string, until: string, currency: Currency, excludeCancelled: boolean, timeGranularity: AnalyticsTimeGranularity) => Promise<AnalyticsCardChart>)

    고객사의 카드결제 현황을 조회합니다.

    Throws

    Errors.ForbiddenError 요청이 거절된 경우

    Throws

    Errors.InvalidRequestError 요청된 입력 정보가 유효하지 않은 경우

    Throws

    Errors.UnauthorizedError 인증 정보가 올바르지 않은 경우

    Throws

    Errors.UnknownError API 응답이 알 수 없는 형식인 경우

      • (from, until, currency, excludeCancelled, timeGranularity): Promise<AnalyticsCardChart>

      • Parameters

        • from: string

          조회할 카드결제 현황의 시작 시간

        • until: string

          조회할 카드결제 현황의 끝 시간

        • currency: Currency

          조회할 결제 통화

          입력된 통화로 발생한 결제내역만 응답에 포함됩니다.

        • excludeCancelled: boolean

          결제취소건 제외 여부

          true 이면 결제취소내역은 응답에 포함 및 반영되지 않습니다. false 또는 값을 명시하지 않은 경우 결제취소내역이 응답에 반영됩니다.

        • timeGranularity: AnalyticsTimeGranularity

          카드결제 현황 조회 단위

          시간별, 월별 단위만 지원됩니다.

        Returns Promise<AnalyticsCardChart>

  • getAnalyticsCardCompanyChart: ((from: string, until: string, currency: Currency, excludeCancelled: boolean, timeGranularity: AnalyticsTimeGranularity, cardCompanies: CardCompany[], excludesFromRemainders: CardCompany[]) => Promise<AnalyticsCardCompanyChart>)

    고객사의 카드사별 결제 현황을 조회합니다.

    Throws

    Errors.ForbiddenError 요청이 거절된 경우

    Throws

    Errors.InvalidRequestError 요청된 입력 정보가 유효하지 않은 경우

    Throws

    Errors.UnauthorizedError 인증 정보가 올바르지 않은 경우

    Throws

    Errors.UnknownError API 응답이 알 수 없는 형식인 경우

      • (from, until, currency, excludeCancelled, timeGranularity, cardCompanies, excludesFromRemainders): Promise<AnalyticsCardCompanyChart>

      • Parameters

        • from: string

          조회할 카드사별 결제 현황의 시작 시간

        • until: string

          조회할 카드사별 결제 현황의 끝 시간

        • currency: Currency

          조회할 결제 통화

          입력된 통화로 발생한 결제내역만 응답에 포함됩니다.

        • excludeCancelled: boolean

          결제취소건 제외 여부

          true 이면 결제취소내역은 응답에 포함 및 반영되지 않습니다. false 또는 값을 명시하지 않은 경우 결제취소내역이 응답에 반영됩니다.

        • timeGranularity: AnalyticsTimeGranularity

          카드사별 결제 현황 조회 단위

          시간별, 월별 단위만 지원됩니다.

        • cardCompanies: CardCompany[]

          조회할 카드사

        • excludesFromRemainders: CardCompany[]

          나머지 집계에 포함되지 않을 카드사

        Returns Promise<AnalyticsCardCompanyChart>

  • getAnalyticsEasyPayChart: ((from: string, until: string, currency: Currency, excludeCancelled: boolean, timeGranularity: AnalyticsTimeGranularity) => Promise<AnalyticsEasyPayChart>)

    고객사의 간편결제 현황을 조회합니다.

    Throws

    Errors.ForbiddenError 요청이 거절된 경우

    Throws

    Errors.InvalidRequestError 요청된 입력 정보가 유효하지 않은 경우

    Throws

    Errors.UnauthorizedError 인증 정보가 올바르지 않은 경우

    Throws

    Errors.UnknownError API 응답이 알 수 없는 형식인 경우

      • (from, until, currency, excludeCancelled, timeGranularity): Promise<AnalyticsEasyPayChart>

      • Parameters

        • from: string

          조회할 간편결제 현황의 시작 시간

        • until: string

          조회할 간편결제 현황의 끝 시간

        • currency: Currency

          조회할 결제 통화

          입력된 통화로 발생한 결제내역만 응답에 포함됩니다.

        • excludeCancelled: boolean

          결제취소건 제외 여부

          true 이면 결제취소내역은 응답에 포함 및 반영되지 않습니다. false 또는 값을 명시하지 않은 경우 결제취소내역이 응답에 반영됩니다.

        • timeGranularity: AnalyticsTimeGranularity

          간편결제 현황 조회 단위

          시간별, 월별 단위만 지원됩니다.

        Returns Promise<AnalyticsEasyPayChart>

  • getAnalyticsEasyPayProviderChart: ((from: string, until: string, currency: Currency, excludeCancelled: boolean, timeGranularity: AnalyticsTimeGranularity, easyPayProviders: EasyPayProvider[], excludesFromRemainders: EasyPayProvider[]) => Promise<AnalyticsEasyPayProviderChart>)

    고객사의 간편결제사별 결제 현황을 조회합니다.

    Throws

    Errors.ForbiddenError 요청이 거절된 경우

    Throws

    Errors.InvalidRequestError 요청된 입력 정보가 유효하지 않은 경우

    Throws

    Errors.UnauthorizedError 인증 정보가 올바르지 않은 경우

    Throws

    Errors.UnknownError API 응답이 알 수 없는 형식인 경우

      • (from, until, currency, excludeCancelled, timeGranularity, easyPayProviders, excludesFromRemainders): Promise<AnalyticsEasyPayProviderChart>

      • Parameters

        • from: string

          조회할 간편결제사별 결제 현황의 시작 시간

        • until: string

          조회할 간편결제사별 결제 현황의 끝 시간

        • currency: Currency

          조회할 결제 통화

          입력된 통화로 발생한 결제내역만 응답에 포함됩니다.

        • excludeCancelled: boolean

          결제취소건 제외 여부

          true 이면 결제취소내역은 응답에 포함 및 반영되지 않습니다. false 또는 값을 명시하지 않은 경우 결제취소내역이 응답에 반영됩니다.

        • timeGranularity: AnalyticsTimeGranularity

          간편결제사별 결제 현황 조회 단위

          시간별, 월별 단위만 지원됩니다.

        • easyPayProviders: EasyPayProvider[]

          조회할 간편결제사

        • excludesFromRemainders: EasyPayProvider[]

          나머지 집계에 포함되지 않을 간편결제사

        Returns Promise<AnalyticsEasyPayProviderChart>

  • getPgCompanyChart: ((from: string, until: string, currency: Currency, excludeCancelled: boolean) => Promise<AnalyticsPgCompanyChart>)

    고객사의 결제대행사 현황을 조회합니다.

    Throws

    Errors.ForbiddenError 요청이 거절된 경우

    Throws

    Errors.InvalidRequestError 요청된 입력 정보가 유효하지 않은 경우

    Throws

    Errors.UnauthorizedError 인증 정보가 올바르지 않은 경우

    Throws

    Errors.UnknownError API 응답이 알 수 없는 형식인 경우

      • (from, until, currency, excludeCancelled): Promise<AnalyticsPgCompanyChart>

      • Parameters

        • from: string

          조회할 결제대행사 현황의 시작 시간

        • until: string

          조회할 결제대행사 현황의 끝 시간

        • currency: Currency

          조회할 결제 통화

          입력된 통화로 발생한 결제내역만 응답에 포함됩니다.

        • excludeCancelled: boolean

          결제취소건 제외 여부

          true 이면 결제취소내역은 응답에 포함 및 반영되지 않습니다. false 또는 값을 명시하지 않은 경우 결제취소내역이 응답에 반영됩니다.

        Returns Promise<AnalyticsPgCompanyChart>

  • getPgCompanyTrendChart: ((from: string, until: string, currency: Currency, excludeCancelled: boolean, timeGranularity: AnalyticsTimeGranularity, pgCompanies: PgCompany[]) => Promise<AnalyticsPgCompanyTrendChart>)

    고객사의 결제대행사별 거래 추이를 조회합니다.

    Throws

    Errors.ForbiddenError 요청이 거절된 경우

    Throws

    Errors.InvalidRequestError 요청된 입력 정보가 유효하지 않은 경우

    Throws

    Errors.UnauthorizedError 인증 정보가 올바르지 않은 경우

    Throws

    Errors.UnknownError API 응답이 알 수 없는 형식인 경우

      • (from, until, currency, excludeCancelled, timeGranularity, pgCompanies): Promise<AnalyticsPgCompanyTrendChart>

      • Parameters

        • from: string

          조회할 결제대행사별 거래 추이의 시작 시간

        • until: string

          조회할 결제대행사별 거래 추이의 끝 시간

        • currency: Currency

          조회할 결제 통화

          입력된 통화로 발생한 결제내역만 응답에 포함됩니다.

        • excludeCancelled: boolean

          결제취소건 제외 여부

          true 이면 결제취소내역은 응답에 포함 및 반영되지 않습니다. false 또는 값을 명시하지 않은 경우 결제취소내역이 응답에 반영됩니다.

        • timeGranularity: AnalyticsTimeGranularity

          결제 결제대행사별 거래 추이 조회 단위

          시간별, 월별 단위만 지원됩니다.

        • pgCompanies: PgCompany[]

          조회할 결제대행사

        Returns Promise<AnalyticsPgCompanyTrendChart>

  • getAnalyticsOverseasPaymentUsage: (() => Promise<AnalyticsOverseasPaymentUsage>)

    고객사의 해외 결제 사용 여부를 조회합니다.

    Throws

    Errors.ForbiddenError 요청이 거절된 경우

    Throws

    Errors.UnauthorizedError 인증 정보가 올바르지 않은 경우

    Throws

    Errors.UnknownError API 응답이 알 수 없는 형식인 경우

  • getAnalyticsCancellationRate: ((from: string, until: string, currency: Currency) => Promise<AnalyticsCancellationRate>)

    고객사의 환불율을 조회합니다.

    Throws

    Errors.ForbiddenError 요청이 거절된 경우

    Throws

    Errors.InvalidRequestError 요청된 입력 정보가 유효하지 않은 경우

    Throws

    Errors.UnauthorizedError 인증 정보가 올바르지 않은 경우

    Throws

    Errors.UnknownError API 응답이 알 수 없는 형식인 경우

      • (from, until, currency): Promise<AnalyticsCancellationRate>

      • Parameters

        • from: string

          환불율 조회 기간의 시작 시간

        • until: string

          환불율 조회 기간의 끝 시간

        • currency: Currency

          조회할 결제 통화

          입력된 통화로 발생한 결제내역만 응답에 포함됩니다.

        Returns Promise<AnalyticsCancellationRate>

  • getPaymentStatusChart: ((from: string, until: string, currency: Currency) => Promise<AnalyticsPaymentStatusChart>)

    고객사의 결제상태 이력 집계를 조회합니다.

    Throws

    Errors.ForbiddenError 요청이 거절된 경우

    Throws

    Errors.InvalidRequestError 요청된 입력 정보가 유효하지 않은 경우

    Throws

    Errors.UnauthorizedError 인증 정보가 올바르지 않은 경우

    Throws

    Errors.UnknownError API 응답이 알 수 없는 형식인 경우

      • (from, until, currency): Promise<AnalyticsPaymentStatusChart>

      • Parameters

        • from: string

          조회할 결제 현황의 시작 시간

        • until: string

          조회할 결제 현황의 끝 시간

        • currency: Currency

          조회할 결제 통화

          입력된 통화로 발생한 결제내역만 응답에 포함됩니다.

        Returns Promise<AnalyticsPaymentStatusChart>

  • getPaymentStatusByPaymentMethodChart: ((from: string, until: string, currency: Currency) => Promise<AnalyticsPaymentStatusByPaymentMethodChart>)

    고객사의 결제수단별 결제전환율을 조회합니다.

    Throws

    Errors.ForbiddenError 요청이 거절된 경우

    Throws

    Errors.InvalidRequestError 요청된 입력 정보가 유효하지 않은 경우

    Throws

    Errors.UnauthorizedError 인증 정보가 올바르지 않은 경우

    Throws

    Errors.UnknownError API 응답이 알 수 없는 형식인 경우

  • getPaymentStatusByPgCompanyChart: ((from: string, until: string, currency: Currency) => Promise<AnalyticsPaymentStatusByPgCompanyChart>)

    고객사의 PG사별 결제전환율을 조회합니다.

    Throws

    Errors.ForbiddenError 요청이 거절된 경우

    Throws

    Errors.InvalidRequestError 요청된 입력 정보가 유효하지 않은 경우

    Throws

    Errors.UnauthorizedError 인증 정보가 올바르지 않은 경우

    Throws

    Errors.UnknownError API 응답이 알 수 없는 형식인 경우

  • getPaymentStatusByPaymentClientChart: ((from: string, until: string, currency: Currency) => Promise<AnalyticsPaymentStatusByPaymentClientChart>)

    고객사의 결제환경별 결제전환율을 조회합니다.

    Throws

    Errors.ForbiddenError 요청이 거절된 경우

    Throws

    Errors.InvalidRequestError 요청된 입력 정보가 유효하지 않은 경우

    Throws

    Errors.UnauthorizedError 인증 정보가 올바르지 않은 경우

    Throws

    Errors.UnknownError API 응답이 알 수 없는 형식인 경우

Settings

Member Visibility