개발자센터

PortOne REST API - V2

API 결제, 결제 정보 조회, 결제 취소 등의 기능을 제공하는 REST API입니다.

V2 API hostname: api.portone.io

OpenAPI JSON 내려받기Postman 등에서 import하여 활용할 수 있습니다.

요청 및 응답 형식

요청과 응답의 본문은 JSON 형식입니다.

API 매개 변수 중 URL 경로에 들어가는 문자열 값이 있는 경우, URL 경로에 들어갈 수 없는 문자열은 이스케이프하여야 합니다. 자바스크립트의 encodeURIComponent 함수 등을 사용할 수 있습니다.

인증 방식

V2 API를 사용하기 위해서는 V2 API Secret이 필요하며, 포트원 관리자콘솔 내 결제연동 탭에서 발급받으실 수 있습니다.

인증 관련 API를 제외한 모든 API는 HTTP Authorization 헤더로 아래 형식의 인증 정보를 전달해주셔야 합니다.

  • Authorization: PortOne MY_API_SECRET

GET 요청 시 Body 대신 Query 사용하기

GET 요청 시에 Body를 전달해야 하는 경우, Body 대신 Query를 사용할 수 있습니다.

이 경우, Body 객체를 requestBody Query 필드에 넣어주시면 됩니다.

하위호환성

포트원이 제공하는 모든 Stable API에 대해 아래와 같은 하위호환성이 보장됩니다.

  1. 현재 사용 가능한 입력 형식은 앞으로도 사용할 수 있습니다.

    • 입력 형식 내 필드 정의가 삭제되지 않습니다.

    • 필수 입력 정보가 추가되거나, 선택 입력 정보가 필수로 변경되지 않습니다.

      • 오로지 선택 입력 정보만 추가될 수 있습니다.

    • 하위 필드의 형식(타입) 또한 위 규칙을 지키며 변경됩니다.

    • enum 타입의 값이 삭제되지 않습니다.

  2. 출력 형식이 확장될 수 있지만, 축소되지 않습니다.

    • 출력 형식 내 필드 정의가 삭제되지 않습니다.

    • 사용 중인 필수 출력 정보가 선택사항으로 변경되거나 출력 시 누락되지 않습니다.

      • 이미 존재하는 용례 내에서는 필수 출력 정보가 언제나 유지됩니다.
      • 단, 기능이 추가 및 확장되는 등 새로운 용례로 사용될 때의 출력 정보에 한하여 선택사항으로 변경될 수 있습니다.

    • 하위 필드의 형식(타입) 또한 위 규칙을 지키며 변경됩니다.

    • 단, 새로운 필드 또는 enum 값, oneOf 케이스가 추가될 수 있습니다.

      • 알지 못하는 필드 및 값이 주어지더라도 crash가 발생하지 않도록 유의하여 개발해주세요.

UNSTABLE이 표기된 일부 API의 경우, 위 하위호환성 정책과 무관하게 변경 및 지원 종료될 수 있으니 이용에 유의하세요.

인증 관련 API

인증과 관련된 API 기능을 제공합니다.

결제 관련 API

결제와 관련된 API 기능을 제공합니다.

목차

결제 정보 사전 등록
post/payments/{paymentId}/pre-register
결제 단건 조회
get/payments/{paymentId}
결제 시도 내역 조회
get/payments/{paymentId}/transactions
결제 다건 조회(페이지 기반)
get/payments
결제 대용량 다건 조회(커서 기반)
get/payments-by-cursor
결제 취소
post/payments/{paymentId}/cancel
빌링키 결제
post/payments/{paymentId}/billing-key
수기 결제
post/payments/{paymentId}/instant
가상계좌 말소
post/payments/{paymentId}/virtual-account/close
에스크로 배송 정보 등록
post/payments/{paymentId}/escrow/logistics
에스크로 배송 정보 수정
patch/payments/{paymentId}/escrow/logistics
에스크로 구매 확정
post/payments/{paymentId}/escrow/complete
웹훅 재발송
post/payments/{paymentId}/resend-webhook
영수증 내 하위 상점 거래 등록
post/payments/{paymentId}/register-store-receipt

결제 예약 관련 API

결제 예약과 관련된 API 기능을 제공합니다.

빌링키 관련 API

빌링키와 관련된 API 기능을 제공합니다.

현금 영수증 관련 API

현금 영수증과 관련된 API 기능을 제공합니다.

프로모션 관련 API

프로모션과 관련된 API 기능을 제공합니다.

본인인증 관련 API

본인인증과 관련된 API 기능을 제공합니다.

파트너 정산 관련 API

파트너 정산 서비스 API 기능을 제공합니다.

정책 관련 API

파트너 정산에 적용할 정책에 관한 API 입니다.

목차

할인 분담 정책 다건 조회
get/platform/discount-share-policies
할인 분담 정책 생성
post/platform/discount-share-policies
할인 분담 정책 조회
get/platform/discount-share-policies/{id}
할인 분담 정책 수정
patch/platform/discount-share-policies/{id}
할인 분담 정책 보관
post/platform/discount-share-policies/{id}/archive
할인 분담 정책 복원
post/platform/discount-share-policies/{id}/recover
추가 수수료 정책 다건 조회
get/platform/additional-fee-policies
추가 수수료 정책 생성
post/platform/additional-fee-policies
추가 수수료 정책 조회
get/platform/additional-fee-policies/{id}
추가 수수료 정책 수정
patch/platform/additional-fee-policies/{id}
추가 수수료 정책 보관
post/platform/additional-fee-policies/{id}/archive
추가 수수료 정책 복원
post/platform/additional-fee-policies/{id}/recover
계약 다건 조회
get/platform/contracts
계약 생성
post/platform/contracts
계약 조회
get/platform/contracts/{id}
계약 수정
patch/platform/contracts/{id}
계약 보관
post/platform/contracts/{id}/archive
계약 복원
post/platform/contracts/{id}/recover

파트너 관련 API

파트너 정산에 적용할 파트너에 관한 API 입니다.

정산 상세내역 관련 API

파트너 정산 서비스의 정산 상세내역과 관련된 API 입니다.

계좌 관련 API

파트너 정산 서비스의 계좌와 관련된 API 입니다.

정산 내역 관련 API

파트너 정산 서비스의 정산 내역과 관련된 API 입니다.

지급 내역 관련 API

파트너 정산 서비스의 지급 내역과 관련된 API 입니다.

일괄 지급 내역 관련 API

파트너 정산 서비스의 일괄 지급 내역과 관련된 API 입니다.

이체 내역 관련 API

파트너 정산 서비스의 이체 내역과 관련된 API 입니다.

사업자 관련 API

파트너 정산 서비스의 사업자와 관련된 API 입니다.

특정 PG사 관련 API

특정 PG사에 국한된 API 기능을 제공합니다.

대사 서비스 API

거래 대사 및 정산 대사 관련 API 기능을 제공합니다.

공통 API

공통 API 기능을 제공합니다.

타입 정의

API 요청/응답의 각 필드에서 사용되는 타입 정의들을 확인할 수 있습니다
AddressAlreadyPaidErrorAlreadyPaidOrWaitingErrorApplyEscrowLogisticsErrorApplyEscrowLogisticsResponseArchivePlatformAdditionalFeePolicyErrorArchivePlatformAdditionalFeePolicyResponseArchivePlatformContractErrorArchivePlatformContractResponseArchivePlatformDiscountSharePolicyErrorArchivePlatformDiscountSharePolicyResponseArchivePlatformPartnerErrorArchivePlatformPartnerResponseB2bBusinessInfoB2bBusinessInfoResultB2bExternalServiceErrorB2bNotEnabledErrorBankBankInfoBankInfoNameBeforeRegisteredPaymentEscrowBillingKeyAlreadyDeletedErrorBillingKeyFailureBillingKeyFilterInputBillingKeyInfoBillingKeyInfoSummaryBillingKeyNotFoundErrorBillingKeyNotIssuedErrorBillingKeyPaymentInputBillingKeyPaymentMethodBillingKeyPaymentMethodCardBillingKeyPaymentMethodEasyPayBillingKeyPaymentMethodEasyPayChargeBillingKeyPaymentMethodEasyPayMethodBillingKeyPaymentMethodMobileBillingKeyPaymentMethodPaypalBillingKeyPaymentMethodTransferBillingKeyPaymentMethodTypeBillingKeyPaymentSummaryBillingKeySortByBillingKeySortInputBillingKeyStatusBillingKeyTextSearchBillingKeyTextSearchFieldBillingKeyTimeRangeFieldCancelAmountExceedsCancellableAmountErrorCancelCashReceiptErrorCancelCashReceiptResponseCancelPaymentBodyRefundAccountCancelPaymentErrorCancelPaymentResponseCancelRequesterCancelTaxAmountExceedsCancellableTaxAmountErrorCancelTaxFreeAmountExceedsCancellableTaxFreeAmountErrorCancellableAmountConsistencyBrokenErrorCancelledCashReceiptCancelledPaymentCancelledPaymentCashReceiptCancelledPaymentEscrowCancelledPaymentTransactionCardCardBrandCardCredentialCardOwnerTypeCardPromotionCardTypeCarrierCashReceiptCashReceiptAlreadyIssuedErrorCashReceiptFilterInputCashReceiptInputCashReceiptInputTypeCashReceiptNotFoundErrorCashReceiptNotIssuedErrorCashReceiptSortByCashReceiptSortInputCashReceiptStatusCashReceiptSummaryCashReceiptTimeRangeFieldCashReceiptTypeChannelGroupSummaryChannelNotFoundErrorChannelSpecificErrorChannelSpecificFailureChannelSpecificFailureInvalidRequestChannelSpecificFailurePgProviderCloseVirtualAccountErrorCloseVirtualAccountResponseConfirmEscrowErrorConfirmEscrowResponseConfirmIdentityVerificationErrorConfirmIdentityVerificationResponseConfirmedPaymentEscrowConnectBulkPartnerMemberCompanyErrorConnectBulkPartnerMemberCompanyResponseConnectPartnerMemberCompanyErrorConnectPartnerMemberCompanyResponseCountryCreateManualTransferResponseCreateOrderCancelTransferResponseCreateOrderTransferResponseCreatePaymentScheduleErrorCreatePaymentScheduleResponseCreatePlatformAdditionalFeePolicyErrorCreatePlatformAdditionalFeePolicyResponseCreatePlatformContractErrorCreatePlatformContractResponseCreatePlatformDiscountSharePolicyErrorCreatePlatformDiscountSharePolicyResponseCreatePlatformManualTransferErrorCreatePlatformOrderCancelTransferBodyDiscountCreatePlatformOrderCancelTransferBodyExternalCancellationDetailCreatePlatformOrderCancelTransferBodyOrderDetailCreatePlatformOrderCancelTransferBodyOrderDetailAllCreatePlatformOrderCancelTransferBodyOrderLineCreatePlatformOrderCancelTransferErrorCreatePlatformOrderTransferBodyAdditionalFeeCreatePlatformOrderTransferBodyDiscountCreatePlatformOrderTransferBodyExternalPaymentDetailCreatePlatformOrderTransferBodyOrderDetailCreatePlatformOrderTransferBodyOrderLineCreatePlatformOrderTransferBodyProductCreatePlatformOrderTransferErrorCreatePlatformPartnerBodyCreatePlatformPartnerBodyAccountCreatePlatformPartnerBodyContactCreatePlatformPartnerBodyTypeCreatePlatformPartnerBodyTypeBusinessCreatePlatformPartnerBodyTypeNonWhtPayerCreatePlatformPartnerBodyTypeWhtPayerCreatePlatformPartnerErrorCreatePlatformPartnerResponseCreatePlatformPartnersErrorCreatePlatformPartnersResponseCurrencyCustomerCustomerInputCustomerNameInputCustomerSeparatedNameDateRangeDateTimeRangeDayOfWeekDeleteBillingKeyErrorDeleteBillingKeyResponseDeletePlatformTransferErrorDeletePlatformTransferResponseDeletedBillingKeyInfoDeliveredPaymentEscrowDisconnectBulkPartnerMemberCompanyErrorDisconnectBulkPartnerMemberCompanyResponseDisconnectPartnerMemberCompanyErrorDisconnectPartnerMemberCompanyResponseDiscountAmountExceedsTotalAmountErrorDisputeDisputeStatusDownloadPlatformTransferSheetErrorEasyPayMethodTypeEasyPayProviderFailedIdentityVerificationFailedPaymentFailedPaymentCancellationFailedPaymentScheduleFailedPaymentTransactionFailedPgBillingKeyIssueResponseForbiddenErrorGenderGetAllPaymentsByCursorResponseGetAllPaymentsErrorGetB2bBusinessInfosErrorGetB2bBusinessInfosResponseGetBankInfosErrorGetBankInfosResponseGetBillingKeyInfoErrorGetBillingKeyInfosErrorGetBillingKeyInfosResponseGetCashReceiptErrorGetCashReceiptsErrorGetCashReceiptsResponseGetIdentityVerificationErrorGetIdentityVerificationsErrorGetIdentityVerificationsResponseGetKakaopayPaymentOrderErrorGetKakaopayPaymentOrderResponseGetPaymentErrorGetPaymentScheduleErrorGetPaymentSchedulesErrorGetPaymentSchedulesResponseGetPaymentTransactionsErrorGetPaymentTransactionsResponseGetPaymentsErrorGetPaymentsResponseGetPlatformAccountHolderErrorGetPlatformAccountTransfersErrorGetPlatformAccountTransfersResponseGetPlatformAdditionalFeePoliciesErrorGetPlatformAdditionalFeePoliciesResponseGetPlatformAdditionalFeePolicyErrorGetPlatformBulkPayoutsErrorGetPlatformBulkPayoutsResponseGetPlatformCompanyStateErrorGetPlatformCompanyStatePayloadGetPlatformContractErrorGetPlatformContractsErrorGetPlatformContractsResponseGetPlatformDiscountSharePoliciesErrorGetPlatformDiscountSharePoliciesResponseGetPlatformDiscountSharePolicyErrorGetPlatformPartnerErrorGetPlatformPartnerSettlementsErrorGetPlatformPartnerSettlementsResponseGetPlatformPartnersErrorGetPlatformPartnersResponseGetPlatformPayoutsErrorGetPlatformPayoutsResponseGetPlatformTransferErrorGetPlatformTransferSummariesErrorGetPlatformTransferSummariesResponseGetPromotionErrorIdentityVerificationIdentityVerificationAlreadySentErrorIdentityVerificationAlreadyVerifiedErrorIdentityVerificationFailureIdentityVerificationFilterCustomerInputIdentityVerificationFilterInputIdentityVerificationMethodIdentityVerificationNotFoundErrorIdentityVerificationNotSentErrorIdentityVerificationOperatorIdentityVerificationRequestedCustomerIdentityVerificationSortByIdentityVerificationSortInputIdentityVerificationStatusIdentityVerificationTimeRangeFieldIdentityVerificationVerifiedCustomerInstantBillingKeyPaymentMethodInputInstantBillingKeyPaymentMethodInputCardInstantPaymentMethodInputInstantPaymentMethodInputCardInstantPaymentMethodInputVirtualAccountInstantPaymentMethodInputVirtualAccountCashReceiptInfoInstantPaymentMethodInputVirtualAccountExpiryInstantPaymentMethodInputVirtualAccountOptionInstantPaymentMethodInputVirtualAccountOptionFixedInstantPaymentMethodInputVirtualAccountOptionTypeInstantPaymentSummaryInvalidRequestErrorIssueBillingKeyErrorIssueBillingKeyResponseIssueCashReceiptCustomerInputIssueCashReceiptErrorIssueCashReceiptPaymentMethodTypeIssueCashReceiptResponseIssueFailedCashReceiptIssuedBillingKeyInfoIssuedCashReceiptIssuedPaymentCashReceiptIssuedPgBillingKeyIssueResponseLoginViaApiSecretErrorLoginViaApiSecretResponseMaxTransactionCountReachedErrorMaxWebhookRetryCountReachedErrorModifyEscrowLogisticsErrorModifyEscrowLogisticsResponseMonthDayNegativePromotionAdjustedCancelAmountErrorOneLineAddressPageInfoPageInputPaidPaymentPaidPaymentTransactionPartialCancelledPaymentPartialCancelledPaymentTransactionPayInstantlyErrorPayInstantlyResponsePayPendingPaymentPayPendingPaymentTransactionPayWithBillingKeyErrorPayWithBillingKeyResponsePaymentPaymentAlreadyCancelledErrorPaymentAmountPaymentAmountInputPaymentCancellationPaymentCashReceiptPaymentCashReceiptStatusPaymentClientTypePaymentEscrowPaymentEscrowReceiverInputPaymentEscrowSenderInputPaymentFailurePaymentFilterInputPaymentFilterInputEscrowStatusPaymentInstallmentPaymentLogisticsPaymentLogisticsCompanyPaymentMethodPaymentMethodCardPaymentMethodConvenienceStorePaymentMethodEasyPayPaymentMethodEasyPayMethodPaymentMethodEasyPayMethodChargePaymentMethodGiftCertificatePaymentMethodGiftCertificateTypePaymentMethodMobilePaymentMethodTransferPaymentMethodTypePaymentMethodVirtualAccountPaymentMethodVirtualAccountRefundStatusPaymentMethodVirtualAccountTypePaymentNotFoundErrorPaymentNotPaidErrorPaymentNotWaitingForDepositErrorPaymentProductPaymentProductTypePaymentSchedulePaymentScheduleAlreadyExistsErrorPaymentScheduleAlreadyProcessedErrorPaymentScheduleAlreadyRevokedErrorPaymentScheduleFilterInputPaymentScheduleNotFoundErrorPaymentScheduleSortByPaymentScheduleSortInputPaymentScheduleStatusPaymentScheduleSummaryPaymentSortByPaymentStatusPaymentTextSearchPaymentTextSearchFieldPaymentTimestampTypePaymentTransactionPaymentWebhookPaymentWebhookPaymentStatusPaymentWebhookRequestPaymentWebhookResponsePaymentWebhookStatusPaymentWebhookTriggerPaymentWithCursorPendingPaymentSchedulePgBillingKeyIssueResponsePgCompanyPgProviderPgProviderErrorPlatformAccountPlatformAccountHolderPlatformAccountStatusPlatformAccountTransferPlatformAccountTransferFilterPlatformAccountTransferTypePlatformAccountVerificationAlreadyUsedErrorPlatformAccountVerificationFailedErrorPlatformAccountVerificationNotFoundErrorPlatformAdditionalFeePoliciesNotFoundErrorPlatformAdditionalFeePolicyPlatformAdditionalFeePolicyAlreadyExistsErrorPlatformAdditionalFeePolicyFilterInputPlatformAdditionalFeePolicyFilterInputKeywordPlatformAdditionalFeePolicyNotFoundErrorPlatformAdditionalFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedErrorPlatformAmountExceededTypePlatformArchivedAdditionalFeePolicyErrorPlatformArchivedContractErrorPlatformArchivedDiscountSharePolicyErrorPlatformArchivedPartnerErrorPlatformBtxNotEnabledErrorPlatformBulkPayoutPlatformBulkPayoutFilterInputPlatformBulkPayoutFilterInputCriteriaPlatformBulkPayoutStatsPlatformBulkPayoutStatusPlatformBulkPayoutStatusStatsPlatformBulkTaskPlatformBulkTaskProgressStatsPlatformBulkTaskStatusPlatformBulkTaskTypePlatformBusinessStatusPlatformCancelOrderTransfersExistsErrorPlatformCancellableAmountExceededErrorPlatformCancellableAmountTypePlatformCancellableDiscountAmountExceededErrorPlatformCancellableDiscountTaxFreeAmountExceededErrorPlatformCancellableProductQuantityExceededErrorPlatformCancellationAndPaymentTypeMismatchedErrorPlatformCancellationNotFoundErrorPlatformCannotArchiveScheduledAdditionalFeePolicyErrorPlatformCannotArchiveScheduledContractErrorPlatformCannotArchiveScheduledDiscountSharePolicyErrorPlatformCannotArchiveScheduledPartnerErrorPlatformCannotSpecifyTransferErrorPlatformCompanyNotFoundErrorPlatformCompanyStatePlatformCompanyVerificationAlreadyUsedErrorPlatformContactPlatformContractPlatformContractAlreadyExistsErrorPlatformContractFilterInputPlatformContractFilterInputKeywordPlatformContractNotFoundErrorPlatformContractPlatformFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedErrorPlatformContractsNotFoundErrorPlatformCurrencyNotSupportedErrorPlatformDepositAccountTransferPlatformDiscountSharePoliciesNotFoundErrorPlatformDiscountSharePolicyPlatformDiscountSharePolicyAlreadyExistsErrorPlatformDiscountSharePolicyFilterInputPlatformDiscountSharePolicyFilterInputKeywordPlatformDiscountSharePolicyIdDuplicatedErrorPlatformDiscountSharePolicyNotFoundErrorPlatformExternalApiFailedErrorPlatformExternalApiTemporarilyFailedErrorPlatformExternalPaymentPlatformFeePlatformFeeInputPlatformFixedAmountFeePlatformFixedRateFeePlatformInsufficientDataToChangePartnerTypeErrorPlatformManualTransferPlatformManualTransferSummaryPlatformMemberCompanyConnectedPartnerBrnUnchangeableErrorPlatformMemberCompanyConnectedPartnerTypeUnchangeableErrorPlatformMemberCompanyNotConnectableStatusErrorPlatformMemberCompanyNotConnectedErrorPlatformNotEnabledErrorPlatformNotSupportedBankErrorPlatformOngoingTaxInvoiceExistsErrorPlatformOrderCancelTransferPlatformOrderCancelTransferSummaryPlatformOrderDetailMismatchedErrorPlatformOrderSettlementAmountPlatformOrderTransferPlatformOrderTransferAdditionalFeePlatformOrderTransferAlreadyCancelledErrorPlatformOrderTransferCancellationPlatformOrderTransferDiscountPlatformOrderTransferOrderLinePlatformOrderTransferProductPlatformOrderTransferSummaryPlatformPartnerPlatformPartnerBusinessStatusPlatformPartnerFilterInputPlatformPartnerFilterInputKeywordPlatformPartnerIdAlreadyExistsErrorPlatformPartnerIdsAlreadyExistErrorPlatformPartnerIdsDuplicatedErrorPlatformPartnerManualSettlementPlatformPartnerMemberCompanyConnectionStatusPlatformPartnerNotFoundErrorPlatformPartnerOrderCancelSettlementPlatformPartnerOrderSettlementPlatformPartnerPayoutAccountTransferPlatformPartnerScheduleExistsErrorPlatformPartnerSettlementPlatformPartnerSettlementFilterInputPlatformPartnerSettlementFilterKeywordInputPlatformPartnerSettlementStatusPlatformPartnerSettlementStatusStatsPlatformPartnerSettlementTypePlatformPartnerStatusPlatformPartnerTaxationTypePlatformPartnerTaxationTypeIsSimpleErrorPlatformPartnerTypePlatformPartnerTypeBusinessPlatformPartnerTypeIsNotBusinessErrorPlatformPartnerTypeNamePlatformPartnerTypeNonWhtPayerPlatformPartnerTypeWhtPayerPlatformPayerPlatformPaymentPlatformPaymentMethodPlatformPaymentMethodCardPlatformPaymentMethodCardInputPlatformPaymentMethodEasyPayPlatformPaymentMethodEasyPayInputPlatformPaymentMethodGiftCertificatePlatformPaymentMethodGiftCertificateInputPlatformPaymentMethodInputPlatformPaymentMethodMobilePlatformPaymentMethodMobileInputPlatformPaymentMethodTransferPlatformPaymentMethodTransferInputPlatformPaymentMethodVirtualAccountPlatformPaymentMethodVirtualAccountInputPlatformPaymentNotFoundErrorPlatformPayoutPlatformPayoutAccountPlatformPayoutFilterInputPlatformPayoutFilterInputCriteriaPlatformPayoutMethodPlatformPayoutStatusPlatformPayoutStatusStatsPlatformPortOnePaymentPlatformPortOnePaymentCancelAmountTypePlatformProductIdDuplicatedErrorPlatformProductIdNotFoundErrorPlatformPropertiesPlatformRemitAccountTransferPlatformSettlementAmountExceededErrorPlatformSettlementCancelAmountExceededPortOneCancelErrorPlatformSettlementCyclePlatformSettlementCycleDatePolicyPlatformSettlementCycleInputPlatformSettlementCycleMethodPlatformSettlementCycleMethodDailyPlatformSettlementCycleMethodDailyInputPlatformSettlementCycleMethodInputPlatformSettlementCycleMethodManualDatesPlatformSettlementCycleMethodManualDatesInputPlatformSettlementCycleMethodMonthlyPlatformSettlementCycleMethodMonthlyInputPlatformSettlementCycleMethodWeeklyPlatformSettlementCycleMethodWeeklyInputPlatformSettlementCycleTypePlatformSettlementParameterNotFoundErrorPlatformSettlementParameterValuePlatformSettlementPaymentAmountExceededPortOnePaymentErrorPlatformSettlementSupplyWithVatAmountExceededPortOnePaymentErrorPlatformSettlementTaxFreeAmountExceededPortOnePaymentErrorPlatformTargetPartnerNotFoundErrorPlatformTaxationTypePlatformTransferPlatformTransferAlreadyExistsErrorPlatformTransferDiscountSharePolicyNotFoundErrorPlatformTransferFilterInputPlatformTransferFilterInputKeywordPlatformTransferNonDeletableStatusErrorPlatformTransferNotFoundErrorPlatformTransferSheetFieldPlatformTransferStatusPlatformTransferSummaryPlatformTransferSummaryExternalPaymentPlatformTransferSummaryPartnerPlatformTransferSummaryPartnerTypePlatformTransferSummaryPaymentPlatformTransferSummaryPortOnePaymentPlatformTransferTypePlatformUserDefinedFormulaResultsPlatformUserDefinedPropertyKeyValuePlatformUserDefinedPropertyNotFoundErrorPlatformUserDefinedPropertyValuePortOneVersionPreRegisterPaymentErrorPreRegisterPaymentResponsePromotionPromotionAmountDiscountSchemePromotionCardCompanyPromotionDiscountPartitionPromotionDiscountPolicyPromotionDiscountRetainOptionPromotionDiscountRetainOptionShouldNotBeChangedErrorPromotionDiscountSchemePromotionNotFoundErrorPromotionPayMethodDoesNotMatchErrorPromotionPercentDiscountSchemePromotionRecoverOptionPromotionRecoverOptionNoRecoverPromotionRecoverOptionRecoverPromotionSpareBudgetPromotionSpareBudgetAmountPromotionSpareBudgetPercentPromotionStatusReadyIdentityVerificationReadyPaymentReadyPaymentTransactionRecoverPlatformAdditionalFeePolicyErrorRecoverPlatformAdditionalFeePolicyResponseRecoverPlatformContractErrorRecoverPlatformContractResponseRecoverPlatformDiscountSharePolicyErrorRecoverPlatformDiscountSharePolicyResponseRecoverPlatformPartnerErrorRecoverPlatformPartnerResponseRefreshTokenErrorRefreshTokenResponseRegisterStoreReceiptBodyItemRegisterStoreReceiptErrorRegisterStoreReceiptResponseRegisteredPaymentEscrowRejectConfirmedPaymentEscrowRejectedPaymentEscrowRequestedPaymentCancellationResendIdentityVerificationErrorResendIdentityVerificationResponseResendWebhookErrorResendWebhookResponseRevokePaymentSchedulesErrorRevokePaymentSchedulesResponseRevokedPaymentScheduleScheduledPaymentScheduleSelectedChannelSelectedChannelTypeSendIdentityVerificationBodyCustomerSendIdentityVerificationErrorSendIdentityVerificationResponseSeparatedAddressSeparatedAddressInputSortOrderStartedPaymentScheduleSucceededPaymentCancellationSucceededPaymentScheduleSumOfPartsExceedsCancelAmountErrorSumOfPartsExceedsTotalAmountErrorTransferParametersTriggerUnauthorizedErrorUpdatePlatformAdditionalFeePolicyErrorUpdatePlatformAdditionalFeePolicyResponseUpdatePlatformContractErrorUpdatePlatformContractResponseUpdatePlatformDiscountSharePolicyErrorUpdatePlatformDiscountSharePolicyResponseUpdatePlatformPartnerBodyAccountUpdatePlatformPartnerBodyContactUpdatePlatformPartnerBodyTypeUpdatePlatformPartnerBodyTypeBusinessUpdatePlatformPartnerBodyTypeNonWhtPayerUpdatePlatformPartnerBodyTypeWhtPayerUpdatePlatformPartnerErrorUpdatePlatformPartnerResponseVerifiedIdentityVerificationVirtualAccountIssuedPaymentVirtualAccountIssuedPaymentTransactionWebhookNotFoundError
Address: OneLineAddress | SeparatedAddress
분리 형식 주소

oneLine(한 줄 형식 주소) 필드는 항상 존재합니다.

AlreadyPaidError: { type, message }
결제가 이미 완료된 경우

결제가 이미 완료된 경우

AlreadyPaidOrWaitingError: { type, message }
결제가 이미 완료되었거나 대기중인 경우

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

ApplyEscrowLogisticsError: ForbiddenError | InvalidRequestError | PaymentNotFoundError | ...
ApplyEscrowLogisticsError
ApplyEscrowLogisticsResponse: { invoiceNumber, sentAt, appliedAt }
에스크로 배송 정보 등록 성공 응답

에스크로 배송 정보 등록 성공 응답

ArchivePlatformAdditionalFeePolicyError: ForbiddenError | InvalidRequestError | PlatformAdditionalFeePolicyNotFoundError | ...
ArchivePlatformAdditionalFeePolicyError
ArchivePlatformAdditionalFeePolicyResponse: { additionalFeePolicy }
추가 수수료 정책 보관 성공 응답

추가 수수료 정책 보관 성공 응답

ArchivePlatformContractError: ForbiddenError | InvalidRequestError | PlatformCannotArchiveScheduledContractError | ...
ArchivePlatformContractError
ArchivePlatformContractResponse: { contract }
계약 보관 성공 응답

계약 보관 성공 응답

ArchivePlatformDiscountSharePolicyError: ForbiddenError | InvalidRequestError | PlatformCannotArchiveScheduledDiscountSharePolicyError | ...
ArchivePlatformDiscountSharePolicyError
ArchivePlatformDiscountSharePolicyResponse: { discountSharePolicy }
할인 분담 보관 성공 응답

할인 분담 보관 성공 응답

ArchivePlatformPartnerError: ForbiddenError | InvalidRequestError | PlatformCannotArchiveScheduledPartnerError | ...
ArchivePlatformPartnerError
ArchivePlatformPartnerResponse: { partner }
파트너 보관 성공 응답

파트너 보관 성공 응답

B2bBusinessInfo: { brn, name, ceoName, ... }
사업자등록 정보

사업자등록 정보

B2bBusinessInfoResult: { brn, businessInfo, error }
사업자등록 정보조회 결과

사업자등록 정보조회 결과

B2bExternalServiceError: { type, message }
외부 서비스에서 에러가 발생한 경우

외부 서비스에서 에러가 발생한 경우

B2bNotEnabledError: { type, message }
B2B 기능이 활성화되지 않은 경우

B2B 기능이 활성화되지 않은 경우

Bank: "BANK_OF_KOREA" | "KDB" | "IBK" | ...
은행

은행

BankInfo: { bank, name }
은행 정보

은행 정보

BankInfoName: { ko }
은행 명칭

은행 명칭

BeforeRegisteredPaymentEscrow: { status }
배송 정보 등록 전

배송 정보 등록 전

BillingKeyAlreadyDeletedError: { type, message }
빌링키가 이미 삭제된 경우

빌링키가 이미 삭제된 경우

BillingKeyFailure: { message, pgCode, pgMessage, ... }
발급 실패 상세 정보

발급 실패 상세 정보

BillingKeyFilterInput: { storeId, timeRangeField, from, ... }
빌링키 다건 조회를 위한 입력 정보

빌링키 다건 조회를 위한 입력 정보

BillingKeyInfo: DeletedBillingKeyInfo | IssuedBillingKeyInfo
빌링키 정보

빌링키 정보

BillingKeyInfoSummary: { billingKey, channels, issuedAt }
BillingKeyInfoSummary
BillingKeyNotFoundError: { type, message }
빌링키가 존재하지 않는 경우

빌링키가 존재하지 않는 경우

BillingKeyNotIssuedError: { type, message }
BillingKeyNotIssuedError
BillingKeyPaymentInput: { storeId, billingKey, channelKey, ... }
빌링키 결제 요청 입력 정보

빌링키 결제 요청 입력 정보

BillingKeyPaymentMethod: BillingKeyPaymentMethodCard | BillingKeyPaymentMethodEasyPay | BillingKeyPaymentMethodMobile | ...
빌링키 발급 수단 정보

빌링키 발급 수단 정보

BillingKeyPaymentMethodCard: { type, card }
카드 정보

카드 정보

BillingKeyPaymentMethodEasyPay: { type, provider, method }
간편 결제 정보

간편 결제 정보

BillingKeyPaymentMethodEasyPayCharge: { type }
충전식 포인트 결제 정보

충전식 포인트 결제 정보

BillingKeyPaymentMethodEasyPayMethod: BillingKeyPaymentMethodCard | BillingKeyPaymentMethodEasyPayCharge | BillingKeyPaymentMethodTransfer
간편 결제 수단

간편 결제 수단

BillingKeyPaymentMethodMobile: { type, phoneNumber }
모바일 정보

모바일 정보

BillingKeyPaymentMethodPaypal: { type }
페이팔 정보

페이팔 정보

BillingKeyPaymentMethodTransfer: { type, bank, accountNumber }
계좌이체 정보

계좌이체 정보

BillingKeyPaymentMethodType: "CARD" | "MOBILE" | "EASY_PAY" | ...
빌링키 결제 수단

빌링키 결제 수단

BillingKeyPaymentSummary: { pgTxId, paidAt }
빌링키 결제 완료된 결제 건 요약 정보

빌링키 결제 완료된 결제 건 요약 정보

BillingKeySortBy: "REQUESTED_AT" | "ISSUED_AT" | "DELETED_AT" | ...
빌링키 정렬 기준

빌링키 정렬 기준

BillingKeySortInput: { by, order }
빌링키 다건 조회 시 정렬 조건

빌링키 다건 조회 시 정렬 조건

BillingKeyStatus: "ISSUED" | "DELETED"
빌링키 상태

빌링키 상태

BillingKeyTextSearch: { field, value }
통합검색 입력 정보

통합검색 입력 정보

BillingKeyTextSearchField: "CARD_BIN" | "CARD_NUMBER" | "PG_MERCHANT_ID" | ...
통합검색 항목

통합검색 항목

BillingKeyTimeRangeField: "REQUESTED_AT" | "ISSUED_AT" | "DELETED_AT" | ...
빌링키 다건 조회 시, 시각 범위를 적용할 필드

빌링키 다건 조회 시, 시각 범위를 적용할 필드

CancelAmountExceedsCancellableAmountError: { type, message }
결제 취소 금액이 취소 가능 금액을 초과한 경우

결제 취소 금액이 취소 가능 금액을 초과한 경우

CancelCashReceiptError: CashReceiptNotFoundError | CashReceiptNotIssuedError | ForbiddenError | ...
CancelCashReceiptError
CancelCashReceiptResponse: { cancelledAmount, cancelledAt }
현금 영수증 취소 성공 응답

현금 영수증 취소 성공 응답

CancelPaymentBodyRefundAccount: { bank, number, holderName, ... }
고객 정보 입력 형식

고객 정보 입력 형식

CancelPaymentError: CancellableAmountConsistencyBrokenError | CancelAmountExceedsCancellableAmountError | CancelTaxAmountExceedsCancellableTaxAmountError | ...
CancelPaymentError
CancelPaymentResponse: { cancellation }
결제 취소 성공 응답

결제 취소 성공 응답

CancelRequester: "CUSTOMER" | "ADMIN"
CancelRequester
CancelTaxAmountExceedsCancellableTaxAmountError: { type, message }
취소 과세 금액이 취소 가능한 과세 금액을 초과한 경우

취소 과세 금액이 취소 가능한 과세 금액을 초과한 경우

CancelTaxFreeAmountExceedsCancellableTaxFreeAmountError: { type, message }
취소 면세 금액이 취소 가능한 면세 금액을 초과한 경우

취소 면세 금액이 취소 가능한 면세 금액을 초과한 경우

CancellableAmountConsistencyBrokenError: { type, message }
취소 가능 잔액 검증에 실패한 경우

취소 가능 잔액 검증에 실패한 경우

CancelledCashReceipt: { status, merchantId, storeId, ... }
발급 취소

발급 취소

CancelledPayment: { status, id, transactionId, ... }
결제 취소 상태 건

결제 취소 상태 건

CancelledPaymentCashReceipt: { status, type, pgReceiptId, ... }
취소된 현금영수증

취소된 현금영수증

CancelledPaymentEscrow: { status, company, invoiceNumber, ... }
거래 취소

거래 취소

CancelledPaymentTransaction: { status, id, paymentId, ... }
결제 취소 상태 건

결제 취소 상태 건

Card: { publisher, issuer, brand, ... }
카드 상세 정보

카드 상세 정보

CardBrand: "LOCAL" | "MASTER" | "UNIONPAY" | ...
카드 브랜드

카드 브랜드

CardCredential: { number, expiryYear, expiryMonth, ... }
카드 인증 관련 정보

카드 인증 관련 정보

CardOwnerType: "PERSONAL" | "CORPORATE"
카드 소유주 유형

카드 소유주 유형

CardPromotion: { type, id, storeId, ... }
카드 프로모션

카드 프로모션

CardType: "CREDIT" | "DEBIT" | "GIFT"
카드 유형

카드 유형

Carrier: "SKT" | "KT" | "LGU" | ...
통신사

통신사

CashReceipt: CancelledCashReceipt | IssuedCashReceipt | IssueFailedCashReceipt
현금영수증 내역

현금영수증 내역

CashReceiptAlreadyIssuedError: { type, message }
현금영수증이 이미 발급된 경우

현금영수증이 이미 발급된 경우

CashReceiptFilterInput: { storeId, timeRangeField, from, ... }
현금영수증 다건 조회를 위한 입력 정보

현금영수증 다건 조회를 위한 입력 정보

CashReceiptInput: { type, customerIdentityNumber }
현금영수증 입력 정보

현금영수증 입력 정보

CashReceiptInputType: "PERSONAL" | "CORPORATE" | "NO_RECEIPT"
입력 시 발급 유형

입력 시 발급 유형

CashReceiptNotFoundError: { type, message }
현금영수증이 존재하지 않는 경우

현금영수증이 존재하지 않는 경우

CashReceiptNotIssuedError: { type, message }
현금영수증이 발급되지 않은 경우

현금영수증이 발급되지 않은 경우

CashReceiptSortBy: "ISSUED_AT" | "CANCELLED_AT" | "STATUS_UPDATED_AT"
현금영수증 정렬 기준

현금영수증 정렬 기준

CashReceiptSortInput: { by, order }
현금영수증 다건 조회 시 정렬 조건

현금영수증 다건 조회 시 정렬 조건

CashReceiptStatus: "ISSUED" | "CANCELLED" | "FAILED"
현금영수증 발급 건 상태

현금영수증 발급 건 상태

CashReceiptSummary: { issueNumber, url, pgReceiptId }
현금영수증 내역

현금영수증 내역

CashReceiptTimeRangeField: "ISSUED_AT" | "CANCELLED_AT" | "STATUS_UPDATED_AT"
현금영수증 다건 조회 시, 시각 범위를 적용할 필드

현금영수증 다건 조회 시, 시각 범위를 적용할 필드

CashReceiptType: "PERSONAL" | "CORPORATE"
발급 유형

발급 유형

ChannelGroupSummary: { id, name, isForTest }
채널 그룹 정보

채널 그룹 정보

ChannelNotFoundError: { type, message }
요청된 채널이 존재하지 않는 경우

요청된 채널이 존재하지 않는 경우

ChannelSpecificError: { type, message, failures, ... }
여러 채널을 지정한 요청에서, 채널 각각에서 오류가 발생한 경우

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

ChannelSpecificFailure: ChannelSpecificFailureInvalidRequest | ChannelSpecificFailurePgProvider
ChannelSpecificFailure
ChannelSpecificFailureInvalidRequest: { type, channel, message }
요청된 입력 정보가 유효하지 않은 경우

허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

ChannelSpecificFailurePgProvider: { type, channel, message, ... }
PG사에서 오류를 전달한 경우

PG사에서 오류를 전달한 경우

CloseVirtualAccountError: ForbiddenError | InvalidRequestError | PaymentNotFoundError | ...
CloseVirtualAccountError
CloseVirtualAccountResponse: { closedAt }
가상계좌 말소 성공 응답

가상계좌 말소 성공 응답

ConfirmEscrowError: ForbiddenError | InvalidRequestError | PaymentNotFoundError | ...
ConfirmEscrowError
ConfirmEscrowResponse: { completedAt }
에스크로 구매 확정 성공 응답

에스크로 구매 확정 성공 응답

ConfirmIdentityVerificationError: ForbiddenError | IdentityVerificationAlreadyVerifiedError | IdentityVerificationNotFoundError | ...
ConfirmIdentityVerificationError
ConfirmIdentityVerificationResponse: { identityVerification }
본인인증 확인 성공 응답

본인인증 확인 성공 응답

ConfirmedPaymentEscrow: { status, company, invoiceNumber, ... }
구매 확정

구매 확정

ConnectBulkPartnerMemberCompanyError: ForbiddenError | InvalidRequestError | PlatformBtxNotEnabledError | ...
ConnectBulkPartnerMemberCompanyError
ConnectBulkPartnerMemberCompanyResponse: { bulkTask }
파트너 연동 사업자 일괄 연동 요청 응답

파트너 연동 사업자 일괄 연동 요청 응답

ConnectPartnerMemberCompanyError: ForbiddenError | InvalidRequestError | PlatformBtxNotEnabledError | ...
ConnectPartnerMemberCompanyError
ConnectPartnerMemberCompanyResponse: { partner }
파트너 연동 사업자 연동 요청 응답

파트너 연동 사업자 연동 요청 응답

Country: "AD" | "AE" | "AF" | ...
국가

국가

CreateManualTransferResponse: { transfer }
CreateManualTransferResponse
CreateOrderCancelTransferResponse: { transfer }
CreateOrderCancelTransferResponse
CreateOrderTransferResponse: { transfer }
CreateOrderTransferResponse
CreatePaymentScheduleError: AlreadyPaidOrWaitingError | BillingKeyAlreadyDeletedError | BillingKeyNotFoundError | ...
CreatePaymentScheduleError
CreatePaymentScheduleResponse: { schedule }
결제 예약 성공 응답

결제 예약 성공 응답

CreatePlatformAdditionalFeePolicyError: ForbiddenError | InvalidRequestError | PlatformAdditionalFeePolicyAlreadyExistsError | ...
CreatePlatformAdditionalFeePolicyError
CreatePlatformAdditionalFeePolicyResponse: { additionalFeePolicy }
플랫폼 생성 성공 응답 정보

플랫폼 생성 성공 응답 정보

CreatePlatformContractError: ForbiddenError | InvalidRequestError | PlatformContractAlreadyExistsError | ...
CreatePlatformContractError
CreatePlatformContractResponse: { contract }
계약 객체 생성 성공 응답

계약 객체 생성 성공 응답

CreatePlatformDiscountSharePolicyError: ForbiddenError | InvalidRequestError | PlatformDiscountSharePolicyAlreadyExistsError | ...
CreatePlatformDiscountSharePolicyError
CreatePlatformDiscountSharePolicyResponse: { discountSharePolicy }
할인 분담 정책 생성 성공 응답

할인 분담 정책 생성 성공 응답

CreatePlatformManualTransferError: ForbiddenError | InvalidRequestError | PlatformNotEnabledError | ...
CreatePlatformManualTransferError
CreatePlatformOrderCancelTransferBodyDiscount: { sharePolicyId, amount, taxFreeAmount }
할인 정보

할인 정보

CreatePlatformOrderCancelTransferBodyExternalCancellationDetail: { cancelledAt }
외부 결제 상세 정보

외부 결제 상세 정보

CreatePlatformOrderCancelTransferBodyOrderDetail: { orderAmount, orderLines, all }
주문 취소 정보

orderAmount, orderLines, all 중에서 하나만 입력하여야 합니다.

CreatePlatformOrderCancelTransferBodyOrderDetailAll: { }
전체 금액 취소

전체 금액 취소

CreatePlatformOrderCancelTransferBodyOrderLine: { productId, quantity, discounts }
주문 취소 항목 리스트

주문 취소 항목 리스트

CreatePlatformOrderCancelTransferError: ForbiddenError | InvalidRequestError | PlatformCancellableAmountExceededError | ...
CreatePlatformOrderCancelTransferError
CreatePlatformOrderTransferBodyAdditionalFee: { policyId }
추가 수수료 정보

추가 수수료 정보

CreatePlatformOrderTransferBodyDiscount: { sharePolicyId, amount, taxFreeAmount }
할인 정보

할인 정보

CreatePlatformOrderTransferBodyExternalPaymentDetail: { currency, orderName, paidAt, ... }
외부 결제 상세 정보

외부 결제 상세 정보

CreatePlatformOrderTransferBodyOrderDetail: { orderAmount, orderLines }
주문 정보

주문 금액 또는 주문 항목 하나만 입력 가능합니다.

CreatePlatformOrderTransferBodyOrderLine: { product, quantity, discounts, ... }
주문 항목

주문 항목

CreatePlatformOrderTransferBodyProduct: { id, name, amount, ... }
상품

상품

CreatePlatformOrderTransferError: ForbiddenError | InvalidRequestError | PlatformAdditionalFeePoliciesNotFoundError | ...
CreatePlatformOrderTransferError
CreatePlatformPartnerBody: { id, name, contact, ... }
파트너 생성을 위한 입력 정보

파트너 생성을 위한 입력 정보

CreatePlatformPartnerBodyAccount: { bank, currency, number, ... }
파트너 계좌 등록을 위한 정보

파트너 계좌 등록을 위한 정보

CreatePlatformPartnerBodyContact: { name, phoneNumber, email }
파트너 담당자 정보

파트너 담당자 정보

CreatePlatformPartnerBodyType: { business, whtPayer, nonWhtPayer }
파트너 생성을 위한 유형별 추가 정보

파트너 생성을 위한 유형별 추가 정보

CreatePlatformPartnerBodyTypeBusiness: { companyName, taxationType, businessRegistrationNumber, ... }
CreatePlatformPartnerBodyTypeBusiness
CreatePlatformPartnerBodyTypeNonWhtPayer: { birthdate }
CreatePlatformPartnerBodyTypeNonWhtPayer
CreatePlatformPartnerBodyTypeWhtPayer: { birthdate }
CreatePlatformPartnerBodyTypeWhtPayer
CreatePlatformPartnerError: ForbiddenError | InvalidRequestError | PlatformAccountVerificationAlreadyUsedError | ...
CreatePlatformPartnerError
CreatePlatformPartnerResponse: { partner }
파트너 생성 성공 응답

파트너 생성 성공 응답

CreatePlatformPartnersError: ForbiddenError | InvalidRequestError | PlatformContractsNotFoundError | ...
CreatePlatformPartnersError
CreatePlatformPartnersResponse: { partners }
파트너 다건 생성 성공 응답

파트너 다건 생성 성공 응답

Currency: "KRW" | "USD" | "JPY" | ...
통화 단위

통화 단위

Customer: { id, name, birthYear, ... }
고객 정보

고객 정보

CustomerInput: { id, name, birthYear, ... }
고객 정보 입력 정보

고객 정보 입력 정보

CustomerNameInput: { full, separated }
고객 이름 입력 정보

두 개의 이름 형식 중 한 가지만 선택하여 입력해주세요.

CustomerSeparatedName: { first, last }
고객 분리형 이름

고객 분리형 이름

DateRange: { from, until }
DateRange
DateTimeRange: { from, until }
시간 범위

시간 범위

DayOfWeek: "SUN" | "MON" | "TUE" | ...
요일

요일

DeleteBillingKeyError: BillingKeyAlreadyDeletedError | BillingKeyNotFoundError | BillingKeyNotIssuedError | ...
DeleteBillingKeyError
DeleteBillingKeyResponse: { deletedAt }
빌링키 삭제 성공 응답

빌링키 삭제 성공 응답

DeletePlatformTransferError: ForbiddenError | InvalidRequestError | PlatformCancelOrderTransfersExistsError | ...
DeletePlatformTransferError
DeletePlatformTransferResponse: { }
DeletePlatformTransferResponse
DeletedBillingKeyInfo: { status, billingKey, merchantId, ... }
빌링키 삭제 완료 상태 건

빌링키 삭제 완료 상태 건

DeliveredPaymentEscrow: { status, company, invoiceNumber, ... }
배송 완료

배송 완료

DisconnectBulkPartnerMemberCompanyError: ForbiddenError | InvalidRequestError | PlatformBtxNotEnabledError | ...
DisconnectBulkPartnerMemberCompanyError
DisconnectBulkPartnerMemberCompanyResponse: { bulkTask }
파트너 연동 사업자 일괄 연동 해제 요청 응답

파트너 연동 사업자 일괄 연동 해제 요청 응답

DisconnectPartnerMemberCompanyError: ForbiddenError | InvalidRequestError | PlatformBtxNotEnabledError | ...
DisconnectPartnerMemberCompanyError
DisconnectPartnerMemberCompanyResponse: { partner }
연동 사업자 연동 해제 요청 응답

연동 사업자 연동 해제 요청 응답

DiscountAmountExceedsTotalAmountError: { type, message }
프로모션 할인 금액이 결제 시도 금액 이상인 경우

프로모션 할인 금액이 결제 시도 금액 이상인 경우

Dispute: { status, pgDisputeId, reason, ... }
분쟁 내역

분쟁 내역

DisputeStatus: "UNRESOLVED" | "RESOLVED"
분쟁 상태

분쟁 상태

DownloadPlatformTransferSheetError: InvalidRequestError | UnauthorizedError
DownloadPlatformTransferSheetError
EasyPayMethodType: "CARD" | "TRANSFER" | "CHARGE"
간편 결제 수단

간편 결제 수단

EasyPayProvider: "SAMSUNGPAY" | "KAKAOPAY" | "NAVERPAY" | ...
간편 결제사

간편 결제사

FailedIdentityVerification: { status, id, channel, ... }
실패한 본인인증 내역

실패한 본인인증 내역

FailedPayment: { status, id, transactionId, ... }
결제 실패 상태 건

결제 실패 상태 건

FailedPaymentCancellation: { status, id, pgCancellationId, ... }
취소 실패 상태

취소 실패 상태

FailedPaymentSchedule: { status, id, merchantId, ... }
결제 실패 상태

결제 실패 상태

FailedPaymentTransaction: { status, id, paymentId, ... }
결제 실패 상태 건

결제 실패 상태 건

FailedPgBillingKeyIssueResponse: { type, channel, failure }
빌링키 발급 실패 채널 응답

빌링키 발급 실패 채널 응답

ForbiddenError: { type, message }
요청이 거절된 경우

요청이 거절된 경우

Gender: "MALE" | "FEMALE" | "OTHER"
성별

성별

GetAllPaymentsByCursorResponse: { items }
결제 건 커서 기반 대용량 다건 조회 성공 응답 정보

결제 건 커서 기반 대용량 다건 조회 성공 응답 정보

GetAllPaymentsError: ForbiddenError | InvalidRequestError | UnauthorizedError
GetAllPaymentsError
GetB2bBusinessInfosError: B2bExternalServiceError | B2bNotEnabledError | ForbiddenError | ...
GetB2bBusinessInfosError
GetB2bBusinessInfosResponse: { result }
사업자등록 정보 조회 성공 응답

사업자등록 정보 조회 성공 응답

GetBankInfosError: InvalidRequestError
GetBankInfosError
GetBankInfosResponse: { items }
은행 정보 조회 성공 응답 정보

은행 정보 조회 성공 응답 정보

GetBillingKeyInfoError: BillingKeyNotFoundError | ForbiddenError | InvalidRequestError | ...
GetBillingKeyInfoError
GetBillingKeyInfosError: ForbiddenError | InvalidRequestError | UnauthorizedError
GetBillingKeyInfosError
GetBillingKeyInfosResponse: { items, page }
빌링키 다건 조회 성공 응답 정보

빌링키 다건 조회 성공 응답 정보

GetCashReceiptError: CashReceiptNotFoundError | ForbiddenError | InvalidRequestError | ...
GetCashReceiptError
GetCashReceiptsError: ForbiddenError | InvalidRequestError | UnauthorizedError
GetCashReceiptsError
GetCashReceiptsResponse: { items, page }
현금영수증 다건 조회 성공 응답 정보

현금영수증 다건 조회 성공 응답 정보

GetIdentityVerificationError: ForbiddenError | IdentityVerificationNotFoundError | InvalidRequestError | ...
GetIdentityVerificationError
GetIdentityVerificationsError: ForbiddenError | InvalidRequestError | UnauthorizedError
GetIdentityVerificationsError
GetIdentityVerificationsResponse: { items, page }
본인인증 내역 다건 조회 성공 응답 정보

본인인증 내역 다건 조회 성공 응답 정보

GetKakaopayPaymentOrderError: InvalidRequestError | UnauthorizedError
GetKakaopayPaymentOrderError
GetKakaopayPaymentOrderResponse: { statusCode, body }
카카오페이 주문 조회 응답

카카오페이 주문 조회 응답

GetPaymentError: ForbiddenError | InvalidRequestError | PaymentNotFoundError | ...
GetPaymentError
GetPaymentScheduleError: ForbiddenError | InvalidRequestError | PaymentScheduleNotFoundError | ...
GetPaymentScheduleError
GetPaymentSchedulesError: ForbiddenError | InvalidRequestError | UnauthorizedError
GetPaymentSchedulesError
GetPaymentSchedulesResponse: { items, page }
결제 예약 다건 조회 성공 응답 정보

결제 예약 다건 조회 성공 응답 정보

GetPaymentTransactionsError: ForbiddenError | InvalidRequestError | PaymentNotFoundError | ...
GetPaymentTransactionsError
GetPaymentTransactionsResponse: { items }
결제 시도 내역 조회 응답 정보

결제 시도 내역 조회 응답 정보

GetPaymentsError: ForbiddenError | InvalidRequestError | UnauthorizedError
GetPaymentsError
GetPaymentsResponse: { items, page }
결제 건 다건 조회 성공 응답 정보

결제 건 다건 조회 성공 응답 정보

GetPlatformAccountHolderError: ForbiddenError | InvalidRequestError | PlatformExternalApiFailedError | ...
GetPlatformAccountHolderError
GetPlatformAccountTransfersError: ForbiddenError | InvalidRequestError | PlatformNotEnabledError | ...
GetPlatformAccountTransfersError
GetPlatformAccountTransfersResponse: { items, page }
이체내역 다건 조회 성공 응답 정보

이체내역 다건 조회 성공 응답 정보

GetPlatformAdditionalFeePoliciesError: ForbiddenError | InvalidRequestError | PlatformNotEnabledError | ...
GetPlatformAdditionalFeePoliciesError
GetPlatformAdditionalFeePoliciesResponse: { items, page }
추가 수수료 정책 다건 조회 성공 응답 정보

추가 수수료 정책 다건 조회 성공 응답 정보

GetPlatformAdditionalFeePolicyError: ForbiddenError | InvalidRequestError | PlatformAdditionalFeePolicyNotFoundError | ...
GetPlatformAdditionalFeePolicyError
GetPlatformBulkPayoutsError: ForbiddenError | InvalidRequestError | PlatformNotEnabledError | ...
GetPlatformBulkPayoutsError
GetPlatformBulkPayoutsResponse: { items, page, counts }
GetPlatformBulkPayoutsResponse
GetPlatformCompanyStateError: ForbiddenError | InvalidRequestError | PlatformCompanyNotFoundError | ...
GetPlatformCompanyStateError
GetPlatformCompanyStatePayload: { companyState, companyVerificationId }
사업자 조회 성공 응답 정보

사업자 조회 성공 응답 정보

GetPlatformContractError: ForbiddenError | InvalidRequestError | PlatformContractNotFoundError | ...
GetPlatformContractError
GetPlatformContractsError: ForbiddenError | InvalidRequestError | PlatformNotEnabledError | ...
GetPlatformContractsError
GetPlatformContractsResponse: { items, page }
계약 다건 조회 성공 응답

계약 다건 조회 성공 응답

GetPlatformDiscountSharePoliciesError: ForbiddenError | InvalidRequestError | PlatformNotEnabledError | ...
GetPlatformDiscountSharePoliciesError
GetPlatformDiscountSharePoliciesResponse: { items, page }
할인 분담 정책 다건 조회 성공 응답 정보

할인 분담 정책 다건 조회 성공 응답 정보

GetPlatformDiscountSharePolicyError: ForbiddenError | InvalidRequestError | PlatformDiscountSharePolicyNotFoundError | ...
GetPlatformDiscountSharePolicyError
GetPlatformPartnerError: ForbiddenError | InvalidRequestError | PlatformNotEnabledError | ...
GetPlatformPartnerError
GetPlatformPartnerSettlementsError: ForbiddenError | InvalidRequestError | PlatformNotEnabledError | ...
GetPlatformPartnerSettlementsError
GetPlatformPartnerSettlementsResponse: { items, page, counts }
정산내역 다건 조회 성공 응답 정보

정산내역 다건 조회 성공 응답 정보

GetPlatformPartnersError: ForbiddenError | InvalidRequestError | PlatformNotEnabledError | ...
GetPlatformPartnersError
GetPlatformPartnersResponse: { items, page }
파트너 다건 조회 성공 응답 정보

파트너 다건 조회 성공 응답 정보

GetPlatformPayoutsError: ForbiddenError | InvalidRequestError | PlatformNotEnabledError | ...
GetPlatformPayoutsError
GetPlatformPayoutsResponse: { items, page, counts }
GetPlatformPayoutsResponse
GetPlatformTransferError: ForbiddenError | InvalidRequestError | PlatformNotEnabledError | ...
GetPlatformTransferError
GetPlatformTransferSummariesError: ForbiddenError | InvalidRequestError | PlatformNotEnabledError | ...
GetPlatformTransferSummariesError
GetPlatformTransferSummariesResponse: { transferSummaries, page }
GetPlatformTransferSummariesResponse
GetPromotionError: ForbiddenError | InvalidRequestError | PromotionNotFoundError | ...
GetPromotionError
IdentityVerification: FailedIdentityVerification | ReadyIdentityVerification | VerifiedIdentityVerification
본인인증 내역

본인인증 내역

IdentityVerificationAlreadySentError: { type, message }
본인인증 건이 이미 API로 요청된 상태인 경우

본인인증 건이 이미 API로 요청된 상태인 경우

IdentityVerificationAlreadyVerifiedError: { type, message }
본인인증 건이 이미 인증 완료된 상태인 경우

본인인증 건이 이미 인증 완료된 상태인 경우

IdentityVerificationFailure: { reason, pgCode, pgMessage }
본인인증 실패 정보

본인인증 실패 정보

IdentityVerificationFilterCustomerInput: { name, birthYear, birthMonth, ... }
본인인증 다건 조회를 위한 고객 정보 입력 정보

본인인증 다건 조회를 위한 고객 정보 입력 정보

IdentityVerificationFilterInput: { storeId, timeRangeField, from, ... }
본인인증 다건 조회를 위한 입력 정보

본인인증 다건 조회를 위한 입력 정보

IdentityVerificationMethod: "SMS" | "APP"
본인인증 방식

본인인증 방식

IdentityVerificationNotFoundError: { type, message }
요청된 본인인증 건이 존재하지 않는 경우

요청된 본인인증 건이 존재하지 않는 경우

IdentityVerificationNotSentError: { type, message }
본인인증 건이 API로 요청된 상태가 아닌 경우

본인인증 건이 API로 요청된 상태가 아닌 경우

IdentityVerificationOperator: "SKT" | "KT" | "LGU" | ...
본인인증 통신사

본인인증 통신사

IdentityVerificationRequestedCustomer: { id, name, phoneNumber, ... }
요청 시 고객 정보

요청 시 고객 정보

IdentityVerificationSortBy: "REQUESTED_AT" | "VERIFIED_AT" | "FAILED_AT" | ...
본인인증 내역 정렬 기준

본인인증 내역 정렬 기준

IdentityVerificationSortInput: { by, order }
본인인증 내역 다건 조회 시 정렬 조건

본인인증 내역 다건 조회 시 정렬 조건

IdentityVerificationStatus: "READY" | "VERIFIED" | "FAILED"
본인인증 상태

본인인증 상태

IdentityVerificationTimeRangeField: "REQUESTED_AT" | "VERIFIED_AT" | "FAILED_AT" | ...
본인인증 다건 조회 시, 시각 범위를 적용할 필드

본인인증 다건 조회 시, 시각 범위를 적용할 필드

IdentityVerificationVerifiedCustomer: { id, name, operator, ... }
인증된 고객 정보

인증된 고객 정보

InstantBillingKeyPaymentMethodInput: { card }
빌링키 발급 시 결제 수단 입력 양식

card를 반드시 입력해 주세요.

InstantBillingKeyPaymentMethodInputCard: { credential }
카드 수단 정보 입력 양식

카드 수단 정보 입력 양식

InstantPaymentMethodInput: { card, virtualAccount }
수기 결제 수단 입력 정보

하나의 필드만 입력합니다.

InstantPaymentMethodInputCard: { credential, installmentMonth, useFreeInstallmentPlan, ... }
카드 수단 정보 입력 정보

카드 수단 정보 입력 정보

InstantPaymentMethodInputVirtualAccount: { bank, expiry, option, ... }
가상계좌 수단 정보 입력 정보

가상계좌 수단 정보 입력 정보

InstantPaymentMethodInputVirtualAccountCashReceiptInfo: { type, customerIdentityNumber }
가상계좌 결제 시 현금영수증 정보

가상계좌 결제 시 현금영수증 정보

InstantPaymentMethodInputVirtualAccountExpiry: { validHours, dueDate }
입금 만료 기한

validHours와 dueDate 둘 중 하나의 필드만 입력합니다.

InstantPaymentMethodInputVirtualAccountOption: { type, fixed }
가상계좌 발급 방식

가상계좌 발급 방식

InstantPaymentMethodInputVirtualAccountOptionFixed: { pgAccountId, accountNumber }
고정식 가상계좌 발급 유형

pgAccountId, accountNumber 유형 중 한 개의 필드만 입력합니다.

InstantPaymentMethodInputVirtualAccountOptionType: "NORMAL" | "FIXED"
가상계좌 발급 유형

가상계좌 발급 유형

InstantPaymentSummary: { pgTxId, paidAt }
수기 결제가 완료된 결제 건 요약 정보

수기 결제가 완료된 결제 건 요약 정보

InvalidRequestError: { type, message }
요청된 입력 정보가 유효하지 않은 경우

허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

IssueBillingKeyError: ChannelNotFoundError | ChannelSpecificError | ForbiddenError | ...
IssueBillingKeyError
IssueBillingKeyResponse: { billingKeyInfo, channelSpecificFailures }
빌링키 발급 성공 응답

빌링키 발급 성공 응답

IssueCashReceiptCustomerInput: { identityNumber, name, email, ... }
현금영수증 발급 시 고객 관련 입력 정보

현금영수증 발급 시 고객 관련 입력 정보

IssueCashReceiptError: CashReceiptAlreadyIssuedError | ChannelNotFoundError | ForbiddenError | ...
IssueCashReceiptError
IssueCashReceiptPaymentMethodType: "TRANSFER" | "VIRTUAL_ACCOUNT"
현금영수증 발급 가능 결제 수단

현금영수증 발급 가능 결제 수단

IssueCashReceiptResponse: { cashReceipt }
현금 영수증 발급 성공 응답

현금 영수증 발급 성공 응답

IssueFailedCashReceipt: { status, merchantId, storeId, ... }
발급 실패

발급 실패

IssuedBillingKeyInfo: { status, billingKey, merchantId, ... }
빌링키 발급 완료 상태 건

빌링키 발급 완료 상태 건

IssuedCashReceipt: { status, merchantId, storeId, ... }
발급 완료

발급 완료

IssuedPaymentCashReceipt: { status, type, pgReceiptId, ... }
발급 완료된 현금영수증

발급 완료된 현금영수증

IssuedPgBillingKeyIssueResponse: { type, channel, pgTxId, ... }
빌링키 발급 성공 채널 응답

빌링키 발급 성공 채널 응답

LoginViaApiSecretError: InvalidRequestError | UnauthorizedError
LoginViaApiSecretError
LoginViaApiSecretResponse: { accessToken, refreshToken }
API key 로그인 성공 응답

API key 로그인 성공 응답

MaxTransactionCountReachedError: { type, message }
결제 혹은 본인인증 시도 횟수가 최대에 도달한 경우

결제 혹은 본인인증 시도 횟수가 최대에 도달한 경우

MaxWebhookRetryCountReachedError: { type, message }
동일한 webhook id에 대한 수동 재시도 횟수가 최대에 도달한 경우

동일한 webhook id에 대한 수동 재시도 횟수가 최대에 도달한 경우

ModifyEscrowLogisticsError: ForbiddenError | InvalidRequestError | PaymentNotFoundError | ...
ModifyEscrowLogisticsError
ModifyEscrowLogisticsResponse: { invoiceNumber, sentAt, modifiedAt }
에스크로 배송 정보 수정 성공 응답

에스크로 배송 정보 수정 성공 응답

MonthDay: { month, day }
월 및 일자 정보

월 및 일자 정보

NegativePromotionAdjustedCancelAmountError: { type, message }
프로모션에 의해 조정된 취소 금액이 음수인 경우

프로모션에 의해 조정된 취소 금액이 음수인 경우

OneLineAddress: { type, oneLine }
한 줄 형식 주소

한 줄 형식 주소만 존재합니다.

PageInfo: { number, size, totalCount }
반환된 페이지 결과 정보

반환된 페이지 결과 정보

PageInput: { number, size }
다건 조회 API 에 사용되는 페이지 입력 정보

다건 조회 API 에 사용되는 페이지 입력 정보

PaidPayment: { status, id, transactionId, ... }
결제 완료 상태 건

결제 완료 상태 건

PaidPaymentTransaction: { status, id, paymentId, ... }
결제 완료 상태 건

결제 완료 상태 건

PartialCancelledPayment: { status, id, transactionId, ... }
결제 부분 취소 상태 건

결제 부분 취소 상태 건

PartialCancelledPaymentTransaction: { status, id, paymentId, ... }
결제 부분 취소 상태 건

결제 부분 취소 상태 건

PayInstantlyError: AlreadyPaidError | ChannelNotFoundError | DiscountAmountExceedsTotalAmountError | ...
PayInstantlyError
PayInstantlyResponse: { payment }
수기 결제 성공 응답

수기 결제 성공 응답

PayPendingPayment: { status, id, transactionId, ... }
결제 완료 대기 상태 건

결제 완료 대기 상태 건

PayPendingPaymentTransaction: { status, id, paymentId, ... }
결제 완료 대기 상태 건

결제 완료 대기 상태 건

PayWithBillingKeyError: AlreadyPaidError | BillingKeyAlreadyDeletedError | BillingKeyNotFoundError | ...
PayWithBillingKeyError
PayWithBillingKeyResponse: { payment }
빌링키 결제 성공 응답

빌링키 결제 성공 응답

Payment: CancelledPayment | FailedPayment | PaidPayment | ...
결제 건

결제 건

PaymentAlreadyCancelledError: { type, message }
결제가 이미 취소된 경우

결제가 이미 취소된 경우

PaymentAmount: { total, taxFree, vat, ... }
결제 금액 세부 정보

결제 금액 세부 정보

PaymentAmountInput: { total, taxFree, vat }
금액 세부 입력 정보

금액 세부 입력 정보

PaymentCancellation: FailedPaymentCancellation | RequestedPaymentCancellation | SucceededPaymentCancellation
결제 취소 내역

결제 취소 내역

PaymentCashReceipt: CancelledPaymentCashReceipt | IssuedPaymentCashReceipt
결제 건 내 현금영수증 정보

결제 건 내 현금영수증 정보

PaymentCashReceiptStatus: "ISSUED" | "CANCELLED"
결제건 내 현금영수증 상태

결제건 내 현금영수증 상태

PaymentClientType: "SDK_MOBILE" | "SDK_PC" | "API"
결제가 발생한 클라이언트 환경

결제가 발생한 클라이언트 환경

PaymentEscrow: BeforeRegisteredPaymentEscrow | CancelledPaymentEscrow | ConfirmedPaymentEscrow | ...
에스크로 정보

V1 결제 건의 경우 타입이 REGISTERED 로 고정됩니다.

PaymentEscrowReceiverInput: { name, phoneNumber, zipcode, ... }
에스크로 수취인 정보

에스크로 수취인 정보

PaymentEscrowSenderInput: { name, phoneNumber, zipcode, ... }
에스크로 발송자 정보

에스크로 발송자 정보

PaymentFailure: { reason, pgCode, pgMessage }
결제 실패 정보

결제 실패 정보

PaymentFilterInput: { merchantId, storeId, timestampType, ... }
결제 건 다건 조회를 위한 입력 정보

결제 건 다건 조회를 위한 입력 정보

PaymentFilterInputEscrowStatus: "REGISTERED" | "DELIVERED" | "CONFIRMED" | ...
에스크로 상태

에스크로 상태

PaymentInstallment: { month, isInterestFree }
할부 정보

할부 정보

PaymentLogistics: { company, invoiceNumber, sentAt, ... }
배송정보

배송정보

PaymentLogisticsCompany: "LOTTE" | "LOGEN" | "DONGWON" | ...
물류 회사

물류 회사

PaymentMethod: PaymentMethodCard | PaymentMethodConvenienceStore | PaymentMethodEasyPay | ...
결제수단 정보

결제수단 정보

PaymentMethodCard: { type, card, approvalNumber, ... }
결제수단 카드 정보

결제수단 카드 정보

PaymentMethodConvenienceStore: { type }
편의점 결제 상세 정보

편의점 결제 상세 정보

PaymentMethodEasyPay: { type, provider, easyPayMethod }
간편 결제 상세 정보

간편 결제 상세 정보

PaymentMethodEasyPayMethod: PaymentMethodCard | PaymentMethodEasyPayMethodCharge | PaymentMethodTransfer
간편 결제 수단

간편 결제 수단

PaymentMethodEasyPayMethodCharge: { type, bank }
충전식 포인트 결제 정보

충전식 포인트 결제 정보

PaymentMethodGiftCertificate: { type, giftCertificateType, approvalNumber }
상품권 상세 정보

상품권 상세 정보

PaymentMethodGiftCertificateType: "BOOKNLIFE" | "SMART_MUNSANG" | "CULTURELAND" | ...
상품권 종류

상품권 종류

PaymentMethodMobile: { type, phoneNumber }
모바일 상세 정보

모바일 상세 정보

PaymentMethodTransfer: { type, bank, accountNumber }
계좌 이체 상세 정보

계좌 이체 상세 정보

PaymentMethodType: "CARD" | "TRANSFER" | "VIRTUAL_ACCOUNT" | ...
PaymentMethodType
PaymentMethodVirtualAccount: { type, bank, accountNumber, ... }
가상계좌 상세 정보

가상계좌 상세 정보

PaymentMethodVirtualAccountRefundStatus: "PENDING" | "PARTIAL_REFUND_FAILED" | "FAILED" | ...
가상계좌 환불 상태

가상계좌 환불 상태

PaymentMethodVirtualAccountType: "FIXED" | "NORMAL"
가상계좌 유형

가상계좌 유형

PaymentNotFoundError: { type, message }
결제 건이 존재하지 않는 경우

결제 건이 존재하지 않는 경우

PaymentNotPaidError: { type, message }
결제가 완료되지 않은 경우

결제가 완료되지 않은 경우

PaymentNotWaitingForDepositError: { type, message }
결제 건이 입금 대기 상태가 아닌 경우

결제 건이 입금 대기 상태가 아닌 경우

PaymentProduct: { id, name, tag, ... }
상품 정보

상품 정보

PaymentProductType: "PHYSICAL" | "DIGITAL"
상품 유형

상품 유형

PaymentSchedule: FailedPaymentSchedule | PendingPaymentSchedule | RevokedPaymentSchedule | ...
결제 예약 건

결제 예약 건

PaymentScheduleAlreadyExistsError: { type, message }
결제 예약건이 이미 존재하는 경우

결제 예약건이 이미 존재하는 경우

PaymentScheduleAlreadyProcessedError: { type, message }
결제 예약건이 이미 처리된 경우

결제 예약건이 이미 처리된 경우

PaymentScheduleAlreadyRevokedError: { type, message }
결제 예약건이 이미 취소된 경우

결제 예약건이 이미 취소된 경우

PaymentScheduleFilterInput: { storeId, billingKey, from, ... }
결제 예약 건 다건 조회를 위한 입력 정보

결제 예약 건 다건 조회를 위한 입력 정보

PaymentScheduleNotFoundError: { type, message }
결제 예약건이 존재하지 않는 경우

결제 예약건이 존재하지 않는 경우

PaymentScheduleSortBy: "CREATED_AT" | "TIME_TO_PAY" | "COMPLETED_AT"
결제 예약 건 정렬 기준

결제 예약 건 정렬 기준

PaymentScheduleSortInput: { by, order }
결제 예약 건 다건 조회 시 정렬 조건

결제 예약 건 다건 조회 시 정렬 조건

PaymentScheduleStatus: "SCHEDULED" | "STARTED" | "SUCCEEDED" | ...
결제 예약 건 상태

결제 예약 건 상태

PaymentScheduleSummary: { id }
결제 예약 건

결제 예약 건

PaymentSortBy: "REQUESTED_AT" | "STATUS_CHANGED_AT"
결제 건 정렬 기준

결제 건 정렬 기준

PaymentStatus: "READY" | "PENDING" | "VIRTUAL_ACCOUNT_ISSUED" | ...
결제 건 상태

결제 건 상태

PaymentTextSearch: { field, value }
통합검색 입력 정보

통합검색 입력 정보

PaymentTextSearchField: "ALL" | "PAYMENT_ID" | "TX_ID" | ...
통합검색 항목

통합검색 항목

PaymentTimestampType: "CREATED_AT" | "STATUS_CHANGED_AT"
조회 시점 기준

어떤 시점을 기준으로 조회를 할 것인지 선택합니다. CREATED_AT: 결제 건 생성 시점을 기준으로 조회합니다. STATUS_CHANGED_AT: 상태 승인 시점을 기준으로 조회합니다. 결제 건의 최종 상태에 따라 검색 기준이 다르게 적용됩니다. ready -> 결제 요청 시점 기준 paid -> 결제 완료 시점 기준 cancelled -> 결제 취소 시점 기준 failed -> 결제 실패 시점 기준 값을 입력하지 않으면 STATUS_CHANGED_AT 으로 자동 적용됩니다.

PaymentTransaction: CancelledPaymentTransaction | FailedPaymentTransaction | PaidPaymentTransaction | ...
결제 시도

결제 시도

PaymentWebhook: { paymentStatus, id, status, ... }
성공 웹훅 내역

성공 웹훅 내역

PaymentWebhookPaymentStatus: "READY" | "VIRTUAL_ACCOUNT_ISSUED" | "PAID" | ...
웹훅 발송 시 결제 건 상태

웹훅 발송 시 결제 건 상태

PaymentWebhookRequest: { header, body, requestedAt }
웹훅 요청 정보

웹훅 요청 정보

PaymentWebhookResponse: { code, header, body, ... }
웹훅 응답 정보

웹훅 응답 정보

PaymentWebhookStatus: "SUCCEEDED" | "FAILED_NOT_OK_RESPONSE" | "FAILED_UNEXPECTED_ERROR"
웹훅 전송 상태

웹훅 전송 상태

PaymentWebhookTrigger: "MANUAL" | "VIRTUAL_ACCOUNT_DEPOSIT" | "ASYNC_CANCEL_APPROVED" | ...
웹훅 실행 트리거

수동 웹훅 재발송, 가상계좌 입금, 비동기 취소 승인 시 발생한 웹훅일 때 필드의 값이 존재합니다.

PaymentWithCursor: { payment, cursor }
결제 건 및 커서 정보

결제 건 및 커서 정보

PendingPaymentSchedule: { status, id, merchantId, ... }
결제 완료 대기 상태

결제 완료 대기 상태

PgBillingKeyIssueResponse: FailedPgBillingKeyIssueResponse | IssuedPgBillingKeyIssueResponse
채널 별 빌링키 발급 응답

채널 별 빌링키 발급 응답

PgCompany: "INICIS" | "NICE" | "KCP" | ...
PG사

PG사

PgProvider: "HTML5_INICIS" | "PAYPAL" | "PAYPAL_V2" | ...
PG사 결제 모듈

PG사 결제 모듈

PgProviderError: { type, message, pgCode, ... }
PG사에서 오류를 전달한 경우

PG사에서 오류를 전달한 경우

PlatformAccount: { bank, currency, number, ... }
플랫폼 정산 계좌

currency 가 KRW 일 경우 예금주 조회 API 를 통해 올바른 계좌인지 검증합니다. 그 외의 화폐일 경우 따로 검증하지는 않습니다.

PlatformAccountHolder: { holderName, accountVerificationId }
예금주 조회 성공 응답 정보

예금주 조회 성공 응답 정보

PlatformAccountStatus: "VERIFIED" | "VERIFY_FAILED" | "VERIFY_ERROR" | ...
플랫폼 계좌 상태

플랫폼 계좌 상태

PlatformAccountTransfer: PlatformDepositAccountTransfer | PlatformPartnerPayoutAccountTransfer | PlatformRemitAccountTransfer
계좌 이체

송금 대행을 통해 일어난 정산 금액 지급, 인출 목적의 계좌 이체 결과 정보입니다.

PlatformAccountTransferFilter: { types }
PlatformAccountTransferFilter
PlatformAccountTransferType: "DEPOSIT" | "WITHDRAWAL_PARTNER_PAYOUT" | "WITHDRAWAL_REMIT"
계좌 이체 유형

계좌 이체 유형

PlatformAccountVerificationAlreadyUsedError: { type, message }
파트너 계좌 검증 아이디를 이미 사용한 경우

파트너 계좌 검증 아이디를 이미 사용한 경우

PlatformAccountVerificationFailedError: { type, message }
파트너 계좌 인증이 실패한 경우

파트너 계좌 인증이 실패한 경우

PlatformAccountVerificationNotFoundError: { type, message }
파트너 계좌 검증 아이디를 찾을 수 없는 경우

파트너 계좌 검증 아이디를 찾을 수 없는 경우

PlatformAdditionalFeePoliciesNotFoundError: { type, ids, graphqlIds, ... }
PlatformAdditionalFeePoliciesNotFoundError
PlatformAdditionalFeePolicy: { id, graphqlId, name, ... }
추가 수수료 정책

추가 수수료 정책는 고객사의 주문건에 대한 중개수수료에 별도로 추가로 부여되는 수수료입니다. 대표적인 사용 예시로 풀필먼트 수수료, 로켓배송 수수료, 마케팅 채널 수수료등이 있습니다.

PlatformAdditionalFeePolicyAlreadyExistsError: { type, message }
PlatformAdditionalFeePolicyAlreadyExistsError
PlatformAdditionalFeePolicyFilterInput: { isArchived, vatPayers, keyword }
추가 수수료 정책 다건 조회를 위한 필터 조건

추가 수수료 정책 다건 조회를 위한 필터 조건

PlatformAdditionalFeePolicyFilterInputKeyword: { name, id, fee }
검색 키워드 입력 정보

검색 키워드 적용을 위한 옵션으로, 명시된 키워드를 포함하는 추가 수수료 정책만 조회합니다. 하위 필드는 명시된 값 중 한 가지만 적용됩니다.

PlatformAdditionalFeePolicyNotFoundError: { type, message }
PlatformAdditionalFeePolicyNotFoundError
PlatformAdditionalFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedError: { type, id, graphqlId, ... }
PlatformAdditionalFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedError
PlatformAmountExceededType: "DISCOUNT_THAN_ORDER" | "DISCOUNT_TAX_FREE_THAN_DISCOUNT" | "DISCOUNT_TAX_FREE_THAN_ORDER_TAX_FREE" | ...
PlatformAmountExceededType
PlatformArchivedAdditionalFeePolicyError: { type, message }
보관된 추가 수수료 정책을 업데이트하려고 하는 경우

보관된 추가 수수료 정책을 업데이트하려고 하는 경우

PlatformArchivedContractError: { type, message }
보관된 계약을 업데이트하려고 하는 경우

보관된 계약을 업데이트하려고 하는 경우

PlatformArchivedDiscountSharePolicyError: { type, message }
보관된 할인 분담 정책을 업데이트하려고 하는 경우

보관된 할인 분담 정책을 업데이트하려고 하는 경우

PlatformArchivedPartnerError: { type, message }
보관된 파트너를 업데이트하려고 하는 경우

보관된 파트너를 업데이트하려고 하는 경우

PlatformBtxNotEnabledError: { type, message }
BTX 기능이 활성화되지 않아 요청을 처리할 수 없는 경우

BTX 기능이 활성화되지 않아 요청을 처리할 수 없는 경우

PlatformBulkPayout: { id, graphqlId, name, ... }
PlatformBulkPayout
PlatformBulkPayoutFilterInput: { statuses, methods, criteria }
PlatformBulkPayoutFilterInput
PlatformBulkPayoutFilterInputCriteria: { timestampRange, bulkPayoutId }
PlatformBulkPayoutFilterInputCriteria
PlatformBulkPayoutStats: { amount, count }
PlatformBulkPayoutStats
PlatformBulkPayoutStatus: "SCHEDULED" | "PREPARING" | "PREPARED" | ...
PlatformBulkPayoutStatus
PlatformBulkPayoutStatusStats: { scheduled, preparing, prepared, ... }
PlatformBulkPayoutStatusStats
PlatformBulkTask: { id, graphqlId, status, ... }
PlatformBulkTask
PlatformBulkTaskProgressStats: { preparedCount, processingCount, succeededCount, ... }
PlatformBulkTaskProgressStats
PlatformBulkTaskStatus: "PREPARED" | "PROCESSING" | "COMPLETED" | ...
PlatformBulkTaskStatus
PlatformBulkTaskType: "CREATE_TRANSFERS" | "CREATE_PARTNERS" | "CONNECT_MEMBER_COMPANIES" | ...
PlatformBulkTaskType
PlatformBusinessStatus: "IN_BUSINESS" | "CLOSED" | "SUSPENDED"
플랫폼 사업자 상태

플랫폼 사업자 상태

PlatformCancelOrderTransfersExistsError: { type, message }
PlatformCancelOrderTransfersExistsError
PlatformCancellableAmountExceededError: { type, cancellableAmount, requestAmount, ... }
취소 가능한 금액이 초과한 경우

취소 가능한 금액이 초과한 경우

PlatformCancellableAmountType: "SUPPLY_WITH_VAT" | "TAX_FREE"
금액 타입

금액 타입

PlatformCancellableDiscountAmountExceededError: { type, discountSharePolicyId, discountSharePolicyGraphqlId, ... }
PlatformCancellableDiscountAmountExceededError
PlatformCancellableDiscountTaxFreeAmountExceededError: { type, discountSharePolicyId, discountSharePolicyGraphqlId, ... }
PlatformCancellableDiscountTaxFreeAmountExceededError
PlatformCancellableProductQuantityExceededError: { type, productId, cancellableQuantity, ... }
PlatformCancellableProductQuantityExceededError
PlatformCancellationAndPaymentTypeMismatchedError: { type, message }
PlatformCancellationAndPaymentTypeMismatchedError
PlatformCancellationNotFoundError: { type, message }
PlatformCancellationNotFoundError
PlatformCannotArchiveScheduledAdditionalFeePolicyError: { type, message }
예약된 업데이트가 있는 추가 수수료 정책을 보관하려고 하는 경우

예약된 업데이트가 있는 추가 수수료 정책을 보관하려고 하는 경우

PlatformCannotArchiveScheduledContractError: { type, message }
예약된 업데이트가 있는 계약을 보관하려고 하는 경우

예약된 업데이트가 있는 계약을 보관하려고 하는 경우

PlatformCannotArchiveScheduledDiscountSharePolicyError: { type, message }
예약된 업데이트가 있는 할인 분담 정책을 보관하려고 하는 경우

예약된 업데이트가 있는 할인 분담 정책을 보관하려고 하는 경우

PlatformCannotArchiveScheduledPartnerError: { type, message }
예약된 업데이트가 있는 파트너를 보관하려고 하는 경우

예약된 업데이트가 있는 파트너를 보관하려고 하는 경우

PlatformCannotSpecifyTransferError: { type, message }
정산 건 식별에 실패한 경우

정산 건 식별에 실패한 경우

PlatformCompanyNotFoundError: { type, message }
사업자 정보를 찾을 수 없는 경우

사업자 정보를 찾을 수 없는 경우

PlatformCompanyState: { taxationType, taxationTypeDate, businessStatus, ... }
PlatformCompanyState
PlatformCompanyVerificationAlreadyUsedError: { type, message }
파트너 사업자 검증 아이디를 이미 사용한 경우

파트너 사업자 검증 아이디를 이미 사용한 경우

PlatformContact: { name, phoneNumber, email }
플랫폼 파트너 담당자 연락 정보

파트너 담당자에게 연락하기 위한 정보들 입니다.

PlatformContract: { id, graphqlId, name, ... }
계약

계약은 플랫폼 고객사가 파트너에게 정산해줄 대금과 정산일을 계산하는 데 적용되는 정보입니다. 고객사의 플랫폼에서 재화 및 서비스를 판매하기 위한 중개수수료와 판매금에 대한 정산일로 구성되어 있습니다.

PlatformContractAlreadyExistsError: { type, message }
PlatformContractAlreadyExistsError
PlatformContractFilterInput: { platformFeePayers, cycleTypes, datePolicies, ... }
계약 다건 조회를 위한 필터 조건

계약 다건 조회를 위한 필터 조건

PlatformContractFilterInputKeyword: { id, name }
검색 키워드 입력 정보

검색 키워드 적용을 위한 옵션으로, 명시된 키워드를 포함하는 계약만 조회합니다. 하나의 하위 필드에만 값을 명시하여 요청합니다.

PlatformContractNotFoundError: { type, message }
PlatformContractNotFoundError
PlatformContractPlatformFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedError: { type, id, graphqlId, ... }
PlatformContractPlatformFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedError
PlatformContractsNotFoundError: { type, ids, graphqlIds, ... }
PlatformContractsNotFoundError
PlatformCurrencyNotSupportedError: { type, message }
지원 되지 않는 통화를 선택한 경우

지원 되지 않는 통화를 선택한 경우

PlatformDepositAccountTransfer: { type, id, currency, ... }
PlatformDepositAccountTransfer
PlatformDiscountSharePoliciesNotFoundError: { type, ids, graphqlIds, ... }
PlatformDiscountSharePoliciesNotFoundError
PlatformDiscountSharePolicy: { id, graphqlId, name, ... }
할인 분담 정책

할인 분담은 고객사의 주문건에 쿠폰 및 포인트와 같은 할인금액이 적용될 때, 파트너 정산 시 할인금액에 대한 분담 정책을 가지는 객체입니다. 할인 유형에 대한 아이디와 메모, 그리고 파트너 분담율을 가집니다.

PlatformDiscountSharePolicyAlreadyExistsError: { type, message }
PlatformDiscountSharePolicyAlreadyExistsError
PlatformDiscountSharePolicyFilterInput: { isArchived, partnerShareRates, keyword }
할인 분담 정책 다건 조회를 위한 필터 조건

할인 분담 정책 다건 조회를 위한 필터 조건

PlatformDiscountSharePolicyFilterInputKeyword: { id, name }
검색 키워드 입력 정보

검색 키워드 적용을 위한 옵션으로, 명시된 키워드를 포함하는 할인 분담 정책만 조회합니다. 하위 필드는 명시된 값 중 한 가지만 적용됩니다.

PlatformDiscountSharePolicyIdDuplicatedError: { type, id, graphqlId, ... }
PlatformDiscountSharePolicyIdDuplicatedError
PlatformDiscountSharePolicyNotFoundError: { type, message }
PlatformDiscountSharePolicyNotFoundError
PlatformExternalApiFailedError: { type, message }
외부 api 오류

외부 api 오류

PlatformExternalApiTemporarilyFailedError: { type, message }
외부 api의 일시적인 오류

외부 api의 일시적인 오류

PlatformExternalPayment: { type, id, orderName, ... }
외부 결제 정보

외부 결제 정보

PlatformFee: PlatformFixedAmountFee | PlatformFixedRateFee
플랫폼 중개수수료 정보

플랫폼 중개수수료 정보

PlatformFeeInput: { fixedRate, fixedAmount }
수수료 계산 방식을 특정하기 위한 입력 정보

정률 수수료를 설정하고 싶은 경우 fixedRate 필드에, 정액 수수료를 설정하고 싶은 경우 fixedAmount 필드에 값을 명시해 요청합니다. 두 필드 모두 값이 들어있지 않은 경우 요청이 거절됩니다.

PlatformFixedAmountFee: { type, amount }
정액 수수료

총 금액에 무관하게 정해진 수수료 금액을 책정합니다.

PlatformFixedRateFee: { type, rate }
정률 수수료

총 금액에 정해진 비율을 곱한 만큼의 수수료를 책정합니다.

PlatformInsufficientDataToChangePartnerTypeError: { type, message }
파트너 타입 수정에 필요한 데이터가 부족한 경우

파트너 타입 수정에 필요한 데이터가 부족한 경우

PlatformManualTransfer: { type, id, graphqlId, ... }
수기 정산건

수기 정산건

PlatformManualTransferSummary: { type, id, graphqlId, ... }
PlatformManualTransferSummary
PlatformMemberCompanyConnectedPartnerBrnUnchangeableError: { type, message }
연동 사업자로 연동된 파트너의 사업자등록번호를 변경하려고 시도한 경우

연동 사업자로 연동된 파트너의 사업자등록번호를 변경하려고 시도한 경우

PlatformMemberCompanyConnectedPartnerTypeUnchangeableError: { type, message }
연동 사업자로 연동된 파트너의 파트너 유형을 변경하려고 시도한 경우

연동 사업자로 연동된 파트너의 파트너 유형을 변경하려고 시도한 경우

PlatformMemberCompanyNotConnectableStatusError: { type, message }
파트너 연동 사업자 연동 상태가 연동 가능한 상태가 아닌 경우

파트너 연동 사업자 연동 상태가 연동 가능한 상태가 아닌 경우

PlatformMemberCompanyNotConnectedError: { type, message }
파트너가 연동 사업자로 연동 되어있지 않은 경우

파트너가 연동 사업자로 연동 되어있지 않은 경우

PlatformNotEnabledError: { type, message }
플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우

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

PlatformNotSupportedBankError: { type, message }
지원하지 않는 은행인 경우

지원하지 않는 은행인 경우

PlatformOngoingTaxInvoiceExistsError: { type, message }
진행 중인 세금계산서가 존재하는 경우

진행 중인 세금계산서가 존재하는 경우

PlatformOrderCancelTransfer: { type, id, graphqlId, ... }
주문 취소 정산건

주문 취소 정산건

PlatformOrderCancelTransferSummary: { type, id, graphqlId, ... }
PlatformOrderCancelTransferSummary
PlatformOrderDetailMismatchedError: { type, message }
PlatformOrderDetailMismatchedError
PlatformOrderSettlementAmount: { settlement, payment, paymentVat, ... }
정산 금액 정보

정산 금액과 정산 금액 계산에 사용된 금액 정보들 입니다.

PlatformOrderTransfer: { type, id, graphqlId, ... }
주문 정산건

주문 정산건

PlatformOrderTransferAdditionalFee: { policy, amount, vat }
추가 수수료 정보

추가 수수료 정보

PlatformOrderTransferAlreadyCancelledError: { type, message }
PlatformOrderTransferAlreadyCancelledError
PlatformOrderTransferCancellation: { id, cancelledAt }
주문 취소 정보

주문 취소 정보

PlatformOrderTransferDiscount: { sharePolicy, amount, taxFreeAmount, ... }
할인 정보

할인 정보

PlatformOrderTransferOrderLine: { product, quantity, discounts, ... }
주문 항목

주문 항목

PlatformOrderTransferProduct: { id, name, amount, ... }
상품

상품

PlatformOrderTransferSummary: { type, id, graphqlId, ... }
PlatformOrderTransferSummary
PlatformPartner: { id, graphqlId, name, ... }
파트너

파트너는 고객사가 정산해주어야 할 대상입니다. 기본 사업자 정보와 정산정보, 그리고 적용될 계약의 정보를 등록 및 관리할 수 있습니다.

PlatformPartnerBusinessStatus: "NOT_VERIFIED" | "VERIFY_ERROR" | "NOT_FOUND" | ...
플랫폼 파트너 사업자 상태

플랫폼 파트너 사업자 상태

PlatformPartnerFilterInput: { isArchived, tags, banks, ... }
파트너 필터 입력 정보

파트너 필터 입력 정보

PlatformPartnerFilterInputKeyword: { id, name, email, ... }
파트너 검색 키워드 입력 정보

검색 키워드 적용을 위한 옵션으로, 명시된 키워드를 포함하는 파트너만 조회합니다. 하나의 하위 필드에만 값을 명시하여 요청합니다.

PlatformPartnerIdAlreadyExistsError: { type, message }
PlatformPartnerIdAlreadyExistsError
PlatformPartnerIdsAlreadyExistError: { type, ids, graphqlIds, ... }
PlatformPartnerIdsAlreadyExistError
PlatformPartnerIdsDuplicatedError: { type, ids, graphqlIds, ... }
PlatformPartnerIdsDuplicatedError
PlatformPartnerManualSettlement: { type, id, graphqlId, ... }
PlatformPartnerManualSettlement
PlatformPartnerMemberCompanyConnectionStatus: "NOT_CONNECTED" | "CONNECT_PENDING" | "CONNECTED" | ...
플랫폼 파트너 연동 사업자 연결 상태

플랫폼 파트너 연동 사업자 연결 상태

PlatformPartnerNotFoundError: { type, message }
PlatformPartnerNotFoundError
PlatformPartnerOrderCancelSettlement: { type, id, graphqlId, ... }
PlatformPartnerOrderCancelSettlement
PlatformPartnerOrderSettlement: { type, id, graphqlId, ... }
PlatformPartnerOrderSettlement
PlatformPartnerPayoutAccountTransfer: { type, id, sequenceNumber, ... }
PlatformPartnerPayoutAccountTransfer
PlatformPartnerScheduleExistsError: { type, message }
파트너 수정 예약 건이 존재하는 경우

파트너 수정 예약 건이 존재하는 경우

PlatformPartnerSettlement: PlatformPartnerManualSettlement | PlatformPartnerOrderSettlement | PlatformPartnerOrderCancelSettlement
PlatformPartnerSettlement
PlatformPartnerSettlementFilterInput: { settlementDates, contractIds, partnerTags, ... }
PlatformPartnerSettlementFilterInput
PlatformPartnerSettlementFilterKeywordInput: { partnerSettlementId, payoutId, bulkPayoutId }
PlatformPartnerSettlementFilterKeywordInput
PlatformPartnerSettlementStatus: "PAYOUT_SCHEDULED" | "PAYOUT_PREPARED" | "PAYOUT_WITHHELD" | ...
정산 상태

정산 상태

PlatformPartnerSettlementStatusStats: { payoutScheduled, payoutPrepared, payoutWithheld, ... }
PlatformPartnerSettlementStatusStats
PlatformPartnerSettlementType: "MANUAL" | "ORDER" | "ORDER_CANCEL"
정산 유형

정산 유형

PlatformPartnerStatus: "PENDING" | "APPROVED" | "REJECTED"
플랫폼 파트너 상태

플랫폼 파트너 상태

PlatformPartnerTaxationType: "NORMAL" | "SIMPLE_TAX_INVOICE_ISSUER" | "SIMPLE" | ...
플랫폼 파트너 과세 유형

플랫폼 파트너 과세 유형

PlatformPartnerTaxationTypeIsSimpleError: { type, message }
파트너의 과세 유형이 간이 과세 세금계산서 미발행 유형인 경우

파트너의 과세 유형이 간이 과세 세금계산서 미발행 유형인 경우

PlatformPartnerType: PlatformPartnerTypeBusiness | PlatformPartnerTypeNonWhtPayer | PlatformPartnerTypeWhtPayer
파트너 유형별 추가 정보

파트너 유형별 추가 정보

PlatformPartnerTypeBusiness: { type, companyName, taxationType, ... }
사업자 파트너 정보

사업자 유형의 파트너 추가 정보 입니다.

PlatformPartnerTypeIsNotBusinessError: { type, message }
파트너 유형이 사업자가 아닌 경우

파트너 유형이 사업자가 아닌 경우

PlatformPartnerTypeName: "BUSINESS" | "WHT_PAYER" | "NON_WHT_PAYER"
플랫폼 파트너 유형 이름

플랫폼 파트너 유형 이름

PlatformPartnerTypeNonWhtPayer: { type, birthdate }
원천징수 비대상자 파트너 정보

비사업자 유형의 파트너 추가 정보 입니다.

PlatformPartnerTypeWhtPayer: { type, birthdate }
원천징수 대상자 파트너 정보

비사업자 유형의 파트너 추가 정보 입니다.

PlatformPayer: "PARTNER" | "MERCHANT"
금액 부담 주체

플랫폼에서 발생한 결제 수수료, 부가세 등 금액을 부담하는 주체를 나타냅니다.

PlatformPayment: PlatformExternalPayment | PlatformPortOnePayment
결제 정보

결제 정보

PlatformPaymentMethod: PlatformPaymentMethodCard | PlatformPaymentMethodEasyPay | PlatformPaymentMethodGiftCertificate | ...
결제 수단

결제 수단

PlatformPaymentMethodCard: { type }
카드

카드

PlatformPaymentMethodCardInput: { }
PlatformPaymentMethodCardInput
PlatformPaymentMethodEasyPay: { type, provider, methodType }
간편 결제

간편 결제

PlatformPaymentMethodEasyPayInput: { provider, methodType }
간편 결제 입력 정보

간편 결제 입력 정보

PlatformPaymentMethodGiftCertificate: { type }
상품권

상품권

PlatformPaymentMethodGiftCertificateInput: { }
PlatformPaymentMethodGiftCertificateInput
PlatformPaymentMethodInput: { card, transfer, virtualAccount, ... }
결제 수단 입력 정보

결제 수단 입력 정보

PlatformPaymentMethodMobile: { type }
모바일

모바일

PlatformPaymentMethodMobileInput: { }
PlatformPaymentMethodMobileInput
PlatformPaymentMethodTransfer: { type }
계좌이체

계좌이체

PlatformPaymentMethodTransferInput: { }
PlatformPaymentMethodTransferInput
PlatformPaymentMethodVirtualAccount: { type }
가상계좌

가상계좌

PlatformPaymentMethodVirtualAccountInput: { }
PlatformPaymentMethodVirtualAccountInput
PlatformPaymentNotFoundError: { type, message }
PlatformPaymentNotFoundError
PlatformPayout: { id, graphqlId, method, ... }
PlatformPayout
PlatformPayoutAccount: { bank, number, holder }
PlatformPayoutAccount
PlatformPayoutFilterInput: { statuses, partnerIds, criteria, ... }
지급 내역 필터 입력 정보

지급 내역 필터 입력 정보

PlatformPayoutFilterInputCriteria: { timestampRange, payoutId, bulkPayoutId }
검색 기준 입력 정보

검색 기준 입력 정보

PlatformPayoutMethod: "DIRECT" | "AGENCY"
PlatformPayoutMethod
PlatformPayoutStatus: "PREPARED" | "CANCELLED" | "STOPPED" | ...
PlatformPayoutStatus
PlatformPayoutStatusStats: { prepared, cancelled, stopped, ... }
PlatformPayoutStatusStats
PlatformPortOnePayment: { type, id, storeId, ... }
포트원 결제 정보

포트원 결제 정보

PlatformPortOnePaymentCancelAmountType: "SUPPLY_WITH_VAT" | "TAX_FREE"
금액 타입

금액 타입

PlatformProductIdDuplicatedError: { type, id, message }
PlatformProductIdDuplicatedError
PlatformProductIdNotFoundError: { type, id, message }
PlatformProductIdNotFoundError
PlatformProperties: { [key: string]: PlatformUserDefinedPropertyValue }
PlatformProperties
PlatformRemitAccountTransfer: { type, id, sequenceNumber, ... }
PlatformRemitAccountTransfer
PlatformSettlementAmountExceededError: { type, message, productId, ... }
정산 가능한 금액을 초과한 경우

정산 가능한 금액을 초과한 경우

PlatformSettlementCancelAmountExceededPortOneCancelError: { type, registeredSettlementCancelAmount, requestSettlementCancelAmount, ... }
정산 취소 요청 금액이 포트원 결제 취소 내역의 취소 금액을 초과한 경우

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

PlatformSettlementCycle: { lagDays, datePolicy, method }
정산 주기

지체일, 정산일, 기준일로 구성되며, 해당 요소들의 조합으로 실제 정산일을 계산합니다.

PlatformSettlementCycleDatePolicy: "HOLIDAY_BEFORE" | "HOLIDAY_AFTER" | "CALENDAR_DAY"
플랫폼 정산 기준일

플랫폼 정산 기준일

PlatformSettlementCycleInput: { lagDays, datePolicy, method }
플랫폼 정산 주기 입력 정보

플랫폼 정산 주기 입력 정보

PlatformSettlementCycleMethod: PlatformSettlementCycleMethodDaily | PlatformSettlementCycleMethodManualDates | PlatformSettlementCycleMethodMonthly | ...
플랫폼 정산 주기 계산 방식

플랫폼 정산 주기 계산 방식

PlatformSettlementCycleMethodDaily: { type }
매일 정산

매일 정산

PlatformSettlementCycleMethodDailyInput: { }
PlatformSettlementCycleMethodDailyInput
PlatformSettlementCycleMethodInput: { daily, weekly, monthly, ... }
플랫폼 정산 주기 계산 방식 입력 정보

하나의 하위 필드에만 값을 명시하여 요청합니다.

PlatformSettlementCycleMethodManualDates: { type, dates }
정해진 날짜(월, 일)에 정산

정해진 날짜(월, 일)에 정산

PlatformSettlementCycleMethodManualDatesInput: { dates }
PlatformSettlementCycleMethodManualDatesInput
PlatformSettlementCycleMethodMonthly: { type, daysOfMonth }
매월 정해진 날(일)에 정산

매월 정해진 날(일)에 정산

PlatformSettlementCycleMethodMonthlyInput: { daysOfMonth }
PlatformSettlementCycleMethodMonthlyInput
PlatformSettlementCycleMethodWeekly: { type, daysOfWeek }
매주 정해진 요일에 정산

매주 정해진 요일에 정산

PlatformSettlementCycleMethodWeeklyInput: { daysOfWeek }
PlatformSettlementCycleMethodWeeklyInput
PlatformSettlementCycleType: "DAILY" | "WEEKLY" | "MONTHLY" | ...
플랫폼 정산 주기 계산 방식

플랫폼 정산 주기 계산 방식

PlatformSettlementParameterNotFoundError: { type, message }
정산 파라미터가 존재하지 않는 경우

정산 파라미터가 존재하지 않는 경우

PlatformSettlementParameterValue: { decimal, decimalScale }
플랫폼 정산 파라미터 값

플랫폼 정산 파라미터 값

PlatformSettlementPaymentAmountExceededPortOnePaymentError: { type, registeredSettlementPaymentAmount, requestSettlementPaymentAmount, ... }
정산 요청 결제 금액이 포트원 결제 내역의 결제 금액을 초과한 경우

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

PlatformSettlementSupplyWithVatAmountExceededPortOnePaymentError: { type, registeredSettlementSupplyWithVatAmount, requestSettlementSupplyWithVatAmount, ... }
정산 요청 공급대가가 포트원 결제 내역의 공급대가를 초과한 경우

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

PlatformSettlementTaxFreeAmountExceededPortOnePaymentError: { type, registeredSettlementTaxFreeAmount, requestSettlementTaxFreeAmount, ... }
정산 요청 면세 금액이 포트원 결제 내역의 면세 금액을 초과한 경우

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

PlatformTargetPartnerNotFoundError: { type, message }
처리 대상 파트너가 존재하지 않는 경우

처리 대상 파트너가 존재하지 않는 경우

PlatformTaxationType: "NORMAL" | "SIMPLE_TAX_INVOICE_ISSUER" | "SIMPLE" | ...
플랫폼 과세 유형

플랫폼 과세 유형

PlatformTransfer: PlatformManualTransfer | PlatformOrderTransfer | PlatformOrderCancelTransfer
정산건

정산건은 파트너에 정산해줄 정산 금액과 정산 방식 등이 포함되어 있는 정산 정보입니다. 정산 방식은은 주문 정산, 주문 취소 정산, 수기 정산이 있습니다.

PlatformTransferAlreadyExistsError: { type, transferId, transferGraphqlId, ... }
PlatformTransferAlreadyExistsError
PlatformTransferDiscountSharePolicyNotFoundError: { type, discountSharePolicyId, discountSharePolicyGraphqlId, ... }
PlatformTransferDiscountSharePolicyNotFoundError
PlatformTransferFilterInput: { settlementStartDateRange, settlementDateRange, partnerTags, ... }
정산건 필터 입력 정보

정산 시작일 범위와 정산 일 범위는 둘 중 하나만 입력 가능합니다.

PlatformTransferFilterInputKeyword: { all, paymentId, transferId, ... }
정산건 검색 키워드 입력 정보

검색 키워드 적용을 위한 옵션으로, 명시된 키워드를 포함하는 정산건만 조회합니다. 하나의 하위 필드에만 값을 명시하여 요청합니다.

PlatformTransferNonDeletableStatusError: { type, message }
PlatformTransferNonDeletableStatusError
PlatformTransferNotFoundError: { type, message }
PlatformTransferNotFoundError
PlatformTransferSheetField: "STATUS" | "TRANSFER_ID" | "PARTNER_NAME" | ...
다운로드 할 시트 컬럼

다운로드 할 시트 컬럼

PlatformTransferStatus: "SCHEDULED" | "IN_PROCESS" | "SETTLED" | ...
정산 상태

정산 상태

PlatformTransferSummary: PlatformManualTransferSummary | PlatformOrderTransferSummary | PlatformOrderCancelTransferSummary
PlatformTransferSummary
PlatformTransferSummaryExternalPayment: { type, id, orderName, ... }
PlatformTransferSummaryExternalPayment
PlatformTransferSummaryPartner: { id, graphqlId, name, ... }
PlatformTransferSummaryPartner
PlatformTransferSummaryPartnerType: "BUSINESS" | "WHT_PAYER" | "NON_WHT_PAYER"
파트너 유형

파트너 유형

PlatformTransferSummaryPayment: PlatformTransferSummaryExternalPayment | PlatformTransferSummaryPortOnePayment
PlatformTransferSummaryPayment
PlatformTransferSummaryPortOnePayment: { type, id, orderName, ... }
PlatformTransferSummaryPortOnePayment
PlatformTransferType: "ORDER" | "ORDER_CANCEL" | "MANUAL"
PlatformTransferType
PlatformUserDefinedFormulaResults: { [key: string]: integer (64 bit) }
PlatformUserDefinedFormulaResults
PlatformUserDefinedPropertyKeyValue: { key, value }
사용자 정의 속성

사용자 정의 속성

PlatformUserDefinedPropertyNotFoundError: { type, message }
사용자 정의 속성이 존재 하지 않는 경우

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

PlatformUserDefinedPropertyValue: { string }
PlatformUserDefinedPropertyValue
PortOneVersion: "V1" | "V2"
포트원 버전

포트원 버전

PreRegisterPaymentError: AlreadyPaidError | ForbiddenError | InvalidRequestError | ...
PreRegisterPaymentError
PreRegisterPaymentResponse: { }
결제 사전 등록 성공 응답

결제 사전 등록 성공 응답

Promotion: CardPromotion
프로모션

프로모션

PromotionAmountDiscountScheme: { type, amount }
PromotionAmountDiscountScheme
PromotionCardCompany: "WOORI_CARD" | "BC_CARD" | "SAMSUNG_CARD" | ...
프로모션 적용 가능한 카드사

프로모션 적용 가능한 카드사

PromotionDiscountPartition: { amountFrom, scheme }
금액 구간별 프로모션 할인 정책

금액 구간별 프로모션 할인 정책

PromotionDiscountPolicy: { partitions }
프로모션 할인 정책

프로모션 할인 정책

PromotionDiscountRetainOption: "RETAIN" | "RELEASE"
PromotionDiscountRetainOption
PromotionDiscountRetainOptionShouldNotBeChangedError: { type, message }
프로모션 혜택 유지 옵션을 이전 부분 취소와 다른 것으로 입력한 경우

프로모션 혜택 유지 옵션을 이전 부분 취소와 다른 것으로 입력한 경우

PromotionDiscountScheme: PromotionAmountDiscountScheme | PromotionPercentDiscountScheme
PromotionDiscountScheme
PromotionNotFoundError: { type, message }
프로모션이 존재하지 않는 경우

프로모션이 존재하지 않는 경우

PromotionPayMethodDoesNotMatchError: { type, message }
결제수단이 프로모션에 지정된 것과 일치하지 않는 경우

결제수단이 프로모션에 지정된 것과 일치하지 않는 경우

PromotionPercentDiscountScheme: { type, percent }
PromotionPercentDiscountScheme
PromotionRecoverOption: PromotionRecoverOptionNoRecover | PromotionRecoverOptionRecover
PromotionRecoverOption
PromotionRecoverOptionNoRecover: { type, spareBudget }
결제 취소 시 프로모션 예산 미복구

결제 취소 시 프로모션 예산 미복구

PromotionRecoverOptionRecover: { type }
결제 취소 시 프로모션 예산 복구

결제 취소 시 프로모션 예산 복구

PromotionSpareBudget: PromotionSpareBudgetAmount | PromotionSpareBudgetPercent
PromotionSpareBudget
PromotionSpareBudgetAmount: { type, amount }
PromotionSpareBudgetAmount
PromotionSpareBudgetPercent: { type, percent }
PromotionSpareBudgetPercent
PromotionStatus: "SCHEDULED" | "IN_PROGRESS" | "PAUSED" | ...
PromotionStatus
ReadyIdentityVerification: { status, id, channel, ... }
준비 상태의 본인인증 내역

준비 상태의 본인인증 내역

ReadyPayment: { status, id, transactionId, ... }
준비 상태 건

준비 상태 건

ReadyPaymentTransaction: { status, id, paymentId, ... }
준비 상태 건

준비 상태 건

RecoverPlatformAdditionalFeePolicyError: ForbiddenError | InvalidRequestError | PlatformAdditionalFeePolicyNotFoundError | ...
RecoverPlatformAdditionalFeePolicyError
RecoverPlatformAdditionalFeePolicyResponse: { additionalFeePolicy }
추가 수수료 정책 복원 성공 응답

추가 수수료 정책 복원 성공 응답

RecoverPlatformContractError: ForbiddenError | InvalidRequestError | PlatformContractNotFoundError | ...
RecoverPlatformContractError
RecoverPlatformContractResponse: { contract }
계약 복원 성공 응답

계약 복원 성공 응답

RecoverPlatformDiscountSharePolicyError: ForbiddenError | InvalidRequestError | PlatformDiscountSharePolicyNotFoundError | ...
RecoverPlatformDiscountSharePolicyError
RecoverPlatformDiscountSharePolicyResponse: { discountSharePolicy }
할인 분담 복원 성공 응답

할인 분담 복원 성공 응답

RecoverPlatformPartnerError: ForbiddenError | InvalidRequestError | PlatformNotEnabledError | ...
RecoverPlatformPartnerError
RecoverPlatformPartnerResponse: { partner }
파트너 복원 성공 응답

파트너 복원 성공 응답

RefreshTokenError: InvalidRequestError | UnauthorizedError
RefreshTokenError
RefreshTokenResponse: { accessToken, refreshToken }
토큰 재발급 성공 응답

토큰 재발급 성공 응답

RegisterStoreReceiptBodyItem: { storeBusinessRegistrationNumber, storeName, totalAmount, ... }
하위 상점 거래 정보

하위 상점 거래 정보

RegisterStoreReceiptError: ForbiddenError | InvalidRequestError | PaymentNotFoundError | ...
RegisterStoreReceiptError
RegisterStoreReceiptResponse: { receiptUrl }
영수증 내 하위 상점 거래 등록 응답

영수증 내 하위 상점 거래 등록 응답

RegisteredPaymentEscrow: { status, company, invoiceNumber, ... }
배송 정보 등록 완료

배송 정보 등록 완료

RejectConfirmedPaymentEscrow: { status, company, invoiceNumber, ... }
구매 거절 확정

구매 거절 확정

RejectedPaymentEscrow: { status, company, invoiceNumber, ... }
구매 거절

구매 거절

RequestedPaymentCancellation: { status, id, pgCancellationId, ... }
취소 요청 상태

취소 요청 상태

ResendIdentityVerificationError: ForbiddenError | IdentityVerificationAlreadyVerifiedError | IdentityVerificationNotFoundError | ...
ResendIdentityVerificationError
ResendIdentityVerificationResponse: { }
본인인증 요청 재전송 성공 응답

본인인증 요청 재전송 성공 응답

ResendWebhookError: ForbiddenError | InvalidRequestError | MaxWebhookRetryCountReachedError | ...
ResendWebhookError
ResendWebhookResponse: { webhook }
웹훅 재발송 응답 정보

웹훅 재발송 응답 정보

RevokePaymentSchedulesError: BillingKeyAlreadyDeletedError | BillingKeyNotFoundError | ForbiddenError | ...
RevokePaymentSchedulesError
RevokePaymentSchedulesResponse: { revokedScheduleIds, revokedAt }
결제 예약 건 취소 성공 응답

결제 예약 건 취소 성공 응답

RevokedPaymentSchedule: { status, id, merchantId, ... }
결제 예약 취소 상태

결제 예약 취소 상태

ScheduledPaymentSchedule: { status, id, merchantId, ... }
결제 예약 완료 상태

결제 예약 완료 상태

SelectedChannel: { type, id, key, ... }
(결제, 본인인증 등에) 선택된 채널 정보

(결제, 본인인증 등에) 선택된 채널 정보

SelectedChannelType: "LIVE" | "TEST"
채널 타입

채널 타입

SendIdentityVerificationBodyCustomer: { id, name, phoneNumber, ... }
본인인증 요청을 위한 고객 정보

본인인증 요청을 위한 고객 정보

SendIdentityVerificationError: ChannelNotFoundError | ForbiddenError | IdentityVerificationAlreadySentError | ...
SendIdentityVerificationError
SendIdentityVerificationResponse: { }
본인인증 요청 전송 성공 응답

본인인증 요청 전송 성공 응답

SeparatedAddress: { type, oneLine, addressLine1, ... }
분리 형식 주소

한 줄 형식 주소와 분리 형식 주소 모두 존재합니다. 한 줄 형식 주소는 분리 형식 주소를 이어 붙인 형태로 생성됩니다.

SeparatedAddressInput: { addressLine1, addressLine2, city, ... }
분리 형식 주소 입력 정보

분리 형식 주소 입력 정보

SortOrder: "DESC" | "ASC"
정렬 방식

정렬 방식

StartedPaymentSchedule: { status, id, merchantId, ... }
결제 시작 상태

결제 시작 상태

SucceededPaymentCancellation: { status, id, pgCancellationId, ... }
취소 완료 상태

취소 완료 상태

SucceededPaymentSchedule: { status, id, merchantId, ... }
결제 성공 상태

결제 성공 상태

SumOfPartsExceedsCancelAmountError: { type, message }
면세 금액 등 하위 항목들의 합이 전체 취소 금액을 초과한 경우

면세 금액 등 하위 항목들의 합이 전체 취소 금액을 초과한 경우

SumOfPartsExceedsTotalAmountError: { type, message }
면세 금액 등 하위 항목들의 합이 전체 결제 금액을 초과한 경우

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

TransferParameters: { [key: string]: PlatformSettlementParameterValue }
TransferParameters
Trigger: "CONSOLE" | "API" | "PORTONE_ADMIN"
Trigger
UnauthorizedError: { type, message }
인증 정보가 올바르지 않은 경우

인증 정보가 올바르지 않은 경우

UpdatePlatformAdditionalFeePolicyError: ForbiddenError | InvalidRequestError | PlatformAdditionalFeePolicyNotFoundError | ...
UpdatePlatformAdditionalFeePolicyError
UpdatePlatformAdditionalFeePolicyResponse: { additionalFeePolicy }
추가 수수료 정책 업데이트 성공 응답

추가 수수료 정책 업데이트 성공 응답

UpdatePlatformContractError: ForbiddenError | InvalidRequestError | PlatformArchivedContractError | ...
UpdatePlatformContractError
UpdatePlatformContractResponse: { contract }
계약 객체 업데이트 성공 응답

계약 객체 업데이트 성공 응답

UpdatePlatformDiscountSharePolicyError: ForbiddenError | InvalidRequestError | PlatformArchivedDiscountSharePolicyError | ...
UpdatePlatformDiscountSharePolicyError
UpdatePlatformDiscountSharePolicyResponse: { discountSharePolicy }
할인 분담 정책 업데이트 성공 응답

할인 분담 정책 업데이트 성공 응답

UpdatePlatformPartnerBodyAccount: { bank, currency, number, ... }
파트너 계좌 업데이트를 위한 입력 정보

파트너 계좌 업데이트를 위한 입력 정보

UpdatePlatformPartnerBodyContact: { name, phoneNumber, email }
파트너 담당자 업데이트를 위한 정보

파트너 담당자 업데이트를 위한 정보

UpdatePlatformPartnerBodyType: { business, whtPayer, nonWhtPayer }
파트너 업데이트를 위한 유형별 추가 정보

파트너 유형별 추가 정보를 수정합니다. 기존과 다른 파트너 유형 정보가 입력된 경우, 파트너의 유형 자체가 변경됩니다.

UpdatePlatformPartnerBodyTypeBusiness: { companyName, taxationType, businessRegistrationNumber, ... }
UpdatePlatformPartnerBodyTypeBusiness
UpdatePlatformPartnerBodyTypeNonWhtPayer: { birthdate }
UpdatePlatformPartnerBodyTypeNonWhtPayer
UpdatePlatformPartnerBodyTypeWhtPayer: { birthdate }
UpdatePlatformPartnerBodyTypeWhtPayer
UpdatePlatformPartnerError: ForbiddenError | InvalidRequestError | PlatformAccountVerificationAlreadyUsedError | ...
UpdatePlatformPartnerError
UpdatePlatformPartnerResponse: { partner }
파트너 업데이트 성공 응답

파트너 업데이트 성공 응답

VerifiedIdentityVerification: { status, id, channel, ... }
완료된 본인인증 내역

완료된 본인인증 내역

VirtualAccountIssuedPayment: { status, id, transactionId, ... }
가상계좌 발급 완료 상태 건

가상계좌 발급 완료 상태 건

VirtualAccountIssuedPaymentTransaction: { status, id, paymentId, ... }
가상계좌 발급 완료 상태 건

가상계좌 발급 완료 상태 건

WebhookNotFoundError: { type, message }
웹훅 내역이 존재하지 않는 경우

웹훅 내역이 존재하지 않는 경우