portone_server_sdk.payment.cash_receipt

portone_server_sdk.payment.cash_receipt#

Classes

`CancelCashReceiptResponse`	현금 영수증 취소 성공 응답
`CancelledCashReceipt`	발급 취소
`CashReceiptFilterInput`	현금영수증 다건 조회를 위한 입력 정보
`CashReceiptSortInput`	현금영수증 다건 조회 시 정렬 조건
`CashReceiptSummary`	현금영수증 내역
`GetCashReceiptsBody`	현금영수증 다건 조회를 위한 입력 정보
`GetCashReceiptsResponse`	현금영수증 다건 조회 성공 응답 정보
`IssueCashReceiptBody`	현금영수증 발급 요청 양식
`IssueCashReceiptCustomerInput`	현금영수증 발급 시 고객 관련 입력 정보
`IssueCashReceiptResponse`	현금 영수증 발급 성공 응답
`IssueFailedCashReceipt`	발급 실패
`IssuedCashReceipt`	발급 완료
`CashReceiptClient`

Exceptions

`CancelCashReceiptError`
`GetCashReceiptError`
`GetCashReceiptsError`
`IssueCashReceiptError`

exception portone_server_sdk.payment.cash_receipt.CancelCashReceiptError#

Bases: PortOneError

args#

with_traceback()#: Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

message: str | None#

exception portone_server_sdk.payment.cash_receipt.GetCashReceiptError#

Bases: PortOneError

args#

with_traceback()#: Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

message: str | None#

exception portone_server_sdk.payment.cash_receipt.GetCashReceiptsError#

Bases: PortOneError

args#

with_traceback()#: Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

message: str | None#

exception portone_server_sdk.payment.cash_receipt.IssueCashReceiptError#

Bases: PortOneError

args#

with_traceback()#: Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

message: str | None#

class portone_server_sdk.payment.cash_receipt.CancelCashReceiptResponse#

Bases: object

현금 영수증 취소 성공 응답

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

cancelled_at: str#: 현금 영수증 취소 완료 시점 (RFC 3339 date-time)

class portone_server_sdk.payment.cash_receipt.CancelledCashReceipt#

Bases: object

발급 취소

merchant_id: str#: 고객사 아이디

store_id: str#: 상점 아이디

payment_id: str#: 결제 건 아이디

channel: SelectedChannel#: 현금영수증 발급에 사용된 채널

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

order_name: str#: 주문명

is_manual: bool#: 수동 발급 여부

issue_number: str#: 승인번호

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

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

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

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

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

pg_receipt_id: str | None#: PG사 현금영수증 아이디

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

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

class portone_server_sdk.payment.cash_receipt.CashReceiptFilterInput#

Bases: object

현금영수증 다건 조회를 위한 입력 정보

store_id: str | None#

상점 아이디

Merchant 사용자만 사용가능하며, 지정되지 않은 경우 고객사 전체 현금영수증을 조회합니다.

time_range_field: Literal['ISSUED_AT', 'CANCELLED_AT', 'STATUS_UPDATED_AT'] | str | None#

조회 기준 시점 유형

값을 입력하지 않으면 ISSUED_AT으로 설정됩니다.

from_: str | None#

조회 기준 시점 범위의 시작

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

until: str | None#

조회 기준 시점 범위의 끝

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

payment_id: str | None#: 고객사 결제 아이디

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

order_name: str | None#: 주문명

statuses: list[Literal['ISSUED', 'CANCELLED', 'FAILED'] | str] | None#

현금영수증 발급 상태 리스트

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

is_manual: bool | None#: 수동 발급 여부

pg_receipt_id: str | None#: PG사 현금영수증 발급 번호

pg_merchant_id: str | None#: PG 상점아이디

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

PG사 결제 모듈 리스트

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

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

PG사 리스트

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

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

class portone_server_sdk.payment.cash_receipt.CashReceiptSortInput#

Bases: object

현금영수증 다건 조회 시 정렬 조건

by: Literal['ISSUED_AT', 'CANCELLED_AT', 'STATUS_UPDATED_AT'] | str | None#

정렬 기준 필드

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

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

정렬 순서

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

class portone_server_sdk.payment.cash_receipt.CashReceiptSummary#

Bases: object

현금영수증 내역

issue_number: str#: 발행 번호

url: str#: 현금 영수증 URL

pg_receipt_id: str#: PG사 현금영수증 아이디

class portone_server_sdk.payment.cash_receipt.GetCashReceiptsBody#

Bases: object

현금영수증 다건 조회를 위한 입력 정보

page: PageInput | None#

요청할 페이지 정보

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

sort: CashReceiptSortInput | None#

정렬 조건

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

filter: CashReceiptFilterInput | None#: 조회할 현금영수증 조건 필터

class portone_server_sdk.payment.cash_receipt.GetCashReceiptsResponse#

Bases: object

현금영수증 다건 조회 성공 응답 정보

items: list[CancelledCashReceipt | IssuedCashReceipt | IssueFailedCashReceipt | dict]#: 조회된 현금영수증 리스트

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

class portone_server_sdk.payment.cash_receipt.IssueCashReceiptBody#

Bases: object

현금영수증 발급 요청 양식

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#: 금액 세부 입력 정보

customer: IssueCashReceiptCustomerInput#: 고객 정보

store_id: str | None#

상점 아이디

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

product_type: Literal['PHYSICAL', 'DIGITAL'] | str | None#: 상품 유형

paid_at: str | None#: 결제 일자 (RFC 3339 date-time)

business_registration_number: str | None#

사업자등록번호

웰컴페이먼츠의 경우에만 입력합니다.

payment_method: Literal['TRANSFER', 'VIRTUAL_ACCOUNT'] | str | None#

결제 수단

웰컴페이먼츠의 경우에만 입력합니다.

class portone_server_sdk.payment.cash_receipt.IssueCashReceiptCustomerInput#

Bases: object

현금영수증 발급 시 고객 관련 입력 정보

identity_number: str#: 고객 식별값

name: str | None#: 이름

email: str | None#: 이메일

phone_number: str | None#: 전화번호

class portone_server_sdk.payment.cash_receipt.IssueCashReceiptResponse#

Bases: object

현금 영수증 발급 성공 응답

cash_receipt: CashReceiptSummary#

class portone_server_sdk.payment.cash_receipt.IssueFailedCashReceipt#

Bases: object

발급 실패

merchant_id: str#: 고객사 아이디

store_id: str#: 상점 아이디

payment_id: str#: 결제 건 아이디

order_name: str#: 주문명

is_manual: bool#: 수동 발급 여부

channel: SelectedChannel | None#: 현금영수증 발급에 사용된 채널

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

class portone_server_sdk.payment.cash_receipt.IssuedCashReceipt#

Bases: object

발급 완료

merchant_id: str#: 고객사 아이디

store_id: str#: 상점 아이디

payment_id: str#: 결제 건 아이디

channel: SelectedChannel#: 현금영수증 발급에 사용된 채널

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

order_name: str#: 주문명

is_manual: bool#: 수동 발급 여부

issue_number: str#: 승인 번호

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

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

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

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

pg_receipt_id: str | None#: PG사 현금영수증 아이디

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

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

class portone_server_sdk.payment.cash_receipt.CashReceiptClient#

Bases: object

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

현금 영수증 단건 조회

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

Parameters:

payment_id (str) – 결제 건 아이디

Raises:

GetCashReceiptError – API 호출이 실패한 경우
ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

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

현금 영수증 단건 조회

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

Parameters:

payment_id (str) – 결제 건 아이디

Raises:

GetCashReceiptError – API 호출이 실패한 경우
ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

get_cash_receipts(*, page: PageInput | None = None, sort: CashReceiptSortInput | None = None, filter: CashReceiptFilterInput | None = None) → GetCashReceiptsResponse#

현금영수증 다건 조회

주어진 조건에 맞는 현금영수증들을 페이지 기반으로 조회합니다.

Parameters:

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

미 입력 시 number: 0, size: 10 으로 기본값이 적용됩니다.
sort (CashReceiptSortInput, optional) –
정렬 조건

미 입력 시 sortBy: ISSUED_AT, sortOrder: DESC 으로 기본값이 적용됩니다.
filter (CashReceiptFilterInput, optional) – 조회할 현금영수증 조건 필터

Raises:

GetCashReceiptsError – API 호출이 실패한 경우
ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

async get_cash_receipts_async(*, page: PageInput | None = None, sort: CashReceiptSortInput | None = None, filter: CashReceiptFilterInput | None = None) → GetCashReceiptsResponse#

현금영수증 다건 조회

주어진 조건에 맞는 현금영수증들을 페이지 기반으로 조회합니다.

Parameters:

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

미 입력 시 number: 0, size: 10 으로 기본값이 적용됩니다.
sort (CashReceiptSortInput, optional) –
정렬 조건

미 입력 시 sortBy: ISSUED_AT, sortOrder: DESC 으로 기본값이 적용됩니다.
filter (CashReceiptFilterInput, optional) – 조회할 현금영수증 조건 필터

Raises:

GetCashReceiptsError – API 호출이 실패한 경우
ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

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, business_registration_number: str | None = None, payment_method: Literal['TRANSFER', 'VIRTUAL_ACCOUNT'] | 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) – 결제 일자
business_registration_number (str, optional) –
사업자등록번호

웰컴페이먼츠의 경우에만 입력합니다.
payment_method (IssueCashReceiptPaymentMethodType, optional) –
결제 수단

웰컴페이먼츠의 경우에만 입력합니다.

Raises:

IssueCashReceiptError – API 호출이 실패한 경우
ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

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, business_registration_number: str | None = None, payment_method: Literal['TRANSFER', 'VIRTUAL_ACCOUNT'] | 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) – 결제 일자
business_registration_number (str, optional) –
사업자등록번호

웰컴페이먼츠의 경우에만 입력합니다.
payment_method (IssueCashReceiptPaymentMethodType, optional) –
결제 수단

웰컴페이먼츠의 경우에만 입력합니다.

Raises:

IssueCashReceiptError – API 호출이 실패한 경우
ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

cancel_cash_receipt_by_payment_id(*, payment_id: str) → CancelCashReceiptResponse#

현금 영수증 취소

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

Parameters:

payment_id (str) – 결제 건 아이디

Raises:

CancelCashReceiptError – API 호출이 실패한 경우
ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

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

현금 영수증 취소

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

Parameters:

payment_id (str) – 결제 건 아이디

Raises:

CancelCashReceiptError – API 호출이 실패한 경우
ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

portone_server_sdk.payment.cash_receipt

Contents

portone_server_sdk.payment.cash_receipt#