portone_server_sdk.payment

portone_server_sdk.payment#

Classes

`ApplyEscrowLogisticsResponse`	에스크로 배송 정보 등록 성공 응답
`BeforeRegisteredPaymentEscrow`	배송 정보 등록 전
`BillingKeyPaymentSummary`	빌링키 결제 완료된 결제 건 요약 정보
`CancelPaymentBody`	결제 취소 요청 입력 정보
`CancelPaymentBodyRefundAccount`	고객 정보 입력 형식
`CancelPaymentResponse`	결제 취소 성공 응답
`CancelledPayment`	결제 취소 상태 건
`CancelledPaymentCashReceipt`	취소된 현금영수증
`CancelledPaymentEscrow`	거래 취소
`CloseVirtualAccountResponse`	가상계좌 말소 성공 응답
`ConfirmEscrowBody`	에스크로 구매 확정 입력 정보
`ConfirmEscrowResponse`	에스크로 구매 확정 성공 응답
`ConfirmedPaymentEscrow`	구매 확정
`DeliveredPaymentEscrow`	배송 완료
`FailedPayment`	결제 실패 상태 건
`FailedPaymentCancellation`	취소 실패 상태
`GetAllPaymentsByCursorBody`	결제 건 커서 기반 대용량 다건 조회를 위한 입력 정보
`GetAllPaymentsByCursorResponse`	결제 건 커서 기반 대용량 다건 조회 성공 응답 정보
`GetPaymentsBody`	결제 건 다건 조회를 위한 입력 정보
`GetPaymentsResponse`	결제 건 다건 조회 성공 응답 정보
`InstantPaymentInput`	수기 결제 요청 정보
`InstantPaymentMethodInput`	수기 결제 수단 입력 정보
`InstantPaymentMethodInputCard`	카드 수단 정보 입력 정보
`InstantPaymentMethodInputVirtualAccount`	가상계좌 수단 정보 입력 정보
`InstantPaymentMethodInputVirtualAccountCashReceiptInfo`	가상계좌 결제 시 현금영수증 정보
`InstantPaymentMethodInputVirtualAccountExpiry`	입금 만료 기한
`InstantPaymentMethodInputVirtualAccountOption`	가상계좌 발급 방식
`InstantPaymentMethodInputVirtualAccountOptionFixed`	고정식 가상계좌 발급 유형
`InstantPaymentSummary`	수기 결제가 완료된 결제 건 요약 정보
`IssuedPaymentCashReceipt`	발급 완료된 현금영수증
`ModifyEscrowLogisticsBody`	에스크로 배송 정보 수정 입력 정보
`ModifyEscrowLogisticsResponse`	에스크로 배송 정보 수정 성공 응답
`PaidPayment`	결제 완료 상태 건
`PartialCancelledPayment`	결제 부분 취소 상태 건
`PayInstantlyResponse`	수기 결제 성공 응답
`PayPendingPayment`	결제 완료 대기 상태 건
`PayWithBillingKeyResponse`	빌링키 결제 성공 응답
`PaymentAmount`	결제 금액 세부 정보
`PaymentEscrowReceiverInput`	에스크로 수취인 정보
`PaymentEscrowSenderInput`	에스크로 발송자 정보
`PaymentFailure`	결제 실패 정보
`PaymentFilterInput`	결제 건 다건 조회를 위한 입력 정보
`PaymentInstallment`	할부 정보
`PaymentLogistics`	배송정보
`PaymentMethodCard`	결제수단 카드 정보
`PaymentMethodEasyPay`	간편 결제 상세 정보
`PaymentMethodEasyPayMethodCharge`	충전식 포인트 결제 정보
`PaymentMethodGiftCertificate`	상품권 상세 정보
`PaymentMethodMobile`	모바일 상세 정보
`PaymentMethodTransfer`	계좌 이체 상세 정보
`PaymentMethodVirtualAccount`	가상계좌 상세 정보
`PaymentTextSearch`	통합검색 입력 정보
`PaymentWebhook`	성공 웹훅 내역
`PaymentWebhookRequest`	웹훅 요청 정보
`PaymentWebhookResponse`	웹훅 응답 정보
`PaymentWithCursor`	결제 건 및 커서 정보
`PreRegisterPaymentBody`	결제 정보 사전 등록 입력 정보
`PreRegisterPaymentResponse`	결제 사전 등록 성공 응답
`ReadyPayment`	준비 상태의 결제 건
`RegisterEscrowLogisticsBody`	에스크로 배송 정보 등록 입력 정보
`RegisterStoreReceiptBody`	영수증 내 하위 상점 거래 등록 정보
`RegisterStoreReceiptBodyItem`	하위 상점 거래 정보
`RegisterStoreReceiptResponse`	영수증 내 하위 상점 거래 등록 응답
`RegisteredPaymentEscrow`	배송 정보 등록 완료
`RejectConfirmedPaymentEscrow`	구매 거절 확정
`RejectedPaymentEscrow`	구매 거절
`RequestedPaymentCancellation`	취소 요청 상태
`ResendWebhookBody`	웹훅 재발송을 위한 입력 정보
`ResendWebhookResponse`	웹훅 재발송 응답 정보
`SucceededPaymentCancellation`	취소 완료 상태
`VirtualAccountIssuedPayment`	가상계좌 발급 완료 상태 건
`PaymentClient`

class portone_server_sdk.payment.ApplyEscrowLogisticsResponse#

에스크로 배송 정보 등록 성공 응답

invoice_number: str#: 송장 번호

sent_at: str#: 발송 시점 (RFC 3339 date-time)

applied_at: str#: 에스크로 정보 등록 시점 (RFC 3339 date-time)

class portone_server_sdk.payment.BeforeRegisteredPaymentEscrow#

배송 정보 등록 전

status: Literal['BEFORE_REGISTERED']#: 에스크로 상태

class portone_server_sdk.payment.BillingKeyPaymentSummary#

빌링키 결제 완료된 결제 건 요약 정보

pg_tx_id: str#: PG사 결제 아이디

paid_at: str#: 결제 완료 시점 (RFC 3339 date-time)

class portone_server_sdk.payment.CancelPaymentBody#

결제 취소 요청 입력 정보

reason: str#: 취소 사유

store_id: str | None#

상점 아이디

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

amount: int | None#

취소 총 금액

값을 입력하지 않으면 전액 취소됩니다. (int64)

tax_free_amount: int | None#

취소 금액 중 면세 금액

값을 입력하지 않으면 전액 과세 취소됩니다. (int64)

vat_amount: int | None#

취소 금액 중 부가세액

값을 입력하지 않으면 자동 계산됩니다. (int64)

requester: Literal['CUSTOMER', 'ADMIN'] | None#

취소 요청자

고객에 의한 취소일 경우 Customer, 관리자에 의한 취소일 경우 Admin으로 입력합니다.

current_cancellable_amount: int | None#

결제 건의 취소 가능 잔액

본 취소 요청 이전의 취소 가능 잔액으로써, 값을 입력하면 잔액이 일치하는 경우에만 취소가 진행됩니다. 값을 입력하지 않으면 별도의 검증 처리를 수행하지 않습니다. (int64)

refund_account: CancelPaymentBodyRefundAccount | None#

환불 계좌

계좌 환불일 경우 입력합니다. 계좌 환불이 필요한 경우는 가상계좌 환불, 휴대폰 익월 환불 등이 있습니다.

class portone_server_sdk.payment.CancelPaymentBodyRefundAccount#

고객 정보 입력 형식

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']#: 은행

number: str#: 계좌번호

holder_name: str#: 예금주

holder_phone_number: str | None#: 예금주 연락처 - 스마트로 가상계좌 결제인 경우에 필요합니다.

class portone_server_sdk.payment.CancelPaymentResponse#

결제 취소 성공 응답

cancellation: FailedPaymentCancellation | RequestedPaymentCancellation | SucceededPaymentCancellation#: 결체 취소 내역

class portone_server_sdk.payment.CancelledPayment#

결제 취소 상태 건

status: Literal['CANCELLED']#: 결제 건 상태

id: str#: 결제 건 아이디

transaction_id: str#

결제 건 포트원 채번 아이디

V1 결제 건의 경우 imp_uid에 해당합니다.

merchant_id: str#: 고객사 아이디

store_id: str#: 상점 아이디

channel: SelectedChannel#: 결제 채널

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

requested_at: str#: 결제 요청 시점 (RFC 3339 date-time)

updated_at: str#: 업데이트 시점 (RFC 3339 date-time)

status_changed_at: str#: 상태 업데이트 시점 (RFC 3339 date-time)

order_name: str#: 주문명

amount: PaymentAmount#: 결제 금액 관련 세부 정보

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']#: 통화

customer: Customer#: 구매자 정보

cancellations: list[FailedPaymentCancellation | RequestedPaymentCancellation | SucceededPaymentCancellation]#: 결제 취소 내역

cancelled_at: str#: 결제 취소 시점 (RFC 3339 date-time)

method: PaymentMethodCard | PaymentMethodEasyPay | PaymentMethodGiftCertificate | PaymentMethodMobile | PaymentMethodTransfer | PaymentMethodVirtualAccount | None#: 결제수단 정보

channel_group: ChannelGroupSummary | None#: 결제 채널 그룹 정보

schedule_id: str | None#

결제 예약 건 아이디

결제 예약을 이용한 경우에만 존재

billing_key: str | None#

결제 시 사용된 빌링키

빌링키 결제인 경우에만 존재

webhooks: list[PaymentWebhook] | None#: 웹훅 발송 내역

promotion_id: str | None#: 프로모션 아이디

is_cultural_expense: bool | None#: 문화비 지출 여부

에스크로 결제 정보

에스크로 결제인 경우 존재합니다.

products: list[PaymentProduct] | None#: 상품 정보

product_count: int | None#: 상품 갯수 (int32)

custom_data: 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#: 국가 코드

paid_at: str | None#: 결제 완료 시점 (RFC 3339 date-time)

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

cash_receipt: CancelledPaymentCashReceipt | IssuedPaymentCashReceipt | None#: 현금영수증

receipt_url: str | None#: 거래 영수증 URL

class portone_server_sdk.payment.CancelledPaymentCashReceipt#

취소된 현금영수증

status: Literal['CANCELLED']#: 결제 건 내 현금영수증 상태

issue_number: str#: 승인 번호

total_amount: int#: 총 금액 (int64)

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']#: 통화

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

cancelled_at: str#: 취소 시점 (RFC 3339 date-time)

type: Literal['PERSONAL', 'CORPORATE'] | None#: 현금영수증 유형

pg_receipt_id: str | None#: PG사 영수증 발급 아이디

tax_free_amount: int | None#: 면세액 (int64)

url: str | None#: 현금영수증 URL

class portone_server_sdk.payment.CancelledPaymentEscrow#

거래 취소

status: Literal['CANCELLED']#: 에스크로 상태

company: str#: 택배사

invoice_number: str#: 송장번호

sent_at: str | None#: 발송 일시 (RFC 3339 date-time)

applied_at: str | None#: 배송등록 처리 일자 (RFC 3339 date-time)

class portone_server_sdk.payment.CloseVirtualAccountResponse#

가상계좌 말소 성공 응답

closed_at: str#: 가상계좌 말소 시점 (RFC 3339 date-time)

class portone_server_sdk.payment.ConfirmEscrowBody#

에스크로 구매 확정 입력 정보

store_id: str | None#

상점 아이디

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

from_store: bool | None#

확인 주체가 상점인지 여부

구매확정요청 주체가 고객사 관리자인지 구매자인지 구분하기 위한 필드입니다. 네이버페이 전용 파라미터이며, 구분이 모호한 경우 고객사 관리자(true)로 입력합니다.

class portone_server_sdk.payment.ConfirmEscrowResponse#

에스크로 구매 확정 성공 응답

completed_at: str#: 에스크로 구매 확정 시점 (RFC 3339 date-time)

class portone_server_sdk.payment.ConfirmedPaymentEscrow#

구매 확정

status: Literal['CONFIRMED']#: 에스크로 상태

company: str#: 택배사

invoice_number: str#: 송장번호

is_automatically_confirmed: bool#: 자동 구매 확정 처리 여부

sent_at: str | None#: 발송 일시 (RFC 3339 date-time)

applied_at: str | None#: 배송등록 처리 일자 (RFC 3339 date-time)

class portone_server_sdk.payment.DeliveredPaymentEscrow#

배송 완료

status: Literal['DELIVERED']#: 에스크로 상태

company: str#: 택배사

invoice_number: str#: 송장번호

sent_at: str | None#: 발송 일시 (RFC 3339 date-time)

applied_at: str | None#: 배송등록 처리 일자 (RFC 3339 date-time)

class portone_server_sdk.payment.FailedPayment#

결제 실패 상태 건

status: Literal['FAILED']#: 결제 건 상태

id: str#: 결제 건 아이디

transaction_id: str#

결제 건 포트원 채번 아이디

V1 결제 건의 경우 imp_uid에 해당합니다.

merchant_id: str#: 고객사 아이디

store_id: str#: 상점 아이디

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

requested_at: str#: 결제 요청 시점 (RFC 3339 date-time)

updated_at: str#: 업데이트 시점 (RFC 3339 date-time)

status_changed_at: str#: 상태 업데이트 시점 (RFC 3339 date-time)

order_name: str#: 주문명

amount: PaymentAmount#: 결제 금액 관련 세부 정보

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']#: 통화

customer: Customer#: 구매자 정보

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

failure: PaymentFailure#: 결제 실패 정보

method: PaymentMethodCard | PaymentMethodEasyPay | PaymentMethodGiftCertificate | PaymentMethodMobile | PaymentMethodTransfer | PaymentMethodVirtualAccount | None#: 결제수단 정보

channel: SelectedChannel | None#: 결제 채널

channel_group: ChannelGroupSummary | None#: 결제 채널 그룹 정보

schedule_id: str | None#

결제 예약 건 아이디

결제 예약을 이용한 경우에만 존재

billing_key: str | None#

결제 시 사용된 빌링키

빌링키 결제인 경우에만 존재

webhooks: list[PaymentWebhook] | None#: 웹훅 발송 내역

promotion_id: str | None#: 프로모션 아이디

is_cultural_expense: bool | None#: 문화비 지출 여부

에스크로 결제 정보

에스크로 결제인 경우 존재합니다.

products: list[PaymentProduct] | None#: 상품 정보

product_count: int | None#: 상품 갯수 (int32)

custom_data: 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.payment.FailedPaymentCancellation#

취소 실패 상태

status: Literal['FAILED']#: 결제 취소 내역 상태

id: str#: 취소 내역 아이디

total_amount: int#: 취소 총 금액 (int64)

tax_free_amount: int#: 취소 금액 중 면세 금액 (int64)

vat_amount: int#: 취소 금액 중 부가세액 (int64)

reason: str#: 취소 사유

requested_at: str#: 취소 요청 시점 (RFC 3339 date-time)

pg_cancellation_id: str | None#: PG사 결제 취소 내역 아이디

easy_pay_discount_amount: int | None#: 적립형 포인트의 환불 금액 (int64)

cancelled_at: str | None#: 취소 시점 (RFC 3339 date-time)

class portone_server_sdk.payment.GetAllPaymentsByCursorBody#

결제 건 커서 기반 대용량 다건 조회를 위한 입력 정보

store_id: str | None#

상점 아이디

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

from_: str | None#

결제 건 생성시점 범위 조건의 시작

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

until: str | None#

결제 건 생성시점 범위 조건의 끝

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

cursor: str | None#

커서

결제 건 리스트 중 어디서부터 읽어야 할지 가리키는 값입니다. 최초 요청일 경우 값을 입력하지 마시되, 두번째 요청 부터는 이전 요청 응답값의 cursor를 입력해주시면 됩니다.

size: int | None#

페이지 크기

미입력 시 기본값은 10 이며 최대 1000까지 허용 (int32)

class portone_server_sdk.payment.GetAllPaymentsByCursorResponse#

결제 건 커서 기반 대용량 다건 조회 성공 응답 정보

items: list[PaymentWithCursor]#: 조회된 결제 건 및 커서 정보 리스트

class portone_server_sdk.payment.GetPaymentsBody#

결제 건 다건 조회를 위한 입력 정보

page: PageInput | None#

요청할 페이지 정보

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

filter: PaymentFilterInput | None#

조회할 결제 건 조건 필터

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

class portone_server_sdk.payment.GetPaymentsResponse#

결제 건 다건 조회 성공 응답 정보

items: list[CancelledPayment | FailedPayment | PaidPayment | PartialCancelledPayment | PayPendingPayment | ReadyPayment | VirtualAccountIssuedPayment]#: 조회된 결제 건 리스트

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

class portone_server_sdk.payment.InstantPaymentInput#

수기 결제 요청 정보

method: InstantPaymentMethodInput#: 결제수단 정보

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#

채널 키

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

channel_group_id: str | None#

채널 그룹 ID

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

is_cultural_expense: bool | None#

문화비 지출 여부

기본값은 false 입니다.

is_escrow: bool | None#

에스크로 결제 여부

기본값은 false 입니다.

customer: CustomerInput | None#: 고객 정보

custom_data: 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#: 결제 국가

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#: 해당 결제에 적용할 프로모션 아이디

class portone_server_sdk.payment.InstantPaymentMethodInput#

수기 결제 수단 입력 정보

하나의 필드만 입력합니다.

card: InstantPaymentMethodInputCard | None#: 카드

virtual_account: InstantPaymentMethodInputVirtualAccount | None#: 가상계좌

class portone_server_sdk.payment.InstantPaymentMethodInputCard#

카드 수단 정보 입력 정보

credential: CardCredential#: 카드 인증 관련 정보

installment_month: int | None#: 카드 할부 개월 수 (int32)

use_free_installment_plan: bool | None#: 무이자 할부 적용 여부

use_free_interest_from_merchant: bool | None#: 무이자 할부 이자를 고객사가 부담할지 여부

use_card_point: bool | None#: 카드 포인트 사용 여부

class portone_server_sdk.payment.InstantPaymentMethodInputVirtualAccount#

가상계좌 수단 정보 입력 정보

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']#: 은행

expiry: InstantPaymentMethodInputVirtualAccountExpiry#: 입금 만료 기한

option: InstantPaymentMethodInputVirtualAccountOption#: 가상계좌 유형

cash_receipt: InstantPaymentMethodInputVirtualAccountCashReceiptInfo#: 현금영수증 정보

remittee_name: str | None#: 예금주명

class portone_server_sdk.payment.InstantPaymentMethodInputVirtualAccountCashReceiptInfo#

가상계좌 결제 시 현금영수증 정보

type: Literal['PERSONAL', 'CORPORATE', 'NO_RECEIPT']#: 현금영수증 유형

customer_identity_number: str#: 사용자 식별 번호

class portone_server_sdk.payment.InstantPaymentMethodInputVirtualAccountExpiry#

입금 만료 기한

validHours와 dueDate 둘 중 하나의 필드만 입력합니다.

valid_hours: int | None#

유효 시간

시간 단위로 입력합니다. (int32)

due_date: str | None#: 만료 시점 (RFC 3339 date-time)

class portone_server_sdk.payment.InstantPaymentMethodInputVirtualAccountOption#

가상계좌 발급 방식

type: Literal['NORMAL', 'FIXED']#: 발급 유형

fixed: InstantPaymentMethodInputVirtualAccountOptionFixed | None#

고정식 가상계좌 발급 방식

발급 유형을 FIXED 로 선택했을 시에만 입력합니다.

class portone_server_sdk.payment.InstantPaymentMethodInputVirtualAccountOptionFixed#

고정식 가상계좌 발급 유형

pgAccountId, accountNumber 유형 중 한 개의 필드만 입력합니다.

pg_account_id: str | None#

Account ID 고정식 가상계좌

고객사가 가상계좌번호를 직접 관리하지 않고 PG사가 pgAccountId에 매핑되는 가상계좌번호를 내려주는 방식입니다. 동일한 pgAccountId로 가상계좌 발급 요청시에는 항상 같은 가상계좌번호가 내려옵니다.

account_number: str | None#

Account Number 고정식 가상계좌

PG사가 일정 개수만큼의 가상계좌번호를 발급하여 고객사에게 미리 전달하고 고객사가 그 중 하나를 선택하여 사용하는 방식입니다.

class portone_server_sdk.payment.InstantPaymentSummary#

수기 결제가 완료된 결제 건 요약 정보

pg_tx_id: str#: PG사 결제 아이디

paid_at: str#: 결제 완료 시점 (RFC 3339 date-time)

class portone_server_sdk.payment.IssuedPaymentCashReceipt#

발급 완료된 현금영수증

status: Literal['ISSUED']#: 결제 건 내 현금영수증 상태

issue_number: str#: 승인 번호

total_amount: int#: 총 금액 (int64)

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']#: 통화

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

type: Literal['PERSONAL', 'CORPORATE'] | None#: 현금영수증 유형

pg_receipt_id: str | None#: PG사 영수증 발급 아이디

tax_free_amount: int | None#: 면세액 (int64)

url: str | None#: 현금영수증 URL

class portone_server_sdk.payment.ModifyEscrowLogisticsBody#

에스크로 배송 정보 수정 입력 정보

logistics: PaymentLogistics#: 에스크로 물류 정보

store_id: str | None#

상점 아이디

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

sender: PaymentEscrowSenderInput | None#: 에스크로 발송자 정보

receiver: PaymentEscrowReceiverInput | None#: 에스크로 수취인 정보

send_email: bool | None#

이메일 알림 전송 여부

에스크로 구매 확정 시 이메일로 알림을 보낼지 여부입니다.

products: list[PaymentProduct] | None#: 상품 정보

class portone_server_sdk.payment.ModifyEscrowLogisticsResponse#

에스크로 배송 정보 수정 성공 응답

invoice_number: str#: 송장 번호

sent_at: str#: 발송 시점 (RFC 3339 date-time)

modified_at: str#: 에스크로 정보 수정 시점 (RFC 3339 date-time)

class portone_server_sdk.payment.PaidPayment#

결제 완료 상태 건

status: Literal['PAID']#: 결제 건 상태

id: str#: 결제 건 아이디

transaction_id: str#

결제 건 포트원 채번 아이디

V1 결제 건의 경우 imp_uid에 해당합니다.

merchant_id: str#: 고객사 아이디

store_id: str#: 상점 아이디

channel: SelectedChannel#: 결제 채널

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

requested_at: str#: 결제 요청 시점 (RFC 3339 date-time)

updated_at: str#: 업데이트 시점 (RFC 3339 date-time)

status_changed_at: str#: 상태 업데이트 시점 (RFC 3339 date-time)

order_name: str#: 주문명

amount: PaymentAmount#: 결제 금액 관련 세부 정보

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']#: 통화

customer: Customer#: 구매자 정보

paid_at: str#: 결제 완료 시점 (RFC 3339 date-time)

method: PaymentMethodCard | PaymentMethodEasyPay | PaymentMethodGiftCertificate | PaymentMethodMobile | PaymentMethodTransfer | PaymentMethodVirtualAccount | None#: 결제수단 정보

channel_group: ChannelGroupSummary | None#: 결제 채널 그룹 정보

schedule_id: str | None#

결제 예약 건 아이디

결제 예약을 이용한 경우에만 존재

billing_key: str | None#

결제 시 사용된 빌링키

빌링키 결제인 경우에만 존재

webhooks: list[PaymentWebhook] | None#: 웹훅 발송 내역

promotion_id: str | None#: 프로모션 아이디

is_cultural_expense: bool | None#: 문화비 지출 여부

에스크로 결제 정보

에스크로 결제인 경우 존재합니다.

products: list[PaymentProduct] | None#: 상품 정보

product_count: int | None#: 상품 갯수 (int32)

custom_data: 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#: 국가 코드

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

pg_response: str | None#: PG사 거래 응답 본문

cash_receipt: CancelledPaymentCashReceipt | IssuedPaymentCashReceipt | None#: 현금영수증

receipt_url: str | None#: 거래 영수증 URL

class portone_server_sdk.payment.PartialCancelledPayment#

결제 부분 취소 상태 건

status: Literal['PARTIAL_CANCELLED']#: 결제 건 상태

id: str#: 결제 건 아이디

transaction_id: str#

결제 건 포트원 채번 아이디

V1 결제 건의 경우 imp_uid에 해당합니다.

merchant_id: str#: 고객사 아이디

store_id: str#: 상점 아이디

channel: SelectedChannel#: 결제 채널

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

requested_at: str#: 결제 요청 시점 (RFC 3339 date-time)

updated_at: str#: 업데이트 시점 (RFC 3339 date-time)

status_changed_at: str#: 상태 업데이트 시점 (RFC 3339 date-time)

order_name: str#: 주문명

amount: PaymentAmount#: 결제 금액 관련 세부 정보

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']#: 통화

customer: Customer#: 구매자 정보

cancellations: list[FailedPaymentCancellation | RequestedPaymentCancellation | SucceededPaymentCancellation]#: 결제 취소 내역

cancelled_at: str#: 결제 취소 시점 (RFC 3339 date-time)

method: PaymentMethodCard | PaymentMethodEasyPay | PaymentMethodGiftCertificate | PaymentMethodMobile | PaymentMethodTransfer | PaymentMethodVirtualAccount | None#: 결제수단 정보

channel_group: ChannelGroupSummary | None#: 결제 채널 그룹 정보

schedule_id: str | None#

결제 예약 건 아이디

결제 예약을 이용한 경우에만 존재

billing_key: str | None#

결제 시 사용된 빌링키

빌링키 결제인 경우에만 존재

webhooks: list[PaymentWebhook] | None#: 웹훅 발송 내역

promotion_id: str | None#: 프로모션 아이디

is_cultural_expense: bool | None#: 문화비 지출 여부

에스크로 결제 정보

에스크로 결제인 경우 존재합니다.

products: list[PaymentProduct] | None#: 상품 정보

product_count: int | None#: 상품 갯수 (int32)

custom_data: 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#: 국가 코드

paid_at: str | None#: 결제 완료 시점 (RFC 3339 date-time)

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

cash_receipt: CancelledPaymentCashReceipt | IssuedPaymentCashReceipt | None#: 현금영수증

receipt_url: str | None#: 거래 영수증 URL

class portone_server_sdk.payment.PayInstantlyResponse#

수기 결제 성공 응답

payment: InstantPaymentSummary#: 결제 건 요약 정보

class portone_server_sdk.payment.PayPendingPayment#

결제 완료 대기 상태 건

status: Literal['PAY_PENDING']#: 결제 건 상태

id: str#: 결제 건 아이디

merchant_id: str#: 고객사 아이디

store_id: str#: 상점 아이디

channel: SelectedChannel#: 결제 채널

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

requested_at: str#: 결제 요청 시점 (RFC 3339 date-time)

updated_at: str#: 업데이트 시점 (RFC 3339 date-time)

status_changed_at: str#: 상태 업데이트 시점 (RFC 3339 date-time)

order_name: str#: 주문명

amount: PaymentAmount#: 결제 금액 관련 세부 정보

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']#: 통화

customer: Customer#: 구매자 정보

method: PaymentMethodCard | PaymentMethodEasyPay | PaymentMethodGiftCertificate | PaymentMethodMobile | PaymentMethodTransfer | PaymentMethodVirtualAccount | None#: 결제수단 정보

channel_group: ChannelGroupSummary | None#: 결제 채널 그룹 정보

schedule_id: str | None#

결제 예약 건 아이디

결제 예약을 이용한 경우에만 존재

billing_key: str | None#

결제 시 사용된 빌링키

빌링키 결제인 경우에만 존재

webhooks: list[PaymentWebhook] | None#: 웹훅 발송 내역

promotion_id: str | None#: 프로모션 아이디

is_cultural_expense: bool | None#: 문화비 지출 여부

에스크로 결제 정보

에스크로 결제인 경우 존재합니다.

products: list[PaymentProduct] | None#: 상품 정보

product_count: int | None#: 상품 갯수 (int32)

custom_data: 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#: 국가 코드

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

class portone_server_sdk.payment.PayWithBillingKeyResponse#

빌링키 결제 성공 응답

payment: BillingKeyPaymentSummary#: 결제 건 요약 정보

class portone_server_sdk.payment.PaymentAmount#

결제 금액 세부 정보

total: int#: 총 결제금액 (int64)

tax_free: int#: 면세액 (int64)

discount: int#

할인금액

카드사 프로모션, 포트원 프로모션, 적립형 포인트 결제, 쿠폰 할인 등을 포함합니다. (int64)

paid: int#: 실제 결제금액 (int64)

cancelled: int#: 취소금액 (int64)

cancelled_tax_free: int#: 취소금액 중 면세액 (int64)

vat: int | None#: 부가세액 (int64)

supply: int | None#: 공급가액 (int64)

class portone_server_sdk.payment.PaymentEscrowReceiverInput#

에스크로 수취인 정보

name: str | None#: 이름

phone_number: str | None#: 전화번호

zipcode: str | None#: 우편번호

address: SeparatedAddressInput | None#: 주소

class portone_server_sdk.payment.PaymentEscrowSenderInput#

에스크로 발송자 정보

name: str | None#: 이름

phone_number: str | None#: 전화번호

zipcode: str | None#: 우편번호

relationship: str | None#: 수취인과의 관계

address: SeparatedAddressInput | None#: 주소

class portone_server_sdk.payment.PaymentFailure#

결제 실패 정보

reason: str | None#: 실패 사유

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

pg_message: str | None#: PG사 실패 메시지

class portone_server_sdk.payment.PaymentFilterInput#

결제 건 다건 조회를 위한 입력 정보

merchant_id: str | None#: 고객사 아이디

store_id: str | None#

상점 아이디

Merchant 사용자만 사용가능하며, 지정되지 않은 경우 고객사 전체 결제 건을 조회합니다.

timestamp_type: Literal['CREATED_AT', 'STATUS_CHANGED_AT'] | None#: 조회 기준 시점 유형

from_: str | None#

결제 요청/상태 승인 시점 범위의 시작

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

until: str | None#

결제 요청/상태 승인 시점 범위의 끝

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

status: list[Literal['READY', 'PENDING', 'VIRTUAL_ACCOUNT_ISSUED', 'PAID', 'FAILED', 'PARTIAL_CANCELLED', 'CANCELLED']] | None#

결제 상태 리스트

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

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

결제수단 리스트

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

pg_provider: 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사 리스트

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

is_test: bool | None#: 테스트 결제 필터링

is_scheduled: bool | None#: 결제 예약 건 필터링

sort_by: Literal['REQUESTED_AT', 'STATUS_CHANGED_AT'] | None#: 결제 건 정렬 기준

sort_order: Literal['DESC', 'ASC'] | None#: 결제 건 정렬 방식

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

webhook_status: Literal['SUCCEEDED', 'FAILED_NOT_OK_RESPONSE', 'FAILED_UNEXPECTED_ERROR'] | None#: 웹훅 상태

platform_type: Literal['SDK_MOBILE', 'SDK_PC', 'API'] | 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'] | None#: 통화

is_escrow: bool | None#: 에스크로 결제 여부

escrow_status: Literal['REGISTERED', 'DELIVERED', 'CONFIRMED', 'REJECTED', 'CANCELLED', 'REJECT_CONFIRMED'] | None#: 에스크로 결제의 배송 정보 상태

card_brand: Literal['LOCAL', 'MASTER', 'UNIONPAY', 'VISA', 'JCB', 'AMEX', 'DINERS'] | None#: 카드 브랜드

card_type: Literal['CREDIT', 'DEBIT', 'GIFT'] | None#: 카드 유형

card_owner_type: Literal['PERSONAL', 'CORPORATE'] | None#: 카드 소유주 유형

gift_certificate_type: Literal['BOOKNLIFE', 'SMART_MUNSANG', 'CULTURELAND', 'HAPPYMONEY', 'CULTUREGIFT'] | None#: 상품권 종류

cash_receipt_type: Literal['PERSONAL', 'CORPORATE', 'NO_RECEIPT'] | None#: 현금영수증 유형

cash_receipt_status: Literal['ISSUED', 'CANCELLED'] | None#: 현금영수증 상태

cash_receipt_issued_at_range: DateTimeRange | None#: 현금영수증 발급 시간 범위

cash_receipt_cancelled_at_range: DateTimeRange | None#: 현금영수증 취소 시간 범위

text_search: list[PaymentTextSearch] | None#: 통합 검색 리스트 필터

class portone_server_sdk.payment.PaymentInstallment#

할부 정보

month: int#: 할부 개월 수 (int32)

is_interest_free: bool#: 무이자할부 여부

class portone_server_sdk.payment.PaymentLogistics#

배송정보

company: Literal['LOTTE', 'LOGEN', 'DONGWON', 'POST', 'CJ', 'HANJIN', 'DAESIN', 'ILYANG', 'KYUNGDONG', 'CHUNIL', 'POST_REGISTERED', 'GS', 'WOORI', 'HAPDONG', 'FEDEX', 'UPS', 'GSM_NTON', 'SUNGWON', 'LX_PANTOS', 'ACI', 'CJ_INTL', 'USPS', 'EMS', 'DHL', 'KGL', 'GOODSTOLUCK', 'KUNYOUNG', 'SLX', 'SF', 'ETC']#: 물류회사

invoice_number: str#: 송장번호

sent_at: str#: 발송시점 (RFC 3339 date-time)

received_at: str | None#: 수령시점 (RFC 3339 date-time)

address: SeparatedAddressInput | None#: 주소

class portone_server_sdk.payment.PaymentMethodCard#

결제수단 카드 정보

type: Literal['PaymentMethodCard']#

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

approval_number: str | None#: 승인 번호

installment: PaymentInstallment | None#: 할부 정보

point_used: bool | None#: 카드 포인트 사용여부

class portone_server_sdk.payment.PaymentMethodEasyPay#

간편 결제 상세 정보

type: Literal['PaymentMethodEasyPay']#

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

easy_pay_method: PaymentMethodCard | PaymentMethodEasyPayMethodCharge | PaymentMethodTransfer | None#: 간편 결제 수단

class portone_server_sdk.payment.PaymentMethodEasyPayMethodCharge#

충전식 포인트 결제 정보

type: Literal['PaymentMethodEasyPayMethodCharge']#

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#: 표준 은행 코드

class portone_server_sdk.payment.PaymentMethodGiftCertificate#

상품권 상세 정보

type: Literal['PaymentMethodGiftCertificate']#

approval_number: str#: 상품권 승인 번호

gift_certificate_type: Literal['BOOKNLIFE', 'SMART_MUNSANG', 'CULTURELAND', 'HAPPYMONEY', 'CULTUREGIFT'] | None#: 상품권 종류

class portone_server_sdk.payment.PaymentMethodMobile#

모바일 상세 정보

type: Literal['PaymentMethodMobile']#

phone_number: str | None#: 전화번호

class portone_server_sdk.payment.PaymentMethodTransfer#

계좌 이체 상세 정보

type: Literal['PaymentMethodTransfer']#

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#: 표준 은행 코드

class portone_server_sdk.payment.PaymentMethodVirtualAccount#

가상계좌 상세 정보

type: Literal['PaymentMethodVirtualAccount']#

account_number: str#: 계좌번호

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_type: Literal['FIXED', 'NORMAL'] | None#: 계좌 유형

remittee_name: str | None#: 계좌주

remitter_name: str | None#: 송금인(입금자)

expired_at: str | None#: 입금만료시점 (RFC 3339 date-time)

issued_at: str | None#: 계좌발급시점 (RFC 3339 date-time)

refund_status: Literal['PENDING', 'PARTIAL_REFUND_FAILED', 'FAILED', 'COMPLETED'] | None#: 가상계좌 결제가 환불 단계일 때의 환불 상태

class portone_server_sdk.payment.PaymentTextSearch#

통합검색 입력 정보

field: Literal['ALL', 'PAYMENT_ID', 'TX_ID', 'SCHEDULE_ID', 'FAIL_REASON', 'CARD_ISSUER', 'CARD_ACQUIRER', 'CARD_BIN', 'CARD_NUMBER', 'CARD_APPROVAL_NUMBER', 'CARD_RECEIPT_NAME', 'CARD_INSTALLMENT', 'TRANS_BANK', 'VIRTUAL_ACCOUNT_HOLDER_NAME', 'VIRTUAL_ACCOUNT_BANK', 'VIRTUAL_ACCOUNT_NUMBER', 'PG_MERCHANT_ID', 'PG_TX_ID', 'PG_RECEIPT_ID', 'RECEIPT_APPROVAL_NUMBER', 'PG_CANCELLATION_ID', 'CANCEL_REASON', 'ORDER_NAME', 'CUSTOMER_NAME', 'CUSTOMER_EMAIL', 'CUSTOMER_PHONE_NUMBER', 'CUSTOMER_ADDRESS', 'CUSTOMER_ZIPCODE', 'USER_AGENT', 'BILLING_KEY', 'PROMOTION_ID', 'GIFT_CERTIFICATION_APPROVAL_NUMBER']#

value: str#

class portone_server_sdk.payment.PaymentWebhook#

성공 웹훅 내역

id: str#: 웹훅 아이디

url: str#

웹훅이 발송된 url

V1 결제 건인 경우, 값이 존재하지 않습니다.

payment_status: Literal['READY', 'VIRTUAL_ACCOUNT_ISSUED', 'PAID', 'FAILED', 'PARTIAL_CANCELLED', 'CANCELLED', 'PAY_PENDING'] | None#

웹훅 발송 시 결제 건 상태

V1 결제 건인 경우, 값이 존재하지 않습니다.

status: Literal['SUCCEEDED', 'FAILED_NOT_OK_RESPONSE', 'FAILED_UNEXPECTED_ERROR'] | None#: 웹훅 상태

is_async: bool | None#

비동기 웹훅 여부

V1 결제 건인 경우, 값이 존재하지 않습니다.

current_execution_count: int | None#: 현재 발송 횟수 (int32)

max_execution_count: int | None#: 최대 발송 횟수 (int32)

trigger: Literal['MANUAL', 'VIRTUAL_ACCOUNT_DEPOSIT', 'ASYNC_CANCEL_APPROVED', 'ASYNC_CANCEL_FAILED', 'ASYNC_PAY_APPROVED', 'ASYNC_PAY_FAILED'] | None#: 웹훅 실행 맥락

request: PaymentWebhookRequest | None#: 웹훅 요청 정보

response: PaymentWebhookResponse | None#: 웹훅 응답 정보

triggered_at: str | None#: 웹훅 처리 시작 시점 (RFC 3339 date-time)

class portone_server_sdk.payment.PaymentWebhookRequest#

웹훅 요청 정보

body: str#: 요청 본문

header: str | None#: 요청 헤더

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

class portone_server_sdk.payment.PaymentWebhookResponse#

웹훅 응답 정보

code: str#: 응답 HTTP 코드

header: str#: 응답 헤더

body: str#: 응답 본문

responded_at: str#: 응답 시점 (RFC 3339 date-time)

class portone_server_sdk.payment.PaymentWithCursor#

결제 건 및 커서 정보

payment: CancelledPayment | FailedPayment | PaidPayment | PartialCancelledPayment | PayPendingPayment | ReadyPayment | VirtualAccountIssuedPayment#: 결제 건 정보

cursor: str#: 해당 결제 건의 커서 정보

class portone_server_sdk.payment.PreRegisterPaymentBody#

결제 정보 사전 등록 입력 정보

store_id: str | None#

상점 아이디

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

total_amount: int | None#: 결제 총 금액 (int64)

tax_free_amount: int | None#: 결제 면세 금액 (int64)

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'] | None#: 통화 단위

class portone_server_sdk.payment.PreRegisterPaymentResponse#: 결제 사전 등록 성공 응답

class portone_server_sdk.payment.ReadyPayment#

준비 상태의 결제 건

status: Literal['READY']#: 결제 건 상태

id: str#: 결제 건 아이디

transaction_id: str#

결제 건 포트원 채번 아이디

V1 결제 건의 경우 imp_uid에 해당합니다.

merchant_id: str#: 고객사 아이디

store_id: str#: 상점 아이디

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

requested_at: str#: 결제 요청 시점 (RFC 3339 date-time)

updated_at: str#: 업데이트 시점 (RFC 3339 date-time)

status_changed_at: str#: 상태 업데이트 시점 (RFC 3339 date-time)

order_name: str#: 주문명

amount: PaymentAmount#: 결제 금액 관련 세부 정보

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']#: 통화

customer: Customer#: 구매자 정보

method: PaymentMethodCard | PaymentMethodEasyPay | PaymentMethodGiftCertificate | PaymentMethodMobile | PaymentMethodTransfer | PaymentMethodVirtualAccount | None#: 결제수단 정보

channel: SelectedChannel | None#: 결제 채널

channel_group: ChannelGroupSummary | None#: 결제 채널 그룹 정보

schedule_id: str | None#

결제 예약 건 아이디

결제 예약을 이용한 경우에만 존재

billing_key: str | None#

결제 시 사용된 빌링키

빌링키 결제인 경우에만 존재

webhooks: list[PaymentWebhook] | None#: 웹훅 발송 내역

promotion_id: str | None#: 프로모션 아이디

is_cultural_expense: bool | None#: 문화비 지출 여부

에스크로 결제의 배송 정보

에스크로 결제인 경우 존재합니다.

products: list[PaymentProduct] | None#: 상품 정보

product_count: int | None#: 상품 갯수 (int32)

custom_data: 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.payment.RegisterEscrowLogisticsBody#

에스크로 배송 정보 등록 입력 정보

logistics: PaymentLogistics#: 에스크로 물류 정보

store_id: str | None#

상점 아이디

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

sender: PaymentEscrowSenderInput | None#: 에스크로 발송자 정보

receiver: PaymentEscrowReceiverInput | None#: 에스크로 수취인 정보

send_email: bool | None#

이메일 알림 전송 여부

에스크로 구매 확정 시 이메일로 알림을 보낼지 여부입니다.

products: list[PaymentProduct] | None#: 상품 정보

class portone_server_sdk.payment.RegisterStoreReceiptBody#

영수증 내 하위 상점 거래 등록 정보

items: list[RegisterStoreReceiptBodyItem]#: 하위 상점 거래 목록

store_id: str | None#: 상점 아이디

class portone_server_sdk.payment.RegisterStoreReceiptBodyItem#

하위 상점 거래 정보

store_business_registration_number: str#: 하위 상점 사업자등록번호

store_name: str#: 하위 상점명

total_amount: int#: 결제 총 금액 (int64)

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']#: 통화

tax_free_amount: int | None#: 면세액 (int64)

vat_amount: int | None#: 부가세액 (int64)

supply_amount: int | None#: 공급가액 (int64)

class portone_server_sdk.payment.RegisterStoreReceiptResponse#

영수증 내 하위 상점 거래 등록 응답

receipt_url: str | None#: 결제 영수증 URL

class portone_server_sdk.payment.RegisteredPaymentEscrow#

배송 정보 등록 완료

status: Literal['REGISTERED']#: 에스크로 상태

company: str#: 택배사

invoice_number: str#: 송장번호

sent_at: str | None#: 발송 일시 (RFC 3339 date-time)

applied_at: str | None#: 배송등록 처리 일자 (RFC 3339 date-time)

class portone_server_sdk.payment.RejectConfirmedPaymentEscrow#

구매 거절 확정

status: Literal['REJECT_CONFIRMED']#: 에스크로 상태

company: str#: 택배사

invoice_number: str#: 송장번호

sent_at: str | None#: 발송 일시 (RFC 3339 date-time)

applied_at: str | None#: 배송등록 처리 일자 (RFC 3339 date-time)

class portone_server_sdk.payment.RejectedPaymentEscrow#

구매 거절

status: Literal['REJECTED']#: 에스크로 상태

company: str#: 택배사

invoice_number: str#: 송장번호

sent_at: str | None#: 발송 일시 (RFC 3339 date-time)

applied_at: str | None#: 배송등록 처리 일자 (RFC 3339 date-time)

class portone_server_sdk.payment.RequestedPaymentCancellation#

취소 요청 상태

status: Literal['REQUESTED']#: 결제 취소 내역 상태

id: str#: 취소 내역 아이디

total_amount: int#: 취소 총 금액 (int64)

tax_free_amount: int#: 취소 금액 중 면세 금액 (int64)

vat_amount: int#: 취소 금액 중 부가세액 (int64)

reason: str#: 취소 사유

requested_at: str#: 취소 요청 시점 (RFC 3339 date-time)

pg_cancellation_id: str | None#: PG사 결제 취소 내역 아이디

easy_pay_discount_amount: int | None#: 적립형 포인트의 환불 금액 (int64)

cancelled_at: str | None#: 취소 시점 (RFC 3339 date-time)

class portone_server_sdk.payment.ResendWebhookBody#

웹훅 재발송을 위한 입력 정보

store_id: str | None#

상점 아이디

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

webhook_id: str | None#

웹훅 아이디

입력하지 않으면 결제 건의 가장 최근 웹훅 아이디가 기본 적용됩니다

class portone_server_sdk.payment.ResendWebhookResponse#

웹훅 재발송 응답 정보

webhook: PaymentWebhook#: 재발송 웹훅 정보

class portone_server_sdk.payment.SucceededPaymentCancellation#

취소 완료 상태

status: Literal['SUCCEEDED']#: 결제 취소 내역 상태

id: str#: 취소 내역 아이디

total_amount: int#: 취소 총 금액 (int64)

tax_free_amount: int#: 취소 금액 중 면세 금액 (int64)

vat_amount: int#: 취소 금액 중 부가세액 (int64)

reason: str#: 취소 사유

requested_at: str#: 취소 요청 시점 (RFC 3339 date-time)

pg_cancellation_id: str | None#: PG사 결제 취소 내역 아이디

easy_pay_discount_amount: int | None#: 적립형 포인트의 환불 금액 (int64)

cancelled_at: str | None#: 취소 시점 (RFC 3339 date-time)

receipt_url: str | None#: 취소 영수증 URL

class portone_server_sdk.payment.VirtualAccountIssuedPayment#

가상계좌 발급 완료 상태 건

status: Literal['VIRTUAL_ACCOUNT_ISSUED']#: 결제 건 상태

id: str#: 결제 건 아이디

transaction_id: str#

결제 건 포트원 채번 아이디

V1 결제 건의 경우 imp_uid에 해당합니다.

merchant_id: str#: 고객사 아이디

store_id: str#: 상점 아이디

channel: SelectedChannel#: 결제 채널

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

requested_at: str#: 결제 요청 시점 (RFC 3339 date-time)

updated_at: str#: 업데이트 시점 (RFC 3339 date-time)

status_changed_at: str#: 상태 업데이트 시점 (RFC 3339 date-time)

order_name: str#: 주문명

amount: PaymentAmount#: 결제 금액 관련 세부 정보

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']#: 통화

customer: Customer#: 구매자 정보

method: PaymentMethodCard | PaymentMethodEasyPay | PaymentMethodGiftCertificate | PaymentMethodMobile | PaymentMethodTransfer | PaymentMethodVirtualAccount | None#: 결제수단 정보

channel_group: ChannelGroupSummary | None#: 결제 채널 그룹 정보

schedule_id: str | None#

결제 예약 건 아이디

결제 예약을 이용한 경우에만 존재

billing_key: str | None#

결제 시 사용된 빌링키

빌링키 결제인 경우에만 존재

webhooks: list[PaymentWebhook] | None#: 웹훅 발송 내역

promotion_id: str | None#: 프로모션 아이디

is_cultural_expense: bool | None#: 문화비 지출 여부

에스크로 결제 정보

에스크로 결제인 경우 존재합니다.

products: list[PaymentProduct] | None#: 상품 정보

product_count: int | None#: 상품 갯수 (int32)

custom_data: 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#: 국가 코드

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

class portone_server_sdk.payment.PaymentClient#

billing_key: BillingKeyClient#

cash_receipt: CashReceiptClient#

payment_schedule: PaymentScheduleClient#

promotion: PromotionClient#

pre_register_payment(*, payment_id: str, total_amount: int | None = None, tax_free_amount: int | 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'] | None = None) → PreRegisterPaymentResponse#

결제 정보 사전 등록

결제 정보를 사전 등록합니다.

Parameters:

payment_id (str) – 결제 건 아이디
total_amount (int, optional) – 결제 총 금액
tax_free_amount (int, optional) – 결제 면세 금액
currency (Currency, optional) – 통화 단위

Raises:

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

async pre_register_payment_async(*, payment_id: str, total_amount: int | None = None, tax_free_amount: int | 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'] | None = None) → PreRegisterPaymentResponse#

결제 정보 사전 등록

결제 정보를 사전 등록합니다.

Parameters:

payment_id (str) – 결제 건 아이디
total_amount (int, optional) – 결제 총 금액
tax_free_amount (int, optional) – 결제 면세 금액
currency (Currency, optional) – 통화 단위

Raises:

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

결제 단건 조회

주어진 아이디에 대응되는 결제 건을 조회합니다.

Parameters:

payment_id (str) – 조회할 결제 아이디

Raises:

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

결제 단건 조회

주어진 아이디에 대응되는 결제 건을 조회합니다.

Parameters:

payment_id (str) – 조회할 결제 아이디

Raises:

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

get_payments(*, page: PageInput | None = None, filter: PaymentFilterInput | None = None) → GetPaymentsResponse#

결제 다건 조회(페이지 기반)

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

Parameters:

page (PageInput, optional) –
요청할 페이지 정보

미 입력 시 number: 0, size: 10 으로 기본값이 적용됩니다.
filter (PaymentFilterInput, optional) –
조회할 결제 건 조건 필터

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

Raises:

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

async get_payments_async(*, page: PageInput | None = None, filter: PaymentFilterInput | None = None) → GetPaymentsResponse#

결제 다건 조회(페이지 기반)

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

Parameters:

page (PageInput, optional) –
요청할 페이지 정보

미 입력 시 number: 0, size: 10 으로 기본값이 적용됩니다.
filter (PaymentFilterInput, optional) –
조회할 결제 건 조건 필터

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

Raises:

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

get_all_payments_by_cursor(*, from_: str | None = None, until: str | None = None, cursor: str | None = None, size: int | None = None) → GetAllPaymentsByCursorResponse#

결제 대용량 다건 조회(커서 기반)

기간 내 모든 결제 건을 커서 기반으로 조회합니다. 결제 건의 생성일시를 기준으로 주어진 기간 내 존재하는 모든 결제 건이 조회됩니다.

Parameters:

from (str, optional) –
결제 건 생성시점 범위 조건의 시작

값을 입력하지 않으면 end의 90일 전으로 설정됩니다.
until (str, optional) –
결제 건 생성시점 범위 조건의 끝

값을 입력하지 않으면 현재 시점으로 설정됩니다.
cursor (str, optional) –
커서

결제 건 리스트 중 어디서부터 읽어야 할지 가리키는 값입니다. 최초 요청일 경우 값을 입력하지 마시되, 두번째 요청 부터는 이전 요청 응답값의 cursor를 입력해주시면 됩니다.
size (int, optional) –
페이지 크기

미입력 시 기본값은 10 이며 최대 1000까지 허용

Raises:

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

async get_all_payments_by_cursor_async(*, from_: str | None = None, until: str | None = None, cursor: str | None = None, size: int | None = None) → GetAllPaymentsByCursorResponse#

결제 대용량 다건 조회(커서 기반)

기간 내 모든 결제 건을 커서 기반으로 조회합니다. 결제 건의 생성일시를 기준으로 주어진 기간 내 존재하는 모든 결제 건이 조회됩니다.

Parameters:

from (str, optional) –
결제 건 생성시점 범위 조건의 시작

값을 입력하지 않으면 end의 90일 전으로 설정됩니다.
until (str, optional) –
결제 건 생성시점 범위 조건의 끝

값을 입력하지 않으면 현재 시점으로 설정됩니다.
cursor (str, optional) –
커서

결제 건 리스트 중 어디서부터 읽어야 할지 가리키는 값입니다. 최초 요청일 경우 값을 입력하지 마시되, 두번째 요청 부터는 이전 요청 응답값의 cursor를 입력해주시면 됩니다.
size (int, optional) –
페이지 크기

미입력 시 기본값은 10 이며 최대 1000까지 허용

Raises:

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

cancel_payment(*, payment_id: str, amount: int | None = None, tax_free_amount: int | None = None, vat_amount: int | None = None, reason: str, requester: Literal['CUSTOMER', 'ADMIN'] | None = None, current_cancellable_amount: int | None = None, refund_account: CancelPaymentBodyRefundAccount | None = None) → CancelPaymentResponse#

결제 취소

결제 취소를 요청합니다.

Parameters:

payment_id (str) – 결제 건 아이디
amount (int, optional) –
취소 총 금액

값을 입력하지 않으면 전액 취소됩니다.
tax_free_amount (int, optional) –
취소 금액 중 면세 금액

값을 입력하지 않으면 전액 과세 취소됩니다.
vat_amount (int, optional) –
취소 금액 중 부가세액

값을 입력하지 않으면 자동 계산됩니다.
reason (str) – 취소 사유
requester (CancelRequester, optional) –
취소 요청자

고객에 의한 취소일 경우 Customer, 관리자에 의한 취소일 경우 Admin으로 입력합니다.
current_cancellable_amount (int, optional) –
결제 건의 취소 가능 잔액

본 취소 요청 이전의 취소 가능 잔액으로써, 값을 입력하면 잔액이 일치하는 경우에만 취소가 진행됩니다. 값을 입력하지 않으면 별도의 검증 처리를 수행하지 않습니다.
refund_account (CancelPaymentBodyRefundAccount, optional) –
환불 계좌

계좌 환불일 경우 입력합니다. 계좌 환불이 필요한 경우는 가상계좌 환불, 휴대폰 익월 환불 등이 있습니다.

Raises:

CancellableAmountConsistencyBrokenError – 취소 가능 잔액 검증에 실패한 경우 취소 가능 잔액 검증에 실패한 경우
CancelAmountExceedsCancellableAmountError – 결제 취소 금액이 취소 가능 금액을 초과한 경우 결제 취소 금액이 취소 가능 금액을 초과한 경우
CancelTaxAmountExceedsCancellableTaxAmountError – 취소 과세 금액이 취소 가능한 과세 금액을 초과한 경우 취소 과세 금액이 취소 가능한 과세 금액을 초과한 경우
CancelTaxFreeAmountExceedsCancellableTaxFreeAmountError – 취소 면세 금액이 취소 가능한 면세 금액을 초과한 경우 취소 면세 금액이 취소 가능한 면세 금액을 초과한 경우
ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PaymentAlreadyCancelledError – 결제가 이미 취소된 경우 결제가 이미 취소된 경우
PaymentNotFoundError – 결제 건이 존재하지 않는 경우 결제 건이 존재하지 않는 경우
PaymentNotPaidError – 결제가 완료되지 않은 경우 결제가 완료되지 않은 경우
PgProviderError – PG사에서 오류를 전달한 경우 PG사에서 오류를 전달한 경우
RemainedAmountLessThanPromotionMinPaymentAmountError – 부분 취소 시, 취소하게 될 경우 남은 금액이 프로모션의 최소 결제 금액보다 작아지는 경우 부분 취소 시, 취소하게 될 경우 남은 금액이 프로모션의 최소 결제 금액보다 작아지는 경우
SumOfPartsExceedsCancelAmountError – 면세 금액 등 하위 항목들의 합이 전체 취소 금액을 초과한 경우 면세 금액 등 하위 항목들의 합이 전체 취소 금액을 초과한 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

async cancel_payment_async(*, payment_id: str, amount: int | None = None, tax_free_amount: int | None = None, vat_amount: int | None = None, reason: str, requester: Literal['CUSTOMER', 'ADMIN'] | None = None, current_cancellable_amount: int | None = None, refund_account: CancelPaymentBodyRefundAccount | None = None) → CancelPaymentResponse#

결제 취소

결제 취소를 요청합니다.

Parameters:

payment_id (str) – 결제 건 아이디
amount (int, optional) –
취소 총 금액

값을 입력하지 않으면 전액 취소됩니다.
tax_free_amount (int, optional) –
취소 금액 중 면세 금액

값을 입력하지 않으면 전액 과세 취소됩니다.
vat_amount (int, optional) –
취소 금액 중 부가세액

값을 입력하지 않으면 자동 계산됩니다.
reason (str) – 취소 사유
requester (CancelRequester, optional) –
취소 요청자

고객에 의한 취소일 경우 Customer, 관리자에 의한 취소일 경우 Admin으로 입력합니다.
current_cancellable_amount (int, optional) –
결제 건의 취소 가능 잔액

본 취소 요청 이전의 취소 가능 잔액으로써, 값을 입력하면 잔액이 일치하는 경우에만 취소가 진행됩니다. 값을 입력하지 않으면 별도의 검증 처리를 수행하지 않습니다.
refund_account (CancelPaymentBodyRefundAccount, optional) –
환불 계좌

계좌 환불일 경우 입력합니다. 계좌 환불이 필요한 경우는 가상계좌 환불, 휴대폰 익월 환불 등이 있습니다.

Raises:

CancellableAmountConsistencyBrokenError – 취소 가능 잔액 검증에 실패한 경우 취소 가능 잔액 검증에 실패한 경우
CancelAmountExceedsCancellableAmountError – 결제 취소 금액이 취소 가능 금액을 초과한 경우 결제 취소 금액이 취소 가능 금액을 초과한 경우
CancelTaxAmountExceedsCancellableTaxAmountError – 취소 과세 금액이 취소 가능한 과세 금액을 초과한 경우 취소 과세 금액이 취소 가능한 과세 금액을 초과한 경우
CancelTaxFreeAmountExceedsCancellableTaxFreeAmountError – 취소 면세 금액이 취소 가능한 면세 금액을 초과한 경우 취소 면세 금액이 취소 가능한 면세 금액을 초과한 경우
ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PaymentAlreadyCancelledError – 결제가 이미 취소된 경우 결제가 이미 취소된 경우
PaymentNotFoundError – 결제 건이 존재하지 않는 경우 결제 건이 존재하지 않는 경우
PaymentNotPaidError – 결제가 완료되지 않은 경우 결제가 완료되지 않은 경우
PgProviderError – PG사에서 오류를 전달한 경우 PG사에서 오류를 전달한 경우
RemainedAmountLessThanPromotionMinPaymentAmountError – 부분 취소 시, 취소하게 될 경우 남은 금액이 프로모션의 최소 결제 금액보다 작아지는 경우 부분 취소 시, 취소하게 될 경우 남은 금액이 프로모션의 최소 결제 금액보다 작아지는 경우
SumOfPartsExceedsCancelAmountError – 면세 금액 등 하위 항목들의 합이 전체 취소 금액을 초과한 경우 면세 금액 등 하위 항목들의 합이 전체 취소 금액을 초과한 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

pay_with_billing_key(*, payment_id: str, billing_key: str, channel_key: str | None = None, order_name: str, customer: CustomerInput | None = None, custom_data: str | None = None, 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'], installment_month: int | None = None, use_free_interest_from_merchant: bool | None = None, use_card_point: bool | None = None, cash_receipt: CashReceiptInput | None = 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 = None, notice_urls: list[str] | None = None, products: list[PaymentProduct] | None = None, product_count: int | None = None, product_type: Literal['PHYSICAL', 'DIGITAL'] | None = None, shipping_address: SeparatedAddressInput | None = None, promotion_id: str | None = None, bypass: dict) → PayWithBillingKeyResponse#

빌링키 결제

빌링키로 결제를 진행합니다.

Parameters:

payment_id (str) – 결제 건 아이디
billing_key (str) – 빌링키 결제에 사용할 빌링키
channel_key (str, optional) –
채널 키

다수 채널에 대해 발급된 빌링키에 대해, 결제 채널을 특정하고 싶을 때 명시
order_name (str) – 주문명
customer (CustomerInput, optional) – 고객 정보
custom_data (str, optional) – 사용자 지정 데이터
amount (PaymentAmountInput) – 결제 금액 세부 입력 정보
currency (Currency) – 통화
installment_month (int, optional) – 할부 개월 수
use_free_interest_from_merchant (bool, optional) – 무이자 할부 이자를 고객사가 부담할지 여부
use_card_point (bool, optional) – 카드 포인트 사용 여부
cash_receipt (CashReceiptInput, optional) – 현금영수증 정보
country (Country, optional) – 결제 국가
notice_urls (list[str], optional) –
웹훅 주소

결제 승인/실패 시 요청을 받을 웹훅 주소입니다. 상점에 설정되어 있는 값보다 우선적으로 적용됩니다. 입력된 값이 없을 경우에는 빈 배열로 해석됩니다.
products (list[PaymentProduct], optional) –
상품 정보

입력된 값이 없을 경우에는 빈 배열로 해석됩니다.
product_count (int, optional) – 상품 개수
product_type (PaymentProductType, optional) – 상품 유형
shipping_address (SeparatedAddressInput, optional) – 배송지 주소
promotion_id (str, optional) – 해당 결제에 적용할 프로모션 아이디
bypass (dict, optional) – PG사별 추가 파라미터 (“PG사별 연동 가이드” 참고)

Raises:

AlreadyPaidError – 결제가 이미 완료된 경우 결제가 이미 완료된 경우
BillingKeyAlreadyDeletedError – 빌링키가 이미 삭제된 경우 빌링키가 이미 삭제된 경우
BillingKeyNotFoundError – 빌링키가 존재하지 않는 경우 빌링키가 존재하지 않는 경우
ChannelNotFoundError – 요청된 채널이 존재하지 않는 경우 요청된 채널이 존재하지 않는 경우
DiscountAmountExceedsTotalAmountError – 프로모션 할인 금액이 결제 시도 금액 이상인 경우 프로모션 할인 금액이 결제 시도 금액 이상인 경우
ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
MaxTransactionCountReachedError – 결제 혹은 본인인증 시도 횟수가 최대에 도달한 경우 결제 혹은 본인인증 시도 횟수가 최대에 도달한 경우
PaymentScheduleAlreadyExistsError – 결제 예약건이 이미 존재하는 경우 결제 예약건이 이미 존재하는 경우
PgProviderError – PG사에서 오류를 전달한 경우 PG사에서 오류를 전달한 경우
PromotionPayMethodDoesNotMatchError – 결제수단이 프로모션에 지정된 것과 일치하지 않는 경우 결제수단이 프로모션에 지정된 것과 일치하지 않는 경우
SumOfPartsExceedsTotalAmountError – 면세 금액 등 하위 항목들의 합이 전체 결제 금액을 초과한 경우 면세 금액 등 하위 항목들의 합이 전체 결제 금액을 초과한 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

async pay_with_billing_key_async(*, payment_id: str, billing_key: str, channel_key: str | None = None, order_name: str, customer: CustomerInput | None = None, custom_data: str | None = None, 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'], installment_month: int | None = None, use_free_interest_from_merchant: bool | None = None, use_card_point: bool | None = None, cash_receipt: CashReceiptInput | None = 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 = None, notice_urls: list[str] | None = None, products: list[PaymentProduct] | None = None, product_count: int | None = None, product_type: Literal['PHYSICAL', 'DIGITAL'] | None = None, shipping_address: SeparatedAddressInput | None = None, promotion_id: str | None = None, bypass: dict) → PayWithBillingKeyResponse#

빌링키 결제

빌링키로 결제를 진행합니다.

Parameters:

payment_id (str) – 결제 건 아이디
billing_key (str) – 빌링키 결제에 사용할 빌링키
channel_key (str, optional) –
채널 키

다수 채널에 대해 발급된 빌링키에 대해, 결제 채널을 특정하고 싶을 때 명시
order_name (str) – 주문명
customer (CustomerInput, optional) – 고객 정보
custom_data (str, optional) – 사용자 지정 데이터
amount (PaymentAmountInput) – 결제 금액 세부 입력 정보
currency (Currency) – 통화
installment_month (int, optional) – 할부 개월 수
use_free_interest_from_merchant (bool, optional) – 무이자 할부 이자를 고객사가 부담할지 여부
use_card_point (bool, optional) – 카드 포인트 사용 여부
cash_receipt (CashReceiptInput, optional) – 현금영수증 정보
country (Country, optional) – 결제 국가
notice_urls (list[str], optional) –
웹훅 주소

결제 승인/실패 시 요청을 받을 웹훅 주소입니다. 상점에 설정되어 있는 값보다 우선적으로 적용됩니다. 입력된 값이 없을 경우에는 빈 배열로 해석됩니다.
products (list[PaymentProduct], optional) –
상품 정보

입력된 값이 없을 경우에는 빈 배열로 해석됩니다.
product_count (int, optional) – 상품 개수
product_type (PaymentProductType, optional) – 상품 유형
shipping_address (SeparatedAddressInput, optional) – 배송지 주소
promotion_id (str, optional) – 해당 결제에 적용할 프로모션 아이디
bypass (dict, optional) – PG사별 추가 파라미터 (“PG사별 연동 가이드” 참고)

Raises:

AlreadyPaidError – 결제가 이미 완료된 경우 결제가 이미 완료된 경우
BillingKeyAlreadyDeletedError – 빌링키가 이미 삭제된 경우 빌링키가 이미 삭제된 경우
BillingKeyNotFoundError – 빌링키가 존재하지 않는 경우 빌링키가 존재하지 않는 경우
ChannelNotFoundError – 요청된 채널이 존재하지 않는 경우 요청된 채널이 존재하지 않는 경우
DiscountAmountExceedsTotalAmountError – 프로모션 할인 금액이 결제 시도 금액 이상인 경우 프로모션 할인 금액이 결제 시도 금액 이상인 경우
ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
MaxTransactionCountReachedError – 결제 혹은 본인인증 시도 횟수가 최대에 도달한 경우 결제 혹은 본인인증 시도 횟수가 최대에 도달한 경우
PaymentScheduleAlreadyExistsError – 결제 예약건이 이미 존재하는 경우 결제 예약건이 이미 존재하는 경우
PgProviderError – PG사에서 오류를 전달한 경우 PG사에서 오류를 전달한 경우
PromotionPayMethodDoesNotMatchError – 결제수단이 프로모션에 지정된 것과 일치하지 않는 경우 결제수단이 프로모션에 지정된 것과 일치하지 않는 경우
SumOfPartsExceedsTotalAmountError – 면세 금액 등 하위 항목들의 합이 전체 결제 금액을 초과한 경우 면세 금액 등 하위 항목들의 합이 전체 결제 금액을 초과한 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

pay_instantly(*, payment_id: str, channel_key: str | None = None, channel_group_id: str | None = None, method: InstantPaymentMethodInput, order_name: str, is_cultural_expense: bool | None = None, is_escrow: bool | None = None, customer: CustomerInput | None = None, custom_data: str | None = None, 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'], 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 = None, notice_urls: list[str] | None = None, products: list[PaymentProduct] | None = None, product_count: int | None = None, product_type: Literal['PHYSICAL', 'DIGITAL'] | None = None, shipping_address: SeparatedAddressInput | None = None, promotion_id: str | None = None) → PayInstantlyResponse#

수기 결제

수기 결제를 진행합니다.

Parameters:

payment_id (str) – 결제 건 아이디
channel_key (str, optional) –
채널 키

채널 키 또는 채널 그룹 ID 필수
channel_group_id (str, optional) –
채널 그룹 ID

채널 키 또는 채널 그룹 ID 필수
method (InstantPaymentMethodInput) – 결제수단 정보
order_name (str) – 주문명
is_cultural_expense (bool, optional) –
문화비 지출 여부

기본값은 false 입니다.
is_escrow (bool, optional) –
에스크로 결제 여부

기본값은 false 입니다.
customer (CustomerInput, optional) – 고객 정보
custom_data (str, optional) – 사용자 지정 데이터
amount (PaymentAmountInput) – 결제 금액 세부 입력 정보
currency (Currency) – 통화
country (Country, optional) – 결제 국가
notice_urls (list[str], optional) –
웹훅 주소

결제 승인/실패 시 요청을 받을 웹훅 주소입니다. 상점에 설정되어 있는 값보다 우선적으로 적용됩니다. 입력된 값이 없을 경우에는 빈 배열로 해석됩니다.
products (list[PaymentProduct], optional) –
상품 정보

입력된 값이 없을 경우에는 빈 배열로 해석됩니다.
product_count (int, optional) – 상품 개수
product_type (PaymentProductType, optional) – 상품 유형
shipping_address (SeparatedAddressInput, optional) – 배송지 주소
promotion_id (str, optional) – 해당 결제에 적용할 프로모션 아이디

Raises:

AlreadyPaidError – 결제가 이미 완료된 경우 결제가 이미 완료된 경우
ChannelNotFoundError – 요청된 채널이 존재하지 않는 경우 요청된 채널이 존재하지 않는 경우
DiscountAmountExceedsTotalAmountError – 프로모션 할인 금액이 결제 시도 금액 이상인 경우 프로모션 할인 금액이 결제 시도 금액 이상인 경우
ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
MaxTransactionCountReachedError – 결제 혹은 본인인증 시도 횟수가 최대에 도달한 경우 결제 혹은 본인인증 시도 횟수가 최대에 도달한 경우
PaymentScheduleAlreadyExistsError – 결제 예약건이 이미 존재하는 경우 결제 예약건이 이미 존재하는 경우
PgProviderError – PG사에서 오류를 전달한 경우 PG사에서 오류를 전달한 경우
PromotionPayMethodDoesNotMatchError – 결제수단이 프로모션에 지정된 것과 일치하지 않는 경우 결제수단이 프로모션에 지정된 것과 일치하지 않는 경우
SumOfPartsExceedsTotalAmountError – 면세 금액 등 하위 항목들의 합이 전체 결제 금액을 초과한 경우 면세 금액 등 하위 항목들의 합이 전체 결제 금액을 초과한 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

async pay_instantly_async(*, payment_id: str, channel_key: str | None = None, channel_group_id: str | None = None, method: InstantPaymentMethodInput, order_name: str, is_cultural_expense: bool | None = None, is_escrow: bool | None = None, customer: CustomerInput | None = None, custom_data: str | None = None, 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'], 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 = None, notice_urls: list[str] | None = None, products: list[PaymentProduct] | None = None, product_count: int | None = None, product_type: Literal['PHYSICAL', 'DIGITAL'] | None = None, shipping_address: SeparatedAddressInput | None = None, promotion_id: str | None = None) → PayInstantlyResponse#

수기 결제

수기 결제를 진행합니다.

Parameters:

payment_id (str) – 결제 건 아이디
channel_key (str, optional) –
채널 키

채널 키 또는 채널 그룹 ID 필수
channel_group_id (str, optional) –
채널 그룹 ID

채널 키 또는 채널 그룹 ID 필수
method (InstantPaymentMethodInput) – 결제수단 정보
order_name (str) – 주문명
is_cultural_expense (bool, optional) –
문화비 지출 여부

기본값은 false 입니다.
is_escrow (bool, optional) –
에스크로 결제 여부

기본값은 false 입니다.
customer (CustomerInput, optional) – 고객 정보
custom_data (str, optional) – 사용자 지정 데이터
amount (PaymentAmountInput) – 결제 금액 세부 입력 정보
currency (Currency) – 통화
country (Country, optional) – 결제 국가
notice_urls (list[str], optional) –
웹훅 주소

결제 승인/실패 시 요청을 받을 웹훅 주소입니다. 상점에 설정되어 있는 값보다 우선적으로 적용됩니다. 입력된 값이 없을 경우에는 빈 배열로 해석됩니다.
products (list[PaymentProduct], optional) –
상품 정보

입력된 값이 없을 경우에는 빈 배열로 해석됩니다.
product_count (int, optional) – 상품 개수
product_type (PaymentProductType, optional) – 상품 유형
shipping_address (SeparatedAddressInput, optional) – 배송지 주소
promotion_id (str, optional) – 해당 결제에 적용할 프로모션 아이디

Raises:

AlreadyPaidError – 결제가 이미 완료된 경우 결제가 이미 완료된 경우
ChannelNotFoundError – 요청된 채널이 존재하지 않는 경우 요청된 채널이 존재하지 않는 경우
DiscountAmountExceedsTotalAmountError – 프로모션 할인 금액이 결제 시도 금액 이상인 경우 프로모션 할인 금액이 결제 시도 금액 이상인 경우
ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
MaxTransactionCountReachedError – 결제 혹은 본인인증 시도 횟수가 최대에 도달한 경우 결제 혹은 본인인증 시도 횟수가 최대에 도달한 경우
PaymentScheduleAlreadyExistsError – 결제 예약건이 이미 존재하는 경우 결제 예약건이 이미 존재하는 경우
PgProviderError – PG사에서 오류를 전달한 경우 PG사에서 오류를 전달한 경우
PromotionPayMethodDoesNotMatchError – 결제수단이 프로모션에 지정된 것과 일치하지 않는 경우 결제수단이 프로모션에 지정된 것과 일치하지 않는 경우
SumOfPartsExceedsTotalAmountError – 면세 금액 등 하위 항목들의 합이 전체 결제 금액을 초과한 경우 면세 금액 등 하위 항목들의 합이 전체 결제 금액을 초과한 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

close_virtual_account(*, payment_id: str) → CloseVirtualAccountResponse#

가상계좌 말소

발급된 가상계좌를 말소합니다.

Parameters:

payment_id (str) – 결제 건 아이디

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PaymentNotFoundError – 결제 건이 존재하지 않는 경우 결제 건이 존재하지 않는 경우
PaymentNotWaitingForDepositError – 결제 건이 입금 대기 상태가 아닌 경우 결제 건이 입금 대기 상태가 아닌 경우
PgProviderError – PG사에서 오류를 전달한 경우 PG사에서 오류를 전달한 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

async close_virtual_account_async(*, payment_id: str) → CloseVirtualAccountResponse#

가상계좌 말소

발급된 가상계좌를 말소합니다.

Parameters:

payment_id (str) – 결제 건 아이디

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PaymentNotFoundError – 결제 건이 존재하지 않는 경우 결제 건이 존재하지 않는 경우
PaymentNotWaitingForDepositError – 결제 건이 입금 대기 상태가 아닌 경우 결제 건이 입금 대기 상태가 아닌 경우
PgProviderError – PG사에서 오류를 전달한 경우 PG사에서 오류를 전달한 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

apply_escrow_logistics(*, payment_id: str, sender: PaymentEscrowSenderInput | None = None, receiver: PaymentEscrowReceiverInput | None = None, logistics: PaymentLogistics, send_email: bool | None = None, products: list[PaymentProduct] | None = None) → ApplyEscrowLogisticsResponse#

에스크로 배송 정보 등록

에스크로 배송 정보를 등록합니다.

Parameters:

payment_id (str) – 결제 건 아이디
sender (PaymentEscrowSenderInput, optional) – 에스크로 발송자 정보
receiver (PaymentEscrowReceiverInput, optional) – 에스크로 수취인 정보
logistics (PaymentLogistics) – 에스크로 물류 정보
send_email (bool, optional) –
이메일 알림 전송 여부

에스크로 구매 확정 시 이메일로 알림을 보낼지 여부입니다.
products (list[PaymentProduct], optional) – 상품 정보

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PaymentNotFoundError – 결제 건이 존재하지 않는 경우 결제 건이 존재하지 않는 경우
PaymentNotPaidError – 결제가 완료되지 않은 경우 결제가 완료되지 않은 경우
PgProviderError – PG사에서 오류를 전달한 경우 PG사에서 오류를 전달한 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

async apply_escrow_logistics_async(*, payment_id: str, sender: PaymentEscrowSenderInput | None = None, receiver: PaymentEscrowReceiverInput | None = None, logistics: PaymentLogistics, send_email: bool | None = None, products: list[PaymentProduct] | None = None) → ApplyEscrowLogisticsResponse#

에스크로 배송 정보 등록

에스크로 배송 정보를 등록합니다.

Parameters:

payment_id (str) – 결제 건 아이디
sender (PaymentEscrowSenderInput, optional) – 에스크로 발송자 정보
receiver (PaymentEscrowReceiverInput, optional) – 에스크로 수취인 정보
logistics (PaymentLogistics) – 에스크로 물류 정보
send_email (bool, optional) –
이메일 알림 전송 여부

에스크로 구매 확정 시 이메일로 알림을 보낼지 여부입니다.
products (list[PaymentProduct], optional) – 상품 정보

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PaymentNotFoundError – 결제 건이 존재하지 않는 경우 결제 건이 존재하지 않는 경우
PaymentNotPaidError – 결제가 완료되지 않은 경우 결제가 완료되지 않은 경우
PgProviderError – PG사에서 오류를 전달한 경우 PG사에서 오류를 전달한 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

modify_escrow_logistics(*, payment_id: str, sender: PaymentEscrowSenderInput | None = None, receiver: PaymentEscrowReceiverInput | None = None, logistics: PaymentLogistics, send_email: bool | None = None, products: list[PaymentProduct] | None = None) → ModifyEscrowLogisticsResponse#

에스크로 배송 정보 수정

에스크로 배송 정보를 수정합니다.

Parameters:

payment_id (str) – 결제 건 아이디
sender (PaymentEscrowSenderInput, optional) – 에스크로 발송자 정보
receiver (PaymentEscrowReceiverInput, optional) – 에스크로 수취인 정보
logistics (PaymentLogistics) – 에스크로 물류 정보
send_email (bool, optional) –
이메일 알림 전송 여부

에스크로 구매 확정 시 이메일로 알림을 보낼지 여부입니다.
products (list[PaymentProduct], optional) – 상품 정보

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PaymentNotFoundError – 결제 건이 존재하지 않는 경우 결제 건이 존재하지 않는 경우
PaymentNotPaidError – 결제가 완료되지 않은 경우 결제가 완료되지 않은 경우
PgProviderError – PG사에서 오류를 전달한 경우 PG사에서 오류를 전달한 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

async modify_escrow_logistics_async(*, payment_id: str, sender: PaymentEscrowSenderInput | None = None, receiver: PaymentEscrowReceiverInput | None = None, logistics: PaymentLogistics, send_email: bool | None = None, products: list[PaymentProduct] | None = None) → ModifyEscrowLogisticsResponse#

에스크로 배송 정보 수정

에스크로 배송 정보를 수정합니다.

Parameters:

payment_id (str) – 결제 건 아이디
sender (PaymentEscrowSenderInput, optional) – 에스크로 발송자 정보
receiver (PaymentEscrowReceiverInput, optional) – 에스크로 수취인 정보
logistics (PaymentLogistics) – 에스크로 물류 정보
send_email (bool, optional) –
이메일 알림 전송 여부

에스크로 구매 확정 시 이메일로 알림을 보낼지 여부입니다.
products (list[PaymentProduct], optional) – 상품 정보

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PaymentNotFoundError – 결제 건이 존재하지 않는 경우 결제 건이 존재하지 않는 경우
PaymentNotPaidError – 결제가 완료되지 않은 경우 결제가 완료되지 않은 경우
PgProviderError – PG사에서 오류를 전달한 경우 PG사에서 오류를 전달한 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

confirm_escrow(*, payment_id: str, from_store: bool | None = None) → ConfirmEscrowResponse#

에스크로 구매 확정

에스크로 결제를 구매 확정 처리합니다

Parameters:

payment_id (str) – 결제 건 아이디
from_store (bool, optional) –
확인 주체가 상점인지 여부

구매확정요청 주체가 고객사 관리자인지 구매자인지 구분하기 위한 필드입니다. 네이버페이 전용 파라미터이며, 구분이 모호한 경우 고객사 관리자(true)로 입력합니다.

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PaymentNotFoundError – 결제 건이 존재하지 않는 경우 결제 건이 존재하지 않는 경우
PaymentNotPaidError – 결제가 완료되지 않은 경우 결제가 완료되지 않은 경우
PgProviderError – PG사에서 오류를 전달한 경우 PG사에서 오류를 전달한 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

async confirm_escrow_async(*, payment_id: str, from_store: bool | None = None) → ConfirmEscrowResponse#

에스크로 구매 확정

에스크로 결제를 구매 확정 처리합니다

Parameters:

payment_id (str) – 결제 건 아이디
from_store (bool, optional) –
확인 주체가 상점인지 여부

구매확정요청 주체가 고객사 관리자인지 구매자인지 구분하기 위한 필드입니다. 네이버페이 전용 파라미터이며, 구분이 모호한 경우 고객사 관리자(true)로 입력합니다.

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PaymentNotFoundError – 결제 건이 존재하지 않는 경우 결제 건이 존재하지 않는 경우
PaymentNotPaidError – 결제가 완료되지 않은 경우 결제가 완료되지 않은 경우
PgProviderError – PG사에서 오류를 전달한 경우 PG사에서 오류를 전달한 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

resend_webhook(*, payment_id: str, webhook_id: str | None = None) → ResendWebhookResponse#

웹훅 재발송

웹훅을 재발송합니다.

Parameters:

payment_id (str) – 결제 건 아이디
webhook_id (str, optional) –
웹훅 아이디

입력하지 않으면 결제 건의 가장 최근 웹훅 아이디가 기본 적용됩니다

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
MaxWebhookRetryCountReachedError – 동일한 webhook id에 대한 수동 재시도 횟수가 최대에 도달한 경우 동일한 webhook id에 대한 수동 재시도 횟수가 최대에 도달한 경우
PaymentNotFoundError – 결제 건이 존재하지 않는 경우 결제 건이 존재하지 않는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
WebhookNotFoundError – 웹훅 내역이 존재하지 않는 경우 웹훅 내역이 존재하지 않는 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

async resend_webhook_async(*, payment_id: str, webhook_id: str | None = None) → ResendWebhookResponse#

웹훅 재발송

웹훅을 재발송합니다.

Parameters:

payment_id (str) – 결제 건 아이디
webhook_id (str, optional) –
웹훅 아이디

입력하지 않으면 결제 건의 가장 최근 웹훅 아이디가 기본 적용됩니다

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
MaxWebhookRetryCountReachedError – 동일한 webhook id에 대한 수동 재시도 횟수가 최대에 도달한 경우 동일한 webhook id에 대한 수동 재시도 횟수가 최대에 도달한 경우
PaymentNotFoundError – 결제 건이 존재하지 않는 경우 결제 건이 존재하지 않는 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
WebhookNotFoundError – 웹훅 내역이 존재하지 않는 경우 웹훅 내역이 존재하지 않는 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

register_store_receipt(*, payment_id: str, items: list[RegisterStoreReceiptBodyItem]) → RegisterStoreReceiptResponse#

영수증 내 하위 상점 거래 등록

결제 내역 매출전표에 하위 상점의 거래를 등록합니다. 지원되는 PG사: KG이니시스(이용 전 콘솔 -> 결제연동 탭에서 INIApi Key 등록 필요)

Parameters:

payment_id (str) – 등록할 하위 상점 결제 건 아이디
items (list[RegisterStoreReceiptBodyItem]) – 하위 상점 거래 목록

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PaymentNotFoundError – 결제 건이 존재하지 않는 경우 결제 건이 존재하지 않는 경우
PaymentNotPaidError – 결제가 완료되지 않은 경우 결제가 완료되지 않은 경우
PgProviderError – PG사에서 오류를 전달한 경우 PG사에서 오류를 전달한 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

async register_store_receipt_async(*, payment_id: str, items: list[RegisterStoreReceiptBodyItem]) → RegisterStoreReceiptResponse#

영수증 내 하위 상점 거래 등록

결제 내역 매출전표에 하위 상점의 거래를 등록합니다. 지원되는 PG사: KG이니시스(이용 전 콘솔 -> 결제연동 탭에서 INIApi Key 등록 필요)

Parameters:

payment_id (str) – 등록할 하위 상점 결제 건 아이디
items (list[RegisterStoreReceiptBodyItem]) – 하위 상점 거래 목록

Raises:

ForbiddenError – 요청이 거절된 경우 요청이 거절된 경우
InvalidRequestError – 요청된 입력 정보가 유효하지 않은 경우 요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PaymentNotFoundError – 결제 건이 존재하지 않는 경우 결제 건이 존재하지 않는 경우
PaymentNotPaidError – 결제가 완료되지 않은 경우 결제가 완료되지 않은 경우
PgProviderError – PG사에서 오류를 전달한 경우 PG사에서 오류를 전달한 경우
UnauthorizedError – 인증 정보가 올바르지 않은 경우 인증 정보가 올바르지 않은 경우
UnknownError – API 응답이 알 수 없는 형식인 경우

Modules

`billing_key`
`cash_receipt`
`payment_schedule`
`promotion`

portone_server_sdk.payment

Contents

portone_server_sdk.payment#