portone_server_sdk.analytics

Contents

portone_server_sdk.analytics#

Classes

AnalyticsAverageAmountChart

고객사의 평균 거래액 현황 조회 응답

AnalyticsAverageAmountChartStat

특정 시점의 건별 평균 거래액, 고객 당 평균 거래액을 나타냅니다.

AnalyticsAverageAmountChartSummary

전체 구간의 건별 평균 거래액, 고객 당 평균 거래액을 나타냅니다.

AnalyticsCancellationRate

고객사의 환불율 정보

AnalyticsCardChart

고객사의 카드결제 현황 차트 정보

AnalyticsCardChartStat

특정 시점의 카드결제 거래 건 수와 금액을 나타냅니다.

AnalyticsCardCompanyChart

고객사의 카드사별 결제 현황 조회 응답

AnalyticsCardCompanyChartRemainderStat

특정 시점의 나머지 카드사들의 결제금액, 결제 건수를 나타냅니다.

AnalyticsCardCompanyChartStat

특정 시점의 카드사 별 결제금액, 결제 건수를 나타냅니다.

AnalyticsCardCompanyChartSummary

결제금액, 결제 건수의 총합을 나타냅니다.

AnalyticsEasyPayChart

고객사의 간편결제 현황 차트 정보

AnalyticsEasyPayChartStat

특정 시점의 간편결제 거래 건수와 금액을 나타냅니다.

AnalyticsEasyPayProviderChart

고객사의 간편결제사별 결제 현황 차트 정보

AnalyticsEasyPayProviderChartRemainderStat

특정 시점의 나머지 간편결제사들의 결제금액, 결제 건수를 나타냅니다.

AnalyticsEasyPayProviderChartStat

특정 시점의 간편결제사별 결제금액, 결제 건수를 나타냅니다.

AnalyticsEasyPayProviderChartSummary

결제금액, 결제 건수의 총합을 나타냅니다.

AnalyticsOverseasPaymentUsage

고객사의 해외 결제 사용 여부

AnalyticsPaymentChart

고객사의 결제 현황 차트 정보

AnalyticsPaymentChartInsight

고객사의 결제 현황 인사이트 정보

AnalyticsPaymentChartStat

특정 시점의 거래 건 수와 금액을 나타냅니다.

AnalyticsPaymentMethodChart

고객사의 결제수단 현황 차트 정보

AnalyticsPaymentMethodChartStat

결제수단별 결제금액, 결제 건수를 나타냅니다.

AnalyticsPaymentMethodTrendChart

고객사의 결제수단 트렌드 차트 정보

AnalyticsPaymentMethodTrendChartStat

특정 시점의 결제수단별 결제금액, 결제 건수를 나타냅니다.

AnalyticsPaymentStatusByPaymentClientChart

고객사의 결제 환경 별 결제 상태 차트 정보

AnalyticsPaymentStatusByPaymentClientChartStat

고객사의 결제 환경 별 결제 상태 차트 정보

AnalyticsPaymentStatusByPaymentMethodChart

고객사의 결제 수단 별 결제 상태 차트 정보

AnalyticsPaymentStatusByPaymentMethodChartStat

각 결제수단, 상태 별 건수와 금액을 나타냅니다.

AnalyticsPaymentStatusByPgCompanyChart

고객사의 PG사 별 결제 상태 차트 정보

AnalyticsPaymentStatusByPgCompanyChartStat

각 상태의 건수와 금액, 사분위수를 나타냅니다.

AnalyticsPaymentStatusChart

고객사의 결제 상태 차트 정보

AnalyticsPaymentStatusChartStat

각 상태의 건수와 금액, 사분위수를 나타냅니다.

AnalyticsPgCompanyChart

고객사의 결제대행사 현황 차트 정보

AnalyticsPgCompanyChartStat

결제대행사별 결제금액, 결제 건수를 나타냅니다.

AnalyticsPgCompanyTrendChart

고객사의 결제대행사별 거래 추이 차트 정보

AnalyticsPgCompanyTrendChartStat

특정 시점의 결제대행사 별 결제금액, 결제 건수를 나타냅니다.

AnalyticsTimeGranularity

조회 시간 단위

AnalyticsTimeGranularityDay

AnalyticsTimeGranularityHour

시간

AnalyticsTimeGranularityMinute

AnalyticsTimeGranularityMonth

AnalyticsTimeGranularityWeek

GetAnalyticsAverageAmountChartBody

고객사의 평균 거래액 현황 조회를 위한 입력 정보

GetAnalyticsCancellationRateBody

고객사의 환불율 조회를 위한 입력 정보

GetAnalyticsCardChartBody

고객사의 카드결제 현황 조회를 위한 입력 정보

GetAnalyticsCardCompanyChartBody

고객사의 카드사별 결제 현황 조회를 위한 입력 정보

GetAnalyticsEasyPayChartBody

고객사의 간편결제 현황 조회를 위한 입력 정보

GetAnalyticsEasyPayProviderChartBody

고객사의 간편결제사별 결제 현황 조회를 위한 입력 정보

GetAnalyticsPaymentChartBody

고객사의 결제 현황 조회를 위한 입력 정보

GetAnalyticsPaymentChartInsightBody

고객사의 결제 현황 인사이트 조회를 위한 입력 정보

GetAnalyticsPaymentMethodChartBody

고객사의 결제수단 현황 조회를 위한 입력 정보

GetAnalyticsPaymentMethodTrendChartBody

고객사의 결제수단 트렌드 조회를 위한 입력 정보

GetAnalyticsPaymentStatusByPaymentClientChartBody

고객사의 결제환경별 결제전환율 조회를 위한 입력 정보

GetAnalyticsPaymentStatusByPaymentMethodChartBody

고객사의 결제수단별 결제전환율 조회를 위한 입력 정보

GetAnalyticsPaymentStatusByPgCompanyChartBody

고객사의 PG사별 결제전환율 조회를 위한 입력 정보

GetAnalyticsPaymentStatusChartBody

고객사의 결제상태 이력 집계 조회를 위한 입력 정보

GetAnalyticsPgCompanyChartBody

고객사의 결제대행사 현황 조회를 위한 입력 정보

GetAnalyticsPgCompanyTrendChartBody

고객사의 결제대행사별 거래 추이 조회를 위한 입력 정보

AnalyticsClient

class portone_server_sdk.analytics.AnalyticsAverageAmountChart#

고객사의 평균 거래액 현황 조회 응답

stats: list[AnalyticsAverageAmountChartStat]#
summary: AnalyticsAverageAmountChartSummary#
class portone_server_sdk.analytics.AnalyticsAverageAmountChartStat#

특정 시점의 건별 평균 거래액, 고객 당 평균 거래액을 나타냅니다.

timestamp: str#

시점 (RFC 3339 date-time)

payment_average_amount: int#

건별 평균 거래액 (int64)

customer_average_amount: int#

고객 당 평균 거래액 (int64)

class portone_server_sdk.analytics.AnalyticsAverageAmountChartSummary#

전체 구간의 건별 평균 거래액, 고객 당 평균 거래액을 나타냅니다.

payment_average_amount: int#

건별 평균 거래액 (int64)

customer_average_amount: int#

고객 당 평균 거래액 (int64)

class portone_server_sdk.analytics.AnalyticsCancellationRate#

고객사의 환불율 정보

cancellation_rate: float#
class portone_server_sdk.analytics.AnalyticsCardChart#

고객사의 카드결제 현황 차트 정보

stats: list[AnalyticsCardChartStat]#
class portone_server_sdk.analytics.AnalyticsCardChartStat#

특정 시점의 카드결제 거래 건 수와 금액을 나타냅니다.

timestamp: str#

시점 (RFC 3339 date-time)

amount: int#

거래액 (int64)

count: int#

거래 건수 (int64)

class portone_server_sdk.analytics.AnalyticsCardCompanyChart#

고객사의 카드사별 결제 현황 조회 응답

stats: list[AnalyticsCardCompanyChartStat]#
remainder_stats: list[AnalyticsCardCompanyChartRemainderStat]#
summary: AnalyticsCardCompanyChartSummary#
class portone_server_sdk.analytics.AnalyticsCardCompanyChartRemainderStat#

특정 시점의 나머지 카드사들의 결제금액, 결제 건수를 나타냅니다.

timestamp: str#

시점 (RFC 3339 date-time)

amount: int#

결제금액 (int64)

count: int#

결제 건수 (int64)

class portone_server_sdk.analytics.AnalyticsCardCompanyChartStat#

특정 시점의 카드사 별 결제금액, 결제 건수를 나타냅니다.

timestamp: str#

시점 (RFC 3339 date-time)

card_company: Literal['KOREA_DEVELOPMENT_BANK', 'KFCC', 'SHINHYUP', 'EPOST', 'SAVINGS_BANK_KOREA', 'KAKAO_BANK', 'K_BANK', 'TOSS_BANK', 'WOORI_CARD', 'BC_CARD', 'GWANGJU_CARD', 'SAMSUNG_CARD', 'SHINHAN_CARD', 'HYUNDAI_CARD', 'LOTTE_CARD', 'SUHYUP_CARD', 'CITI_CARD', 'NH_CARD', 'JEONBUK_CARD', 'JEJU_CARD', 'HANA_CARD', 'KOOKMIN_CARD', 'UNIDENTIFIED_GLOBAL_CARD', 'CHAI_CARD', 'AMEX_CARD', 'MIR_CARD', 'UNION_CARD', 'JCB_CARD', 'VISA_CARD', 'MASTER_CARD', 'DINERS_CARD', 'DISCOVER_CARD', 'IBK', 'NH_BANK', 'DAEGU_CARD', 'BUSAN_CARD', 'SC_BANK', 'KYONGNAM_CARD', 'WOORI_BANK', 'CHINA_BANK', 'NFCF', 'KB_SECURITIES', 'YUANTA_SECURITIES', 'NH_SECURITIES', 'DB_SECURITIES', 'SK_SECURITIES', 'EUGENE_SECURITIES', 'KYOBO_SECURITIES', 'MIRAE_ASSET_SECURITIES', 'KOREA_SECURITIES', 'HANHWA_SECURITIES', 'SSG', 'KONA_I', 'CHAI', 'TOSS_CARD', 'PAYCO', 'GMONEY_TRANS', 'FINT', 'KG_MOBILIANS', 'HANPASS', 'FINSHOT', 'BIZPLAY', 'NICE', 'DANAL', 'SECTA', 'GME', 'LORD_SYSTEM', 'NAVERPAY', 'KAKAOPAY', 'KDBC', 'TEEN_CASH', 'EGG_MONEY', 'ON_CASH', 'GALAXIA_MONEY_TREE', 'FIRFIN']#

카드사

amount: int#

결제금액 (int64)

count: int#

결제 건수 (int64)

class portone_server_sdk.analytics.AnalyticsCardCompanyChartSummary#

결제금액, 결제 건수의 총합을 나타냅니다.

total_amount: int#

결제금액 합 (int64)

total_count: int#

결제 건수 합 (int64)

class portone_server_sdk.analytics.AnalyticsEasyPayChart#

고객사의 간편결제 현황 차트 정보

stats: list[AnalyticsEasyPayChartStat]#
class portone_server_sdk.analytics.AnalyticsEasyPayChartStat#

특정 시점의 간편결제 거래 건수와 금액을 나타냅니다.

timestamp: str#

시점 (RFC 3339 date-time)

amount: int#

거래액 (int64)

count: int#

거래 건수 (int64)

class portone_server_sdk.analytics.AnalyticsEasyPayProviderChart#

고객사의 간편결제사별 결제 현황 차트 정보

stats: list[AnalyticsEasyPayProviderChartStat]#
remainder_stats: list[AnalyticsEasyPayProviderChartRemainderStat]#
summary: AnalyticsEasyPayProviderChartSummary#
class portone_server_sdk.analytics.AnalyticsEasyPayProviderChartRemainderStat#

특정 시점의 나머지 간편결제사들의 결제금액, 결제 건수를 나타냅니다.

timestamp: str#

시점 (RFC 3339 date-time)

amount: int#

결제금액 (int64)

count: int#

결제 건수 (int64)

class portone_server_sdk.analytics.AnalyticsEasyPayProviderChartStat#

특정 시점의 간편결제사별 결제금액, 결제 건수를 나타냅니다.

timestamp: str#

시점 (RFC 3339 date-time)

easy_pay_provider: Literal['SAMSUNGPAY', 'KAKAOPAY', 'NAVERPAY', 'PAYCO', 'SSGPAY', 'CHAI', 'LPAY', 'KPAY', 'TOSSPAY', 'LGPAY', 'PINPAY', 'APPLEPAY', 'SKPAY', 'TOSS_BRANDPAY', 'KB_APP', 'ALIPAY', 'HYPHEN', 'TMONEY']#

간편결제사

amount: int#

결제금액 (int64)

count: int#

결제 건수 (int64)

class portone_server_sdk.analytics.AnalyticsEasyPayProviderChartSummary#

결제금액, 결제 건수의 총합을 나타냅니다.

total_amount: int#

결제금액의 합 (int64)

total_count: int#

결제 건수의 합 (int64)

class portone_server_sdk.analytics.AnalyticsOverseasPaymentUsage#

고객사의 해외 결제 사용 여부

is_using: bool#
class portone_server_sdk.analytics.AnalyticsPaymentChart#

고객사의 결제 현황 차트 정보

stats: list[AnalyticsPaymentChartStat]#
class portone_server_sdk.analytics.AnalyticsPaymentChartInsight#

고객사의 결제 현황 인사이트 정보

highest_hour_in_day: int#

일간 최고 거래액 발생 시간 (int64)

lowest_hour_in_day: int#

일간 최저 거래액 발생 시간 (int64)

highest_date_in_month: int | None#

월간 최고 거래액 발생일 (int64)

lowest_date_in_month: int | None#

월간 최저 거래액 발생일 (int64)

highest_day_in_week: Literal['SUN', 'MON', 'TUE', 'WED', 'THU', 'FRI', 'SAT'] | None#

주간 최고 거래액 발생 요일

lowest_day_in_week: Literal['SUN', 'MON', 'TUE', 'WED', 'THU', 'FRI', 'SAT'] | None#

주간 최저 거래액 발생 요일

class portone_server_sdk.analytics.AnalyticsPaymentChartStat#

특정 시점의 거래 건 수와 금액을 나타냅니다.

timestamp: str#

시점 (RFC 3339 date-time)

amount: int#

거래액 (int64)

count: int#

거래 건수 (int64)

class portone_server_sdk.analytics.AnalyticsPaymentMethodChart#

고객사의 결제수단 현황 차트 정보

stats: list[AnalyticsPaymentMethodChartStat]#
class portone_server_sdk.analytics.AnalyticsPaymentMethodChartStat#

결제수단별 결제금액, 결제 건수를 나타냅니다.

amount: int#

결제수단별 결제금액 (int64)

count: int#

결제수단별 결제 건수 (int64)

payment_method: Literal['CARD', 'TRANSFER', 'VIRTUAL_ACCOUNT', 'GIFT_CERTIFICATE', 'MOBILE', 'EASY_PAY'] | None#

결제수단

class portone_server_sdk.analytics.AnalyticsPaymentMethodTrendChart#

고객사의 결제수단 트렌드 차트 정보

stats: list[AnalyticsPaymentMethodTrendChartStat]#

결제수단별 결제금액, 결제 건수 데이터

(timestamp, paymentMethod) 를 기준으로 오름차순 정렬되어 주어집니다.

class portone_server_sdk.analytics.AnalyticsPaymentMethodTrendChartStat#

특정 시점의 결제수단별 결제금액, 결제 건수를 나타냅니다.

timestamp: str#

시점 (RFC 3339 date-time)

amount: int#

결제금액 (int64)

count: int#

결제 건수 (int64)

payment_method: Literal['CARD', 'TRANSFER', 'VIRTUAL_ACCOUNT', 'GIFT_CERTIFICATE', 'MOBILE', 'EASY_PAY'] | None#

결제수단

class portone_server_sdk.analytics.AnalyticsPaymentStatusByPaymentClientChart#

고객사의 결제 환경 별 결제 상태 차트 정보

stats: list[AnalyticsPaymentStatusByPaymentClientChartStat]#
class portone_server_sdk.analytics.AnalyticsPaymentStatusByPaymentClientChartStat#

고객사의 결제 환경 별 결제 상태 차트 정보

payment_client_type: Literal['SDK_MOBILE', 'SDK_PC', 'API']#

결제가 발생한 클라이언트 환경

payment_status: Literal['READY', 'PENDING', 'VIRTUAL_ACCOUNT_ISSUED', 'PAID', 'FAILED', 'PARTIAL_CANCELLED', 'CANCELLED']#

결제 건 상태

amount: int#

거래액 (int64)

count: int#

거래 건수 (int64)

class portone_server_sdk.analytics.AnalyticsPaymentStatusByPaymentMethodChart#

고객사의 결제 수단 별 결제 상태 차트 정보

stats: list[AnalyticsPaymentStatusByPaymentMethodChartStat]#
class portone_server_sdk.analytics.AnalyticsPaymentStatusByPaymentMethodChartStat#

각 결제수단, 상태 별 건수와 금액을 나타냅니다.

payment_status: Literal['READY', 'PENDING', 'VIRTUAL_ACCOUNT_ISSUED', 'PAID', 'FAILED', 'PARTIAL_CANCELLED', 'CANCELLED']#

결제 건 상태

amount: int#

거래액 (int64)

count: int#

거래 건수 (int64)

payment_method: Literal['CARD', 'TRANSFER', 'VIRTUAL_ACCOUNT', 'GIFT_CERTIFICATE', 'MOBILE', 'EASY_PAY'] | None#

결제수단

class portone_server_sdk.analytics.AnalyticsPaymentStatusByPgCompanyChart#

고객사의 PG사 별 결제 상태 차트 정보

stats: list[AnalyticsPaymentStatusByPgCompanyChartStat]#
class portone_server_sdk.analytics.AnalyticsPaymentStatusByPgCompanyChartStat#

각 상태의 건수와 금액, 사분위수를 나타냅니다.

pg_company: Literal['INICIS', 'NICE', 'KCP', 'DANAL', 'TOSSPAYMENTS', 'MOBILIANS', 'KICC', 'SMARTRO', 'DAOU', 'BLUEWALNUT', 'PAYPAL', 'ALIPAY', 'EXIMBAY', 'PAYMENTWALL', 'SETTLE', 'GALAXIA', 'NAVERPAY', 'KAKAOPAY', 'SMILEPAY', 'KAKAO', 'TOSSPAY', 'CHAI', 'PAYCO', 'PAYPLE', 'SYRUP', 'KSNET', 'WELCOME', 'JTNET', 'KPN', 'HYPHEN']#

PG사

payment_status: Literal['READY', 'PENDING', 'VIRTUAL_ACCOUNT_ISSUED', 'PAID', 'FAILED', 'PARTIAL_CANCELLED', 'CANCELLED']#

결제 건 상태

amount: int#

거래액 (int64)

count: int#

거래 건수 (int64)

class portone_server_sdk.analytics.AnalyticsPaymentStatusChart#

고객사의 결제 상태 차트 정보

stats: list[AnalyticsPaymentStatusChartStat]#
class portone_server_sdk.analytics.AnalyticsPaymentStatusChartStat#

각 상태의 건수와 금액, 사분위수를 나타냅니다.

payment_status: Literal['READY', 'PENDING', 'VIRTUAL_ACCOUNT_ISSUED', 'PAID', 'FAILED', 'PARTIAL_CANCELLED', 'CANCELLED']#

결제 건 상태

amount: int#

거래액 (int64)

count: int#

거래 건수 (int64)

average_ratio: int#

해당 상태 비율 (int64)

first_quantile: int#

1 사분위수 (int64)

median: int#

중앙값 (int64)

third_quantile: int#

3 사분위수 (int64)

class portone_server_sdk.analytics.AnalyticsPgCompanyChart#

고객사의 결제대행사 현황 차트 정보

stats: list[AnalyticsPgCompanyChartStat]#
class portone_server_sdk.analytics.AnalyticsPgCompanyChartStat#

결제대행사별 결제금액, 결제 건수를 나타냅니다.

pg_company: Literal['INICIS', 'NICE', 'KCP', 'DANAL', 'TOSSPAYMENTS', 'MOBILIANS', 'KICC', 'SMARTRO', 'DAOU', 'BLUEWALNUT', 'PAYPAL', 'ALIPAY', 'EXIMBAY', 'PAYMENTWALL', 'SETTLE', 'GALAXIA', 'NAVERPAY', 'KAKAOPAY', 'SMILEPAY', 'KAKAO', 'TOSSPAY', 'CHAI', 'PAYCO', 'PAYPLE', 'SYRUP', 'KSNET', 'WELCOME', 'JTNET', 'KPN', 'HYPHEN']#

결제대행사

amount: int#

결제대행사별 결제금액 (int64)

count: int#

결제대행사별 결제 건수 (int64)

class portone_server_sdk.analytics.AnalyticsPgCompanyTrendChart#

고객사의 결제대행사별 거래 추이 차트 정보

stats: list[AnalyticsPgCompanyTrendChartStat]#
class portone_server_sdk.analytics.AnalyticsPgCompanyTrendChartStat#

특정 시점의 결제대행사 별 결제금액, 결제 건수를 나타냅니다.

timestamp: str#

시점 (RFC 3339 date-time)

pg_company: Literal['INICIS', 'NICE', 'KCP', 'DANAL', 'TOSSPAYMENTS', 'MOBILIANS', 'KICC', 'SMARTRO', 'DAOU', 'BLUEWALNUT', 'PAYPAL', 'ALIPAY', 'EXIMBAY', 'PAYMENTWALL', 'SETTLE', 'GALAXIA', 'NAVERPAY', 'KAKAOPAY', 'SMILEPAY', 'KAKAO', 'TOSSPAY', 'CHAI', 'PAYCO', 'PAYPLE', 'SYRUP', 'KSNET', 'WELCOME', 'JTNET', 'KPN', 'HYPHEN']#

결제대행사

amount: int#

결제금액 (int64)

count: int#

결제 건수 (int64)

class portone_server_sdk.analytics.AnalyticsTimeGranularity#

조회 시간 단위

하나의 단위 필드만 선택하여 입력합니다.

minute: AnalyticsTimeGranularityMinute | None#
hour: AnalyticsTimeGranularityHour | None#
day: AnalyticsTimeGranularityDay | None#
week: AnalyticsTimeGranularityWeek | None#
month: AnalyticsTimeGranularityMonth | None#
class portone_server_sdk.analytics.AnalyticsTimeGranularityDay#

timezone_hour_offset: int#

(int32)

class portone_server_sdk.analytics.AnalyticsTimeGranularityHour#

시간

class portone_server_sdk.analytics.AnalyticsTimeGranularityMinute#

class portone_server_sdk.analytics.AnalyticsTimeGranularityMonth#

timezone_hour_offset: int#

(int32)

class portone_server_sdk.analytics.AnalyticsTimeGranularityWeek#

timezone_hour_offset: int#

(int32)

class portone_server_sdk.analytics.GetAnalyticsAverageAmountChartBody#

고객사의 평균 거래액 현황 조회를 위한 입력 정보

from_: str#

조회할 평균 거래액 현황의 시작 시간 (RFC 3339 date-time)

until: str#

조회할 평균 거래액 현황의 끝 시간 (RFC 3339 date-time)

currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL']#

조회할 결제 통화

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

exclude_cancelled: bool#

결제취소건 제외 여부

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

time_granularity: AnalyticsTimeGranularity#

평균 거래액 현황 조회 단위

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

class portone_server_sdk.analytics.GetAnalyticsCancellationRateBody#

고객사의 환불율 조회를 위한 입력 정보

from_: str#

환불율 조회 기간의 시작 시간 (RFC 3339 date-time)

until: str#

환불율 조회 기간의 끝 시간 (RFC 3339 date-time)

currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL']#

조회할 결제 통화

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

class portone_server_sdk.analytics.GetAnalyticsCardChartBody#

고객사의 카드결제 현황 조회를 위한 입력 정보

from_: str#

조회할 카드결제 현황의 시작 시간 (RFC 3339 date-time)

until: str#

조회할 카드결제 현황의 끝 시간 (RFC 3339 date-time)

currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL']#

조회할 결제 통화

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

exclude_cancelled: bool#

결제취소건 제외 여부

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

time_granularity: AnalyticsTimeGranularity#

카드결제 현황 조회 단위

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

class portone_server_sdk.analytics.GetAnalyticsCardCompanyChartBody#

고객사의 카드사별 결제 현황 조회를 위한 입력 정보

from_: str#

조회할 카드사별 결제 현황의 시작 시간 (RFC 3339 date-time)

until: str#

조회할 카드사별 결제 현황의 끝 시간 (RFC 3339 date-time)

currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL']#

조회할 결제 통화

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

exclude_cancelled: bool#

결제취소건 제외 여부

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

time_granularity: AnalyticsTimeGranularity#

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

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

card_companies: list[Literal['KOREA_DEVELOPMENT_BANK', 'KFCC', 'SHINHYUP', 'EPOST', 'SAVINGS_BANK_KOREA', 'KAKAO_BANK', 'K_BANK', 'TOSS_BANK', 'WOORI_CARD', 'BC_CARD', 'GWANGJU_CARD', 'SAMSUNG_CARD', 'SHINHAN_CARD', 'HYUNDAI_CARD', 'LOTTE_CARD', 'SUHYUP_CARD', 'CITI_CARD', 'NH_CARD', 'JEONBUK_CARD', 'JEJU_CARD', 'HANA_CARD', 'KOOKMIN_CARD', 'UNIDENTIFIED_GLOBAL_CARD', 'CHAI_CARD', 'AMEX_CARD', 'MIR_CARD', 'UNION_CARD', 'JCB_CARD', 'VISA_CARD', 'MASTER_CARD', 'DINERS_CARD', 'DISCOVER_CARD', 'IBK', 'NH_BANK', 'DAEGU_CARD', 'BUSAN_CARD', 'SC_BANK', 'KYONGNAM_CARD', 'WOORI_BANK', 'CHINA_BANK', 'NFCF', 'KB_SECURITIES', 'YUANTA_SECURITIES', 'NH_SECURITIES', 'DB_SECURITIES', 'SK_SECURITIES', 'EUGENE_SECURITIES', 'KYOBO_SECURITIES', 'MIRAE_ASSET_SECURITIES', 'KOREA_SECURITIES', 'HANHWA_SECURITIES', 'SSG', 'KONA_I', 'CHAI', 'TOSS_CARD', 'PAYCO', 'GMONEY_TRANS', 'FINT', 'KG_MOBILIANS', 'HANPASS', 'FINSHOT', 'BIZPLAY', 'NICE', 'DANAL', 'SECTA', 'GME', 'LORD_SYSTEM', 'NAVERPAY', 'KAKAOPAY', 'KDBC', 'TEEN_CASH', 'EGG_MONEY', 'ON_CASH', 'GALAXIA_MONEY_TREE', 'FIRFIN']]#

조회할 카드사

excludes_from_remainders: list[Literal['KOREA_DEVELOPMENT_BANK', 'KFCC', 'SHINHYUP', 'EPOST', 'SAVINGS_BANK_KOREA', 'KAKAO_BANK', 'K_BANK', 'TOSS_BANK', 'WOORI_CARD', 'BC_CARD', 'GWANGJU_CARD', 'SAMSUNG_CARD', 'SHINHAN_CARD', 'HYUNDAI_CARD', 'LOTTE_CARD', 'SUHYUP_CARD', 'CITI_CARD', 'NH_CARD', 'JEONBUK_CARD', 'JEJU_CARD', 'HANA_CARD', 'KOOKMIN_CARD', 'UNIDENTIFIED_GLOBAL_CARD', 'CHAI_CARD', 'AMEX_CARD', 'MIR_CARD', 'UNION_CARD', 'JCB_CARD', 'VISA_CARD', 'MASTER_CARD', 'DINERS_CARD', 'DISCOVER_CARD', 'IBK', 'NH_BANK', 'DAEGU_CARD', 'BUSAN_CARD', 'SC_BANK', 'KYONGNAM_CARD', 'WOORI_BANK', 'CHINA_BANK', 'NFCF', 'KB_SECURITIES', 'YUANTA_SECURITIES', 'NH_SECURITIES', 'DB_SECURITIES', 'SK_SECURITIES', 'EUGENE_SECURITIES', 'KYOBO_SECURITIES', 'MIRAE_ASSET_SECURITIES', 'KOREA_SECURITIES', 'HANHWA_SECURITIES', 'SSG', 'KONA_I', 'CHAI', 'TOSS_CARD', 'PAYCO', 'GMONEY_TRANS', 'FINT', 'KG_MOBILIANS', 'HANPASS', 'FINSHOT', 'BIZPLAY', 'NICE', 'DANAL', 'SECTA', 'GME', 'LORD_SYSTEM', 'NAVERPAY', 'KAKAOPAY', 'KDBC', 'TEEN_CASH', 'EGG_MONEY', 'ON_CASH', 'GALAXIA_MONEY_TREE', 'FIRFIN']]#

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

class portone_server_sdk.analytics.GetAnalyticsEasyPayChartBody#

고객사의 간편결제 현황 조회를 위한 입력 정보

from_: str#

조회할 간편결제 현황의 시작 시간 (RFC 3339 date-time)

until: str#

조회할 간편결제 현황의 끝 시간 (RFC 3339 date-time)

currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL']#

조회할 결제 통화

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

exclude_cancelled: bool#

결제취소건 제외 여부

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

time_granularity: AnalyticsTimeGranularity#

간편결제 현황 조회 단위

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

class portone_server_sdk.analytics.GetAnalyticsEasyPayProviderChartBody#

고객사의 간편결제사별 결제 현황 조회를 위한 입력 정보

from_: str#

조회할 간편결제사별 결제 현황의 시작 시간 (RFC 3339 date-time)

until: str#

조회할 간편결제사별 결제 현황의 끝 시간 (RFC 3339 date-time)

currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL']#

조회할 결제 통화

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

exclude_cancelled: bool#

결제취소건 제외 여부

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

time_granularity: AnalyticsTimeGranularity#

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

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

easy_pay_providers: list[Literal['SAMSUNGPAY', 'KAKAOPAY', 'NAVERPAY', 'PAYCO', 'SSGPAY', 'CHAI', 'LPAY', 'KPAY', 'TOSSPAY', 'LGPAY', 'PINPAY', 'APPLEPAY', 'SKPAY', 'TOSS_BRANDPAY', 'KB_APP', 'ALIPAY', 'HYPHEN', 'TMONEY']]#

조회할 간편결제사

excludes_from_remainders: list[Literal['SAMSUNGPAY', 'KAKAOPAY', 'NAVERPAY', 'PAYCO', 'SSGPAY', 'CHAI', 'LPAY', 'KPAY', 'TOSSPAY', 'LGPAY', 'PINPAY', 'APPLEPAY', 'SKPAY', 'TOSS_BRANDPAY', 'KB_APP', 'ALIPAY', 'HYPHEN', 'TMONEY']]#

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

class portone_server_sdk.analytics.GetAnalyticsPaymentChartBody#

고객사의 결제 현황 조회를 위한 입력 정보

from_: str#

조회할 결제 현황의 시작 시간 (RFC 3339 date-time)

until: str#

조회할 결제 현황의 끝 시간 (RFC 3339 date-time)

currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL']#

조회할 결제 통화

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

time_granularity: AnalyticsTimeGranularity#

결제 현황 조회 단위

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

exclude_cancelled: bool | None#

결제취소건 제외 여부

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

class portone_server_sdk.analytics.GetAnalyticsPaymentChartInsightBody#

고객사의 결제 현황 인사이트 조회를 위한 입력 정보

from_: str#

조회할 결제 현황의 시작 시간 (RFC 3339 date-time)

until: str#

조회할 결제 현황의 끝 시간 (RFC 3339 date-time)

currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL']#

조회할 결제 통화

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

timezone_hour_offset: int#

타임존 시간 오프셋

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

exclude_cancelled: bool | None#

결제취소건 제외 여부

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

class portone_server_sdk.analytics.GetAnalyticsPaymentMethodChartBody#

고객사의 결제수단 현황 조회를 위한 입력 정보

from_: str#

조회할 결제수단 현황의 시작 시간 (RFC 3339 date-time)

until: str#

조회할 결제수단 현황의 끝 시간 (RFC 3339 date-time)

currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL']#

조회할 결제 통화

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

exclude_cancelled: bool#

결제취소건 제외 여부

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

class portone_server_sdk.analytics.GetAnalyticsPaymentMethodTrendChartBody#

고객사의 결제수단 트렌드 조회를 위한 입력 정보

from_: str#

조회할 결제수단 트렌드의 시작 시간 (RFC 3339 date-time)

until: str#

조회할 결제수단 트렌드의 끝 시간 (RFC 3339 date-time)

currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL']#

조회할 결제 통화

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

exclude_cancelled: bool#

결제취소건 제외 여부

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

time_granularity: AnalyticsTimeGranularity#

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

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

class portone_server_sdk.analytics.GetAnalyticsPaymentStatusByPaymentClientChartBody#

고객사의 결제환경별 결제전환율 조회를 위한 입력 정보

from_: str#

조회할 결제 현황의 시작 시간 (RFC 3339 date-time)

until: str#

조회할 결제 현황의 끝 시간 (RFC 3339 date-time)

currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL']#

조회할 결제 통화

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

class portone_server_sdk.analytics.GetAnalyticsPaymentStatusByPaymentMethodChartBody#

고객사의 결제수단별 결제전환율 조회를 위한 입력 정보

from_: str#

조회할 결제 현황의 시작 시간 (RFC 3339 date-time)

until: str#

조회할 결제 현황의 끝 시간 (RFC 3339 date-time)

currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL']#

조회할 결제 통화

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

class portone_server_sdk.analytics.GetAnalyticsPaymentStatusByPgCompanyChartBody#

고객사의 PG사별 결제전환율 조회를 위한 입력 정보

from_: str#

조회할 결제 현황의 시작 시간 (RFC 3339 date-time)

until: str#

조회할 결제 현황의 끝 시간 (RFC 3339 date-time)

currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL']#

조회할 결제 통화

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

class portone_server_sdk.analytics.GetAnalyticsPaymentStatusChartBody#

고객사의 결제상태 이력 집계 조회를 위한 입력 정보

from_: str#

조회할 결제 현황의 시작 시간 (RFC 3339 date-time)

until: str#

조회할 결제 현황의 끝 시간 (RFC 3339 date-time)

currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL']#

조회할 결제 통화

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

class portone_server_sdk.analytics.GetAnalyticsPgCompanyChartBody#

고객사의 결제대행사 현황 조회를 위한 입력 정보

from_: str#

조회할 결제대행사 현황의 시작 시간 (RFC 3339 date-time)

until: str#

조회할 결제대행사 현황의 끝 시간 (RFC 3339 date-time)

currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL']#

조회할 결제 통화

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

exclude_cancelled: bool#

결제취소건 제외 여부

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

class portone_server_sdk.analytics.GetAnalyticsPgCompanyTrendChartBody#

고객사의 결제대행사별 거래 추이 조회를 위한 입력 정보

from_: str#

조회할 결제대행사별 거래 추이의 시작 시간 (RFC 3339 date-time)

until: str#

조회할 결제대행사별 거래 추이의 끝 시간 (RFC 3339 date-time)

currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL']#

조회할 결제 통화

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

exclude_cancelled: bool#

결제취소건 제외 여부

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

time_granularity: AnalyticsTimeGranularity#

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

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

pg_companies: list[Literal['INICIS', 'NICE', 'KCP', 'DANAL', 'TOSSPAYMENTS', 'MOBILIANS', 'KICC', 'SMARTRO', 'DAOU', 'BLUEWALNUT', 'PAYPAL', 'ALIPAY', 'EXIMBAY', 'PAYMENTWALL', 'SETTLE', 'GALAXIA', 'NAVERPAY', 'KAKAOPAY', 'SMILEPAY', 'KAKAO', 'TOSSPAY', 'CHAI', 'PAYCO', 'PAYPLE', 'SYRUP', 'KSNET', 'WELCOME', 'JTNET', 'KPN', 'HYPHEN']]#

조회할 결제대행사

class portone_server_sdk.analytics.AnalyticsClient#
get_analytics_payment_chart(*, from_: str, until: str, currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL'], exclude_cancelled: bool | None = None, time_granularity: AnalyticsTimeGranularity) AnalyticsPaymentChart#

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

Parameters:
  • from (str) – 조회할 결제 현황의 시작 시간

  • until (str) – 조회할 결제 현황의 끝 시간

  • currency (Currency) –

    조회할 결제 통화

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

  • exclude_cancelled (bool, optional) –

    결제취소건 제외 여부

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

  • time_granularity (AnalyticsTimeGranularity) –

    결제 현황 조회 단위

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

Raises:
  • ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우

  • InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

  • UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우

  • UnknownError – API 응답이 알 수 없는 형식인 경우

async get_analytics_payment_chart_async(*, from_: str, until: str, currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL'], exclude_cancelled: bool | None = None, time_granularity: AnalyticsTimeGranularity) AnalyticsPaymentChart#

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

Parameters:
  • from (str) – 조회할 결제 현황의 시작 시간

  • until (str) – 조회할 결제 현황의 끝 시간

  • currency (Currency) –

    조회할 결제 통화

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

  • exclude_cancelled (bool, optional) –

    결제취소건 제외 여부

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

  • time_granularity (AnalyticsTimeGranularity) –

    결제 현황 조회 단위

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

Raises:
  • ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우

  • InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

  • UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우

  • UnknownError – API 응답이 알 수 없는 형식인 경우

get_analytics_payment_chart_insight(*, from_: str, until: str, currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL'], exclude_cancelled: bool | None = None, timezone_hour_offset: int) AnalyticsPaymentChartInsight#

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

Parameters:
  • from (str) – 조회할 결제 현황의 시작 시간

  • until (str) – 조회할 결제 현황의 끝 시간

  • currency (Currency) –

    조회할 결제 통화

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

  • exclude_cancelled (bool, optional) –

    결제취소건 제외 여부

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

  • timezone_hour_offset (int) –

    타임존 시간 오프셋

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

Raises:
  • ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우

  • InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

  • UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우

  • UnknownError – API 응답이 알 수 없는 형식인 경우

async get_analytics_payment_chart_insight_async(*, from_: str, until: str, currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL'], exclude_cancelled: bool | None = None, timezone_hour_offset: int) AnalyticsPaymentChartInsight#

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

Parameters:
  • from (str) – 조회할 결제 현황의 시작 시간

  • until (str) – 조회할 결제 현황의 끝 시간

  • currency (Currency) –

    조회할 결제 통화

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

  • exclude_cancelled (bool, optional) –

    결제취소건 제외 여부

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

  • timezone_hour_offset (int) –

    타임존 시간 오프셋

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

Raises:
  • ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우

  • InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

  • UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우

  • UnknownError – API 응답이 알 수 없는 형식인 경우

get_average_amount_chart(*, from_: str, until: str, currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL'], exclude_cancelled: bool, time_granularity: AnalyticsTimeGranularity) AnalyticsAverageAmountChart#

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

Parameters:
  • from (str) – 조회할 평균 거래액 현황의 시작 시간

  • until (str) – 조회할 평균 거래액 현황의 끝 시간

  • currency (Currency) –

    조회할 결제 통화

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

  • exclude_cancelled (bool) –

    결제취소건 제외 여부

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

  • time_granularity (AnalyticsTimeGranularity) –

    평균 거래액 현황 조회 단위

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

Raises:
  • ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우

  • InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

  • UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우

  • UnknownError – API 응답이 알 수 없는 형식인 경우

async get_average_amount_chart_async(*, from_: str, until: str, currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL'], exclude_cancelled: bool, time_granularity: AnalyticsTimeGranularity) AnalyticsAverageAmountChart#

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

Parameters:
  • from (str) – 조회할 평균 거래액 현황의 시작 시간

  • until (str) – 조회할 평균 거래액 현황의 끝 시간

  • currency (Currency) –

    조회할 결제 통화

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

  • exclude_cancelled (bool) –

    결제취소건 제외 여부

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

  • time_granularity (AnalyticsTimeGranularity) –

    평균 거래액 현황 조회 단위

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

Raises:
  • ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우

  • InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

  • UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우

  • UnknownError – API 응답이 알 수 없는 형식인 경우

get_payment_method_chart(*, from_: str, until: str, currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL'], exclude_cancelled: bool) AnalyticsPaymentMethodChart#

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

Parameters:
  • from (str) – 조회할 결제수단 현황의 시작 시간

  • until (str) – 조회할 결제수단 현황의 끝 시간

  • currency (Currency) –

    조회할 결제 통화

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

  • exclude_cancelled (bool) –

    결제취소건 제외 여부

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

Raises:
  • ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우

  • InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

  • UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우

  • UnknownError – API 응답이 알 수 없는 형식인 경우

async get_payment_method_chart_async(*, from_: str, until: str, currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL'], exclude_cancelled: bool) AnalyticsPaymentMethodChart#

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

Parameters:
  • from (str) – 조회할 결제수단 현황의 시작 시간

  • until (str) – 조회할 결제수단 현황의 끝 시간

  • currency (Currency) –

    조회할 결제 통화

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

  • exclude_cancelled (bool) –

    결제취소건 제외 여부

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

Raises:
  • ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우

  • InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

  • UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우

  • UnknownError – API 응답이 알 수 없는 형식인 경우

get_payment_method_trend_chart(*, from_: str, until: str, currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL'], exclude_cancelled: bool, time_granularity: AnalyticsTimeGranularity) AnalyticsPaymentMethodTrendChart#

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

Parameters:
  • from (str) – 조회할 결제수단 트렌드의 시작 시간

  • until (str) – 조회할 결제수단 트렌드의 끝 시간

  • currency (Currency) –

    조회할 결제 통화

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

  • exclude_cancelled (bool) –

    결제취소건 제외 여부

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

  • time_granularity (AnalyticsTimeGranularity) –

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

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

Raises:
  • ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우

  • InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

  • UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우

  • UnknownError – API 응답이 알 수 없는 형식인 경우

async get_payment_method_trend_chart_async(*, from_: str, until: str, currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL'], exclude_cancelled: bool, time_granularity: AnalyticsTimeGranularity) AnalyticsPaymentMethodTrendChart#

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

Parameters:
  • from (str) – 조회할 결제수단 트렌드의 시작 시간

  • until (str) – 조회할 결제수단 트렌드의 끝 시간

  • currency (Currency) –

    조회할 결제 통화

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

  • exclude_cancelled (bool) –

    결제취소건 제외 여부

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

  • time_granularity (AnalyticsTimeGranularity) –

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

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

Raises:
  • ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우

  • InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

  • UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우

  • UnknownError – API 응답이 알 수 없는 형식인 경우

get_analytics_card_chart(*, from_: str, until: str, currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL'], exclude_cancelled: bool, time_granularity: AnalyticsTimeGranularity) AnalyticsCardChart#

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

Parameters:
  • from (str) – 조회할 카드결제 현황의 시작 시간

  • until (str) – 조회할 카드결제 현황의 끝 시간

  • currency (Currency) –

    조회할 결제 통화

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

  • exclude_cancelled (bool) –

    결제취소건 제외 여부

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

  • time_granularity (AnalyticsTimeGranularity) –

    카드결제 현황 조회 단위

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

Raises:
  • ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우

  • InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

  • UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우

  • UnknownError – API 응답이 알 수 없는 형식인 경우

async get_analytics_card_chart_async(*, from_: str, until: str, currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL'], exclude_cancelled: bool, time_granularity: AnalyticsTimeGranularity) AnalyticsCardChart#

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

Parameters:
  • from (str) – 조회할 카드결제 현황의 시작 시간

  • until (str) – 조회할 카드결제 현황의 끝 시간

  • currency (Currency) –

    조회할 결제 통화

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

  • exclude_cancelled (bool) –

    결제취소건 제외 여부

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

  • time_granularity (AnalyticsTimeGranularity) –

    카드결제 현황 조회 단위

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

Raises:
  • ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우

  • InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

  • UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우

  • UnknownError – API 응답이 알 수 없는 형식인 경우

get_analytics_card_company_chart(*, from_: str, until: str, currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL'], exclude_cancelled: bool, time_granularity: AnalyticsTimeGranularity, card_companies: list[Literal['KOREA_DEVELOPMENT_BANK', 'KFCC', 'SHINHYUP', 'EPOST', 'SAVINGS_BANK_KOREA', 'KAKAO_BANK', 'K_BANK', 'TOSS_BANK', 'WOORI_CARD', 'BC_CARD', 'GWANGJU_CARD', 'SAMSUNG_CARD', 'SHINHAN_CARD', 'HYUNDAI_CARD', 'LOTTE_CARD', 'SUHYUP_CARD', 'CITI_CARD', 'NH_CARD', 'JEONBUK_CARD', 'JEJU_CARD', 'HANA_CARD', 'KOOKMIN_CARD', 'UNIDENTIFIED_GLOBAL_CARD', 'CHAI_CARD', 'AMEX_CARD', 'MIR_CARD', 'UNION_CARD', 'JCB_CARD', 'VISA_CARD', 'MASTER_CARD', 'DINERS_CARD', 'DISCOVER_CARD', 'IBK', 'NH_BANK', 'DAEGU_CARD', 'BUSAN_CARD', 'SC_BANK', 'KYONGNAM_CARD', 'WOORI_BANK', 'CHINA_BANK', 'NFCF', 'KB_SECURITIES', 'YUANTA_SECURITIES', 'NH_SECURITIES', 'DB_SECURITIES', 'SK_SECURITIES', 'EUGENE_SECURITIES', 'KYOBO_SECURITIES', 'MIRAE_ASSET_SECURITIES', 'KOREA_SECURITIES', 'HANHWA_SECURITIES', 'SSG', 'KONA_I', 'CHAI', 'TOSS_CARD', 'PAYCO', 'GMONEY_TRANS', 'FINT', 'KG_MOBILIANS', 'HANPASS', 'FINSHOT', 'BIZPLAY', 'NICE', 'DANAL', 'SECTA', 'GME', 'LORD_SYSTEM', 'NAVERPAY', 'KAKAOPAY', 'KDBC', 'TEEN_CASH', 'EGG_MONEY', 'ON_CASH', 'GALAXIA_MONEY_TREE', 'FIRFIN']], excludes_from_remainders: list[Literal['KOREA_DEVELOPMENT_BANK', 'KFCC', 'SHINHYUP', 'EPOST', 'SAVINGS_BANK_KOREA', 'KAKAO_BANK', 'K_BANK', 'TOSS_BANK', 'WOORI_CARD', 'BC_CARD', 'GWANGJU_CARD', 'SAMSUNG_CARD', 'SHINHAN_CARD', 'HYUNDAI_CARD', 'LOTTE_CARD', 'SUHYUP_CARD', 'CITI_CARD', 'NH_CARD', 'JEONBUK_CARD', 'JEJU_CARD', 'HANA_CARD', 'KOOKMIN_CARD', 'UNIDENTIFIED_GLOBAL_CARD', 'CHAI_CARD', 'AMEX_CARD', 'MIR_CARD', 'UNION_CARD', 'JCB_CARD', 'VISA_CARD', 'MASTER_CARD', 'DINERS_CARD', 'DISCOVER_CARD', 'IBK', 'NH_BANK', 'DAEGU_CARD', 'BUSAN_CARD', 'SC_BANK', 'KYONGNAM_CARD', 'WOORI_BANK', 'CHINA_BANK', 'NFCF', 'KB_SECURITIES', 'YUANTA_SECURITIES', 'NH_SECURITIES', 'DB_SECURITIES', 'SK_SECURITIES', 'EUGENE_SECURITIES', 'KYOBO_SECURITIES', 'MIRAE_ASSET_SECURITIES', 'KOREA_SECURITIES', 'HANHWA_SECURITIES', 'SSG', 'KONA_I', 'CHAI', 'TOSS_CARD', 'PAYCO', 'GMONEY_TRANS', 'FINT', 'KG_MOBILIANS', 'HANPASS', 'FINSHOT', 'BIZPLAY', 'NICE', 'DANAL', 'SECTA', 'GME', 'LORD_SYSTEM', 'NAVERPAY', 'KAKAOPAY', 'KDBC', 'TEEN_CASH', 'EGG_MONEY', 'ON_CASH', 'GALAXIA_MONEY_TREE', 'FIRFIN']]) AnalyticsCardCompanyChart#

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

Parameters:
  • from (str) – 조회할 카드사별 결제 현황의 시작 시간

  • until (str) – 조회할 카드사별 결제 현황의 끝 시간

  • currency (Currency) –

    조회할 결제 통화

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

  • exclude_cancelled (bool) –

    결제취소건 제외 여부

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

  • time_granularity (AnalyticsTimeGranularity) –

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

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

  • card_companies (list[CardCompany]) – 조회할 카드사

  • excludes_from_remainders (list[CardCompany]) – 나머지 집계에 포함되지 않을 카드사

Raises:
  • ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우

  • InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

  • UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우

  • UnknownError – API 응답이 알 수 없는 형식인 경우

async get_analytics_card_company_chart_async(*, from_: str, until: str, currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL'], exclude_cancelled: bool, time_granularity: AnalyticsTimeGranularity, card_companies: list[Literal['KOREA_DEVELOPMENT_BANK', 'KFCC', 'SHINHYUP', 'EPOST', 'SAVINGS_BANK_KOREA', 'KAKAO_BANK', 'K_BANK', 'TOSS_BANK', 'WOORI_CARD', 'BC_CARD', 'GWANGJU_CARD', 'SAMSUNG_CARD', 'SHINHAN_CARD', 'HYUNDAI_CARD', 'LOTTE_CARD', 'SUHYUP_CARD', 'CITI_CARD', 'NH_CARD', 'JEONBUK_CARD', 'JEJU_CARD', 'HANA_CARD', 'KOOKMIN_CARD', 'UNIDENTIFIED_GLOBAL_CARD', 'CHAI_CARD', 'AMEX_CARD', 'MIR_CARD', 'UNION_CARD', 'JCB_CARD', 'VISA_CARD', 'MASTER_CARD', 'DINERS_CARD', 'DISCOVER_CARD', 'IBK', 'NH_BANK', 'DAEGU_CARD', 'BUSAN_CARD', 'SC_BANK', 'KYONGNAM_CARD', 'WOORI_BANK', 'CHINA_BANK', 'NFCF', 'KB_SECURITIES', 'YUANTA_SECURITIES', 'NH_SECURITIES', 'DB_SECURITIES', 'SK_SECURITIES', 'EUGENE_SECURITIES', 'KYOBO_SECURITIES', 'MIRAE_ASSET_SECURITIES', 'KOREA_SECURITIES', 'HANHWA_SECURITIES', 'SSG', 'KONA_I', 'CHAI', 'TOSS_CARD', 'PAYCO', 'GMONEY_TRANS', 'FINT', 'KG_MOBILIANS', 'HANPASS', 'FINSHOT', 'BIZPLAY', 'NICE', 'DANAL', 'SECTA', 'GME', 'LORD_SYSTEM', 'NAVERPAY', 'KAKAOPAY', 'KDBC', 'TEEN_CASH', 'EGG_MONEY', 'ON_CASH', 'GALAXIA_MONEY_TREE', 'FIRFIN']], excludes_from_remainders: list[Literal['KOREA_DEVELOPMENT_BANK', 'KFCC', 'SHINHYUP', 'EPOST', 'SAVINGS_BANK_KOREA', 'KAKAO_BANK', 'K_BANK', 'TOSS_BANK', 'WOORI_CARD', 'BC_CARD', 'GWANGJU_CARD', 'SAMSUNG_CARD', 'SHINHAN_CARD', 'HYUNDAI_CARD', 'LOTTE_CARD', 'SUHYUP_CARD', 'CITI_CARD', 'NH_CARD', 'JEONBUK_CARD', 'JEJU_CARD', 'HANA_CARD', 'KOOKMIN_CARD', 'UNIDENTIFIED_GLOBAL_CARD', 'CHAI_CARD', 'AMEX_CARD', 'MIR_CARD', 'UNION_CARD', 'JCB_CARD', 'VISA_CARD', 'MASTER_CARD', 'DINERS_CARD', 'DISCOVER_CARD', 'IBK', 'NH_BANK', 'DAEGU_CARD', 'BUSAN_CARD', 'SC_BANK', 'KYONGNAM_CARD', 'WOORI_BANK', 'CHINA_BANK', 'NFCF', 'KB_SECURITIES', 'YUANTA_SECURITIES', 'NH_SECURITIES', 'DB_SECURITIES', 'SK_SECURITIES', 'EUGENE_SECURITIES', 'KYOBO_SECURITIES', 'MIRAE_ASSET_SECURITIES', 'KOREA_SECURITIES', 'HANHWA_SECURITIES', 'SSG', 'KONA_I', 'CHAI', 'TOSS_CARD', 'PAYCO', 'GMONEY_TRANS', 'FINT', 'KG_MOBILIANS', 'HANPASS', 'FINSHOT', 'BIZPLAY', 'NICE', 'DANAL', 'SECTA', 'GME', 'LORD_SYSTEM', 'NAVERPAY', 'KAKAOPAY', 'KDBC', 'TEEN_CASH', 'EGG_MONEY', 'ON_CASH', 'GALAXIA_MONEY_TREE', 'FIRFIN']]) AnalyticsCardCompanyChart#

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

Parameters:
  • from (str) – 조회할 카드사별 결제 현황의 시작 시간

  • until (str) – 조회할 카드사별 결제 현황의 끝 시간

  • currency (Currency) –

    조회할 결제 통화

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

  • exclude_cancelled (bool) –

    결제취소건 제외 여부

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

  • time_granularity (AnalyticsTimeGranularity) –

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

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

  • card_companies (list[CardCompany]) – 조회할 카드사

  • excludes_from_remainders (list[CardCompany]) – 나머지 집계에 포함되지 않을 카드사

Raises:
  • ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우

  • InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

  • UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우

  • UnknownError – API 응답이 알 수 없는 형식인 경우

get_analytics_easy_pay_chart(*, from_: str, until: str, currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL'], exclude_cancelled: bool, time_granularity: AnalyticsTimeGranularity) AnalyticsEasyPayChart#

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

Parameters:
  • from (str) – 조회할 간편결제 현황의 시작 시간

  • until (str) – 조회할 간편결제 현황의 끝 시간

  • currency (Currency) –

    조회할 결제 통화

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

  • exclude_cancelled (bool) –

    결제취소건 제외 여부

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

  • time_granularity (AnalyticsTimeGranularity) –

    간편결제 현황 조회 단위

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

Raises:
  • ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우

  • InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

  • UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우

  • UnknownError – API 응답이 알 수 없는 형식인 경우

async get_analytics_easy_pay_chart_async(*, from_: str, until: str, currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL'], exclude_cancelled: bool, time_granularity: AnalyticsTimeGranularity) AnalyticsEasyPayChart#

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

Parameters:
  • from (str) – 조회할 간편결제 현황의 시작 시간

  • until (str) – 조회할 간편결제 현황의 끝 시간

  • currency (Currency) –

    조회할 결제 통화

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

  • exclude_cancelled (bool) –

    결제취소건 제외 여부

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

  • time_granularity (AnalyticsTimeGranularity) –

    간편결제 현황 조회 단위

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

Raises:
  • ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우

  • InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

  • UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우

  • UnknownError – API 응답이 알 수 없는 형식인 경우

get_analytics_easy_pay_provider_chart(*, from_: str, until: str, currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL'], exclude_cancelled: bool, time_granularity: AnalyticsTimeGranularity, easy_pay_providers: list[Literal['SAMSUNGPAY', 'KAKAOPAY', 'NAVERPAY', 'PAYCO', 'SSGPAY', 'CHAI', 'LPAY', 'KPAY', 'TOSSPAY', 'LGPAY', 'PINPAY', 'APPLEPAY', 'SKPAY', 'TOSS_BRANDPAY', 'KB_APP', 'ALIPAY', 'HYPHEN', 'TMONEY']], excludes_from_remainders: list[Literal['SAMSUNGPAY', 'KAKAOPAY', 'NAVERPAY', 'PAYCO', 'SSGPAY', 'CHAI', 'LPAY', 'KPAY', 'TOSSPAY', 'LGPAY', 'PINPAY', 'APPLEPAY', 'SKPAY', 'TOSS_BRANDPAY', 'KB_APP', 'ALIPAY', 'HYPHEN', 'TMONEY']]) AnalyticsEasyPayProviderChart#

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

Parameters:
  • from (str) – 조회할 간편결제사별 결제 현황의 시작 시간

  • until (str) – 조회할 간편결제사별 결제 현황의 끝 시간

  • currency (Currency) –

    조회할 결제 통화

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

  • exclude_cancelled (bool) –

    결제취소건 제외 여부

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

  • time_granularity (AnalyticsTimeGranularity) –

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

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

  • easy_pay_providers (list[EasyPayProvider]) – 조회할 간편결제사

  • excludes_from_remainders (list[EasyPayProvider]) – 나머지 집계에 포함되지 않을 간편결제사

Raises:
  • ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우

  • InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

  • UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우

  • UnknownError – API 응답이 알 수 없는 형식인 경우

async get_analytics_easy_pay_provider_chart_async(*, from_: str, until: str, currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL'], exclude_cancelled: bool, time_granularity: AnalyticsTimeGranularity, easy_pay_providers: list[Literal['SAMSUNGPAY', 'KAKAOPAY', 'NAVERPAY', 'PAYCO', 'SSGPAY', 'CHAI', 'LPAY', 'KPAY', 'TOSSPAY', 'LGPAY', 'PINPAY', 'APPLEPAY', 'SKPAY', 'TOSS_BRANDPAY', 'KB_APP', 'ALIPAY', 'HYPHEN', 'TMONEY']], excludes_from_remainders: list[Literal['SAMSUNGPAY', 'KAKAOPAY', 'NAVERPAY', 'PAYCO', 'SSGPAY', 'CHAI', 'LPAY', 'KPAY', 'TOSSPAY', 'LGPAY', 'PINPAY', 'APPLEPAY', 'SKPAY', 'TOSS_BRANDPAY', 'KB_APP', 'ALIPAY', 'HYPHEN', 'TMONEY']]) AnalyticsEasyPayProviderChart#

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

Parameters:
  • from (str) – 조회할 간편결제사별 결제 현황의 시작 시간

  • until (str) – 조회할 간편결제사별 결제 현황의 끝 시간

  • currency (Currency) –

    조회할 결제 통화

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

  • exclude_cancelled (bool) –

    결제취소건 제외 여부

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

  • time_granularity (AnalyticsTimeGranularity) –

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

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

  • easy_pay_providers (list[EasyPayProvider]) – 조회할 간편결제사

  • excludes_from_remainders (list[EasyPayProvider]) – 나머지 집계에 포함되지 않을 간편결제사

Raises:
  • ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우

  • InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

  • UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우

  • UnknownError – API 응답이 알 수 없는 형식인 경우

get_pg_company_chart(*, from_: str, until: str, currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL'], exclude_cancelled: bool) AnalyticsPgCompanyChart#

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

Parameters:
  • from (str) – 조회할 결제대행사 현황의 시작 시간

  • until (str) – 조회할 결제대행사 현황의 끝 시간

  • currency (Currency) –

    조회할 결제 통화

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

  • exclude_cancelled (bool) –

    결제취소건 제외 여부

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

Raises:
  • ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우

  • InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

  • UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우

  • UnknownError – API 응답이 알 수 없는 형식인 경우

async get_pg_company_chart_async(*, from_: str, until: str, currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL'], exclude_cancelled: bool) AnalyticsPgCompanyChart#

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

Parameters:
  • from (str) – 조회할 결제대행사 현황의 시작 시간

  • until (str) – 조회할 결제대행사 현황의 끝 시간

  • currency (Currency) –

    조회할 결제 통화

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

  • exclude_cancelled (bool) –

    결제취소건 제외 여부

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

Raises:
  • ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우

  • InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

  • UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우

  • UnknownError – API 응답이 알 수 없는 형식인 경우

get_pg_company_trend_chart(*, from_: str, until: str, currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL'], exclude_cancelled: bool, time_granularity: AnalyticsTimeGranularity, pg_companies: list[Literal['INICIS', 'NICE', 'KCP', 'DANAL', 'TOSSPAYMENTS', 'MOBILIANS', 'KICC', 'SMARTRO', 'DAOU', 'BLUEWALNUT', 'PAYPAL', 'ALIPAY', 'EXIMBAY', 'PAYMENTWALL', 'SETTLE', 'GALAXIA', 'NAVERPAY', 'KAKAOPAY', 'SMILEPAY', 'KAKAO', 'TOSSPAY', 'CHAI', 'PAYCO', 'PAYPLE', 'SYRUP', 'KSNET', 'WELCOME', 'JTNET', 'KPN', 'HYPHEN']]) AnalyticsPgCompanyTrendChart#

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

Parameters:
  • from (str) – 조회할 결제대행사별 거래 추이의 시작 시간

  • until (str) – 조회할 결제대행사별 거래 추이의 끝 시간

  • currency (Currency) –

    조회할 결제 통화

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

  • exclude_cancelled (bool) –

    결제취소건 제외 여부

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

  • time_granularity (AnalyticsTimeGranularity) –

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

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

  • pg_companies (list[PgCompany]) – 조회할 결제대행사

Raises:
  • ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우

  • InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

  • UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우

  • UnknownError – API 응답이 알 수 없는 형식인 경우

async get_pg_company_trend_chart_async(*, from_: str, until: str, currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL'], exclude_cancelled: bool, time_granularity: AnalyticsTimeGranularity, pg_companies: list[Literal['INICIS', 'NICE', 'KCP', 'DANAL', 'TOSSPAYMENTS', 'MOBILIANS', 'KICC', 'SMARTRO', 'DAOU', 'BLUEWALNUT', 'PAYPAL', 'ALIPAY', 'EXIMBAY', 'PAYMENTWALL', 'SETTLE', 'GALAXIA', 'NAVERPAY', 'KAKAOPAY', 'SMILEPAY', 'KAKAO', 'TOSSPAY', 'CHAI', 'PAYCO', 'PAYPLE', 'SYRUP', 'KSNET', 'WELCOME', 'JTNET', 'KPN', 'HYPHEN']]) AnalyticsPgCompanyTrendChart#

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

Parameters:
  • from (str) – 조회할 결제대행사별 거래 추이의 시작 시간

  • until (str) – 조회할 결제대행사별 거래 추이의 끝 시간

  • currency (Currency) –

    조회할 결제 통화

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

  • exclude_cancelled (bool) –

    결제취소건 제외 여부

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

  • time_granularity (AnalyticsTimeGranularity) –

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

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

  • pg_companies (list[PgCompany]) – 조회할 결제대행사

Raises:
  • ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우

  • InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

  • UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우

  • UnknownError – API 응답이 알 수 없는 형식인 경우

get_analytics_overseas_payment_usage() AnalyticsOverseasPaymentUsage#

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

Raises:
  • ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우

  • UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우

  • UnknownError – API 응답이 알 수 없는 형식인 경우

async get_analytics_overseas_payment_usage_async() AnalyticsOverseasPaymentUsage#

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

Raises:
  • ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우

  • UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우

  • UnknownError – API 응답이 알 수 없는 형식인 경우

get_analytics_cancellation_rate(*, from_: str, until: str, currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL']) AnalyticsCancellationRate#

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

Parameters:
  • from (str) – 환불율 조회 기간의 시작 시간

  • until (str) – 환불율 조회 기간의 끝 시간

  • currency (Currency) –

    조회할 결제 통화

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

Raises:
  • ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우

  • InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

  • UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우

  • UnknownError – API 응답이 알 수 없는 형식인 경우

async get_analytics_cancellation_rate_async(*, from_: str, until: str, currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL']) AnalyticsCancellationRate#

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

Parameters:
  • from (str) – 환불율 조회 기간의 시작 시간

  • until (str) – 환불율 조회 기간의 끝 시간

  • currency (Currency) –

    조회할 결제 통화

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

Raises:
  • ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우

  • InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

  • UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우

  • UnknownError – API 응답이 알 수 없는 형식인 경우

get_payment_status_chart(*, from_: str, until: str, currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL']) AnalyticsPaymentStatusChart#

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

Parameters:
  • from (str) – 조회할 결제 현황의 시작 시간

  • until (str) – 조회할 결제 현황의 끝 시간

  • currency (Currency) –

    조회할 결제 통화

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

Raises:
  • ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우

  • InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

  • UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우

  • UnknownError – API 응답이 알 수 없는 형식인 경우

async get_payment_status_chart_async(*, from_: str, until: str, currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL']) AnalyticsPaymentStatusChart#

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

Parameters:
  • from (str) – 조회할 결제 현황의 시작 시간

  • until (str) – 조회할 결제 현황의 끝 시간

  • currency (Currency) –

    조회할 결제 통화

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

Raises:
  • ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우

  • InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

  • UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우

  • UnknownError – API 응답이 알 수 없는 형식인 경우

get_payment_status_by_payment_method_chart(*, from_: str, until: str, currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL']) AnalyticsPaymentStatusByPaymentMethodChart#

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

Parameters:
  • from (str) – 조회할 결제 현황의 시작 시간

  • until (str) – 조회할 결제 현황의 끝 시간

  • currency (Currency) –

    조회할 결제 통화

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

Raises:
  • ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우

  • InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

  • UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우

  • UnknownError – API 응답이 알 수 없는 형식인 경우

async get_payment_status_by_payment_method_chart_async(*, from_: str, until: str, currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL']) AnalyticsPaymentStatusByPaymentMethodChart#

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

Parameters:
  • from (str) – 조회할 결제 현황의 시작 시간

  • until (str) – 조회할 결제 현황의 끝 시간

  • currency (Currency) –

    조회할 결제 통화

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

Raises:
  • ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우

  • InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

  • UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우

  • UnknownError – API 응답이 알 수 없는 형식인 경우

get_payment_status_by_pg_company_chart(*, from_: str, until: str, currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL']) AnalyticsPaymentStatusByPgCompanyChart#

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

Parameters:
  • from (str) – 조회할 결제 현황의 시작 시간

  • until (str) – 조회할 결제 현황의 끝 시간

  • currency (Currency) –

    조회할 결제 통화

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

Raises:
  • ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우

  • InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

  • UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우

  • UnknownError – API 응답이 알 수 없는 형식인 경우

async get_payment_status_by_pg_company_chart_async(*, from_: str, until: str, currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL']) AnalyticsPaymentStatusByPgCompanyChart#

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

Parameters:
  • from (str) – 조회할 결제 현황의 시작 시간

  • until (str) – 조회할 결제 현황의 끝 시간

  • currency (Currency) –

    조회할 결제 통화

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

Raises:
  • ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우

  • InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

  • UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우

  • UnknownError – API 응답이 알 수 없는 형식인 경우

get_payment_status_by_payment_client_chart(*, from_: str, until: str, currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL']) AnalyticsPaymentStatusByPaymentClientChart#

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

Parameters:
  • from (str) – 조회할 결제 현황의 시작 시간

  • until (str) – 조회할 결제 현황의 끝 시간

  • currency (Currency) –

    조회할 결제 통화

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

Raises:
  • ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우

  • InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

  • UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우

  • UnknownError – API 응답이 알 수 없는 형식인 경우

async get_payment_status_by_payment_client_chart_async(*, from_: str, until: str, currency: Literal['KRW', 'USD', 'JPY', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF', 'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRU', 'MUR', 'MVR', 'MWK', 'MXN', 'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLE', 'SLL', 'SOS', 'SRD', 'SSP', 'STN', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USN', 'UYI', 'UYU', 'UYW', 'UZS', 'VED', 'VES', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA', 'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XOF', 'XPD', 'XPF', 'XPT', 'XSU', 'XTS', 'XUA', 'XXX', 'YER', 'ZAR', 'ZMW', 'ZWL']) AnalyticsPaymentStatusByPaymentClientChart#

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

Parameters:
  • from (str) – 조회할 결제 현황의 시작 시간

  • until (str) – 조회할 결제 현황의 끝 시간

  • currency (Currency) –

    조회할 결제 통화

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

Raises:
  • ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우

  • InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

  • UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우

  • UnknownError – API 응답이 알 수 없는 형식인 경우