portone_server_sdk.BillingKeyClient

class portone_server_sdk.BillingKeyClient

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_billing_key(*, billing_issue_token)	빌링키 발급 수동 승인
confirm_billing_key_async(*, billing_issue_token)	빌링키 발급 수동 승인
confirm_billing_key_issue_and_pay(*, ...[, ...])	빌링키 발급 및 초회 결제 수동 승인
confirm_billing_key_issue_and_pay_async(*, ...)	빌링키 발급 및 초회 결제 수동 승인
delete_billing_key(*, billing_key[, reason, ...])	빌링키 삭제
delete_billing_key_async(*, billing_key[, ...])	빌링키 삭제
get_billing_key_info(*, billing_key)	빌링키 단건 조회
get_billing_key_info_async(*, billing_key)	빌링키 단건 조회
get_billing_key_infos(*[, page, sort, filter])	빌링키 다건 조회
get_billing_key_infos_async(*[, page, sort, ...])	빌링키 다건 조회
issue_billing_key(*, method[, channel_key, ...])	빌링키 발급
issue_billing_key_async(*, method[, ...])	빌링키 발급

get_billing_key_infos(*, page: PageInput | None = None, sort: BillingKeySortInput | None = None, filter: BillingKeyFilterInput | None = None) → GetBillingKeyInfosResponse

빌링키 다건 조회

주어진 조건에 맞는 빌링키들을 페이지 기반으로 조회합니다.

Parameters:

• page (PageInput, optional) –

  요청할 페이지 정보

  미 입력 시 number: 0, size: 10 으로 기본값이 적용됩니다.

• sort (BillingKeySortInput, optional) –

  정렬 조건

  미 입력 시 sortBy: TIME_TO_PAY, sortOrder: DESC 으로 기본값이 적용됩니다.

• filter (BillingKeyFilterInput, optional) –

  조회할 빌링키 조건 필터

  V1 빌링키 건의 경우 일부 필드에 대해 필터가 적용되지 않을 수 있습니다.

Raises:

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

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

async get_billing_key_infos_async(*, page: PageInput | None = None, sort: BillingKeySortInput | None = None, filter: BillingKeyFilterInput | None = None) → GetBillingKeyInfosResponse

빌링키 다건 조회

주어진 조건에 맞는 빌링키들을 페이지 기반으로 조회합니다.

Parameters:

• page (PageInput, optional) –

  요청할 페이지 정보

  미 입력 시 number: 0, size: 10 으로 기본값이 적용됩니다.

• sort (BillingKeySortInput, optional) –

  정렬 조건

  미 입력 시 sortBy: TIME_TO_PAY, sortOrder: DESC 으로 기본값이 적용됩니다.

• filter (BillingKeyFilterInput, optional) –

  조회할 빌링키 조건 필터

  V1 빌링키 건의 경우 일부 필드에 대해 필터가 적용되지 않을 수 있습니다.

Raises:

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

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

issue_billing_key(*, method: InstantBillingKeyPaymentMethodInput, channel_key: str | None = None, channel_group_id: str | None = None, customer: CustomerInput | None = None, custom_data: str | None = None, bypass: dict | None = None, notice_urls: list[str] | None = None) → IssueBillingKeyResponse

빌링키 발급

빌링키 발급을 요청합니다.

Parameters:

• method (InstantBillingKeyPaymentMethodInput) – 빌링키 결제 수단 정보

• channel_key (str, optional) –

  채널 키

  채널 키 또는 채널 그룹 ID 필수

• channel_group_id (str, optional) –

  채널 그룹 ID

  채널 키 또는 채널 그룹 ID 필수

• customer (CustomerInput, optional) – 고객 정보

• custom_data (str, optional) – 사용자 지정 데이터

• bypass (dict, optional) – PG사별 추가 파라미터 (“PG사별 연동 가이드” 참고)

• notice_urls (list[str], optional) –

  웹훅 주소

  빌링키 발급 시 요청을 받을 웹훅 주소입니다. 상점에 설정되어 있는 값보다 우선적으로 적용됩니다. 입력된 값이 없을 경우에는 빈 배열로 해석됩니다.

Raises:

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

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

async issue_billing_key_async(*, method: InstantBillingKeyPaymentMethodInput, channel_key: str | None = None, channel_group_id: str | None = None, customer: CustomerInput | None = None, custom_data: str | None = None, bypass: dict | None = None, notice_urls: list[str] | None = None) → IssueBillingKeyResponse

빌링키 발급

빌링키 발급을 요청합니다.

Parameters:

• method (InstantBillingKeyPaymentMethodInput) – 빌링키 결제 수단 정보

• channel_key (str, optional) –

  채널 키

  채널 키 또는 채널 그룹 ID 필수

• channel_group_id (str, optional) –

  채널 그룹 ID

  채널 키 또는 채널 그룹 ID 필수

• customer (CustomerInput, optional) – 고객 정보

• custom_data (str, optional) – 사용자 지정 데이터

• bypass (dict, optional) – PG사별 추가 파라미터 (“PG사별 연동 가이드” 참고)

• notice_urls (list[str], optional) –

  웹훅 주소

  빌링키 발급 시 요청을 받을 웹훅 주소입니다. 상점에 설정되어 있는 값보다 우선적으로 적용됩니다. 입력된 값이 없을 경우에는 빈 배열로 해석됩니다.

Raises:

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

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

confirm_billing_key(*, billing_issue_token: str, is_test: bool | None = None) → ConfirmedBillingKeySummary

빌링키 발급 수동 승인

수동 승인으로 설정된 빌링키 발급에 대해, 빌링키 발급을 완료 처리합니다.

Parameters:

• billing_issue_token (str) –

  빌링키 발급 토큰

  빌링키 발급 요청 완료 시 발급된 토큰입니다.

• is_test (bool, optional) –

  테스트 결제 여부

  검증용 파라미터로, 결제 건 테스트 여부와 일치하지 않을 경우 오류가 반환됩니다.

Raises:

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

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

async confirm_billing_key_async(*, billing_issue_token: str, is_test: bool | None = None) → ConfirmedBillingKeySummary

빌링키 발급 수동 승인

수동 승인으로 설정된 빌링키 발급에 대해, 빌링키 발급을 완료 처리합니다.

Parameters:

• billing_issue_token (str) –

  빌링키 발급 토큰

  빌링키 발급 요청 완료 시 발급된 토큰입니다.

• is_test (bool, optional) –

  테스트 결제 여부

  검증용 파라미터로, 결제 건 테스트 여부와 일치하지 않을 경우 오류가 반환됩니다.

Raises:

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

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

confirm_billing_key_issue_and_pay(*, billing_issue_token: str, payment_id: str | None = None, 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'] | str | None = None, total_amount: int | None = None, tax_free_amount: int | None = None, is_test: bool | None = None) → ConfirmedBillingKeyIssueAndPaySummary

빌링키 발급 및 초회 결제 수동 승인

수동 승인으로 설정된 빌링키 발급 및 초회 결제에 대해, 빌링키 발급과 결제를 완료 처리합니다.

Parameters:

• billing_issue_token (str) –

  빌링키 발급 토큰

  빌링키 발급 및 초회 결제 요청 완료 시 발급된 토큰입니다.

• payment_id (str, optional) –

  결제 건 아이디

  검증용 파라미터로, 결제 건 아이디와 일치하지 않을 경우 오류가 반환됩니다.

• currency (Currency, optional) –

  통화

  검증용 파라미터로, 결제 건 화폐와 일치하지 않을 경우 오류가 반환됩니다.

• total_amount (int, optional) –

  결제 금액

  검증용 파라미터로, 결제 건 총 금액과 일치하지 않을 경우 오류가 반환됩니다. (int64)

• tax_free_amount (int, optional) –

  면세 금액

  검증용 파라미터로, 결제 건 면세 금액과 일치하지 않을 경우 오류가 반환됩니다. (int64)

• is_test (bool, optional) –

  테스트 결제 여부

  검증용 파라미터로, 결제 건 테스트 여부와 일치하지 않을 경우 오류가 반환됩니다.

Raises:

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

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

async confirm_billing_key_issue_and_pay_async(*, billing_issue_token: str, payment_id: str | None = None, 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'] | str | None = None, total_amount: int | None = None, tax_free_amount: int | None = None, is_test: bool | None = None) → ConfirmedBillingKeyIssueAndPaySummary

빌링키 발급 및 초회 결제 수동 승인

수동 승인으로 설정된 빌링키 발급 및 초회 결제에 대해, 빌링키 발급과 결제를 완료 처리합니다.

Parameters:

• billing_issue_token (str) –

  빌링키 발급 토큰

  빌링키 발급 및 초회 결제 요청 완료 시 발급된 토큰입니다.

• payment_id (str, optional) –

  결제 건 아이디

  검증용 파라미터로, 결제 건 아이디와 일치하지 않을 경우 오류가 반환됩니다.

• currency (Currency, optional) –

  통화

  검증용 파라미터로, 결제 건 화폐와 일치하지 않을 경우 오류가 반환됩니다.

• total_amount (int, optional) –

  결제 금액

  검증용 파라미터로, 결제 건 총 금액과 일치하지 않을 경우 오류가 반환됩니다. (int64)

• tax_free_amount (int, optional) –

  면세 금액

  검증용 파라미터로, 결제 건 면세 금액과 일치하지 않을 경우 오류가 반환됩니다. (int64)

• is_test (bool, optional) –

  테스트 결제 여부

  검증용 파라미터로, 결제 건 테스트 여부와 일치하지 않을 경우 오류가 반환됩니다.

Raises:

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

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

get_billing_key_info(*, billing_key: str) → DeletedBillingKeyInfo | IssuedBillingKeyInfo | dict

빌링키 단건 조회

주어진 빌링키에 대응되는 빌링키 정보를 조회합니다.

Parameters:

billing_key (str) – 조회할 빌링키

Raises:

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

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

async get_billing_key_info_async(*, billing_key: str) → DeletedBillingKeyInfo | IssuedBillingKeyInfo | dict

빌링키 단건 조회

주어진 빌링키에 대응되는 빌링키 정보를 조회합니다.

Parameters:

billing_key (str) – 조회할 빌링키

Raises:

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

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

delete_billing_key(*, billing_key: str, reason: str | None = None, requester: Literal['CUSTOMER', 'ADMIN'] | str | None = None) → DeleteBillingKeyResponse

빌링키 삭제

빌링키를 삭제합니다.

Parameters:

• billing_key (str) – 삭제할 빌링키

• reason (str, optional) –

  사유

  네이버페이: 자동결제 해지 사유입니다. 명시가 필요합니다.

• requester (BillingKeyDeleteRequester, optional) –

  요청 주체

  네이버페이: 자동결제 해지 요청 주체입니다. 명시가 필요합니다.

Raises:

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

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

async delete_billing_key_async(*, billing_key: str, reason: str | None = None, requester: Literal['CUSTOMER', 'ADMIN'] | str | None = None) → DeleteBillingKeyResponse

빌링키 삭제

빌링키를 삭제합니다.

Parameters:

• billing_key (str) – 삭제할 빌링키

• reason (str, optional) –

  사유

  네이버페이: 자동결제 해지 사유입니다. 명시가 필요합니다.

• requester (BillingKeyDeleteRequester, optional) –

  요청 주체

  네이버페이: 자동결제 해지 요청 주체입니다. 명시가 필요합니다.

Raises:

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

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