portone_server_sdk.PgSpecificClient

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 클라이언트를 생성합니다.

confirm_paymentwall_delivery(*, ...[, ...])

페이먼트월 배송 정보 등록

confirm_paymentwall_delivery_async(*, ...[, ...])

페이먼트월 배송 정보 등록

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 응답을 받은 경우

confirm_paymentwall_delivery(*, transaction_id: str, delivery_type: Literal['PHYSICAL', 'DIGITAL'] | str, delivery_status: Literal['ORDER_PLACED', 'ORDER_SHIPPED', 'DELIVERED'] | str, estimated_delivery_datetime: str, estimated_update_datetime: str, reason: str | None = None, refundable: bool, details: str, shipping_address_email: str, carrier_tracking_id: str | None = None, carrier_type: str | None = None, shipping_address_country: Literal['AD', 'AE', 'AF', 'AG', 'AI', 'AL', 'AM', 'AO', 'AQ', 'AR', 'AS', 'AT', 'AU', 'AW', 'AX', 'AZ', 'BA', 'BB', 'BD', 'BE', 'BF', 'BG', 'BH', 'BI', 'BJ', 'BL', 'BM', 'BN', 'BO', 'BQ', 'BR', 'BS', 'BT', 'BV', 'BW', 'BY', 'BZ', 'CA', 'CC', 'CD', 'CF', 'CG', 'CH', 'CI', 'CK', 'CL', 'CM', 'CN', 'CO', 'CR', 'CU', 'CV', 'CW', 'CX', 'CY', 'CZ', 'DE', 'DJ', 'DK', 'DM', 'DO', 'DZ', 'EC', 'EE', 'EG', 'EH', 'ER', 'ES', 'ET', 'FI', 'FJ', 'FK', 'FM', 'FO', 'FR', 'GA', 'GB', 'GD', 'GE', 'GF', 'GG', 'GH', 'GI', 'GL', 'GM', 'GN', 'GP', 'GQ', 'GR', 'GS', 'GT', 'GU', 'GW', 'GY', 'HK', 'HM', 'HN', 'HR', 'HT', 'HU', 'ID', 'IE', 'IL', 'IM', 'IN', 'IO', 'IQ', 'IR', 'IS', 'IT', 'JE', 'JM', 'JO', 'JP', 'KE', 'KG', 'KH', 'KI', 'KM', 'KN', 'KP', 'KR', 'KW', 'KY', 'KZ', 'LA', 'LB', 'LC', 'LI', 'LK', 'LR', 'LS', 'LT', 'LU', 'LV', 'LY', 'MA', 'MC', 'MD', 'ME', 'MF', 'MG', 'MH', 'MK', 'ML', 'MM', 'MN', 'MO', 'MP', 'MQ', 'MR', 'MS', 'MT', 'MU', 'MV', 'MW', 'MX', 'MY', 'MZ', 'NA', 'NC', 'NE', 'NF', 'NG', 'NI', 'NL', 'NO', 'NP', 'NR', 'NU', 'NZ', 'OM', 'PA', 'PE', 'PF', 'PG', 'PH', 'PK', 'PL', 'PM', 'PN', 'PR', 'PS', 'PT', 'PW', 'PY', 'QA', 'RE', 'RO', 'RS', 'RU', 'RW', 'SA', 'SB', 'SC', 'SD', 'SE', 'SG', 'SH', 'SI', 'SJ', 'SK', 'SL', 'SM', 'SN', 'SO', 'SR', 'SS', 'ST', 'SV', 'SX', 'SY', 'SZ', 'TC', 'TD', 'TF', 'TG', 'TH', 'TJ', 'TK', 'TL', 'TM', 'TN', 'TO', 'TR', 'TT', 'TV', 'TW', 'TZ', 'UA', 'UG', 'UM', 'US', 'UY', 'UZ', 'VA', 'VC', 'VE', 'VG', 'VI', 'VN', 'VU', 'WF', 'WS', 'YE', 'YT', 'ZA', 'ZM', 'ZW'] | str | None = None, shipping_address_city: str | None = None, shipping_address_zip: str | None = None, shipping_address_state: str | None = None, shipping_address_street: str | None = None, shipping_address_phone: str | None = None, shipping_address_firstname: str | None = None, shipping_address_lastname: str | None = None, attachments: list[str] | None = None) → ConfirmPaymentwallDeliveryResponse#

페이먼트월 배송 정보 등록

배송 정보를 페이먼트월에 등록합니다. 등록된 배송 정보는 차지백 발생 시 고객사의 상품 배송 완료 증빙 자료로 활용되므로, 반드시 연동해야 합니다.

Parameters:

  • transaction_id (str) – 결제 건 포트원 채번 아이디

  • delivery_type (PaymentwallDeliveryType) – 배송 유형

  • delivery_status (PaymentwallDeliveryStatus) – 배송 상태

  • estimated_delivery_datetime (str) –

    배송 완료 예상 일시

    배송 유형이 DIGITAL인 경우 현재 시각을 입력해도 무방합니다. (RFC 3339 date-time)

  • estimated_update_datetime (str) –

    배송 상태 업데이트 예정 일시

    배송 유형이 DIGITAL인 경우 현재 시각을 입력해도 무방합니다. (RFC 3339 date-time)

  • reason (str, optional) – 상태 변경 사유

  • refundable (bool) – 환불 가능 여부

  • details (str) – 상세 설명

  • shipping_address_email (str) – 고객 이메일 주소

  • carrier_tracking_id (str, optional) –

    운송장 번호

    배송 유형이 PHYSICAL인 경우 필수입니다.

  • carrier_type (str, optional) –

    운송사 이름

    배송 유형이 PHYSICAL인 경우 필수입니다.

  • shipping_address_country (Country, optional) –

    수신자 국가

    배송 유형이 PHYSICAL인 경우 필수입니다.

  • shipping_address_city (str, optional) –

    수신자 도시

    배송 유형이 PHYSICAL인 경우 필수입니다.

  • shipping_address_zip (str, optional) –

    수신자 우편번호

    배송 유형이 PHYSICAL인 경우 필수입니다.

  • shipping_address_state (str, optional) –

    수신자 주

    배송 유형이 PHYSICAL인 경우 필수입니다.

  • shipping_address_street (str, optional) –

    수신자 도로명 주소

    배송 유형이 PHYSICAL인 경우 필수입니다.

  • shipping_address_phone (str, optional) –

    수신자 전화번호

    배송 유형이 PHYSICAL인 경우 필수입니다.

  • shipping_address_firstname (str, optional) –

    수신자 이름

    배송 유형이 PHYSICAL인 경우 필수입니다.

  • shipping_address_lastname (str, optional) –

    수신자 성

    배송 유형이 PHYSICAL인 경우 필수입니다.

  • attachments (list[str], optional) –

    배송 증빙 첨부 파일 URL 목록

    배송 증빙 자료의 URL(이미지 등)을 입력합니다. 증빙 자료를 제공하기 어려운 경우 생략할 수 있습니다.

Raises:

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

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

async confirm_paymentwall_delivery_async(*, transaction_id: str, delivery_type: Literal['PHYSICAL', 'DIGITAL'] | str, delivery_status: Literal['ORDER_PLACED', 'ORDER_SHIPPED', 'DELIVERED'] | str, estimated_delivery_datetime: str, estimated_update_datetime: str, reason: str | None = None, refundable: bool, details: str, shipping_address_email: str, carrier_tracking_id: str | None = None, carrier_type: str | None = None, shipping_address_country: Literal['AD', 'AE', 'AF', 'AG', 'AI', 'AL', 'AM', 'AO', 'AQ', 'AR', 'AS', 'AT', 'AU', 'AW', 'AX', 'AZ', 'BA', 'BB', 'BD', 'BE', 'BF', 'BG', 'BH', 'BI', 'BJ', 'BL', 'BM', 'BN', 'BO', 'BQ', 'BR', 'BS', 'BT', 'BV', 'BW', 'BY', 'BZ', 'CA', 'CC', 'CD', 'CF', 'CG', 'CH', 'CI', 'CK', 'CL', 'CM', 'CN', 'CO', 'CR', 'CU', 'CV', 'CW', 'CX', 'CY', 'CZ', 'DE', 'DJ', 'DK', 'DM', 'DO', 'DZ', 'EC', 'EE', 'EG', 'EH', 'ER', 'ES', 'ET', 'FI', 'FJ', 'FK', 'FM', 'FO', 'FR', 'GA', 'GB', 'GD', 'GE', 'GF', 'GG', 'GH', 'GI', 'GL', 'GM', 'GN', 'GP', 'GQ', 'GR', 'GS', 'GT', 'GU', 'GW', 'GY', 'HK', 'HM', 'HN', 'HR', 'HT', 'HU', 'ID', 'IE', 'IL', 'IM', 'IN', 'IO', 'IQ', 'IR', 'IS', 'IT', 'JE', 'JM', 'JO', 'JP', 'KE', 'KG', 'KH', 'KI', 'KM', 'KN', 'KP', 'KR', 'KW', 'KY', 'KZ', 'LA', 'LB', 'LC', 'LI', 'LK', 'LR', 'LS', 'LT', 'LU', 'LV', 'LY', 'MA', 'MC', 'MD', 'ME', 'MF', 'MG', 'MH', 'MK', 'ML', 'MM', 'MN', 'MO', 'MP', 'MQ', 'MR', 'MS', 'MT', 'MU', 'MV', 'MW', 'MX', 'MY', 'MZ', 'NA', 'NC', 'NE', 'NF', 'NG', 'NI', 'NL', 'NO', 'NP', 'NR', 'NU', 'NZ', 'OM', 'PA', 'PE', 'PF', 'PG', 'PH', 'PK', 'PL', 'PM', 'PN', 'PR', 'PS', 'PT', 'PW', 'PY', 'QA', 'RE', 'RO', 'RS', 'RU', 'RW', 'SA', 'SB', 'SC', 'SD', 'SE', 'SG', 'SH', 'SI', 'SJ', 'SK', 'SL', 'SM', 'SN', 'SO', 'SR', 'SS', 'ST', 'SV', 'SX', 'SY', 'SZ', 'TC', 'TD', 'TF', 'TG', 'TH', 'TJ', 'TK', 'TL', 'TM', 'TN', 'TO', 'TR', 'TT', 'TV', 'TW', 'TZ', 'UA', 'UG', 'UM', 'US', 'UY', 'UZ', 'VA', 'VC', 'VE', 'VG', 'VI', 'VN', 'VU', 'WF', 'WS', 'YE', 'YT', 'ZA', 'ZM', 'ZW'] | str | None = None, shipping_address_city: str | None = None, shipping_address_zip: str | None = None, shipping_address_state: str | None = None, shipping_address_street: str | None = None, shipping_address_phone: str | None = None, shipping_address_firstname: str | None = None, shipping_address_lastname: str | None = None, attachments: list[str] | None = None) → ConfirmPaymentwallDeliveryResponse#

페이먼트월 배송 정보 등록

배송 정보를 페이먼트월에 등록합니다. 등록된 배송 정보는 차지백 발생 시 고객사의 상품 배송 완료 증빙 자료로 활용되므로, 반드시 연동해야 합니다.

Parameters:

  • transaction_id (str) – 결제 건 포트원 채번 아이디

  • delivery_type (PaymentwallDeliveryType) – 배송 유형

  • delivery_status (PaymentwallDeliveryStatus) – 배송 상태

  • estimated_delivery_datetime (str) –

    배송 완료 예상 일시

    배송 유형이 DIGITAL인 경우 현재 시각을 입력해도 무방합니다. (RFC 3339 date-time)

  • estimated_update_datetime (str) –

    배송 상태 업데이트 예정 일시

    배송 유형이 DIGITAL인 경우 현재 시각을 입력해도 무방합니다. (RFC 3339 date-time)

  • reason (str, optional) – 상태 변경 사유

  • refundable (bool) – 환불 가능 여부

  • details (str) – 상세 설명

  • shipping_address_email (str) – 고객 이메일 주소

  • carrier_tracking_id (str, optional) –

    운송장 번호

    배송 유형이 PHYSICAL인 경우 필수입니다.

  • carrier_type (str, optional) –

    운송사 이름

    배송 유형이 PHYSICAL인 경우 필수입니다.

  • shipping_address_country (Country, optional) –

    수신자 국가

    배송 유형이 PHYSICAL인 경우 필수입니다.

  • shipping_address_city (str, optional) –

    수신자 도시

    배송 유형이 PHYSICAL인 경우 필수입니다.

  • shipping_address_zip (str, optional) –

    수신자 우편번호

    배송 유형이 PHYSICAL인 경우 필수입니다.

  • shipping_address_state (str, optional) –

    수신자 주

    배송 유형이 PHYSICAL인 경우 필수입니다.

  • shipping_address_street (str, optional) –

    수신자 도로명 주소

    배송 유형이 PHYSICAL인 경우 필수입니다.

  • shipping_address_phone (str, optional) –

    수신자 전화번호

    배송 유형이 PHYSICAL인 경우 필수입니다.

  • shipping_address_firstname (str, optional) –

    수신자 이름

    배송 유형이 PHYSICAL인 경우 필수입니다.

  • shipping_address_lastname (str, optional) –

    수신자 성

    배송 유형이 PHYSICAL인 경우 필수입니다.

  • attachments (list[str], optional) –

    배송 증빙 첨부 파일 URL 목록

    배송 증빙 자료의 URL(이미지 등)을 입력합니다. 증빙 자료를 제공하기 어려운 경우 생략할 수 있습니다.

Raises:

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

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

Contents