portone_server_sdk.common#
Classes
빌링키 결제 요청 입력 정보 |
|
카드 상세 정보 |
|
카드 인증 관련 정보 |
|
현금영수증 입력 정보 |
|
채널 그룹 정보 |
|
고객 정보 |
|
고객 정보 입력 정보 |
|
고객 이름 입력 정보 |
|
고객 분리형 이름 |
|
시간 범위 |
|
한 줄 형식 주소 |
|
반환된 페이지 결과 정보 |
|
다건 조회 API 에 사용되는 페이지 입력 정보 |
|
금액 세부 입력 정보 |
|
상품 정보 |
|
(결제, 본인인증 등에) 선택된 채널 정보 |
|
분리 형식 주소 |
|
분리 형식 주소 입력 정보 |
- class portone_server_sdk.common.BillingKeyPaymentInput#
빌링키 결제 요청 입력 정보
- billing_key: str#
빌링키 결제에 사용할 빌링키
- order_name: str#
주문명
- amount: PaymentAmountInput#
결제 금액 세부 입력 정보
- 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']#
통화
- store_id: str | None#
상점 아이디
접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 토큰에 담긴 상점 아이디를 사용합니다.
- channel_key: str | None#
채널 키
다수 채널에 대해 발급된 빌링키에 대해, 결제 채널을 특정하고 싶을 때 명시
- customer: CustomerInput | None#
고객 정보
- custom_data: str | None#
사용자 지정 데이터
- installment_month: int | None#
할부 개월 수 (int32)
- use_free_interest_from_merchant: bool | None#
무이자 할부 이자를 고객사가 부담할지 여부
- use_card_point: bool | None#
카드 포인트 사용 여부
- cash_receipt: CashReceiptInput | None#
현금영수증 정보
- 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'] | None#
결제 국가
- notice_urls: list[str] | None#
웹훅 주소
결제 승인/실패 시 요청을 받을 웹훅 주소입니다. 상점에 설정되어 있는 값보다 우선적으로 적용됩니다. 입력된 값이 없을 경우에는 빈 배열로 해석됩니다.
- products: list[PaymentProduct] | None#
상품 정보
입력된 값이 없을 경우에는 빈 배열로 해석됩니다.
- product_count: int | None#
상품 개수 (int32)
- product_type: Literal['PHYSICAL', 'DIGITAL'] | None#
상품 유형
- shipping_address: SeparatedAddressInput | None#
배송지 주소
- promotion_id: str | None#
해당 결제에 적용할 프로모션 아이디
- bypass: dict | None#
PG사별 추가 파라미터 (“PG사별 연동 가이드” 참고)
- class portone_server_sdk.common.Card#
카드 상세 정보
- publisher: str | None#
발행사 코드
- issuer: str | None#
발급사 코드
- brand: Literal['LOCAL', 'MASTER', 'UNIONPAY', 'VISA', 'JCB', 'AMEX', 'DINERS'] | None#
카드 브랜드
- type: Literal['CREDIT', 'DEBIT', 'GIFT'] | None#
카드 유형
- owner_type: Literal['PERSONAL', 'CORPORATE'] | None#
카드 소유주 유형
- bin: str | None#
카드 번호 앞 6자리 또는 8자리의 BIN (Bank Identification Number)
- name: str | None#
카드 상품명
- number: str | None#
마스킹된 카드 번호
- class portone_server_sdk.common.CardCredential#
카드 인증 관련 정보
- number: str#
카드 번호 (숫자만)
- expiry_year: str#
유효 기간 만료 연도 (2자리)
- expiry_month: str#
유효 기간 만료 월 (2자리)
- birth_or_business_registration_number: str | None#
생년월일 (yyMMdd) 또는 사업자 등록 번호 (10자리, 숫자만)
- password_two_digits: str | None#
비밀번호 앞 2자리
- class portone_server_sdk.common.CashReceiptInput#
현금영수증 입력 정보
- type: Literal['PERSONAL', 'CORPORATE', 'NO_RECEIPT']#
현금영수증 유형
- customer_identity_number: str | None#
사용자 식별 번호
미발행 유형 선택 시 입력하지 않습니다.
- class portone_server_sdk.common.ChannelGroupSummary#
채널 그룹 정보
- id: str#
채널 그룹 아이디
- name: str#
채널 그룹 이름
- is_for_test: bool#
테스트 채널 그룹 여부
- class portone_server_sdk.common.Customer#
고객 정보
- id: str | None#
고객 아이디
고객사가 지정한 고객의 고유 식별자입니다.
- name: str | None#
이름
- birth_year: str | None#
출생 연도
- gender: Literal['MALE', 'FEMALE', 'OTHER'] | None#
성별
- email: str | None#
이메일
- phone_number: str | None#
전화번호
- address: OneLineAddress | SeparatedAddress | None#
주소
- zipcode: str | None#
우편번호
- class portone_server_sdk.common.CustomerInput#
고객 정보 입력 정보
- id: str | None#
고객 아이디
고객사가 지정한 고객의 고유 식별자입니다.
- name: CustomerNameInput | None#
이름
- birth_year: str | None#
출생 연도
- birth_month: str | None#
출생월
- birth_day: str | None#
출생일
- 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'] | None#
국가
- gender: Literal['MALE', 'FEMALE', 'OTHER'] | None#
성별
- email: str | None#
이메일
- phone_number: str | None#
전화번호
- address: SeparatedAddressInput | None#
주소
- zipcode: str | None#
우편번호
- business_registration_number: str | None#
사업자 등록 번호
- class portone_server_sdk.common.CustomerNameInput#
고객 이름 입력 정보
두 개의 이름 형식 중 한 가지만 선택하여 입력해주세요.
- full: str | None#
한 줄 이름 형식
- separated: CustomerSeparatedName | None#
분리형 이름 형식
- class portone_server_sdk.common.DateTimeRange#
시간 범위
- from_: str#
(RFC 3339 date-time)
- until: str#
(RFC 3339 date-time)
- class portone_server_sdk.common.OneLineAddress#
한 줄 형식 주소
한 줄 형식 주소만 존재합니다.
- type: Literal['ONE_LINE']#
- one_line: str#
주소 (한 줄)
- class portone_server_sdk.common.PageInfo#
반환된 페이지 결과 정보
- number: int#
요청된 페이지 번호 (int32)
- size: int#
요청된 페이지 당 객체 수 (int32)
- total_count: int#
실제 반환된 객체 수 (int32)
- class portone_server_sdk.common.PageInput#
다건 조회 API 에 사용되는 페이지 입력 정보
- number: int | None#
0부터 시작하는 페이지 번호 (int32)
- size: int | None#
각 페이지 당 포함할 객체 수 (int32)
- class portone_server_sdk.common.PaymentAmountInput#
금액 세부 입력 정보
- total: int#
총 금액 (int64)
- tax_free: int | None#
면세액 (int64)
- vat: int | None#
부가세액
고객사에서 직접 계산이 필요한 경우 입력합니다. 입력하지 않으면 면세 금액을 제외한 금액의 1/11 로 자동 계산됩니다. (int64)
- class portone_server_sdk.common.PaymentProduct#
상품 정보
- id: str#
상품 고유 식별자
고객사가 직접 부여한 식별자입니다.
- name: str#
상품명
- amount: int#
상품 단위가격 (int64)
- quantity: int#
주문 수량 (int32)
- tag: str | None#
상품 태그
카테고리 등으로 활용될 수 있습니다.
- code: str | None#
상품 코드
- class portone_server_sdk.common.SelectedChannel#
(결제, 본인인증 등에) 선택된 채널 정보
- type: Literal['LIVE', 'TEST']#
채널 타입
- pg_provider: 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']#
PG사
- pg_merchant_id: str#
PG사 고객사 식별 아이디
- id: str | None#
채널 아이디
- key: str | None#
채널 키
- name: str | None#
채널 명
- class portone_server_sdk.common.SeparatedAddress#
분리 형식 주소
한 줄 형식 주소와 분리 형식 주소 모두 존재합니다. 한 줄 형식 주소는 분리 형식 주소를 이어 붙인 형태로 생성됩니다.
- type: Literal['SEPARATED']#
- one_line: str#
주소 (한 줄)
- address_line_1: str#
상세 주소 1
- address_line_2: str#
상세 주소 2
- city: str | None#
시/군/구
- province: str | None#
주/도/시
- 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'] | None#
국가
- class portone_server_sdk.common.SeparatedAddressInput#
분리 형식 주소 입력 정보
- address_line_1: str#
상세 주소 1
- address_line_2: str#
상세 주소 2
- city: str | None#
시/군/구
- province: str | None#
주/도/시
- 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'] | None#
국가