portone_server_sdk.payment.additional_feature

portone_server_sdk.payment.additional_feature#

Classes

GetPgCardPromotionsResponse

PG사 카드 프로모션 조회 응답

PgCardPromotion

PG사 카드 프로모션

AdditionalFeatureClient

Exceptions

GetPgCardPromotionsError

exception portone_server_sdk.payment.additional_feature.GetPgCardPromotionsError#

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.additional_feature.GetPgCardPromotionsResponse#

Bases: object

PG사 카드 프로모션 조회 응답

promotions: list[PgCardPromotion] | None#

카드 프로모션 목록

class portone_server_sdk.payment.additional_feature.PgCardPromotion#

Bases: object

PG사 카드 프로모션

PG사에서 제공하는 카드 프로모션 정보입니다.

promotion_id: str#

프로모션 아이디

PG사에서 부여한 프로모션 식별자입니다.

card_company: Literal['KOREA_DEVELOPMENT_BANK', 'KFCC', 'SHINHYUP', 'EPOST', 'SAVINGS_BANK_KOREA', 'KAKAO_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', 'K_BANK', 'TOSS_BANK', 'MIRAE_ASSET_SECURITIES'] | str#

카드사

프로모션이 적용되는 카드사입니다.

discount_amount: int#

할인 금액

프로모션 적용 시 할인되는 금액입니다. (int64)

minimum_payment_amount: int#

최소 결제 금액

프로모션이 적용되기 위한 최소 결제 금액입니다. (int64)

class portone_server_sdk.payment.additional_feature.AdditionalFeatureClient#

Bases: object

get_pg_card_promotions(*, channel_key: str, amount: int, card_company: Literal['KOREA_DEVELOPMENT_BANK', 'KFCC', 'SHINHYUP', 'EPOST', 'SAVINGS_BANK_KOREA', 'KAKAO_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', 'K_BANK', 'TOSS_BANK', 'MIRAE_ASSET_SECURITIES'] | str | None = None) → GetPgCardPromotionsResponse#

PG사 카드 프로모션 조회 API

주어진 채널에 대해 PG사에서 제공하는 카드 프로모션 목록을 조회합니다. 해당 API는 현재 특정 PG사(KCP_V2)에 대해서만 지원되며, 지원 여부는 포트원 기술지원팀에 문의 부탁드립니다.

Parameters:

  • channel_key (str) –

    채널 키

    조회하고자 하는 채널의 키

  • amount (int) –

    결제 금액

    결제 금액입니다. 해당 결제 금액 기준 이용 가능한 프로모션 목록이 조회됩니다. (int64)

  • card_company (PgPromotionCardCompany, optional) –

    카드사 필터

    조회할 카드사입니다. 값을 입력하지 않으면 카드사 필터링이 적용되지 않습니다.

Raises:

  • GetPgCardPromotionsError – API 호출이 실패한 경우

  • ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

async get_pg_card_promotions_async(*, channel_key: str, amount: int, card_company: Literal['KOREA_DEVELOPMENT_BANK', 'KFCC', 'SHINHYUP', 'EPOST', 'SAVINGS_BANK_KOREA', 'KAKAO_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', 'K_BANK', 'TOSS_BANK', 'MIRAE_ASSET_SECURITIES'] | str | None = None) → GetPgCardPromotionsResponse#

PG사 카드 프로모션 조회 API

주어진 채널에 대해 PG사에서 제공하는 카드 프로모션 목록을 조회합니다. 해당 API는 현재 특정 PG사(KCP_V2)에 대해서만 지원되며, 지원 여부는 포트원 기술지원팀에 문의 부탁드립니다.

Parameters:

  • channel_key (str) –

    채널 키

    조회하고자 하는 채널의 키

  • amount (int) –

    결제 금액

    결제 금액입니다. 해당 결제 금액 기준 이용 가능한 프로모션 목록이 조회됩니다. (int64)

  • card_company (PgPromotionCardCompany, optional) –

    카드사 필터

    조회할 카드사입니다. 값을 입력하지 않으면 카드사 필터링이 적용되지 않습니다.

Raises:

  • GetPgCardPromotionsError – API 호출이 실패한 경우

  • ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

Contents