portone_server_sdk.payment.promotion

Classes

CardPromotion	카드 프로모션
Promotion	alias of CardPromotion
PromotionAmountDiscountScheme	프로모션 할인 유형
PromotionDiscountPartition	금액 구간별 프로모션 할인 정책
PromotionDiscountPolicy	프로모션 할인 정책
PromotionPercentDiscountScheme	프로모션 할인 유형
PromotionRecoverOptionNoRecover	결제 취소 시 프로모션 예산 미복구
PromotionRecoverOptionRecover	결제 취소 시 프로모션 예산 복구
PromotionSpareBudgetAmount	환불 대비용 프로모션 추가 예산
PromotionSpareBudgetPercent	환불 대비용 프로모션 추가 예산
PromotionClient

Exceptions

GetPromotionError

exception portone_server_sdk.payment.promotion.GetPromotionError

Bases: PortOneError

args

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

message: str | None

class portone_server_sdk.payment.promotion.CardPromotion

Bases: object

카드 프로모션

id: str

프로모션 아이디

store_id: str

상점 아이디

name: str

프로모션 이름

discount_policy: PromotionDiscountPolicy

할인 정책

total_budget: int

총 예산 (int64)

spent_amount: int

소진 금액 (int64)

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'] | str

금액 화폐

start_at: str

프로모션 시작 시각 (RFC 3339 date-time)

end_at: str

프로모션 종료 시각 (RFC 3339 date-time)

card_company: Literal['WOORI_CARD', 'BC_CARD', 'SAMSUNG_CARD', 'SHINHAN_CARD', 'HYUNDAI_CARD', 'LOTTE_CARD', 'NH_CARD', 'HANA_CARD', 'KOOKMIN_CARD'] | str

프로모션 카드사

status: Literal['SCHEDULED', 'IN_PROGRESS', 'PAUSED', 'BUDGET_EXHAUSTED', 'TERMINATED', 'COMPLETED'] | str

프로모션 상태

created_at: str

프로모션 생성 시각 (RFC 3339 date-time)

recover_option: PromotionRecoverOptionNoRecover | PromotionRecoverOptionRecover | dict

결제 취소 시 프로모션 예산 복구 옵션

max_discount_amount: int | None

최대 할인 금액 (int64)

terminated_at: str | None

프로모션 중단 시각 (RFC 3339 date-time)

portone_server_sdk.payment.promotion.Promotion

alias of CardPromotion

class portone_server_sdk.payment.promotion.PromotionAmountDiscountScheme

Bases: object

프로모션 할인 유형

amount: int

(int64)

class portone_server_sdk.payment.promotion.PromotionDiscountPartition

Bases: object

금액 구간별 프로모션 할인 정책

amount_from: int

(int64)

scheme: PromotionAmountDiscountScheme | PromotionPercentDiscountScheme | dict

class portone_server_sdk.payment.promotion.PromotionDiscountPolicy

Bases: object

프로모션 할인 정책

partitions: list[PromotionDiscountPartition]

금액 구간별 프로모션 할인 정책

class portone_server_sdk.payment.promotion.PromotionPercentDiscountScheme

Bases: object

프로모션 할인 유형

percent: int

(int32)

class portone_server_sdk.payment.promotion.PromotionRecoverOptionNoRecover

Bases: object

결제 취소 시 프로모션 예산 미복구

spare_budget: PromotionSpareBudgetAmount | PromotionSpareBudgetPercent | dict | None

class portone_server_sdk.payment.promotion.PromotionRecoverOptionRecover

Bases: object

결제 취소 시 프로모션 예산 복구

class portone_server_sdk.payment.promotion.PromotionSpareBudgetAmount

Bases: object

환불 대비용 프로모션 추가 예산

amount: int

(int64)

class portone_server_sdk.payment.promotion.PromotionSpareBudgetPercent

Bases: object

환불 대비용 프로모션 추가 예산

percent: int

(int32)

class portone_server_sdk.payment.promotion.PromotionClient

Bases: object

get_promotion(*, promotion_id: str) → CardPromotion

프로모션 단건 조회

주어진 아이디에 대응되는 프로모션을 조회합니다.

Parameters:

promotion_id (str) – 조회할 프로모션 아이디

Raises:

GetPromotionError –

async get_promotion_async(*, promotion_id: str) → CardPromotion

프로모션 단건 조회

주어진 아이디에 대응되는 프로모션을 조회합니다.

Parameters:

promotion_id (str) – 조회할 프로모션 아이디

Raises:

GetPromotionError –