portone_server_sdk.CashReceiptClient

portone_server_sdk.CashReceiptClient#

class portone_server_sdk.CashReceiptClient#

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 클라이언트를 생성합니다.

cancel_cash_receipt_by_payment_id(*, payment_id)

현금 영수증 취소

cancel_cash_receipt_by_payment_id_async(*, ...)

현금 영수증 취소

get_cash_receipt_by_payment_id(*, payment_id)

현금 영수증 단건 조회

get_cash_receipt_by_payment_id_async(*, ...)

현금 영수증 단건 조회

issue_cash_receipt(*, payment_id, ...[, ...])

현금 영수증 수동 발급

issue_cash_receipt_async(*, payment_id, ...)

현금 영수증 수동 발급
get_cash_receipt_by_payment_id(*, payment_id: str) → CancelledCashReceipt | IssuedCashReceipt | IssueFailedCashReceipt | dict#

현금 영수증 단건 조회

주어진 결제 아이디에 대응되는 현금 영수증 내역을 조회합니다.

Parameters:

payment_id (str) – 결제 건 아이디

Raises:

GetCashReceiptError –

async get_cash_receipt_by_payment_id_async(*, payment_id: str) → CancelledCashReceipt | IssuedCashReceipt | IssueFailedCashReceipt | dict#

현금 영수증 단건 조회

주어진 결제 아이디에 대응되는 현금 영수증 내역을 조회합니다.

Parameters:

payment_id (str) – 결제 건 아이디

Raises:

GetCashReceiptError –

issue_cash_receipt(*, payment_id: str, channel_key: str, type: Literal['PERSONAL', 'CORPORATE'] | str, order_name: str, 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, amount: PaymentAmountInput, product_type: Literal['PHYSICAL', 'DIGITAL'] | str | None = None, customer: IssueCashReceiptCustomerInput, paid_at: str | None = None) → IssueCashReceiptResponse#

현금 영수증 수동 발급

현금 영수증 발급을 요청합니다.

Parameters:

  • payment_id (str) –

    결제 건 아이디

    외부 결제 건에 대한 수동 발급의 경우, 아이디를 직접 채번하여 입력합니다.

  • channel_key (str) – 채널 키

  • type (CashReceiptType) – 현금 영수증 유형

  • order_name (str) – 주문명

  • currency (Currency) – 화폐

  • amount (PaymentAmountInput) – 금액 세부 입력 정보

  • product_type (PaymentProductType, optional) – 상품 유형

  • customer (IssueCashReceiptCustomerInput) – 고객 정보

  • paid_at (str, optional) – 결제 일자

Raises:

IssueCashReceiptError –

async issue_cash_receipt_async(*, payment_id: str, channel_key: str, type: Literal['PERSONAL', 'CORPORATE'] | str, order_name: str, 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, amount: PaymentAmountInput, product_type: Literal['PHYSICAL', 'DIGITAL'] | str | None = None, customer: IssueCashReceiptCustomerInput, paid_at: str | None = None) → IssueCashReceiptResponse#

현금 영수증 수동 발급

현금 영수증 발급을 요청합니다.

Parameters:

  • payment_id (str) –

    결제 건 아이디

    외부 결제 건에 대한 수동 발급의 경우, 아이디를 직접 채번하여 입력합니다.

  • channel_key (str) – 채널 키

  • type (CashReceiptType) – 현금 영수증 유형

  • order_name (str) – 주문명

  • currency (Currency) – 화폐

  • amount (PaymentAmountInput) – 금액 세부 입력 정보

  • product_type (PaymentProductType, optional) – 상품 유형

  • customer (IssueCashReceiptCustomerInput) – 고객 정보

  • paid_at (str, optional) – 결제 일자

Raises:

IssueCashReceiptError –

cancel_cash_receipt_by_payment_id(*, payment_id: str) → CancelCashReceiptResponse#

현금 영수증 취소

현금 영수증 취소를 요청합니다.

Parameters:

payment_id (str) – 결제 건 아이디

Raises:

CancelCashReceiptError –

async cancel_cash_receipt_by_payment_id_async(*, payment_id: str) → CancelCashReceiptResponse#

현금 영수증 취소

현금 영수증 취소를 요청합니다.

Parameters:

payment_id (str) – 결제 건 아이디

Raises:

CancelCashReceiptError –