portone_server_sdk.PaymentClient

portone_server_sdk.PaymentClient#

class portone_server_sdk.PaymentClient#

Bases: object

__init__(*, secret: str, base_url: str = 'https://api.portone.io', store_id: str | None = None)#: API Secret을 사용해 포트원 API 클라이언트를 생성합니다.

Methods

`__init__`(*, secret[, base_url, store_id])	API Secret을 사용해 포트원 API 클라이언트를 생성합니다.
`apply_escrow_logistics`(*, payment_id[, ...])	에스크로 배송 정보 등록
`apply_escrow_logistics_async`(*, payment_id)	에스크로 배송 정보 등록
`cancel_payment`(*, payment_id[, amount, ...])	결제 취소
`cancel_payment_async`(*, payment_id[, ...])	결제 취소
`close_virtual_account`(*, payment_id)	가상계좌 말소
`close_virtual_account_async`(*, payment_id)	가상계좌 말소
`confirm_escrow`(*, payment_id[, from_store])	에스크로 구매 확정
`confirm_escrow_async`(*, payment_id[, from_store])	에스크로 구매 확정
`get_all_payments_by_cursor`(*[, from_, ...])	결제 대용량 다건 조회(커서 기반)
`get_all_payments_by_cursor_async`(*[, from_, ...])	결제 대용량 다건 조회(커서 기반)
`get_payment`(*, payment_id)	결제 단건 조회
`get_payment_async`(*, payment_id)	결제 단건 조회
`get_payment_transactions`(*, payment_id)	결제 시도 내역 조회
`get_payment_transactions_async`(*, payment_id)	결제 시도 내역 조회
`get_payments`(*[, page, filter])	결제 다건 조회(페이지 기반)
`get_payments_async`(*[, page, filter])	결제 다건 조회(페이지 기반)
`modify_escrow_logistics`(*, payment_id[, ...])	에스크로 배송 정보 수정
`modify_escrow_logistics_async`(*, payment_id)	에스크로 배송 정보 수정
`pay_instantly`(*, payment_id[, channel_key, ...])	수기 결제
`pay_instantly_async`(*, payment_id[, ...])	수기 결제
`pay_with_billing_key`(*, payment_id, billing_key)	빌링키 결제
`pay_with_billing_key_async`(*, payment_id, ...)	빌링키 결제
`pre_register_payment`(*, payment_id[, ...])	결제 정보 사전 등록
`pre_register_payment_async`(*, payment_id[, ...])	결제 정보 사전 등록
`register_store_receipt`(*, payment_id, items)	영수증 내 하위 상점 거래 등록
`register_store_receipt_async`(*, payment_id, ...)	영수증 내 하위 상점 거래 등록
`resend_webhook`(*, payment_id[, webhook_id])	웹훅 재발송
`resend_webhook_async`(*, payment_id[, webhook_id])	웹훅 재발송

Attributes

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

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'] | str | None = None) → PreRegisterPaymentResponse#

결제 정보 사전 등록

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

Parameters:

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

Raises:

PreRegisterPaymentError –

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'] | str | None = None) → PreRegisterPaymentResponse#

결제 정보 사전 등록

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

Parameters:

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

Raises:

PreRegisterPaymentError –

결제 단건 조회

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

Parameters:: payment_id (str) – 조회할 결제 아이디
Raises:: GetPaymentError –

결제 단건 조회

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

Parameters:: payment_id (str) – 조회할 결제 아이디
Raises:: GetPaymentError –

get_payment_transactions(*, payment_id: str) → GetPaymentTransactionsResponse#

결제 시도 내역 조회

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

Parameters:: payment_id (str) – 조회할 결제 아이디
Raises:: GetPaymentTransactionsError –

async get_payment_transactions_async(*, payment_id: str) → GetPaymentTransactionsResponse#

결제 시도 내역 조회

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

Parameters:: payment_id (str) – 조회할 결제 아이디
Raises:: GetPaymentTransactionsError –

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

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

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

Parameters:

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

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

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

Raises:

GetPaymentsError –

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:

GetPaymentsError –

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:

GetAllPaymentsError –

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:

GetAllPaymentsError –

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'] | str | None = None, promotion_discount_retain_option: Literal['RETAIN', 'RELEASE'] | str | 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으로 입력합니다.
promotion_discount_retain_option (PromotionDiscountRetainOption, optional) –
프로모션 할인율 유지 옵션

프로모션이 적용된 결제를 부분 취소하는 경우, 최초 할인율을 유지할지 여부를 선택할 수 있습니다. RETAIN 으로 설정 시, 최초 할인율을 유지할 수 있도록 취소 금액이 조정됩니다. RELEASE 으로 설정 시, 취소 후 남은 금액이 속한 구간에 맞게 프로모션 할인이 새롭게 적용됩니다. 값을 입력하지 않으면 RELEASE 로 취급합니다.
current_cancellable_amount (int, optional) –
결제 건의 취소 가능 잔액

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

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

Raises:

CancelPaymentError –

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'] | str | None = None, promotion_discount_retain_option: Literal['RETAIN', 'RELEASE'] | str | 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으로 입력합니다.
promotion_discount_retain_option (PromotionDiscountRetainOption, optional) –
프로모션 할인율 유지 옵션

프로모션이 적용된 결제를 부분 취소하는 경우, 최초 할인율을 유지할지 여부를 선택할 수 있습니다. RETAIN 으로 설정 시, 최초 할인율을 유지할 수 있도록 취소 금액이 조정됩니다. RELEASE 으로 설정 시, 취소 후 남은 금액이 속한 구간에 맞게 프로모션 할인이 새롭게 적용됩니다. 값을 입력하지 않으면 RELEASE 로 취급합니다.
current_cancellable_amount (int, optional) –
결제 건의 취소 가능 잔액

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

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

Raises:

CancelPaymentError –

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'] | str, 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'] | str | None = None, notice_urls: list[str] | None = None, products: list[PaymentProduct] | None = None, product_count: int | None = None, product_type: Literal['PHYSICAL', 'DIGITAL'] | str | 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:

PayWithBillingKeyError –

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'] | str, 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'] | str | None = None, notice_urls: list[str] | None = None, products: list[PaymentProduct] | None = None, product_count: int | None = None, product_type: Literal['PHYSICAL', 'DIGITAL'] | str | 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:

PayWithBillingKeyError –

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

PayInstantlyError –

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

PayInstantlyError –

close_virtual_account(*, payment_id: str) → CloseVirtualAccountResponse#

가상계좌 말소

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

Parameters:: payment_id (str) – 결제 건 아이디
Raises:: CloseVirtualAccountError –

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

가상계좌 말소

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

Parameters:: payment_id (str) – 결제 건 아이디
Raises:: CloseVirtualAccountError –

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:

ApplyEscrowLogisticsError –

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:

ApplyEscrowLogisticsError –

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:

ModifyEscrowLogisticsError –

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:

ModifyEscrowLogisticsError –

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

에스크로 구매 확정

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

Parameters:

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

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

Raises:

ConfirmEscrowError –

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

에스크로 구매 확정

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

Parameters:

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

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

Raises:

ConfirmEscrowError –

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

웹훅 재발송

웹훅을 재발송합니다.

Parameters:

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

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

Raises:

ResendWebhookError –

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

웹훅 재발송

웹훅을 재발송합니다.

Parameters:

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

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

Raises:

ResendWebhookError –

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

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

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

Parameters:

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

Raises:

RegisterStoreReceiptError –

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

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

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

Parameters:

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

Raises:

RegisterStoreReceiptError –

portone_server_sdk.PaymentClient

Contents

portone_server_sdk.PaymentClient#