정산 상세내역 관련 API
파트너 정산 서비스의 정산 상세내역과 관련된 API 입니다.
타입 정의
API 요청/응답의 각 필드에서 사용되는 타입 정의들을 확인할 수 있습니다
Bank: "BANK_OF_KOREA" | "KDB" | "IBK" | ...
은행
CreateManualTransferResponse: { transfer }
CreateOrderCancelTransferResponse: { transfer }
CreateOrderTransferResponse: { transfer }
CreatePlatformManualTransferBody: { partnerId, memo, settlementAmount, ... }
수기 정산건 생성을 위한 입력 정보
CreatePlatformManualTransferError: | | | ...
CreatePlatformOrderCancelTransferBody: { partnerId, paymentId, transferId, ... }
주문 취소 정산 등록을 위한 입력 정보
하나의 payment에 하나의 정산 건만 존재하는 경우에는 (partnerId, paymentId)로 취소 정산을 등록하실 수 있습니다. 하나의 payment에 여러 개의 정산 건이 존재하는 경우에는 transferId를 필수로 입력해야 합니다. transferId를 입력한 경우 (partnerId, paymentId)는 생략 가능합니다. id를 입력한 경우 생성될 취소 정산건 아이디로 사용됩니다.
CreatePlatformOrderCancelTransferBodyDiscount: { sharePolicyId, amount, taxFreeAmount }
할인 정보
CreatePlatformOrderCancelTransferBodyExternalCancellationDetail: { cancelledAt }
외부 결제 상세 정보
CreatePlatformOrderCancelTransferBodyOrderDetail: { orderAmount, orderLines, all }
주문 취소 정보
orderAmount, orderLines, all 중에서 하나만 입력하여야 합니다.
CreatePlatformOrderCancelTransferBodyOrderDetailAll: { }
전체 금액 취소
CreatePlatformOrderCancelTransferBodyOrderLine: { productId, quantity, discounts }
주문 취소 항목 리스트
CreatePlatformOrderCancelTransferError: | | | ...
CreatePlatformOrderTransferBody: { partnerId, contractId, memo, ... }
주문 정산건 생성을 위한 입력 정보
CreatePlatformOrderTransferBodyAdditionalFee: { policyId }
추가 수수료 정보
CreatePlatformOrderTransferBodyDiscount: { sharePolicyId, amount, taxFreeAmount }
할인 정보
CreatePlatformOrderTransferBodyExternalPaymentDetail: { currency, orderName, paidAt, ... }
외부 결제 상세 정보
CreatePlatformOrderTransferBodyOrderDetail: { orderAmount, orderLines }
주문 정보
주문 금액 또는 주문 항목 하나만 입력 가능합니다.
CreatePlatformOrderTransferBodyOrderLine: { product, quantity, discounts, ... }
주문 항목
CreatePlatformOrderTransferBodyProduct: { id, name, amount, ... }
상품
CreatePlatformOrderTransferError: | | | ...
Currency: "KRW" | "USD" | "JPY" | ...
통화
DateRange: { from, until }
DayOfWeek: "SUN" | "MON" | "TUE" | ...
요일
DeletePlatformTransferError: | | | ...
DeletePlatformTransferResponse: { }
DownloadPlatformTransferSheetBody: { filter, fields }
DownloadPlatformTransferSheetError: |
EasyPayMethodType: "CARD" | "TRANSFER" | "CHARGE"
간편 결제 수단
EasyPayProvider: "SAMSUNGPAY" | "KAKAOPAY" | "NAVERPAY" | ...
간편 결제사
ForbiddenError: { type, message }
요청이 거절된 경우
GetPlatformTransferError: | | | ...
GetPlatformTransferSummariesBody: { page, filter }
정산건 요약 다건 조회를 위한 입력 정보
GetPlatformTransferSummariesError: | | | ...
GetPlatformTransferSummariesResponse: { transferSummaries, page }
InvalidRequestError: { type, message }
요청된 입력 정보가 유효하지 않은 경우
허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
MonthDay: { month, day }
월 및 일자 정보
PageInfo: { number, size, totalCount }
반환된 페이지 결과 정보
PageInput: { number, size }
다건 조회 API 에 사용되는 페이지 입력 정보
PaymentMethodType: "CARD" | "TRANSFER" | "VIRTUAL_ACCOUNT" | ...
PlatformAccount: { bank, currency, number, ... }
플랫폼 정산 계좌
currency 가 KRW 일 경우 예금주 조회 API 를 통해 올바른 계좌인지 검증합니다. 그 외의 화폐일 경우 따로 검증하지는 않습니다.
PlatformAccountStatus: "VERIFIED" | "VERIFY_FAILED" | "VERIFY_ERROR" | ...
플랫폼 계좌 상태
PlatformAdditionalFeePoliciesNotFoundError: { type, ids, graphqlIds, ... }
PlatformAdditionalFeePolicy: { id, graphqlId, name, ... }
추가 수수료 정책
추가 수수료 정책는 고객사의 주문건에 대한 중개수수료에 별도로 추가로 부여되는 수수료입니다. 대표적인 사용 예시로 풀필먼트 수수료, 로켓배송 수수료, 마케팅 채널 수수료등이 있습니다.
PlatformAdditionalFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedError: { type, id, graphqlId, ... }
PlatformAmountExceededType: "DISCOUNT_THAN_ORDER" | "DISCOUNT_TAX_FREE_THAN_DISCOUNT" | "DISCOUNT_TAX_FREE_THAN_ORDER_TAX_FREE" | ...
PlatformCancelOrderTransfersExistsError: { type, message }
PlatformCancellableAmountExceededError: { type, cancellableAmount, requestAmount, ... }
취소 가능한 금액이 초과한 경우
PlatformCancellableAmountType: "SUPPLY_WITH_VAT" | "TAX_FREE"
금액 타입
PlatformCancellableDiscountAmountExceededError: { type, discountSharePolicyId, discountSharePolicyGraphqlId, ... }
PlatformCancellableDiscountTaxFreeAmountExceededError: { type, discountSharePolicyId, discountSharePolicyGraphqlId, ... }
PlatformCancellableProductQuantityExceededError: { type, productId, cancellableQuantity, ... }
PlatformCancellationAndPaymentTypeMismatchedError: { type, message }
PlatformCancellationNotFoundError: { type, message }
PlatformCannotSpecifyTransferError: { type, message }
정산 건 식별에 실패한 경우
PlatformContact: { name, phoneNumber, email }
플랫폼 파트너 담당자 연락 정보
파트너 담당자에게 연락하기 위한 정보들 입니다.
PlatformContract: { id, graphqlId, name, ... }
계약
계약은 플랫폼 고객사가 파트너에게 정산해줄 대금과 정산일을 계산하는 데 적용되는 정보입니다. 고객사의 플랫폼에서 재화 및 서비스를 판매하기 위한 중개수수료와 판매금에 대한 정산일로 구성되어 있습니다.
PlatformContractNotFoundError: { type, message }
PlatformContractPlatformFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedError: { type, id, graphqlId, ... }
PlatformCurrencyNotSupportedError: { type, message }
지원 되지 않는 통화를 선택한 경우
PlatformExternalPayment: { type, id, orderName, ... }
외부 결제 정보
PlatformFee: |
플랫폼 중개수수료 정보
PlatformFixedAmountFee: { type, amount }
정액 수수료
총 금액에 무관하게 정해진 수수료 금액을 책정합니다.
PlatformFixedRateFee: { type, rate }
정률 수수료
총 금액에 정해진 비율을 곱한 만큼의 수수료를 책정합니다.
PlatformManualTransfer: { type, id, graphqlId, ... }
수기 정산건
PlatformManualTransferSummary: { type, id, graphqlId, ... }
PlatformNegativeAmountNotAllowedError: { type, message }
정산 건별 옵션이 켜진 플랫폼에서 음수 금액 수기 정산 생성을 시도한 경우
PlatformNotEnabledError: { type, message }
플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우
PlatformOrderCancelTransfer: { type, id, graphqlId, ... }
주문 취소 정산건
PlatformOrderCancelTransferSummary: { type, id, graphqlId, ... }
PlatformOrderDetailMismatchedError: { type, message }
PlatformOrderSettlementAmount: { settlement, settlementTaxFree, payment, ... }
정산 금액 정보
정산 금액과 정산 금액 계산에 사용된 금액 정보들 입니다.
PlatformOrderTransfer: { type, id, graphqlId, ... }
주문 정산건
PlatformOrderTransferAdditionalFee: { policy, amount, vat }
추가 수수료 정보
PlatformOrderTransferAlreadyCancelledError: { type, message }
PlatformOrderTransferCancellation: { id, cancelledAt }
주문 취소 정보
PlatformOrderTransferDiscount: { sharePolicy, amount, taxFreeAmount, ... }
할인 정보
PlatformOrderTransferOrderLine: { product, quantity, discounts, ... }
주문 항목
PlatformOrderTransferProduct: { id, name, amount, ... }
상품
PlatformOrderTransferSummary: { type, id, graphqlId, ... }
PlatformPartner: { id, graphqlId, name, ... }
파트너
파트너는 고객사가 정산해주어야 할 대상입니다. 기본 사업자 정보와 정산정보, 그리고 적용될 계약의 정보를 등록 및 관리할 수 있습니다.
PlatformPartnerBusinessStatus: "NOT_VERIFIED" | "VERIFY_ERROR" | "NOT_FOUND" | ...
플랫폼 파트너 사업자 상태
PlatformPartnerMemberCompanyConnectionStatus: "NOT_CONNECTED" | "CONNECT_PENDING" | "CONNECTED" | ...
플랫폼 파트너 연동 사업자 연결 상태
PlatformPartnerNotFoundError: { type, message }
PlatformPartnerStatus: "PENDING" | "APPROVED" | "REJECTED"
플랫폼 파트너 상태
PlatformPartnerTaxationType: "NORMAL" | "SIMPLE_TAX_INVOICE_ISSUER" | "SIMPLE" | ...
플랫폼 파트너 과세 유형
PlatformPartnerType: | |
파트너 유형별 추가 정보
PlatformPartnerTypeBusiness: { type, companyName, taxationType, ... }
사업자 파트너 정보
사업자 유형의 파트너 추가 정보 입니다.
PlatformPartnerTypeNonWhtPayer: { type, birthdate }
원천징수 비대상자 파트너 정보
비사업자 유형의 파트너 추가 정보 입니다.
PlatformPartnerTypeWhtPayer: { type, birthdate }
원천징수 대상자 파트너 정보
비사업자 유형의 파트너 추가 정보 입니다.
PlatformPayer: "PARTNER" | "MERCHANT"
금액 부담 주체
플랫폼에서 발생한 결제 수수료, 부가세 등 금액을 부담하는 주체를 나타냅니다.
PlatformPayment: |
결제 정보
PlatformPaymentMethod: | | | ...
결제 수단
PlatformPaymentMethodCard: { type }
카드
PlatformPaymentMethodCardInput: { }
PlatformPaymentMethodEasyPay: { type, provider, methodType }
간편 결제
PlatformPaymentMethodEasyPayInput: { provider, methodType }
간편 결제 입력 정보
PlatformPaymentMethodGiftCertificate: { type }
상품권
PlatformPaymentMethodGiftCertificateInput: { }
PlatformPaymentMethodInput: { card, transfer, virtualAccount, ... }
결제 수단 입력 정보
PlatformPaymentMethodMobile: { type }
모바일
PlatformPaymentMethodMobileInput: { }
PlatformPaymentMethodTransfer: { type }
계좌이체
PlatformPaymentMethodTransferInput: { }
PlatformPaymentMethodVirtualAccount: { type }
가상계좌
PlatformPaymentMethodVirtualAccountInput: { }
PlatformPaymentNotFoundError: { type, message }
PlatformPortOnePayment: { type, id, storeId, ... }
포트원 결제 정보
PlatformPortOnePaymentCancelAmountType: "SUPPLY_WITH_VAT" | "TAX_FREE"
금액 타입
PlatformProductIdDuplicatedError: { type, id, message }
PlatformProductIdNotFoundError: { type, id, message }
PlatformProperties: { [key: string]: }
PlatformSettlementAmountExceededError: { type, message, productId, ... }
정산 가능한 금액을 초과한 경우
PlatformSettlementCancelAmountExceededPortOneCancelError: { type, registeredSettlementCancelAmount, requestSettlementCancelAmount, ... }
정산 취소 요청 금액이 포트원 결제 취소 내역의 취소 금액을 초과한 경우
PlatformSettlementCycle: { lagDays, datePolicy, method }
정산 주기
지체일, 정산일, 기준일로 구성되며, 해당 요소들의 조합으로 실제 정산일을 계산합니다.
PlatformSettlementCycleDatePolicy: "HOLIDAY_BEFORE" | "HOLIDAY_AFTER" | "CALENDAR_DAY"
플랫폼 정산 기준일
PlatformSettlementCycleMethod: | | | ...
플랫폼 정산 주기 계산 방식
PlatformSettlementCycleMethodDaily: { type }
매일 정산
PlatformSettlementCycleMethodManualDates: { type, dates }
정해진 날짜(월, 일)에 정산
PlatformSettlementCycleMethodMonthly: { type, daysOfMonth }
매월 정해진 날(일)에 정산
PlatformSettlementCycleMethodWeekly: { type, daysOfWeek }
매주 정해진 요일에 정산
PlatformSettlementDateEarlierThanSettlementStartDateError: { type, message, settlementStartDate, ... }
정산일이 정산 시작일보다 빠른 경우
PlatformSettlementParameterNotFoundError: { type, message }
정산 파라미터가 존재하지 않는 경우
PlatformSettlementParameterValue: { decimal, decimalScale }
플랫폼 정산 파라미터 값
PlatformSettlementPaymentAmountExceededPortOnePaymentError: { type, registeredSettlementPaymentAmount, requestSettlementPaymentAmount, ... }
정산 요청 결제 금액이 포트원 결제 내역의 결제 금액을 초과한 경우
PlatformSettlementSupplyWithVatAmountExceededPortOnePaymentError: { type, registeredSettlementSupplyWithVatAmount, requestSettlementSupplyWithVatAmount, ... }
정산 요청 공급대가가 포트원 결제 내역의 공급대가를 초과한 경우
PlatformSettlementTaxFreeAmountExceededPortOnePaymentError: { type, registeredSettlementTaxFreeAmount, requestSettlementTaxFreeAmount, ... }
정산 요청 면세 금액이 포트원 결제 내역의 면세 금액을 초과한 경우
PlatformTransfer: | |
정산건
정산건은 파트너에 정산해줄 정산 금액과 정산 방식 등이 포함되어 있는 정산 정보입니다. 정산 방식은은 주문 정산, 주문 취소 정산, 수기 정산이 있습니다.
PlatformTransferAlreadyExistsError: { type, transferId, transferGraphqlId, ... }
PlatformTransferFilterInput: { settlementStartDateRange, settlementDateRange, partnerTags, ... }
정산건 필터 입력 정보
정산 시작일 범위와 정산 일 범위는 둘 중 하나만 입력 가능합니다.
PlatformTransferFilterInputKeyword: { all, paymentId, transferId, ... }
정산건 검색 키워드 입력 정보
검색 키워드 적용을 위한 옵션으로, 명시된 키워드를 포함하는 정산건만 조회합니다. 하나의 하위 필드에만 값을 명시하여 요청합니다.
PlatformTransferIdAlreadyUsedError: { type, message }
PlatformTransferNonDeletableStatusError: { type, message }
PlatformTransferNotFoundError: { type, message }
PlatformTransferPropertyExactMatchInput: { key, value }
사용자 정의 속성 key/value exact match
PlatformTransferStatus: "SCHEDULED" | "IN_PROCESS" | "SETTLED" | ...
정산 상태
PlatformTransferSummary: | |
PlatformTransferSummaryExternalPayment: { type, id, orderName, ... }
PlatformTransferSummaryPartner: { id, graphqlId, name, ... }
PlatformTransferSummaryPartnerType: "BUSINESS" | "WHT_PAYER" | "NON_WHT_PAYER"
파트너 유형
PlatformTransferSummaryPayment: |
PlatformTransferSummaryPortOnePayment: { type, id, orderName, ... }
PlatformTransferType: "ORDER" | "ORDER_CANCEL" | "MANUAL"
PlatformUserDefinedFormulaResults: { [key: string]: integer (64 bit) }
PlatformUserDefinedPropertyKeyValue: { key, value }
사용자 정의 속성
PlatformUserDefinedPropertyNotFoundError: { type, message }
사용자 정의 속성이 존재 하지 않는 경우
PlatformUserDefinedPropertyValue: { string }
TransferParameters: { [key: string]: }