portone_server_sdk.AdditionalFeatureClient

portone_server_sdk.AdditionalFeatureClient#

class portone_server_sdk.AdditionalFeatureClient#

Bases: object

__init__(*, secret: str, base_url: str = 'https://api.portone.io', store_id: str | None = None)#

API Secret을 사용해 포트원 API 클라이언트를 생성합니다.

Parameters:

  • secret (str) – 포트원 API Secret입니다.

  • base_url (str, optional) – 포트원 REST API 주소입니다. 기본값은 `”https://api.portone.io”`입니다.

  • store_id – 하위 상점에 대해 기능을 사용할 때 필요한 하위 상점의 ID입니다.

Methods

__init__(*, secret[, base_url, store_id])

API Secret을 사용해 포트원 API 클라이언트를 생성합니다.

get_pg_card_promotions(*, channel_key, amount)

PG사 카드 프로모션 조회 API

get_pg_card_promotions_async(*, channel_key, ...)

PG사 카드 프로모션 조회 API
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