portone_server_sdk.payment.payment_schedule

Classes

CreatePaymentScheduleBody	결제 예약 요청 입력 정보
CreatePaymentScheduleResponse	결제 예약 성공 응답
FailedPaymentSchedule	결제 실패 상태
GetPaymentSchedulesBody	결제 예약 다건 조회를 위한 입력 정보
GetPaymentSchedulesResponse	결제 예약 다건 조회 성공 응답 정보
PaymentScheduleFilterInput	결제 예약 건 다건 조회를 위한 입력 정보
PaymentScheduleSortInput	결제 예약 건 다건 조회 시 정렬 조건
PaymentScheduleSummary	결제 예약 건
PendingPaymentSchedule	결제 완료 대기 상태
RevokePaymentSchedulesBody	결제 예약 건 취소 요청 입력 정보
RevokePaymentSchedulesResponse	결제 예약 건 취소 성공 응답
RevokedPaymentSchedule	결제 예약 취소 상태
ScheduledPaymentSchedule	결제 예약 완료 상태
StartedPaymentSchedule	결제 시작 상태
SucceededPaymentSchedule	결제 성공 상태
PaymentScheduleClient

Exceptions

CreatePaymentScheduleError
GetPaymentScheduleError
GetPaymentSchedulesError
RevokePaymentSchedulesError

exception portone_server_sdk.payment.payment_schedule.CreatePaymentScheduleError

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.payment_schedule.GetPaymentScheduleError

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.payment_schedule.GetPaymentSchedulesError

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.payment_schedule.RevokePaymentSchedulesError

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.payment_schedule.CreatePaymentScheduleBody

Bases: object

결제 예약 요청 입력 정보

payment: BillingKeyPaymentInput

빌링키 결제 입력 정보

time_to_pay: str

결제 예정 시점 (RFC 3339 date-time)

class portone_server_sdk.payment.payment_schedule.CreatePaymentScheduleResponse

Bases: object

결제 예약 성공 응답

schedule: PaymentScheduleSummary

결제 예약 건

class portone_server_sdk.payment.payment_schedule.FailedPaymentSchedule

Bases: object

결제 실패 상태

id: str

결제 예약 건 아이디

merchant_id: str

고객사 아이디

store_id: str

상점 아이디

payment_id: str

결제 건 아이디

billing_key: str

빌링키

order_name: str

주문명

is_cultural_expense: bool

문화비 지출 여부

is_escrow: bool

에스크로 결제 여부

customer: Customer

고객 정보

custom_data: 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'] | str

통화

created_at: str

결제 예약 등록 시점 (RFC 3339 date-time)

time_to_pay: str

결제 예정 시점 (RFC 3339 date-time)

started_at: str

결제 시작 시점 (RFC 3339 date-time)

completed_at: str

결제 완료 시점 (RFC 3339 date-time)

tax_free_amount: int | None

면세액 (int64)

vat_amount: int | None

부가세 (int64)

installment_month: int | None

할부 개월 수 (int32)

notice_urls: list[str] | None

웹훅 주소

products: list[PaymentProduct] | None

상품 정보

class portone_server_sdk.payment.payment_schedule.GetPaymentSchedulesBody

Bases: object

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

조회 결과는 결제 예정 시점(timeToPay) 기준 최신 순으로 정렬됩니다.

page: PageInput | None

요청할 페이지 정보

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

sort: PaymentScheduleSortInput | None

정렬 조건

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

filter: PaymentScheduleFilterInput | None

조회할 결제 예약 건의 조건 필터

class portone_server_sdk.payment.payment_schedule.GetPaymentSchedulesResponse

Bases: object

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

items: list[FailedPaymentSchedule | PendingPaymentSchedule | RevokedPaymentSchedule | ScheduledPaymentSchedule | StartedPaymentSchedule | SucceededPaymentSchedule | dict]

조회된 결제 예약 건 리스트

page: PageInfo

조회된 페이지 정보

class portone_server_sdk.payment.payment_schedule.PaymentScheduleFilterInput

Bases: object

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

store_id: str | None

상점 아이디

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

billing_key: str | None

빌링키

from_: str | None

결제 예정 시점 조건 범위의 시작

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

until: str | None

결제 예정 시점 조건 범위의 끝

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

status: list[Literal['SCHEDULED', 'STARTED', 'SUCCEEDED', 'FAILED', 'REVOKED', 'PENDING'] | str] | None

결제 예약 건 상태 리스트

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

class portone_server_sdk.payment.payment_schedule.PaymentScheduleSortInput

Bases: object

결제 예약 건 다건 조회 시 정렬 조건

by: Literal['CREATED_AT', 'TIME_TO_PAY', 'COMPLETED_AT'] | str | None

정렬 기준 필드

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

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

정렬 순서

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

class portone_server_sdk.payment.payment_schedule.PaymentScheduleSummary

Bases: object

결제 예약 건

id: str

결제 예약 건 아이디

class portone_server_sdk.payment.payment_schedule.PendingPaymentSchedule

Bases: object

결제 완료 대기 상태

id: str

결제 예약 건 아이디

merchant_id: str

고객사 아이디

store_id: str

상점 아이디

payment_id: str

결제 건 아이디

billing_key: str

빌링키

order_name: str

주문명

is_cultural_expense: bool

문화비 지출 여부

is_escrow: bool

에스크로 결제 여부

customer: Customer

고객 정보

custom_data: 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'] | str

통화

created_at: str

결제 예약 등록 시점 (RFC 3339 date-time)

time_to_pay: str

결제 예정 시점 (RFC 3339 date-time)

started_at: str

결제 시작 시점 (RFC 3339 date-time)

completed_at: str

결제 완료 시점 (RFC 3339 date-time)

tax_free_amount: int | None

면세액 (int64)

vat_amount: int | None

부가세 (int64)

installment_month: int | None

할부 개월 수 (int32)

notice_urls: list[str] | None

웹훅 주소

products: list[PaymentProduct] | None

상품 정보

class portone_server_sdk.payment.payment_schedule.RevokePaymentSchedulesBody

Bases: object

결제 예약 건 취소 요청 입력 정보

store_id: str | None

상점 아이디

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

billing_key: str | None

빌링키

schedule_ids: list[str] | None

결제 예약 건 아이디 목록

class portone_server_sdk.payment.payment_schedule.RevokePaymentSchedulesResponse

Bases: object

결제 예약 건 취소 성공 응답

revoked_schedule_ids: list[str]

취소 완료된 결제 예약 건 아이디 목록

revoked_at: str | None

결제 예약 건 취소 완료 시점 (RFC 3339 date-time)

class portone_server_sdk.payment.payment_schedule.RevokedPaymentSchedule

Bases: object

결제 예약 취소 상태

id: str

결제 예약 건 아이디

merchant_id: str

고객사 아이디

store_id: str

상점 아이디

payment_id: str

결제 건 아이디

billing_key: str

빌링키

order_name: str

주문명

is_cultural_expense: bool

문화비 지출 여부

is_escrow: bool

에스크로 결제 여부

customer: Customer

고객 정보

custom_data: 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'] | str

통화

created_at: str

결제 예약 등록 시점 (RFC 3339 date-time)

time_to_pay: str

결제 예정 시점 (RFC 3339 date-time)

revoked_at: str

결제 취소 시점 (RFC 3339 date-time)

tax_free_amount: int | None

면세액 (int64)

vat_amount: int | None

부가세 (int64)

installment_month: int | None

할부 개월 수 (int32)

notice_urls: list[str] | None

웹훅 주소

products: list[PaymentProduct] | None

상품 정보

class portone_server_sdk.payment.payment_schedule.ScheduledPaymentSchedule

Bases: object

결제 예약 완료 상태

id: str

결제 예약 건 아이디

merchant_id: str

고객사 아이디

store_id: str

상점 아이디

payment_id: str

결제 건 아이디

billing_key: str

빌링키

order_name: str

주문명

is_cultural_expense: bool

문화비 지출 여부

is_escrow: bool

에스크로 결제 여부

customer: Customer

고객 정보

custom_data: 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'] | str

통화

created_at: str

결제 예약 등록 시점 (RFC 3339 date-time)

time_to_pay: str

결제 예정 시점 (RFC 3339 date-time)

tax_free_amount: int | None

면세액 (int64)

vat_amount: int | None

부가세 (int64)

installment_month: int | None

할부 개월 수 (int32)

notice_urls: list[str] | None

웹훅 주소

products: list[PaymentProduct] | None

상품 정보

class portone_server_sdk.payment.payment_schedule.StartedPaymentSchedule

Bases: object

결제 시작 상태

id: str

결제 예약 건 아이디

merchant_id: str

고객사 아이디

store_id: str

상점 아이디

payment_id: str

결제 건 아이디

billing_key: str

빌링키

order_name: str

주문명

is_cultural_expense: bool

문화비 지출 여부

is_escrow: bool

에스크로 결제 여부

customer: Customer

고객 정보

custom_data: 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'] | str

통화

created_at: str

결제 예약 등록 시점 (RFC 3339 date-time)

time_to_pay: str

결제 예정 시점 (RFC 3339 date-time)

started_at: str

결제 시작 시점 (RFC 3339 date-time)

tax_free_amount: int | None

면세액 (int64)

vat_amount: int | None

부가세 (int64)

installment_month: int | None

할부 개월 수 (int32)

notice_urls: list[str] | None

웹훅 주소

products: list[PaymentProduct] | None

상품 정보

class portone_server_sdk.payment.payment_schedule.SucceededPaymentSchedule

Bases: object

결제 성공 상태

id: str

결제 예약 건 아이디

merchant_id: str

고객사 아이디

store_id: str

상점 아이디

payment_id: str

결제 건 아이디

billing_key: str

빌링키

order_name: str

주문명

is_cultural_expense: bool

문화비 지출 여부

is_escrow: bool

에스크로 결제 여부

customer: Customer

고객 정보

custom_data: 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'] | str

통화

created_at: str

결제 예약 등록 시점 (RFC 3339 date-time)

time_to_pay: str

결제 예정 시점 (RFC 3339 date-time)

started_at: str

결제 시작 시점 (RFC 3339 date-time)

completed_at: str

결제 완료 시점 (RFC 3339 date-time)

tax_free_amount: int | None

면세액 (int64)

vat_amount: int | None

부가세 (int64)

installment_month: int | None

할부 개월 수 (int32)

notice_urls: list[str] | None

웹훅 주소

products: list[PaymentProduct] | None

상품 정보

class portone_server_sdk.payment.payment_schedule.PaymentScheduleClient

Bases: object

get_payment_schedule(*, payment_schedule_id: str) → FailedPaymentSchedule | PendingPaymentSchedule | RevokedPaymentSchedule | ScheduledPaymentSchedule | StartedPaymentSchedule | SucceededPaymentSchedule | dict

결제 예약 단건 조회

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

Parameters:

payment_schedule_id (str) – 조회할 결제 예약 건 아이디

Raises:

• GetPaymentScheduleError – API 호출이 실패한 경우

• ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

async get_payment_schedule_async(*, payment_schedule_id: str) → FailedPaymentSchedule | PendingPaymentSchedule | RevokedPaymentSchedule | ScheduledPaymentSchedule | StartedPaymentSchedule | SucceededPaymentSchedule | dict

결제 예약 단건 조회

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

Parameters:

payment_schedule_id (str) – 조회할 결제 예약 건 아이디

Raises:

• GetPaymentScheduleError – API 호출이 실패한 경우

• ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

get_payment_schedules(*, page: PageInput | None = None, sort: PaymentScheduleSortInput | None = None, filter: PaymentScheduleFilterInput | None = None) → GetPaymentSchedulesResponse

결제 예약 다건 조회

주어진 조건에 맞는 결제 예약 건들을 조회합니다. filter.from, filter.until 파라미터의 기본값이 결제 시점 기준 지난 90일에 속하는 건을 조회하도록 되어 있으니, 미래 예약 상태의 건을 조회하기 위해서는 해당 파라미터를 직접 설정해 주셔야 합니다.

Parameters:

• page (PageInput, optional) –

  요청할 페이지 정보

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

• sort (PaymentScheduleSortInput, optional) –

  정렬 조건

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

• filter (PaymentScheduleFilterInput, optional) – 조회할 결제 예약 건의 조건 필터

Raises:

• GetPaymentSchedulesError – API 호출이 실패한 경우

• ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

async get_payment_schedules_async(*, page: PageInput | None = None, sort: PaymentScheduleSortInput | None = None, filter: PaymentScheduleFilterInput | None = None) → GetPaymentSchedulesResponse

결제 예약 다건 조회

주어진 조건에 맞는 결제 예약 건들을 조회합니다. filter.from, filter.until 파라미터의 기본값이 결제 시점 기준 지난 90일에 속하는 건을 조회하도록 되어 있으니, 미래 예약 상태의 건을 조회하기 위해서는 해당 파라미터를 직접 설정해 주셔야 합니다.

Parameters:

• page (PageInput, optional) –

  요청할 페이지 정보

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

• sort (PaymentScheduleSortInput, optional) –

  정렬 조건

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

• filter (PaymentScheduleFilterInput, optional) – 조회할 결제 예약 건의 조건 필터

Raises:

• GetPaymentSchedulesError – API 호출이 실패한 경우

• ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

revoke_payment_schedules(*, billing_key: str | None = None, schedule_ids: list[str] | None = None) → RevokePaymentSchedulesResponse

결제 예약 취소

결제 예약 건을 취소합니다. billingKey, scheduleIds 중 하나 이상은 필수로 입력합니다. billingKey 만 입력된 경우 -> 해당 빌링키로 예약된 모든 결제 예약 건들이 취소됩니다. scheduleIds 만 입력된 경우 -> 입력된 결제 예약 건 아이디에 해당하는 예약 건들이 취소됩니다. billingKey, scheduleIds 모두 입력된 경우 -> 입력된 결제 예약 건 아이디에 해당하는 예약 건들이 취소됩니다. 단, 예약한 빌링키가 입력된 빌링키와 일치하지 않으면 실패합니다. 위 정책에 따라 선택된 결제 예약 건들 중 하나라도 취소에 실패할 경우, 모든 취소 요청이 실패합니다.

Parameters:

• billing_key (str, optional) – 빌링키

• schedule_ids (list[str], optional) – 결제 예약 건 아이디 목록

Raises:

• RevokePaymentSchedulesError – API 호출이 실패한 경우

• ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

async revoke_payment_schedules_async(*, billing_key: str | None = None, schedule_ids: list[str] | None = None) → RevokePaymentSchedulesResponse

결제 예약 취소

결제 예약 건을 취소합니다. billingKey, scheduleIds 중 하나 이상은 필수로 입력합니다. billingKey 만 입력된 경우 -> 해당 빌링키로 예약된 모든 결제 예약 건들이 취소됩니다. scheduleIds 만 입력된 경우 -> 입력된 결제 예약 건 아이디에 해당하는 예약 건들이 취소됩니다. billingKey, scheduleIds 모두 입력된 경우 -> 입력된 결제 예약 건 아이디에 해당하는 예약 건들이 취소됩니다. 단, 예약한 빌링키가 입력된 빌링키와 일치하지 않으면 실패합니다. 위 정책에 따라 선택된 결제 예약 건들 중 하나라도 취소에 실패할 경우, 모든 취소 요청이 실패합니다.

Parameters:

• billing_key (str, optional) – 빌링키

• schedule_ids (list[str], optional) – 결제 예약 건 아이디 목록

Raises:

• RevokePaymentSchedulesError – API 호출이 실패한 경우

• ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

create_payment_schedule(*, payment_id: str, payment: BillingKeyPaymentInput, time_to_pay: str) → CreatePaymentScheduleResponse

결제 예약

결제를 예약합니다.

Parameters:

• payment_id (str) – 결제 건 아이디

• payment (BillingKeyPaymentInput) – 빌링키 결제 입력 정보

• time_to_pay (str) – 결제 예정 시점

Raises:

• CreatePaymentScheduleError – API 호출이 실패한 경우

• ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우

async create_payment_schedule_async(*, payment_id: str, payment: BillingKeyPaymentInput, time_to_pay: str) → CreatePaymentScheduleResponse

결제 예약

결제를 예약합니다.

Parameters:

• payment_id (str) – 결제 건 아이디

• payment (BillingKeyPaymentInput) – 빌링키 결제 입력 정보

• time_to_pay (str) – 결제 예정 시점

Raises:

• CreatePaymentScheduleError – API 호출이 실패한 경우

• ValueError – 현재 SDK 버전에서 지원하지 않는 API 응답을 받은 경우