Type Alias TransferClient

TransferClient: {
    getPlatformTransfer: ((id: string) => Promise<PlatformTransfer>);
    deletePlatformTransfer: ((id: string) => Promise<DeletePlatformTransferResponse>);
    getPlatformTransferSummaries: ((options?: {
        page?: PageInput;
        filter?: PlatformTransferFilterInput;
    }) => Promise<GetPlatformTransferSummariesResponse>);
    createPlatformOrderTransfer: ((options: {
        partnerId: string;
        contractId?: string;
        memo?: string;
        paymentId: string;
        orderDetail: CreatePlatformOrderTransferBodyOrderDetail;
        taxFreeAmount?: number;
        settlementStartDate?: string;
        discounts: CreatePlatformOrderTransferBodyDiscount[];
        additionalFees: CreatePlatformOrderTransferBodyAdditionalFee[];
        externalPaymentDetail?: CreatePlatformOrderTransferBodyExternalPaymentDetail;
        isForTest?: boolean;
        parameters?: TransferParameters;
        userDefinedProperties?: PlatformUserDefinedPropertyKeyValue[];
    }) => Promise<CreateOrderTransferResponse>);
    createPlatformOrderCancelTransfer: ((options: {
        partnerId?: string;
        paymentId?: string;
        transferId?: string;
        cancellationId: string;
        memo?: string;
        orderDetail?: CreatePlatformOrderCancelTransferBodyOrderDetail;
        taxFreeAmount?: number;
        discounts: CreatePlatformOrderCancelTransferBodyDiscount[];
        settlementStartDate?: string;
        externalCancellationDetail?: CreatePlatformOrderCancelTransferBodyExternalCancellationDetail;
        isForTest?: boolean;
        userDefinedProperties?: PlatformUserDefinedPropertyKeyValue[];
    }) => Promise<CreateOrderCancelTransferResponse>);
    createPlatformManualTransfer: ((options: {
        partnerId: string;
        memo?: string;
        settlementAmount: number;
        settlementDate: string;
        isForTest?: boolean;
        userDefinedProperties?: PlatformUserDefinedPropertyKeyValue[];
    }) => Promise<CreateManualTransferResponse>);
    downloadPlatformTransferSheet: ((options?: {
        filter?: PlatformTransferFilterInput;
        fields?: PlatformTransferSheetField[];
        transferUserDefinedPropertyKeys?: string[];
        partnerUserDefinedPropertyKeys?: string[];
    }) => Promise<string>);
}

Type declaration

getPlatformTransfer: ((id: string) => Promise<PlatformTransfer>)
정산건 조회

정산건을 조회합니다.

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

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

Throws
Errors.PlatformNotEnabledError 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우

Throws
Errors.PlatformTransferNotFoundError PlatformTransferNotFoundError

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

Throws
Errors.UnknownError API 응답이 알 수 없는 형식인 경우
- - (id): Promise<PlatformTransfer>
  - Parameters
    - id: string
      조회하고 싶은 정산건 아이디
    Returns Promise<PlatformTransfer>
deletePlatformTransfer: ((id: string) => Promise<DeletePlatformTransferResponse>)
정산건 삭제

scheduled, in_process 상태의 정산건만 삭제가능합니다.

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

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

Throws
Errors.PlatformCancelOrderTransfersExistsError PlatformCancelOrderTransfersExistsError

Throws
Errors.PlatformNotEnabledError 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우

Throws
Errors.PlatformTransferNonDeletableStatusError PlatformTransferNonDeletableStatusError

Throws
Errors.PlatformTransferNotFoundError PlatformTransferNotFoundError

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

Throws
Errors.UnknownError API 응답이 알 수 없는 형식인 경우
- - (id): Promise<DeletePlatformTransferResponse>
  - Parameters
    - id: string
      정산건 아이디
    Returns Promise<DeletePlatformTransferResponse>
getPlatformTransferSummaries: ((options?: {
page?: PageInput;
filter?: PlatformTransferFilterInput;
}) => Promise<GetPlatformTransferSummariesResponse>)
정산건 다건 조회

성공 응답으로 조회된 정산건 요약 리스트와 페이지 정보가 반환됩니다.

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

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

Throws
Errors.PlatformNotEnabledError 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우

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

Throws
Errors.UnknownError API 응답이 알 수 없는 형식인 경우
- - (options?): Promise<GetPlatformTransferSummariesResponse>
  - Parameters
    - Optionaloptions: {
      page?: PageInput;
      filter?: PlatformTransferFilterInput;
      }
      Optionalpage?: PageInput
      요청할 페이지 정보
      
      Optionalfilter?: PlatformTransferFilterInput
      조회할 정산건 조건 필터
    Returns Promise<GetPlatformTransferSummariesResponse>
createPlatformOrderTransfer: ((options: {
    partnerId: string;
    contractId?: string;
    memo?: string;
    paymentId: string;
    orderDetail: CreatePlatformOrderTransferBodyOrderDetail;
    taxFreeAmount?: number;
    settlementStartDate?: string;
    discounts: CreatePlatformOrderTransferBodyDiscount[];
    additionalFees: CreatePlatformOrderTransferBodyAdditionalFee[];
    externalPaymentDetail?: CreatePlatformOrderTransferBodyExternalPaymentDetail;
    isForTest?: boolean;
    parameters?: TransferParameters;
    userDefinedProperties?: PlatformUserDefinedPropertyKeyValue[];
}) => Promise<CreateOrderTransferResponse>)
주문 정산건 생성

성공 응답으로 생성된 주문 정산건 객체가 반환됩니다.

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

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

Throws
Errors.PlatformAdditionalFeePoliciesNotFoundError PlatformAdditionalFeePoliciesNotFoundError

Throws
Errors.PlatformAdditionalFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedError PlatformAdditionalFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedError

Throws
Errors.PlatformContractNotFoundError PlatformContractNotFoundError

Throws
Errors.PlatformContractPlatformFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedError PlatformContractPlatformFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedError

Throws
Errors.PlatformCurrencyNotSupportedError 지원 되지 않는 통화를 선택한 경우

Throws
Errors.PlatformDiscountSharePoliciesNotFoundError PlatformDiscountSharePoliciesNotFoundError

Throws
Errors.PlatformNotEnabledError 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우

Throws
Errors.PlatformPartnerNotFoundError PlatformPartnerNotFoundError

Throws
Errors.PlatformPaymentNotFoundError PlatformPaymentNotFoundError

Throws
Errors.PlatformProductIdDuplicatedError PlatformProductIdDuplicatedError

Throws
Errors.PlatformSettlementAmountExceededError 정산 가능한 금액을 초과한 경우

Throws
Errors.PlatformSettlementParameterNotFoundError 정산 파라미터가 존재하지 않는 경우

Throws
Errors.PlatformSettlementPaymentAmountExceededPortOnePaymentError 정산 요청 결제 금액이 포트원 결제 내역의 결제 금액을 초과한 경우

Throws
Errors.PlatformSettlementSupplyWithVatAmountExceededPortOnePaymentError 정산 요청 공급대가가 포트원 결제 내역의 공급대가를 초과한 경우

Throws
Errors.PlatformSettlementTaxFreeAmountExceededPortOnePaymentError 정산 요청 면세 금액이 포트원 결제 내역의 면세 금액을 초과한 경우

Throws
Errors.PlatformTransferAlreadyExistsError PlatformTransferAlreadyExistsError

Throws
Errors.PlatformUserDefinedPropertyNotFoundError 사용자 정의 속성이 존재 하지 않는 경우

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

Throws
Errors.UnknownError API 응답이 알 수 없는 형식인 경우
- - (options): Promise<CreateOrderTransferResponse>
  - Parameters
    - options: {
          partnerId: string;
          contractId?: string;
          memo?: string;
          paymentId: string;
          orderDetail: CreatePlatformOrderTransferBodyOrderDetail;
          taxFreeAmount?: number;
          settlementStartDate?: string;
          discounts: CreatePlatformOrderTransferBodyDiscount[];
          additionalFees: CreatePlatformOrderTransferBodyAdditionalFee[];
          externalPaymentDetail?: CreatePlatformOrderTransferBodyExternalPaymentDetail;
          isForTest?: boolean;
          parameters?: TransferParameters;
          userDefinedProperties?: PlatformUserDefinedPropertyKeyValue[];
      }
      partnerId: string
      파트너 아이디
      
      OptionalcontractId?: string
      계약 아이디
      
      기본값은 파트너의 기본 계약 아이디 입니다.
      
      Optionalmemo?: string
      메모
      
      paymentId: string
      결제 아이디
      
      orderDetail: CreatePlatformOrderTransferBodyOrderDetail
      주문 정보
      
      OptionaltaxFreeAmount?: number
      주문 면세 금액
      
      주문 항목과 면세 금액을 같이 전달하시면 최종 면세 금액은 주문 항목의 면세 금액이 아닌 전달해주신 면세 금액으로 적용됩니다. (int64)
      
      OptionalsettlementStartDate?: string
      정산 시작일
      
      기본값은 결제 일시 입니다.
      
      discounts: CreatePlatformOrderTransferBodyDiscount[]
      할인 정보
      
      additionalFees: CreatePlatformOrderTransferBodyAdditionalFee[]
      추가 수수료 정보
      
      OptionalexternalPaymentDetail?: CreatePlatformOrderTransferBodyExternalPaymentDetail
      외부 결제 상세 정보
      
      해당 정보가 존재하는 경우 외부 결제 정산건 으로 등록되고, 존재하지않은 경우 포트원 결제 정산건으로 등록됩니다.
      
      OptionalisForTest?: boolean
      테스트 모드 여부
      
      기본값은 false 입니다.
      
      Optionalparameters?: TransferParameters
      정산 파라미터 (실험기능)
      
      OptionaluserDefinedProperties?: PlatformUserDefinedPropertyKeyValue[]
      사용자 정의 속성
    Returns Promise<CreateOrderTransferResponse>
createPlatformOrderCancelTransfer: ((options: {
    partnerId?: string;
    paymentId?: string;
    transferId?: string;
    cancellationId: string;
    memo?: string;
    orderDetail?: CreatePlatformOrderCancelTransferBodyOrderDetail;
    taxFreeAmount?: number;
    discounts: CreatePlatformOrderCancelTransferBodyDiscount[];
    settlementStartDate?: string;
    externalCancellationDetail?: CreatePlatformOrderCancelTransferBodyExternalCancellationDetail;
    isForTest?: boolean;
    userDefinedProperties?: PlatformUserDefinedPropertyKeyValue[];
}) => Promise<CreateOrderCancelTransferResponse>)
주문 취소 정산건 생성

성공 응답으로 생성된 주문 취소 정산건 객체가 반환됩니다.

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

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

Throws
Errors.PlatformCancellableAmountExceededError 취소 가능한 금액이 초과한 경우

Throws
Errors.PlatformCancellableDiscountAmountExceededError PlatformCancellableDiscountAmountExceededError

Throws
Errors.PlatformCancellableDiscountTaxFreeAmountExceededError PlatformCancellableDiscountTaxFreeAmountExceededError

Throws
Errors.PlatformCancellableProductQuantityExceededError PlatformCancellableProductQuantityExceededError

Throws
Errors.PlatformCancellationAndPaymentTypeMismatchedError PlatformCancellationAndPaymentTypeMismatchedError

Throws
Errors.PlatformCancellationNotFoundError PlatformCancellationNotFoundError

Throws
Errors.PlatformCannotSpecifyTransferError 정산 건 식별에 실패한 경우

Throws
Errors.PlatformDiscountSharePolicyIdDuplicatedError PlatformDiscountSharePolicyIdDuplicatedError

Throws
Errors.PlatformNotEnabledError 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우

Throws
Errors.PlatformOrderDetailMismatchedError PlatformOrderDetailMismatchedError

Throws
Errors.PlatformOrderTransferAlreadyCancelledError PlatformOrderTransferAlreadyCancelledError

Throws
Errors.PlatformPaymentNotFoundError PlatformPaymentNotFoundError

Throws
Errors.PlatformProductIdDuplicatedError PlatformProductIdDuplicatedError

Throws
Errors.PlatformProductIdNotFoundError PlatformProductIdNotFoundError

Throws
Errors.PlatformSettlementAmountExceededError 정산 가능한 금액을 초과한 경우

Throws
Errors.PlatformSettlementCancelAmountExceededPortOneCancelError 정산 취소 요청 금액이 포트원 결제 취소 내역의 취소 금액을 초과한 경우

Throws
Errors.PlatformTransferAlreadyExistsError PlatformTransferAlreadyExistsError

Throws
Errors.PlatformTransferDiscountSharePolicyNotFoundError PlatformTransferDiscountSharePolicyNotFoundError

Throws
Errors.PlatformTransferNotFoundError PlatformTransferNotFoundError

Throws
Errors.PlatformUserDefinedPropertyNotFoundError 사용자 정의 속성이 존재 하지 않는 경우

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

Throws
Errors.UnknownError API 응답이 알 수 없는 형식인 경우
- - (options): Promise<CreateOrderCancelTransferResponse>
  - Parameters
    - options: {
          partnerId?: string;
          paymentId?: string;
          transferId?: string;
          cancellationId: string;
          memo?: string;
          orderDetail?: CreatePlatformOrderCancelTransferBodyOrderDetail;
          taxFreeAmount?: number;
          discounts: CreatePlatformOrderCancelTransferBodyDiscount[];
          settlementStartDate?: string;
          externalCancellationDetail?: CreatePlatformOrderCancelTransferBodyExternalCancellationDetail;
          isForTest?: boolean;
          userDefinedProperties?: PlatformUserDefinedPropertyKeyValue[];
      }
      OptionalpartnerId?: string
      파트너 아이디
      
      OptionalpaymentId?: string
      결제 아이디
      
      OptionaltransferId?: string
      정산건 아이디
      
      cancellationId: string
      취소 내역 아이디
      
      Optionalmemo?: string
      메모
      
      OptionalorderDetail?: CreatePlatformOrderCancelTransferBodyOrderDetail
      주문 취소 정보
      
      OptionaltaxFreeAmount?: number
      주문 취소 면세 금액
      
      주문 취소 항목과 취소 면세 금액을 같이 전달하시면 최종 취소 면세 금액은 주문 취소 항목의 면세 금액이 아닌 전달해주신 취소 면세 금액으로 적용됩니다. (int64)
      
      discounts: CreatePlatformOrderCancelTransferBodyDiscount[]
      할인 정보
      
      OptionalsettlementStartDate?: string
      정산 시작일
      
      날짜를 나타내는 문자열로, yyyy-MM-dd 형식을 따릅니다.
      
      OptionalexternalCancellationDetail?: CreatePlatformOrderCancelTransferBodyExternalCancellationDetail
      외부 결제 상세 정보
      
      해당 정보가 존재하는 경우 외부 결제 취소 정산건으로 등록되고, 존재하지않은 경우 포트원 결제 취소 정산건으로 등록됩니다.
      
      OptionalisForTest?: boolean
      테스트 모드 여부
      
      기본값은 false 입니다.
      
      OptionaluserDefinedProperties?: PlatformUserDefinedPropertyKeyValue[]
      사용자 정의 속성
    Returns Promise<CreateOrderCancelTransferResponse>
createPlatformManualTransfer: ((options: {
    partnerId: string;
    memo?: string;
    settlementAmount: number;
    settlementDate: string;
    isForTest?: boolean;
    userDefinedProperties?: PlatformUserDefinedPropertyKeyValue[];
}) => Promise<CreateManualTransferResponse>)
수기 정산건 생성

성공 응답으로 생성된 수기 정산건 객체가 반환됩니다.

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

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

Throws
Errors.PlatformNotEnabledError 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우

Throws
Errors.PlatformPartnerNotFoundError PlatformPartnerNotFoundError

Throws
Errors.PlatformUserDefinedPropertyNotFoundError 사용자 정의 속성이 존재 하지 않는 경우

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

Throws
Errors.UnknownError API 응답이 알 수 없는 형식인 경우
- - (options): Promise<CreateManualTransferResponse>
  - Parameters
    - options: {
          partnerId: string;
          memo?: string;
          settlementAmount: number;
          settlementDate: string;
          isForTest?: boolean;
          userDefinedProperties?: PlatformUserDefinedPropertyKeyValue[];
      }
      partnerId: string
      파트너 아이디
      
      Optionalmemo?: string
      메모
      
      settlementAmount: number
      정산 금액 (int64)
      
      settlementDate: string
      정산 일
      
      날짜를 나타내는 문자열로, yyyy-MM-dd 형식을 따릅니다.
      
      OptionalisForTest?: boolean
      테스트 모드 여부
      
      기본값은 false 입니다.
      
      OptionaluserDefinedProperties?: PlatformUserDefinedPropertyKeyValue[]
      사용자 정의 속성
    Returns Promise<CreateManualTransferResponse>
downloadPlatformTransferSheet: ((options?: {
    filter?: PlatformTransferFilterInput;
    fields?: PlatformTransferSheetField[];
    transferUserDefinedPropertyKeys?: string[];
    partnerUserDefinedPropertyKeys?: string[];
}) => Promise<string>)
정산 상세 내역 다운로드

정산 상세 내역을 csv 파일로 다운로드 합니다.

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

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

Throws
Errors.UnknownError API 응답이 알 수 없는 형식인 경우
- - (options?): Promise<string>
  - Parameters
    - Optionaloptions: {
          filter?: PlatformTransferFilterInput;
          fields?: PlatformTransferSheetField[];
          transferUserDefinedPropertyKeys?: string[];
          partnerUserDefinedPropertyKeys?: string[];
      }
      Optionalfilter?: PlatformTransferFilterInput
      Optionalfields?: PlatformTransferSheetField[]
      다운로드 할 시트 컬럼
      
      OptionaltransferUserDefinedPropertyKeys?: string[]
      OptionalpartnerUserDefinedPropertyKeys?: string[]
    Returns Promise<string>

Type Alias TransferClient

Type declaration

getPlatformTransfer: ((id: string) => Promise<PlatformTransfer>)

Throws

Throws

Throws

Throws

Throws

Throws

Parameters

Returns Promise<PlatformTransfer>

deletePlatformTransfer: ((id: string) => Promise<DeletePlatformTransferResponse>)

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Parameters

Returns Promise<DeletePlatformTransferResponse>

getPlatformTransferSummaries: ((options?: { page?: PageInput; filter?: PlatformTransferFilterInput; }) => Promise<GetPlatformTransferSummariesResponse>)

Throws

Throws

Throws

Throws

Throws

Parameters

Optionalpage?: PageInput

Optionalfilter?: PlatformTransferFilterInput

Returns Promise<GetPlatformTransferSummariesResponse>

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Parameters

partnerId: string

OptionalcontractId?: string

Optionalmemo?: string

paymentId: string

orderDetail: CreatePlatformOrderTransferBodyOrderDetail

OptionaltaxFreeAmount?: number

OptionalsettlementStartDate?: string

discounts: CreatePlatformOrderTransferBodyDiscount[]

additionalFees: CreatePlatformOrderTransferBodyAdditionalFee[]

OptionalexternalPaymentDetail?: CreatePlatformOrderTransferBodyExternalPaymentDetail

OptionalisForTest?: boolean

Optionalparameters?: TransferParameters

OptionaluserDefinedProperties?: PlatformUserDefinedPropertyKeyValue[]

Returns Promise<CreateOrderTransferResponse>

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

getPlatformTransferSummaries: ((options?: {
page?: PageInput;
filter?: PlatformTransferFilterInput;
}) => Promise<GetPlatformTransferSummariesResponse>)

`Optional`page?: PageInput

`Optional`filter?: PlatformTransferFilterInput

`Optional`contractId?: string

`Optional`memo?: string

`Optional`taxFreeAmount?: number

`Optional`settlementStartDate?: string

`Optional`externalPaymentDetail?: CreatePlatformOrderTransferBodyExternalPaymentDetail

`Optional`isForTest?: boolean

`Optional`parameters?: TransferParameters

`Optional`userDefinedProperties?: PlatformUserDefinedPropertyKeyValue[]

`Optional`partnerId?: string

`Optional`paymentId?: string

`Optional`transferId?: string

`Optional`memo?: string

`Optional`orderDetail?: CreatePlatformOrderCancelTransferBodyOrderDetail

`Optional`taxFreeAmount?: number

`Optional`settlementStartDate?: string

`Optional`externalCancellationDetail?: CreatePlatformOrderCancelTransferBodyExternalCancellationDetail

`Optional`isForTest?: boolean

`Optional`userDefinedProperties?: PlatformUserDefinedPropertyKeyValue[]

createPlatformManualTransfer: ((options: {
partnerId: string;
memo?: string;
settlementAmount: number;
settlementDate: string;
isForTest?: boolean;
userDefinedProperties?: PlatformUserDefinedPropertyKeyValue[];
}) => Promise<CreateManualTransferResponse>)

`Optional`memo?: string

`Optional`isForTest?: boolean

`Optional`userDefinedProperties?: PlatformUserDefinedPropertyKeyValue[]

downloadPlatformTransferSheet: ((options?: {
filter?: PlatformTransferFilterInput;
fields?: PlatformTransferSheetField[];
transferUserDefinedPropertyKeys?: string[];
partnerUserDefinedPropertyKeys?: string[];
}) => Promise<string>)

`Optional`filter?: PlatformTransferFilterInput

`Optional`fields?: PlatformTransferSheetField[]

`Optional`transferUserDefinedPropertyKeys?: string[]

`Optional`partnerUserDefinedPropertyKeys?: string[]