portone_server_sdk.PaymentScheduleClient

portone_server_sdk.PaymentScheduleClient#

class portone_server_sdk.PaymentScheduleClient#

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

create_payment_schedule(*, payment_id, ...)

결제 예약

create_payment_schedule_async(*, payment_id, ...)

결제 예약

get_payment_schedule(*, payment_schedule_id)

결제 예약 단건 조회

get_payment_schedule_async(*, ...)

결제 예약 단건 조회

get_payment_schedules(*[, page, sort, filter])

결제 예약 다건 조회

get_payment_schedules_async(*[, page, sort, ...])

결제 예약 다건 조회

revoke_payment_schedules(*[, billing_key, ...])

결제 예약 취소

revoke_payment_schedules_async(*[, ...])

결제 예약 취소
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 응답을 받은 경우