portone_server_sdk.payment.billing_key

portone_server_sdk.payment.billing_key#

Classes

`BillingKeyFailure`	발급 실패 상세 정보
`BillingKeyFilterInput`	빌링키 다건 조회를 위한 입력 정보
`BillingKeyInfoSummary`
`BillingKeyPaymentMethodCard`	카드 정보
`BillingKeyPaymentMethodEasyPay`	간편 결제 정보
`BillingKeyPaymentMethodEasyPayCharge`	충전식 포인트 결제 정보
`BillingKeyPaymentMethodMobile`	모바일 정보
`BillingKeyPaymentMethodPaypal`	페이팔 정보
`BillingKeyPaymentMethodTransfer`	계좌이체 정보
`BillingKeySortInput`	빌링키 다건 조회 시 정렬 조건
`BillingKeyTextSearch`	통합검색 입력 정보
`ChannelSpecificFailureInvalidRequest`	요청된 입력 정보가 유효하지 않은 경우
`ChannelSpecificFailurePgProvider`	PG사에서 오류를 전달한 경우
`DeleteBillingKeyResponse`	빌링키 삭제 성공 응답
`DeletedBillingKeyInfo`	빌링키 삭제 완료 상태 건
`FailedPgBillingKeyIssueResponse`	빌링키 발급 실패 채널 응답
`GetBillingKeyInfosBody`	빌링키 다건 조회를 위한 입력 정보
`GetBillingKeyInfosResponse`	빌링키 다건 조회 성공 응답 정보
`InstantBillingKeyPaymentMethodInput`	빌링키 발급 시 결제 수단 입력 양식
`InstantBillingKeyPaymentMethodInputCard`	카드 수단 정보 입력 양식
`IssueBillingKeyBody`	빌링키 발급 요청 양식
`IssueBillingKeyResponse`	빌링키 발급 성공 응답
`IssuedBillingKeyInfo`	빌링키 발급 완료 상태 건
`IssuedPgBillingKeyIssueResponse`	빌링키 발급 성공 채널 응답
`BillingKeyClient`

class portone_server_sdk.payment.billing_key.BillingKeyFailure#

발급 실패 상세 정보

failed_at: str#: 실패 시점 (RFC 3339 date-time)

message: str | None#: 실패 사유

pg_code: str | None#: PG사 실패 코드

pg_message: str | None#: PG사 실패 사유

class portone_server_sdk.payment.billing_key.BillingKeyFilterInput#

빌링키 다건 조회를 위한 입력 정보

store_id: str | None#

상점 아이디

Merchant 사용자만 사용가능하며, 지정되지 않은 경우 고객사 전체 빌링키를 조회합니다.

time_range_field: Literal['REQUESTED_AT', 'ISSUED_AT', 'DELETED_AT', 'STATUS_TIMESTAMP'] | None#: 조회 기준 시점 유형

from_: str | None#

조회 기준 시점 범위의 시작

값을 입력하지 않으면 end의 90일 전으로 설정됩니다. (RFC 3339 date-time)

until: str | None#

조회 기준 시점 범위의 끝

값을 입력하지 않으면 현재 시점으로 설정됩니다. (RFC 3339 date-time)

status: list[Literal['ISSUED', 'DELETED']] | None#

빌링키 상태 리스트

값을 입력하지 않으면 빌링키 상태 필터링이 적용되지 않습니다.

channel_group_ids: list[str] | None#

채널 그룹 아이디 리스트

값을 입력하지 않으면 스마트 라우팅 그룹 아이디 필터링이 적용되지 않습니다.

customer_id: str | None#: 고객 ID

platform_type: Literal['SDK_MOBILE', 'SDK_PC', 'API'] | None#: 플랫폼 유형

text_search: BillingKeyTextSearch | None#: 통합 검색 필터

pg_providers: list[Literal['HTML5_INICIS', 'PAYPAL', 'PAYPAL_V2', 'INICIS', 'DANAL', 'NICE', 'DANAL_TPAY', 'JTNET', 'UPLUS', 'NAVERPAY', 'KAKAO', 'SETTLE', 'KCP', 'MOBILIANS', 'KAKAOPAY', 'NAVERCO', 'SYRUP', 'KICC', 'EXIMBAY', 'SMILEPAY', 'PAYCO', 'KCP_BILLING', 'ALIPAY', 'PAYPLE', 'CHAI', 'BLUEWALNUT', 'SMARTRO', 'SMARTRO_V2', 'PAYMENTWALL', 'TOSSPAYMENTS', 'KCP_QUICK', 'DAOU', 'GALAXIA', 'TOSSPAY', 'KCP_DIRECT', 'SETTLE_ACC', 'SETTLE_FIRM', 'INICIS_UNIFIED', 'KSNET', 'PINPAY', 'NICE_V2', 'TOSS_BRANDPAY', 'WELCOME', 'TOSSPAY_V2', 'INICIS_V2', 'KPN', 'KCP_V2', 'HYPHEN']] | None#

PG사 결제 모듈 리스트

값을 입력하지 않으면 PG사 결제 모듈 필터링이 적용되지 않습니다.

pg_companies: list[Literal['INICIS', 'NICE', 'KCP', 'DANAL', 'TOSSPAYMENTS', 'MOBILIANS', 'KICC', 'SMARTRO', 'DAOU', 'BLUEWALNUT', 'PAYPAL', 'ALIPAY', 'EXIMBAY', 'PAYMENTWALL', 'SETTLE', 'GALAXIA', 'NAVERPAY', 'KAKAOPAY', 'SMILEPAY', 'KAKAO', 'TOSSPAY', 'CHAI', 'PAYCO', 'PAYPLE', 'SYRUP', 'KSNET', 'WELCOME', 'JTNET', 'KPN', 'HYPHEN']] | None#

PG사 리스트

값을 입력하지 않으면 PG사 필터링이 적용되지 않습니다.

methods: list[Literal['CARD', 'MOBILE', 'EASY_PAY', 'TRANSFER']] | None#

결제수단 리스트

값을 입력하지 않으면 결제수단 필터링이 적용되지 않습니다.

version: Literal['V1', 'V2'] | None#: 포트원 버전

class portone_server_sdk.payment.billing_key.BillingKeyInfoSummary#

billing_key: str#: 발급된 빌링키

issued_at: str#: 빌링크 발급 완료 시점 (RFC 3339 date-time)

channels: list[SelectedChannel] | None#: 발급된 채널

class portone_server_sdk.payment.billing_key.BillingKeyPaymentMethodCard#

카드 정보

type: Literal['BillingKeyPaymentMethodCard']#

card: Card | None#: 카드 상세 정보

class portone_server_sdk.payment.billing_key.BillingKeyPaymentMethodEasyPay#

간편 결제 정보

type: Literal['BillingKeyPaymentMethodEasyPay']#

provider: Literal['SAMSUNGPAY', 'KAKAOPAY', 'NAVERPAY', 'PAYCO', 'SSGPAY', 'CHAI', 'LPAY', 'KPAY', 'TOSSPAY', 'LGPAY', 'PINPAY', 'APPLEPAY', 'SKPAY', 'TOSS_BRANDPAY', 'KB_APP', 'ALIPAY', 'HYPHEN', 'TMONEY'] | None#: 간편 결제 PG사

method: BillingKeyPaymentMethodCard | BillingKeyPaymentMethodEasyPayCharge | BillingKeyPaymentMethodTransfer | None#: 간편 결제 수단

class portone_server_sdk.payment.billing_key.BillingKeyPaymentMethodEasyPayCharge#

충전식 포인트 결제 정보

type: Literal['BillingKeyPaymentMethodEasyPayCharge']#

class portone_server_sdk.payment.billing_key.BillingKeyPaymentMethodMobile#

모바일 정보

type: Literal['BillingKeyPaymentMethodMobile']#

phone_number: str | None#: 전화번호

class portone_server_sdk.payment.billing_key.BillingKeyPaymentMethodPaypal#

페이팔 정보

type: Literal['BillingKeyPaymentMethodPaypal']#

class portone_server_sdk.payment.billing_key.BillingKeyPaymentMethodTransfer#

계좌이체 정보

type: Literal['BillingKeyPaymentMethodTransfer']#

bank: Literal['BANK_OF_KOREA', 'KDB', 'IBK', 'KOOKMIN', 'SUHYUP', 'KEXIM', 'NONGHYUP', 'LOCAL_NONGHYUP', 'WOORI', 'STANDARD_CHARTERED', 'CITI', 'DAEGU', 'BUSAN', 'KWANGJU', 'JEJU', 'JEONBUK', 'KYONGNAM', 'KFCC', 'SHINHYUP', 'SAVINGS_BANK', 'MORGAN_STANLEY', 'HSBC', 'DEUTSCHE', 'JPMC', 'MIZUHO', 'MUFG', 'BANK_OF_AMERICA', 'BNP_PARIBAS', 'ICBC', 'BANK_OF_CHINA', 'NFCF', 'UOB', 'BOCOM', 'CCB', 'POST', 'KODIT', 'KIBO', 'HANA', 'SHINHAN', 'K_BANK', 'KAKAO', 'TOSS', 'MISC_FOREIGN', 'SGI', 'KCIS', 'YUANTA_SECURITIES', 'KB_SECURITIES', 'SANGSANGIN_SECURITIES', 'HANYANG_SECURITIES', 'LEADING_SECURITIES', 'BNK_SECURITIES', 'IBK_SECURITIES', 'DAOL_SECURITIES', 'MIRAE_ASSET_SECURITIES', 'SAMSUNG_SECURITIES', 'KOREA_SECURITIES', 'NH_SECURITIES', 'KYOBO_SECURITIES', 'HI_SECURITIES', 'HYUNDAI_MOTOR_SECURITIES', 'KIWOOM_SECURITIES', 'EBEST_SECURITIES', 'SK_SECURITIES', 'DAISHIN_SECURITIES', 'HANHWA_SECURITIES', 'HANA_SECURITIES', 'TOSS_SECURITIES', 'SHINHAN_SECURITIES', 'DB_SECURITIES', 'EUGENE_SECURITIES', 'MERITZ_SECURITIES', 'KAKAO_PAY_SECURITIES', 'BOOKOOK_SECURITIES', 'SHINYOUNG_SECURITIES', 'CAPE_SECURITIES', 'KOREA_SECURITIES_FINANCE', 'KOREA_FOSS_SECURITIES', 'WOORI_INVESTMENT_BANK'] | None#: 표준 은행 코드

account_number: str | None#: 계좌번호

class portone_server_sdk.payment.billing_key.BillingKeySortInput#

빌링키 다건 조회 시 정렬 조건

by: Literal['REQUESTED_AT', 'ISSUED_AT', 'DELETED_AT', 'STATUS_TIMESTAMP'] | None#

정렬 기준 필드

어떤 필드를 기준으로 정렬할 지 결정합니다. 비워서 보낼 경우, REQUESTED_AT이 기본값으로 설정됩니다.

order: Literal['DESC', 'ASC'] | None#

정렬 순서

어떤 순서로 정렬할 지 결정합니다. 비워서 보낼 경우, DESC(내림차순)가 기본값으로 설정됩니다.

class portone_server_sdk.payment.billing_key.BillingKeyTextSearch#

통합검색 입력 정보

field: Literal['CARD_BIN', 'CARD_NUMBER', 'PG_MERCHANT_ID', 'CUSTOMER_NAME', 'CUSTOMER_EMAIL', 'CUSTOMER_PHONE_NUMBER', 'CUSTOMER_ADDRESS', 'CUSTOMER_ZIPCODE', 'USER_AGENT', 'BILLING_KEY', 'CHANNEL_GROUP_NAME']#

value: str#

class portone_server_sdk.payment.billing_key.ChannelSpecificFailureInvalidRequest#

요청된 입력 정보가 유효하지 않은 경우

허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

type: Literal['INVALID_REQUEST']#

channel: SelectedChannel#

message: str | None#

class portone_server_sdk.payment.billing_key.ChannelSpecificFailurePgProvider#

PG사에서 오류를 전달한 경우

type: Literal['PG_PROVIDER']#

channel: SelectedChannel#

pg_code: str#

pg_message: str#

message: str | None#

class portone_server_sdk.payment.billing_key.DeleteBillingKeyResponse#

빌링키 삭제 성공 응답

deleted_at: str#: 빌링키 삭제 완료 시점 (RFC 3339 date-time)

class portone_server_sdk.payment.billing_key.DeletedBillingKeyInfo#

빌링키 삭제 완료 상태 건

status: Literal['DELETED']#: 빌링키 상태

billing_key: str#: 빌링키

merchant_id: str#: 고객사 아이디

store_id: str#: 상점 아이디

channels: list[SelectedChannel]#

빌링키 발급 시 사용된 채널

추후 슈퍼빌링키 기능 제공 시 여러 채널 정보가 담길 수 있습니다.

customer: Customer#: 고객 정보

issued_at: str#: 발급 시점 (RFC 3339 date-time)

deleted_at: str#: 발급 삭제 시점 (RFC 3339 date-time)

빌링키 결제수단 상세 정보

추후 슈퍼빌링키 기능 제공 시 여러 결제수단 정보가 담길 수 있습니다.

custom_data: str | None#: 사용자 지정 데이터

issue_id: str | None#: 고객사가 채번하는 빌링키 발급 건 고유 아이디

issue_name: str | None#: 빌링키 발급 건 이름

requested_at: str | None#: 발급 요청 시점 (RFC 3339 date-time)

channel_group: ChannelGroupSummary | None#: 채널 그룹

pg_billing_key_issue_responses: list[FailedPgBillingKeyIssueResponse | IssuedPgBillingKeyIssueResponse] | None#

채널 별 빌링키 발급 응답

슈퍼빌링키의 경우, 빌링키 발급이 성공하더라도 일부 채널에 대한 발급은 실패할 수 있습니다.

class portone_server_sdk.payment.billing_key.FailedPgBillingKeyIssueResponse#

빌링키 발급 실패 채널 응답

type: Literal['FAILED']#

channel: SelectedChannel#

채널

빌링키 발급을 시도한 채널입니다.

failure: BillingKeyFailure#: 발급 실패 상세 정보

class portone_server_sdk.payment.billing_key.GetBillingKeyInfosBody#

빌링키 다건 조회를 위한 입력 정보

page: PageInput | None#

요청할 페이지 정보

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

sort: BillingKeySortInput | None#

정렬 조건

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

filter: BillingKeyFilterInput | None#

조회할 빌링키 조건 필터

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

class portone_server_sdk.payment.billing_key.GetBillingKeyInfosResponse#

빌링키 다건 조회 성공 응답 정보

items: list[DeletedBillingKeyInfo | IssuedBillingKeyInfo]#: 조회된 빌링키 리스트

page: PageInfo#: 조회된 페이지 정보

class portone_server_sdk.payment.billing_key.InstantBillingKeyPaymentMethodInput#

빌링키 발급 시 결제 수단 입력 양식

card: InstantBillingKeyPaymentMethodInputCard | None#

class portone_server_sdk.payment.billing_key.InstantBillingKeyPaymentMethodInputCard#

카드 수단 정보 입력 양식

credential: CardCredential#

class portone_server_sdk.payment.billing_key.IssueBillingKeyBody#

빌링키 발급 요청 양식

method: InstantBillingKeyPaymentMethodInput#: 빌링키 결제 수단 정보

store_id: str | None#

상점 아이디

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 토큰에 담긴 상점 아이디를 사용합니다.

channel_key: str | None#

채널 키

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

channel_group_id: str | None#

채널 그룹 ID

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

customer: CustomerInput | None#: 고객 정보

custom_data: str | None#: 사용자 지정 데이터

bypass: dict | None#: PG사별 추가 파라미터 (“PG사별 연동 가이드” 참고)

notice_urls: list[str] | None#

웹훅 주소

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

class portone_server_sdk.payment.billing_key.IssueBillingKeyResponse#

빌링키 발급 성공 응답

billing_key_info: BillingKeyInfoSummary#: 빌링키 정보

channel_specific_failures: list[ChannelSpecificFailureInvalidRequest | ChannelSpecificFailurePgProvider] | None#: 발급에 실패한 채널이 있을시 실패 정보

class portone_server_sdk.payment.billing_key.IssuedBillingKeyInfo#

빌링키 발급 완료 상태 건

status: Literal['ISSUED']#: 빌링키 상태

billing_key: str#: 빌링키

merchant_id: str#: 고객사 아이디

store_id: str#: 상점 아이디

channels: list[SelectedChannel]#

빌링키 발급 시 사용된 채널

추후 슈퍼빌링키 기능 제공 시 여러 채널 정보가 담길 수 있습니다.

customer: Customer#: 고객 정보

issued_at: str#: 발급 시점 (RFC 3339 date-time)

빌링키 결제수단 상세 정보

추후 슈퍼빌링키 기능 제공 시 여러 결제수단 정보가 담길 수 있습니다.

custom_data: str | None#: 사용자 지정 데이터

issue_id: str | None#: 고객사가 채번하는 빌링키 발급 건 고유 아이디

issue_name: str | None#: 빌링키 발급 건 이름

requested_at: str | None#: 발급 요청 시점 (RFC 3339 date-time)

channel_group: ChannelGroupSummary | None#: 채널 그룹

pg_billing_key_issue_responses: list[FailedPgBillingKeyIssueResponse | IssuedPgBillingKeyIssueResponse] | None#

채널 별 빌링키 발급 응답

슈퍼빌링키의 경우, 빌링키 발급이 성공하더라도 일부 채널에 대한 빌링키 발급은 실패할 수 있습니다.

class portone_server_sdk.payment.billing_key.IssuedPgBillingKeyIssueResponse#

빌링키 발급 성공 채널 응답

type: Literal['ISSUED']#

channel: SelectedChannel#

채널

빌링키 발급을 시도한 채널입니다.

pg_tx_id: str | None#: PG사 거래 아이디

빌링키 결제수단 상세 정보

채널에 대응되는 PG사에서 응답한 빌링키 발급 수단 정보입니다.

class portone_server_sdk.payment.billing_key.BillingKeyClient#

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

빌링키 단건 조회

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

Parameters:

billing_key (str) – 조회할 빌링키

Raises:

BillingKeyNotFoundError – 빌링키가 존재하지 않는 경우 빌링키가 존재하지 않는 경우
ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

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

빌링키 단건 조회

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

Parameters:

billing_key (str) – 조회할 빌링키

Raises:

BillingKeyNotFoundError – 빌링키가 존재하지 않는 경우 빌링키가 존재하지 않는 경우
ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

delete_billing_key(*, billing_key: str) → DeleteBillingKeyResponse#

빌링키 삭제

빌링키를 삭제합니다.

Parameters:

billing_key (str) – 삭제할 빌링키

Raises:

BillingKeyAlreadyDeletedError – 빌링키가 이미 삭제된 경우 빌링키가 이미 삭제된 경우
BillingKeyNotFoundError – 빌링키가 존재하지 않는 경우 빌링키가 존재하지 않는 경우
BillingKeyNotIssuedError – BillingKeyNotIssuedError
ChannelSpecificError – 여러 채널을 지정한 요청에서, 채널 각각에서 오류가 발생한 경우 여러 채널을 지정한 요청에서, 채널 각각에서 오류가 발생한 경우
ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PaymentScheduleAlreadyExistsError – 결제 예약건이 이미 존재하는 경우 결제 예약건이 이미 존재하는 경우
PgProviderError – PG사에서 오류를 전달한 경우 PG사에서 오류를 전달한 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

async delete_billing_key_async(*, billing_key: str) → DeleteBillingKeyResponse#

빌링키 삭제

빌링키를 삭제합니다.

Parameters:

billing_key (str) – 삭제할 빌링키

Raises:

BillingKeyAlreadyDeletedError – 빌링키가 이미 삭제된 경우 빌링키가 이미 삭제된 경우
BillingKeyNotFoundError – 빌링키가 존재하지 않는 경우 빌링키가 존재하지 않는 경우
BillingKeyNotIssuedError – BillingKeyNotIssuedError
ChannelSpecificError – 여러 채널을 지정한 요청에서, 채널 각각에서 오류가 발생한 경우 여러 채널을 지정한 요청에서, 채널 각각에서 오류가 발생한 경우
ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PaymentScheduleAlreadyExistsError – 결제 예약건이 이미 존재하는 경우 결제 예약건이 이미 존재하는 경우
PgProviderError – PG사에서 오류를 전달한 경우 PG사에서 오류를 전달한 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

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:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – 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:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – 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, 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:

ChannelNotFoundError – 요청된 채널이 존재하지 않는 경우 요청된 채널이 존재하지 않는 경우
ChannelSpecificError – 여러 채널을 지정한 요청에서, 채널 각각에서 오류가 발생한 경우 여러 채널을 지정한 요청에서, 채널 각각에서 오류가 발생한 경우
ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PgProviderError – PG사에서 오류를 전달한 경우 PG사에서 오류를 전달한 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – 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, 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:

ChannelNotFoundError – 요청된 채널이 존재하지 않는 경우 요청된 채널이 존재하지 않는 경우
ChannelSpecificError – 여러 채널을 지정한 요청에서, 채널 각각에서 오류가 발생한 경우 여러 채널을 지정한 요청에서, 채널 각각에서 오류가 발생한 경우
ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PgProviderError – PG사에서 오류를 전달한 경우 PG사에서 오류를 전달한 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

portone_server_sdk.payment.billing_key

Contents

portone_server_sdk.payment.billing_key#