portone_server_sdk.PgSpecificClient#
- class portone_server_sdk.PgSpecificClient#
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_kakaopay_payment_order
(*, pg_tx_id, ...)카카오페이 주문 조회 API
get_kakaopay_payment_order_async
(*, ...)카카오페이 주문 조회 API
- get_kakaopay_payment_order(*, pg_tx_id: str, channel_key: str) GetKakaopayPaymentOrderResponse #
카카오페이 주문 조회 API
주어진 아이디에 대응되는 카카오페이 주문 건을 조회합니다. 해당 API 사용이 필요한 경우 포트원 기술지원팀으로 문의 주시길 바랍니다.
- Parameters:
pg_tx_id (
str
) – 카카오페이 주문 번호 (tid)channel_key (
str
) – 채널 키
- Raises:
GetKakaopayPaymentOrderError – API 호출이 실패한 경우
ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우
- async get_kakaopay_payment_order_async(*, pg_tx_id: str, channel_key: str) GetKakaopayPaymentOrderResponse #
카카오페이 주문 조회 API
주어진 아이디에 대응되는 카카오페이 주문 건을 조회합니다. 해당 API 사용이 필요한 경우 포트원 기술지원팀으로 문의 주시길 바랍니다.
- Parameters:
pg_tx_id (
str
) – 카카오페이 주문 번호 (tid)channel_key (
str
) – 채널 키
- Raises:
GetKakaopayPaymentOrderError – API 호출이 실패한 경우
ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우