Type Alias BillingKeyClient

BillingKeyClient: {
    getBillingKeyInfo: ((billingKey: string) => Promise<BillingKeyInfo>);
    deleteBillingKey: ((billingKey: string) => Promise<DeleteBillingKeyResponse>);
    getBillingKeyInfos: ((options?: {
        page?: PageInput;
        sort?: BillingKeySortInput;
        filter?: BillingKeyFilterInput;
    }) => Promise<GetBillingKeyInfosResponse>);
    issueBillingKey: ((options: {
        method: InstantBillingKeyPaymentMethodInput;
        channelKey?: string;
        channelGroupId?: string;
        customer?: CustomerInput;
        customData?: string;
        bypass?: object;
        noticeUrls?: string[];
    }) => Promise<IssueBillingKeyResponse>);
}

Type declaration

getBillingKeyInfo: ((billingKey: string) => Promise<BillingKeyInfo>)
빌링키 단건 조회

주어진 빌링키에 대응되는 빌링키 정보를 조회합니다.

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

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

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

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

Throws
Errors.UnknownError API 응답이 알 수 없는 형식인 경우
- - (billingKey): Promise<BillingKeyInfo>
  - Parameters
    - billingKey: string
      조회할 빌링키
    Returns Promise<BillingKeyInfo>
deleteBillingKey: ((billingKey: string) => Promise<DeleteBillingKeyResponse>)
빌링키 삭제

빌링키를 삭제합니다.

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

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

Throws
Errors.BillingKeyNotIssuedError BillingKeyNotIssuedError

Throws
Errors.ChannelSpecificError 여러 채널을 지정한 요청에서, 채널 각각에서 오류가 발생한 경우

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

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

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

Throws
Errors.PgProviderError PG사에서 오류를 전달한 경우

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

Throws
Errors.UnknownError API 응답이 알 수 없는 형식인 경우
- - (billingKey): Promise<DeleteBillingKeyResponse>
  - Parameters
    - billingKey: string
      삭제할 빌링키
    Returns Promise<DeleteBillingKeyResponse>
getBillingKeyInfos: ((options?: {
    page?: PageInput;
    sort?: BillingKeySortInput;
    filter?: BillingKeyFilterInput;
}) => Promise<GetBillingKeyInfosResponse>)
빌링키 다건 조회

주어진 조건에 맞는 빌링키들을 페이지 기반으로 조회합니다.

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

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

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

Throws
Errors.UnknownError API 응답이 알 수 없는 형식인 경우
- - (options?): Promise<GetBillingKeyInfosResponse>
  - Parameters
    - Optionaloptions: {
          page?: PageInput;
          sort?: BillingKeySortInput;
          filter?: BillingKeyFilterInput;
      }
      Optionalpage?: PageInput
      요청할 페이지 정보
      
      미 입력 시 number: 0, size: 10 으로 기본값이 적용됩니다.
      
      Optionalsort?: BillingKeySortInput
      정렬 조건
      
      미 입력 시 sortBy: TIME_TO_PAY, sortOrder: DESC 으로 기본값이 적용됩니다.
      
      Optionalfilter?: BillingKeyFilterInput
      조회할 빌링키 조건 필터
      
      V1 빌링키 건의 경우 일부 필드에 대해 필터가 적용되지 않을 수 있습니다.
    Returns Promise<GetBillingKeyInfosResponse>
issueBillingKey: ((options: {
    method: InstantBillingKeyPaymentMethodInput;
    channelKey?: string;
    channelGroupId?: string;
    customer?: CustomerInput;
    customData?: string;
    bypass?: object;
    noticeUrls?: string[];
}) => Promise<IssueBillingKeyResponse>)
빌링키 발급

빌링키 발급을 요청합니다.

Throws
Errors.ChannelNotFoundError 요청된 채널이 존재하지 않는 경우

Throws
Errors.ChannelSpecificError 여러 채널을 지정한 요청에서, 채널 각각에서 오류가 발생한 경우

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

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

Throws
Errors.PgProviderError PG사에서 오류를 전달한 경우

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

Throws
Errors.UnknownError API 응답이 알 수 없는 형식인 경우
- - (options): Promise<IssueBillingKeyResponse>
  - Parameters
    - options: {
          method: InstantBillingKeyPaymentMethodInput;
          channelKey?: string;
          channelGroupId?: string;
          customer?: CustomerInput;
          customData?: string;
          bypass?: object;
          noticeUrls?: string[];
      }
      method: InstantBillingKeyPaymentMethodInput
      빌링키 결제 수단 정보
      
      OptionalchannelKey?: string
      채널 키
      
      채널 키 또는 채널 그룹 ID 필수
      
      OptionalchannelGroupId?: string
      채널 그룹 ID
      
      채널 키 또는 채널 그룹 ID 필수
      
      Optionalcustomer?: CustomerInput
      고객 정보
      
      OptionalcustomData?: string
      사용자 지정 데이터
      
      Optionalbypass?: object
      PG사별 추가 파라미터 ("PG사별 연동 가이드" 참고)
      
      OptionalnoticeUrls?: string[]
      웹훅 주소
      
      빌링키 발급 시 요청을 받을 웹훅 주소입니다. 상점에 설정되어 있는 값보다 우선적으로 적용됩니다. 입력된 값이 없을 경우에는 빈 배열로 해석됩니다.
    Returns Promise<IssueBillingKeyResponse>

Type Alias BillingKeyClient

Type declaration

getBillingKeyInfo: ((billingKey: string) => Promise<BillingKeyInfo>)

Throws

Throws

Throws

Throws

Throws

Parameters

Returns Promise<BillingKeyInfo>

deleteBillingKey: ((billingKey: string) => Promise<DeleteBillingKeyResponse>)

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Parameters

Returns Promise<DeleteBillingKeyResponse>

getBillingKeyInfos: ((options?: { page?: PageInput; sort?: BillingKeySortInput; filter?: BillingKeyFilterInput; }) => Promise<GetBillingKeyInfosResponse>)

Throws

Throws

Throws

Throws

Parameters

Optionalpage?: PageInput

Optionalsort?: BillingKeySortInput

Optionalfilter?: BillingKeyFilterInput

Returns Promise<GetBillingKeyInfosResponse>

issueBillingKey: ((options: { method: InstantBillingKeyPaymentMethodInput; channelKey?: string; channelGroupId?: string; customer?: CustomerInput; customData?: string; bypass?: object; noticeUrls?: string[]; }) => Promise<IssueBillingKeyResponse>)

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Parameters

method: InstantBillingKeyPaymentMethodInput

OptionalchannelKey?: string

OptionalchannelGroupId?: string

Optionalcustomer?: CustomerInput

OptionalcustomData?: string

Optionalbypass?: object

OptionalnoticeUrls?: string[]

Returns Promise<IssueBillingKeyResponse>

Settings

getBillingKeyInfos: ((options?: {
page?: PageInput;
sort?: BillingKeySortInput;
filter?: BillingKeyFilterInput;
}) => Promise<GetBillingKeyInfosResponse>)

`Optional`page?: PageInput

`Optional`sort?: BillingKeySortInput

`Optional`filter?: BillingKeyFilterInput

issueBillingKey: ((options: {
method: InstantBillingKeyPaymentMethodInput;
channelKey?: string;
channelGroupId?: string;
customer?: CustomerInput;
customData?: string;
bypass?: object;
noticeUrls?: string[];
}) => Promise<IssueBillingKeyResponse>)

`Optional`channelKey?: string

`Optional`channelGroupId?: string

`Optional`customer?: CustomerInput

`Optional`customData?: string

`Optional`bypass?: object

`Optional`noticeUrls?: string[]