portone_server_sdk.payment.promotion

portone_server_sdk.payment.promotion#

Classes

CardPromotion

카드 프로모션

Promotion

alias of CardPromotion

PromotionAmountDiscount

PromotionPercentDiscount

PromotionClient

class portone_server_sdk.payment.promotion.CardPromotion#

카드 프로모션

type: Literal['CARD']#

프로모션 유형

id: str#

프로모션 아이디

store_id: str#

상점 아이디

name: str#

프로모션 이름

discount_type: PromotionAmountDiscount | PromotionPercentDiscount#

할인 유형

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

금액 화폐

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

프로모션 카드사

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

프로모션 상태

created_at: str#

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

min_payment_amount: int | None#

최소 결제 금액 (int64)

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.PromotionAmountDiscount#
type: Literal['AMOUNT']#

프로모션 할인 유형

amount: int#

(int64)

class portone_server_sdk.payment.promotion.PromotionPercentDiscount#
type: Literal['PERCENT']#

프로모션 할인 유형

percent: int#

(int32)

class portone_server_sdk.payment.promotion.PromotionClient#
get_promotion(*, promotion_id: str) → CardPromotion#

프로모션 단건 조회

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

Parameters:

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

Raises:

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

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

  • PromotionNotFoundError – 프로모션이 존재하지 않는 경우 프로모션이 존재하지 않는 경우

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

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

async get_promotion_async(*, promotion_id: str) → CardPromotion#

프로모션 단건 조회

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

Parameters:

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

Raises:

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

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

  • PromotionNotFoundError – 프로모션이 존재하지 않는 경우 프로모션이 존재하지 않는 경우

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

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

Contents