Type Alias PaymentScheduleClient

PaymentScheduleClient: {
    getPaymentSchedule: ((paymentScheduleId: string) => Promise<PaymentSchedule>);
    getPaymentSchedules: ((options?: {
        page?: PageInput;
        sort?: PaymentScheduleSortInput;
        filter?: PaymentScheduleFilterInput;
    }) => Promise<GetPaymentSchedulesResponse>);
    revokePaymentSchedules: ((options?: {
        billingKey?: string;
        scheduleIds?: string[];
    }) => Promise<RevokePaymentSchedulesResponse>);
    createPaymentSchedule: ((paymentId: string, payment: BillingKeyPaymentInput, timeToPay: string) => Promise<CreatePaymentScheduleResponse>);
}

Type declaration

getPaymentSchedule: ((paymentScheduleId: string) => Promise<PaymentSchedule>)
결제 예약 단건 조회

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

Throws
Errors.ForbiddenError 요청이 거절된 경우

Throws
Errors.InvalidRequestError 요청된 입력 정보가 유효하지 않은 경우

Throws
Errors.PaymentScheduleNotFoundError 결제 예약건이 존재하지 않는 경우

Throws
Errors.UnauthorizedError 인증 정보가 올바르지 않은 경우

Throws
Errors.UnknownError API 응답이 알 수 없는 형식인 경우
- - (paymentScheduleId): Promise<PaymentSchedule>
  - Parameters
    - paymentScheduleId: string
      조회할 결제 예약 건 아이디
    Returns Promise<PaymentSchedule>
getPaymentSchedules: ((options?: {
    page?: PageInput;
    sort?: PaymentScheduleSortInput;
    filter?: PaymentScheduleFilterInput;
}) => Promise<GetPaymentSchedulesResponse>)
결제 예약 다건 조회

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

Throws
Errors.ForbiddenError 요청이 거절된 경우

Throws
Errors.InvalidRequestError 요청된 입력 정보가 유효하지 않은 경우

Throws
Errors.UnauthorizedError 인증 정보가 올바르지 않은 경우

Throws
Errors.UnknownError API 응답이 알 수 없는 형식인 경우
- - (options?): Promise<GetPaymentSchedulesResponse>
  - Parameters
    - Optionaloptions: {
          page?: PageInput;
          sort?: PaymentScheduleSortInput;
          filter?: PaymentScheduleFilterInput;
      }
      Optionalpage?: PageInput
      요청할 페이지 정보
      
      미 입력 시 number: 0, size: 10 으로 기본값이 적용됩니다.
      
      Optionalsort?: PaymentScheduleSortInput
      정렬 조건
      
      미 입력 시 sortBy: TIME_TO_PAY, sortOrder: DESC 으로 기본값이 적용됩니다.
      
      Optionalfilter?: PaymentScheduleFilterInput
      조회할 결제 예약 건의 조건 필터
    Returns Promise<GetPaymentSchedulesResponse>
revokePaymentSchedules: ((options?: {
billingKey?: string;
scheduleIds?: string[];
}) => Promise<RevokePaymentSchedulesResponse>)
결제 예약 취소

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

Throws
Errors.BillingKeyAlreadyDeletedError 빌링키가 이미 삭제된 경우

Throws
Errors.BillingKeyNotFoundError 빌링키가 존재하지 않는 경우

Throws
Errors.ForbiddenError 요청이 거절된 경우

Throws
Errors.InvalidRequestError 요청된 입력 정보가 유효하지 않은 경우

Throws
Errors.PaymentScheduleAlreadyProcessedError 결제 예약건이 이미 처리된 경우

Throws
Errors.PaymentScheduleAlreadyRevokedError 결제 예약건이 이미 취소된 경우

Throws
Errors.PaymentScheduleNotFoundError 결제 예약건이 존재하지 않는 경우

Throws
Errors.UnauthorizedError 인증 정보가 올바르지 않은 경우

Throws
Errors.UnknownError API 응답이 알 수 없는 형식인 경우
- - (options?): Promise<RevokePaymentSchedulesResponse>
  - Parameters
    - Optionaloptions: {
      billingKey?: string;
      scheduleIds?: string[];
      }
      OptionalbillingKey?: string
      빌링키
      
      OptionalscheduleIds?: string[]
      결제 예약 건 아이디 목록
    Returns Promise<RevokePaymentSchedulesResponse>
createPaymentSchedule: ((paymentId: string, payment: BillingKeyPaymentInput, timeToPay: string) => Promise<CreatePaymentScheduleResponse>)
결제 예약

결제를 예약합니다.

Throws
Errors.AlreadyPaidOrWaitingError 결제가 이미 완료되었거나 대기중인 경우

Throws
Errors.BillingKeyAlreadyDeletedError 빌링키가 이미 삭제된 경우

Throws
Errors.BillingKeyNotFoundError 빌링키가 존재하지 않는 경우

Throws
Errors.ForbiddenError 요청이 거절된 경우

Throws
Errors.InvalidRequestError 요청된 입력 정보가 유효하지 않은 경우

Throws
Errors.PaymentScheduleAlreadyExistsError 결제 예약건이 이미 존재하는 경우

Throws
Errors.SumOfPartsExceedsTotalAmountError 면세 금액 등 하위 항목들의 합이 전체 결제 금액을 초과한 경우

Throws
Errors.UnauthorizedError 인증 정보가 올바르지 않은 경우

Throws
Errors.UnknownError API 응답이 알 수 없는 형식인 경우
- - (paymentId, payment, timeToPay): Promise<CreatePaymentScheduleResponse>
  - Parameters
    - paymentId: string
      결제 건 아이디
    - payment: BillingKeyPaymentInput
      빌링키 결제 입력 정보
    - timeToPay: string
      결제 예정 시점
    Returns Promise<CreatePaymentScheduleResponse>

Type Alias PaymentScheduleClient

Type declaration

getPaymentSchedule: ((paymentScheduleId: string) => Promise<PaymentSchedule>)

Throws

Throws

Throws

Throws

Throws

Parameters

Returns Promise<PaymentSchedule>

getPaymentSchedules: ((options?: { page?: PageInput; sort?: PaymentScheduleSortInput; filter?: PaymentScheduleFilterInput; }) => Promise<GetPaymentSchedulesResponse>)

Throws

Throws

Throws

Throws

Parameters

Optionalpage?: PageInput

Optionalsort?: PaymentScheduleSortInput

Optionalfilter?: PaymentScheduleFilterInput

Returns Promise<GetPaymentSchedulesResponse>

revokePaymentSchedules: ((options?: { billingKey?: string; scheduleIds?: string[]; }) => Promise<RevokePaymentSchedulesResponse>)

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Parameters

OptionalbillingKey?: string

OptionalscheduleIds?: string[]

Returns Promise<RevokePaymentSchedulesResponse>

createPaymentSchedule: ((paymentId: string, payment: BillingKeyPaymentInput, timeToPay: string) => Promise<CreatePaymentScheduleResponse>)

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Parameters

Returns Promise<CreatePaymentScheduleResponse>

Settings

getPaymentSchedules: ((options?: {
page?: PageInput;
sort?: PaymentScheduleSortInput;
filter?: PaymentScheduleFilterInput;
}) => Promise<GetPaymentSchedulesResponse>)

`Optional`page?: PageInput

`Optional`sort?: PaymentScheduleSortInput

`Optional`filter?: PaymentScheduleFilterInput

revokePaymentSchedules: ((options?: {
billingKey?: string;
scheduleIds?: string[];
}) => Promise<RevokePaymentSchedulesResponse>)

`Optional`billingKey?: string

`Optional`scheduleIds?: string[]