PortOne REST API - V2

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

V2 API hostname: api.portone.io

요청 및 응답 형식

요청과 응답의 본문은 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

현금 영수증 관련 API

프로모션 관련 API

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

본인인증 관련 API

파트너 정산 관련 API

파트너 정산 서비스 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 요청/응답의 각 필드에서 사용되는 타입 정의들을 확인할 수 있습니다
AddressAlreadyPaidErrorAlreadyPaidOrWaitingErrorAmountExceededTypeApplyEscrowLogisticsErrorApplyEscrowLogisticsResponseArchivePlatformAdditionalFeePolicyErrorArchivePlatformAdditionalFeePolicyResponseArchivePlatformContractErrorArchivePlatformContractResponseArchivePlatformDiscountSharePolicyErrorArchivePlatformDiscountSharePolicyResponseArchivePlatformPartnerErrorArchivePlatformPartnerResponseBankBankInfoBankInfoNameBeforeRegisteredPaymentEscrowBillingKeyAlreadyDeletedErrorBillingKeyFailureBillingKeyFilterInputBillingKeyInfoBillingKeyInfoSummaryBillingKeyNotFoundErrorBillingKeyNotIssuedErrorBillingKeyPaymentInputBillingKeyPaymentMethodBillingKeyPaymentMethodCardBillingKeyPaymentMethodEasyPayBillingKeyPaymentMethodEasyPayChargeBillingKeyPaymentMethodEasyPayMethodBillingKeyPaymentMethodMobileBillingKeyPaymentMethodPaypalBillingKeyPaymentMethodTransferBillingKeyPaymentMethodTypeBillingKeyPaymentSummaryBillingKeySortByBillingKeySortInputBillingKeyStatusBillingKeyTextSearchBillingKeyTextSearchFieldBillingKeyTimeRangeFieldCancelAmountExceedsCancellableAmountErrorCancelCashReceiptErrorCancelCashReceiptResponseCancelPaymentBodyRefundAccountCancelPaymentErrorCancelPaymentResponseCancelRequesterCancelTaxAmountExceedsCancellableTaxAmountErrorCancelTaxFreeAmountExceedsCancellableTaxFreeAmountErrorCancellableAmountConsistencyBrokenErrorCancelledCashReceiptCancelledPaymentCancelledPaymentCashReceiptCancelledPaymentEscrowCancelledPaymentTransactionCardCardBrandCardCredentialCardOwnerTypeCardPromotionCardTypeCashReceiptCashReceiptAlreadyIssuedErrorCashReceiptInputCashReceiptInputTypeCashReceiptNotFoundErrorCashReceiptNotIssuedErrorCashReceiptSummaryCashReceiptTypeChannelGroupSummaryChannelNotFoundErrorChannelSpecificErrorChannelSpecificFailureChannelSpecificFailureInvalidRequestChannelSpecificFailurePgProviderCloseVirtualAccountErrorCloseVirtualAccountResponseConfirmEscrowErrorConfirmEscrowResponseConfirmIdentityVerificationErrorConfirmIdentityVerificationResponseConfirmedPaymentEscrowCountryCreateManualTransferResponseCreateOrderCancelTransferResponseCreateOrderTransferResponseCreatePaymentScheduleErrorCreatePaymentScheduleResponseCreatePlatformAdditionalFeePolicyErrorCreatePlatformAdditionalFeePolicyResponseCreatePlatformContractErrorCreatePlatformContractResponseCreatePlatformDiscountSharePolicyErrorCreatePlatformDiscountSharePolicyResponseCreatePlatformManualTransferErrorCreatePlatformOrderCancelTransferBodyDiscountCreatePlatformOrderCancelTransferBodyExternalCancellationDetailCreatePlatformOrderCancelTransferBodyOrderDetailCreatePlatformOrderCancelTransferBodyOrderDetailAllCreatePlatformOrderCancelTransferBodyOrderLineCreatePlatformOrderCancelTransferErrorCreatePlatformOrderTransferBodyAdditionalFeeCreatePlatformOrderTransferBodyDiscountCreatePlatformOrderTransferBodyExternalPaymentDetailCreatePlatformOrderTransferBodyOrderDetailCreatePlatformOrderTransferBodyOrderLineCreatePlatformOrderTransferBodyProductCreatePlatformOrderTransferErrorCreatePlatformPartnerBodyCreatePlatformPartnerBodyAccountCreatePlatformPartnerBodyContactCreatePlatformPartnerBodyTypeCreatePlatformPartnerBodyTypeBusinessCreatePlatformPartnerBodyTypeNonWhtPayerCreatePlatformPartnerBodyTypeWhtPayerCreatePlatformPartnerErrorCreatePlatformPartnerResponseCreatePlatformPartnersErrorCreatePlatformPartnersResponseCurrencyCustomerCustomerInputCustomerNameInputCustomerSeparatedNameDateRangeDateTimeRangeDayOfWeekDeleteBillingKeyErrorDeleteBillingKeyResponseDeletePlatformTransferErrorDeletePlatformTransferResponseDeletedBillingKeyInfoDeliveredPaymentEscrowDiscountAmountExceedsTotalAmountErrorDownloadPlatformTransferSheetErrorEasyPayMethodTypeEasyPayProviderFailedIdentityVerificationFailedPaymentFailedPaymentCancellationFailedPaymentScheduleFailedPaymentTransactionFailedPgBillingKeyIssueResponseForbiddenErrorGenderGetAllPaymentsByCursorResponseGetAllPaymentsErrorGetBankInfosErrorGetBankInfosResponseGetBillingKeyInfoErrorGetBillingKeyInfosErrorGetBillingKeyInfosResponseGetCashReceiptErrorGetIdentityVerificationErrorGetKakaopayPaymentOrderErrorGetKakaopayPaymentOrderResponseGetPaymentErrorGetPaymentScheduleErrorGetPaymentSchedulesErrorGetPaymentSchedulesResponseGetPaymentTransactionsErrorGetPaymentTransactionsResponseGetPaymentsErrorGetPaymentsResponseGetPlatformAccountHolderErrorGetPlatformAccountTransfersErrorGetPlatformAccountTransfersResponseGetPlatformAdditionalFeePoliciesErrorGetPlatformAdditionalFeePoliciesResponseGetPlatformAdditionalFeePolicyErrorGetPlatformBulkPayoutsErrorGetPlatformBulkPayoutsResponseGetPlatformCompanyStateErrorGetPlatformCompanyStatePayloadGetPlatformContractErrorGetPlatformContractsErrorGetPlatformContractsResponseGetPlatformDiscountSharePoliciesErrorGetPlatformDiscountSharePoliciesResponseGetPlatformDiscountSharePolicyErrorGetPlatformPartnerErrorGetPlatformPartnerSettlementsErrorGetPlatformPartnerSettlementsResponseGetPlatformPartnersErrorGetPlatformPartnersResponseGetPlatformPayoutsErrorGetPlatformPayoutsResponseGetPlatformTransferErrorGetPlatformTransferSummariesErrorGetPlatformTransferSummariesResponseGetPromotionErrorIdentityVerificationIdentityVerificationAlreadySentErrorIdentityVerificationAlreadyVerifiedErrorIdentityVerificationFailureIdentityVerificationMethodIdentityVerificationNotFoundErrorIdentityVerificationNotSentErrorIdentityVerificationOperatorIdentityVerificationRequestedCustomerIdentityVerificationVerifiedCustomerInstantBillingKeyPaymentMethodInputInstantBillingKeyPaymentMethodInputCardInstantPaymentMethodInputInstantPaymentMethodInputCardInstantPaymentMethodInputVirtualAccountInstantPaymentMethodInputVirtualAccountCashReceiptInfoInstantPaymentMethodInputVirtualAccountExpiryInstantPaymentMethodInputVirtualAccountOptionInstantPaymentMethodInputVirtualAccountOptionFixedInstantPaymentMethodInputVirtualAccountOptionTypeInstantPaymentSummaryInvalidRequestErrorIssueBillingKeyErrorIssueBillingKeyResponseIssueCashReceiptCustomerInputIssueCashReceiptErrorIssueCashReceiptPaymentMethodTypeIssueCashReceiptResponseIssueFailedCashReceiptIssuedBillingKeyInfoIssuedCashReceiptIssuedPaymentCashReceiptIssuedPgBillingKeyIssueResponseLoginViaApiSecretErrorLoginViaApiSecretResponseMaxTransactionCountReachedErrorMaxWebhookRetryCountReachedErrorModifyEscrowLogisticsErrorModifyEscrowLogisticsResponseMonthDayNegativePromotionAdjustedCancelAmountErrorOneLineAddressPageInfoPageInputPaidPaymentPaidPaymentTransactionPartialCancelledPaymentPartialCancelledPaymentTransactionPayInstantlyErrorPayInstantlyResponsePayPendingPaymentPayPendingPaymentTransactionPayWithBillingKeyErrorPayWithBillingKeyResponsePaymentPaymentAlreadyCancelledErrorPaymentAmountPaymentAmountInputPaymentCancellationPaymentCashReceiptPaymentCashReceiptStatusPaymentClientTypePaymentEscrowPaymentEscrowReceiverInputPaymentEscrowSenderInputPaymentFailurePaymentFilterInputPaymentFilterInputEscrowStatusPaymentInstallmentPaymentLogisticsPaymentLogisticsCompanyPaymentMethodPaymentMethodCardPaymentMethodEasyPayPaymentMethodEasyPayMethodPaymentMethodEasyPayMethodChargePaymentMethodGiftCertificatePaymentMethodGiftCertificateTypePaymentMethodMobilePaymentMethodTransferPaymentMethodTypePaymentMethodVirtualAccountPaymentMethodVirtualAccountRefundStatusPaymentMethodVirtualAccountTypePaymentNotFoundErrorPaymentNotPaidErrorPaymentNotWaitingForDepositErrorPaymentProductPaymentProductTypePaymentSchedulePaymentScheduleAlreadyExistsErrorPaymentScheduleAlreadyProcessedErrorPaymentScheduleAlreadyRevokedErrorPaymentScheduleFilterInputPaymentScheduleNotFoundErrorPaymentScheduleSortByPaymentScheduleSortInputPaymentScheduleStatusPaymentScheduleSummaryPaymentSortByPaymentStatusPaymentTextSearchPaymentTextSearchFieldPaymentTimestampTypePaymentTransactionPaymentWebhookPaymentWebhookPaymentStatusPaymentWebhookRequestPaymentWebhookResponsePaymentWebhookStatusPaymentWebhookTriggerPaymentWithCursorPendingPaymentSchedulePgBillingKeyIssueResponsePgCompanyPgProviderPgProviderErrorPlatformAccountPlatformAccountHolderPlatformAccountStatusPlatformAccountTransferPlatformAccountTransferFilterPlatformAccountTransferTypePlatformAccountVerificationAlreadyUsedErrorPlatformAccountVerificationFailedErrorPlatformAccountVerificationNotFoundErrorPlatformAdditionalFeePoliciesNotFoundErrorPlatformAdditionalFeePolicyPlatformAdditionalFeePolicyAlreadyExistsErrorPlatformAdditionalFeePolicyFilterInputPlatformAdditionalFeePolicyFilterInputKeywordPlatformAdditionalFeePolicyNotFoundErrorPlatformAdditionalFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedErrorPlatformArchivedAdditionalFeePolicyErrorPlatformArchivedContractErrorPlatformArchivedDiscountSharePolicyErrorPlatformArchivedPartnerErrorPlatformBulkPayoutPlatformBulkPayoutFilterInputPlatformBulkPayoutFilterInputCriteriaPlatformBulkPayoutStatsPlatformBulkPayoutStatusPlatformBulkPayoutStatusStatsPlatformBusinessStatusPlatformCancelOrderTransfersExistsErrorPlatformCancellableAmountExceededErrorPlatformCancellableAmountTypePlatformCancellableDiscountAmountExceededErrorPlatformCancellableDiscountTaxFreeAmountExceededErrorPlatformCancellableProductQuantityExceededErrorPlatformCancellationAndPaymentTypeMismatchedErrorPlatformCancellationNotFoundErrorPlatformCannotArchiveScheduledAdditionalFeePolicyErrorPlatformCannotArchiveScheduledContractErrorPlatformCannotArchiveScheduledDiscountSharePolicyErrorPlatformCannotArchiveScheduledPartnerErrorPlatformCannotSpecifyTransferErrorPlatformCompanyNotFoundErrorPlatformCompanyStatePlatformCompanyVerificationAlreadyUsedErrorPlatformContactPlatformContractPlatformContractAlreadyExistsErrorPlatformContractFilterInputPlatformContractFilterInputKeywordPlatformContractNotFoundErrorPlatformContractPlatformFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedErrorPlatformContractsNotFoundErrorPlatformCurrencyNotSupportedErrorPlatformDepositAccountTransferPlatformDiscountSharePoliciesNotFoundErrorPlatformDiscountSharePolicyPlatformDiscountSharePolicyAlreadyExistsErrorPlatformDiscountSharePolicyFilterInputPlatformDiscountSharePolicyFilterInputKeywordPlatformDiscountSharePolicyIdDuplicatedErrorPlatformDiscountSharePolicyNotFoundErrorPlatformExternalApiFailedErrorPlatformExternalApiTemporarilyFailedErrorPlatformExternalPaymentPlatformFeePlatformFeeInputPlatformFixedAmountFeePlatformFixedRateFeePlatformInsufficientDataToChangePartnerTypeErrorPlatformManualTransferPlatformManualTransferSummaryPlatformMemberCompanyConnectedPartnerBrnUnchangeableErrorPlatformMemberCompanyConnectedPartnerTypeUnchangeableErrorPlatformNotEnabledErrorPlatformNotSupportedBankErrorPlatformOrderCancelTransferPlatformOrderCancelTransferSummaryPlatformOrderDetailMismatchedErrorPlatformOrderSettlementAmountPlatformOrderTransferPlatformOrderTransferAdditionalFeePlatformOrderTransferAlreadyCancelledErrorPlatformOrderTransferCancellationPlatformOrderTransferDiscountPlatformOrderTransferOrderLinePlatformOrderTransferProductPlatformOrderTransferSummaryPlatformPartnerPlatformPartnerBusinessStatusPlatformPartnerFilterInputPlatformPartnerFilterInputKeywordPlatformPartnerIdAlreadyExistsErrorPlatformPartnerIdsAlreadyExistErrorPlatformPartnerIdsDuplicatedErrorPlatformPartnerManualSettlementPlatformPartnerMemberCompanyConnectionStatusPlatformPartnerNotFoundErrorPlatformPartnerOrderCancelSettlementPlatformPartnerOrderSettlementPlatformPartnerPayoutAccountTransferPlatformPartnerSettlementPlatformPartnerSettlementFilterInputPlatformPartnerSettlementFilterKeywordInputPlatformPartnerSettlementStatusPlatformPartnerSettlementStatusStatsPlatformPartnerSettlementTypePlatformPartnerStatusPlatformPartnerTaxationTypePlatformPartnerTypePlatformPartnerTypeBusinessPlatformPartnerTypeNamePlatformPartnerTypeNonWhtPayerPlatformPartnerTypeWhtPayerPlatformPayerPlatformPaymentPlatformPaymentMethodPlatformPaymentMethodCardPlatformPaymentMethodCardInputPlatformPaymentMethodEasyPayPlatformPaymentMethodEasyPayInputPlatformPaymentMethodGiftCertificatePlatformPaymentMethodGiftCertificateInputPlatformPaymentMethodInputPlatformPaymentMethodMobilePlatformPaymentMethodMobileInputPlatformPaymentMethodTransferPlatformPaymentMethodTransferInputPlatformPaymentMethodVirtualAccountPlatformPaymentMethodVirtualAccountInputPlatformPaymentNotFoundErrorPlatformPayoutPlatformPayoutAccountPlatformPayoutFilterInputPlatformPayoutFilterInputCriteriaPlatformPayoutMethodPlatformPayoutStatusPlatformPayoutStatusStatsPlatformPortOnePaymentPlatformPortOnePaymentCancelAmountTypePlatformProductIdDuplicatedErrorPlatformProductIdNotFoundErrorPlatformPropertiesPlatformRemitAccountTransferPlatformSettlementAmountExceededErrorPlatformSettlementCancelAmountExceededPortOneCancelErrorPlatformSettlementCyclePlatformSettlementCycleDatePolicyPlatformSettlementCycleInputPlatformSettlementCycleMethodPlatformSettlementCycleMethodDailyPlatformSettlementCycleMethodDailyInputPlatformSettlementCycleMethodInputPlatformSettlementCycleMethodManualDatesPlatformSettlementCycleMethodManualDatesInputPlatformSettlementCycleMethodMonthlyPlatformSettlementCycleMethodMonthlyInputPlatformSettlementCycleMethodWeeklyPlatformSettlementCycleMethodWeeklyInputPlatformSettlementCycleTypePlatformSettlementParameterNotFoundErrorPlatformSettlementParameterValuePlatformSettlementPaymentAmountExceededPortOnePaymentErrorPlatformSettlementSupplyWithVatAmountExceededPortOnePaymentErrorPlatformSettlementTaxFreeAmountExceededPortOnePaymentErrorPlatformTaxationTypePlatformTransferPlatformTransferAlreadyExistsErrorPlatformTransferDiscountSharePolicyNotFoundErrorPlatformTransferFilterInputPlatformTransferFilterInputKeywordPlatformTransferNonDeletableStatusErrorPlatformTransferNotFoundErrorPlatformTransferSheetFieldPlatformTransferStatusPlatformTransferSummaryPlatformTransferSummaryExternalPaymentPlatformTransferSummaryPartnerPlatformTransferSummaryPartnerTypePlatformTransferSummaryPaymentPlatformTransferSummaryPortOnePaymentPlatformTransferTypePlatformUserDefinedPropertyKeyValuePlatformUserDefinedPropertyNotFoundErrorPlatformUserDefinedPropertyValuePortOneVersionPreRegisterPaymentErrorPreRegisterPaymentResponsePromotionPromotionAmountDiscountSchemePromotionCardCompanyPromotionDiscountPartitionPromotionDiscountPolicyPromotionDiscountRetainOptionPromotionDiscountRetainOptionShouldNotBeChangedErrorPromotionDiscountSchemePromotionNotFoundErrorPromotionPayMethodDoesNotMatchErrorPromotionPercentDiscountSchemePromotionRecoverOptionPromotionRecoverOptionNoRecoverPromotionRecoverOptionRecoverPromotionSpareBudgetPromotionSpareBudgetAmountPromotionSpareBudgetPercentPromotionStatusReadyIdentityVerificationReadyPaymentReadyPaymentTransactionRecoverPlatformAdditionalFeePolicyErrorRecoverPlatformAdditionalFeePolicyResponseRecoverPlatformContractErrorRecoverPlatformContractResponseRecoverPlatformDiscountSharePolicyErrorRecoverPlatformDiscountSharePolicyResponseRecoverPlatformPartnerErrorRecoverPlatformPartnerResponseRefreshTokenErrorRefreshTokenResponseRegisterStoreReceiptBodyItemRegisterStoreReceiptErrorRegisterStoreReceiptResponseRegisteredPaymentEscrowRejectConfirmedPaymentEscrowRejectedPaymentEscrowRequestedPaymentCancellationResendIdentityVerificationErrorResendIdentityVerificationResponseResendWebhookErrorResendWebhookResponseRevokePaymentSchedulesErrorRevokePaymentSchedulesResponseRevokedPaymentScheduleScheduledPaymentScheduleSelectedChannelSelectedChannelTypeSendIdentityVerificationBodyCustomerSendIdentityVerificationErrorSendIdentityVerificationResponseSeparatedAddressSeparatedAddressInputSortOrderStartedPaymentScheduleSucceededPaymentCancellationSucceededPaymentScheduleSumOfPartsExceedsCancelAmountErrorSumOfPartsExceedsTotalAmountErrorTransferParametersTriggerUnauthorizedErrorUpdatePlatformAdditionalFeePolicyErrorUpdatePlatformAdditionalFeePolicyResponseUpdatePlatformContractErrorUpdatePlatformContractResponseUpdatePlatformDiscountSharePolicyErrorUpdatePlatformDiscountSharePolicyResponseUpdatePlatformPartnerBodyAccountUpdatePlatformPartnerBodyContactUpdatePlatformPartnerBodyTypeUpdatePlatformPartnerBodyTypeBusinessUpdatePlatformPartnerBodyTypeNonWhtPayerUpdatePlatformPartnerBodyTypeWhtPayerUpdatePlatformPartnerErrorUpdatePlatformPartnerResponseVerifiedIdentityVerificationVirtualAccountIssuedPaymentVirtualAccountIssuedPaymentTransactionWebhookNotFoundError

Addressunion

type: string (Union Tag)
필드의 값이 일 때 타입은 OneLineAddress 입니다.
oneLine: string
주소 (한 줄)

AlreadyPaidErrorobject

type: string
message?: string
(Optional)

AlreadyPaidOrWaitingErrorobject

type: string
message?: string
(Optional)

AmountExceededTypeenum

DISCOUNT_THAN_ORDER할인금액이 주문금액을 초과
DISCOUNT_TAX_FREE_THAN_DISCOUNT면세 할인금액이 할인금액을 초과
DISCOUNT_TAX_FREE_THAN_ORDER_TAX_FREE면세 할인금액이 면세 주문금액을 초과
PAYMENT_TAX_FREE_THAN_PAYMENT면세 결제금액이 결제금액을 초과

ApplyEscrowLogisticsErrorunion

type: string (Union Tag)
필드의 값이 일 때 타입은 ForbiddenError 입니다.
message?: string
(Optional)

ApplyEscrowLogisticsResponseobject

invoiceNumber: string
송장 번호
sentAt: string (RFC 3339 date-time)
발송 시점
appliedAt: string (RFC 3339 date-time)
에스크로 정보 등록 시점

ArchivePlatformAdditionalFeePolicyErrorunion

type: string (Union Tag)
필드의 값이 일 때 타입은 ForbiddenError 입니다.
message?: string
(Optional)

ArchivePlatformAdditionalFeePolicyResponseobject

additionalFeePolicy: PlatformAdditionalFeePolicy
추가 수수료 정책

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

ArchivePlatformContractErrorunion

type: string (Union Tag)
필드의 값이 일 때 타입은 ForbiddenError 입니다.
message?: string
(Optional)

ArchivePlatformContractResponseobject

contract: PlatformContract
계약

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

ArchivePlatformDiscountSharePolicyErrorunion

type: string (Union Tag)
필드의 값이 일 때 타입은 ForbiddenError 입니다.
message?: string
(Optional)

ArchivePlatformDiscountSharePolicyResponseobject

discountSharePolicy: PlatformDiscountSharePolicy
할인 분담 정책

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

ArchivePlatformPartnerErrorunion

type: string (Union Tag)
필드의 값이 일 때 타입은 ForbiddenError 입니다.
message?: string
(Optional)

ArchivePlatformPartnerResponseobject

partner: PlatformPartner
파트너

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

Bankenum

BANK_OF_KOREA한국은행
KDB산업은행
IBK기업은행
KOOKMIN국민은행
SUHYUP수협은행
KEXIM수출입은행
NONGHYUPNH농협은행
LOCAL_NONGHYUP지역농축협
WOORI우리은행
STANDARD_CHARTEREDSC제일은행
CITI한국씨티은행
DAEGU아이엠뱅크
BUSAN부산은행
KWANGJU광주은행
JEJU제주은행
JEONBUK전북은행
KYONGNAM경남은행
KFCC새마을금고
SHINHYUP신협
SAVINGS_BANK저축은행
MORGAN_STANLEY모간스탠리은행
HSBCHSBC은행
DEUTSCHE도이치은행
JPMC제이피모간체이스은행
MIZUHO미즈호은행
MUFG엠유에프지은행
BANK_OF_AMERICABOA은행
BNP_PARIBAS비엔피파리바은행
ICBC중국공상은행
BANK_OF_CHINA중국은행
NFCF산림조합중앙회
UOB대화은행
BOCOM교통은행
CCB중국건설은행
POST우체국
KODIT신용보증기금
KIBO기술보증기금
HANA하나은행
SHINHAN신한은행
K_BANK케이뱅크
KAKAO카카오뱅크
TOSS토스뱅크
MISC_FOREIGN기타 외국계은행(중국 농업은행 등)
SGI서울보증보험
KCIS한국신용정보원
YUANTA_SECURITIES유안타증권
KB_SECURITIESKB증권
SANGSANGIN_SECURITIES상상인증권
HANYANG_SECURITIES한양증권
LEADING_SECURITIES리딩투자증권
BNK_SECURITIESBNK투자증권
IBK_SECURITIESIBK투자증권
DAOL_SECURITIES다올투자증권
MIRAE_ASSET_SECURITIES미래에셋증권
SAMSUNG_SECURITIES삼성증권
KOREA_SECURITIES한국투자증권
NH_SECURITIESNH투자증권
KYOBO_SECURITIES교보증권
HI_SECURITIES하이투자증권
HYUNDAI_MOTOR_SECURITIES현대차증권
KIWOOM_SECURITIES키움증권
EBEST_SECURITIESLS증권
SK_SECURITIESSK증권
DAISHIN_SECURITIES대신증권
HANHWA_SECURITIES한화투자증권
HANA_SECURITIES하나증권
TOSS_SECURITIES토스증권
SHINHAN_SECURITIES신한투자증권
DB_SECURITIESDB금융투자
EUGENE_SECURITIES유진투자증권
MERITZ_SECURITIES메리츠증권
KAKAO_PAY_SECURITIES카카오페이증권
BOOKOOK_SECURITIES부국증권
SHINYOUNG_SECURITIES신영증권
CAPE_SECURITIES케이프투자증권
KOREA_SECURITIES_FINANCE한국증권금융
KOREA_FOSS_SECURITIES한국포스증권
WOORI_INVESTMENT_BANK우리종합금융

BankInfoobject

bank: Bank
은행

은행

은행 명칭

은행 명칭

BankInfoNameobject

ko: string
한국어 명칭

BeforeRegisteredPaymentEscrowobject

status: string
에스크로 상태

BillingKeyAlreadyDeletedErrorobject

type: string
message?: string
(Optional)

BillingKeyFailureobject

message?: string
실패 사유
(Optional)
pgCode?: string
PG사 실패 코드
(Optional)
pgMessage?: string
PG사 실패 사유
(Optional)
failedAt: string (RFC 3339 date-time)
실패 시점

BillingKeyFilterInputobject

storeId?: string
상점 아이디
(Optional)

Merchant 사용자만 사용가능하며, 지정되지 않은 경우 고객사 전체 빌링키를 조회합니다.

timeRangeField?: BillingKeyTimeRangeField
빌링키 다건 조회 시, 시각 범위를 적용할 필드
(Optional)

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

from?: string (RFC 3339 date-time)
조회 기준 시점 범위의 시작
(Optional)

값을 입력하지 않으면 end의 90일 전으로 설정됩니다.

until?: string (RFC 3339 date-time)
조회 기준 시점 범위의 끝
(Optional)

값을 입력하지 않으면 현재 시점으로 설정됩니다.

빌링키 상태 리스트
(Optional)

값을 입력하지 않으면 빌링키 상태 필터링이 적용되지 않습니다.

channelGroupIds?: string[]
채널 그룹 아이디 리스트
(Optional)

값을 입력하지 않으면 스마트 라우팅 그룹 아이디 필터링이 적용되지 않습니다.

customerId?: string
고객 ID
(Optional)
platformType?: PaymentClientType
결제가 발생한 클라이언트 환경
(Optional)

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

textSearch?: BillingKeyTextSearch
통합검색 입력 정보
(Optional)

통합검색 입력 정보

pgProviders?: PgProvider[]
PG사 결제 모듈 리스트
(Optional)

값을 입력하지 않으면 PG사 결제 모듈 필터링이 적용되지 않습니다.

pgCompanies?: PgCompany[]
PG사 리스트
(Optional)

값을 입력하지 않으면 PG사 필터링이 적용되지 않습니다.

결제수단 리스트
(Optional)

값을 입력하지 않으면 결제수단 필터링이 적용되지 않습니다.

version?: PortOneVersion
포트원 버전
(Optional)

포트원 버전

BillingKeyInfounion

status: string (Union Tag)
빌링키 상태
필드의 값이 일 때 타입은 DeletedBillingKeyInfo 입니다.
billingKey: string
빌링키
merchantId: string
고객사 아이디
storeId: string
상점 아이디
빌링키 결제수단 상세 정보
(Optional)

추후 슈퍼빌링키 기능 제공 시 여러 결제수단 정보가 담길 수 있습니다.

빌링키 발급 시 사용된 채널

추후 슈퍼빌링키 기능 제공 시 여러 채널 정보가 담길 수 있습니다.

customer: Customer
고객 정보

고객 정보

customData?: string
사용자 지정 데이터
(Optional)
issueId?: string
고객사가 채번하는 빌링키 발급 건 고유 아이디
(Optional)
issueName?: string
빌링키 발급 건 이름
(Optional)
requestedAt?: string (RFC 3339 date-time)
발급 요청 시점
(Optional)
issuedAt: string (RFC 3339 date-time)
발급 시점
channelGroup?: ChannelGroupSummary
채널 그룹 정보
(Optional)

채널 그룹 정보

pgBillingKeyIssueResponses?: PgBillingKeyIssueResponse[]
채널 별 빌링키 발급 응답
(Optional)

슈퍼빌링키의 경우, 빌링키 발급이 성공하더라도 일부 채널에 대한 발급은 실패할 수 있습니다.

deletedAt: string (RFC 3339 date-time)
발급 삭제 시점

BillingKeyInfoSummaryobject

billingKey: string
발급된 빌링키
channels?: SelectedChannel[]
(결제, 본인인증 등에) 선택된 채널 정보
(Optional)
issuedAt: string (RFC 3339 date-time)
빌링크 발급 완료 시점

BillingKeyNotFoundErrorobject

type: string
message?: string
(Optional)

BillingKeyNotIssuedErrorobject

type: string
message?: string
(Optional)

BillingKeyPaymentInputobject

storeId?: string
상점 아이디
(Optional)

접근 권한이 있는 상점 아이디만 입력 가능하며, 미입력시 토큰에 담긴 상점 아이디를 사용합니다.

billingKey: string
빌링키 결제에 사용할 빌링키
channelKey?: string
채널 키
(Optional)

다수 채널에 대해 발급된 빌링키에 대해, 결제 채널을 특정하고 싶을 때 명시

orderName: string
주문명
customer?: CustomerInput
고객 정보 입력 정보
(Optional)

고객 정보 입력 정보

customData?: string
사용자 지정 데이터
(Optional)
금액 세부 입력 정보

금액 세부 입력 정보

currency: Currency
통화 단위

통화 단위

installmentMonth?: integer (32 bit)
할부 개월 수
(Optional)
useFreeInterestFromMerchant?: boolean
무이자 할부 이자를 고객사가 부담할지 여부
(Optional)
useCardPoint?: boolean
카드 포인트 사용 여부
(Optional)
cashReceipt?: CashReceiptInput
현금영수증 입력 정보
(Optional)

현금영수증 입력 정보

country?: Country
국가
(Optional)

국가

noticeUrls?: string[]
웹훅 주소
(Optional)

결제 승인/실패 시 요청을 받을 웹훅 주소입니다. 상점에 설정되어 있는 값보다 우선적으로 적용됩니다. 입력된 값이 없을 경우에는 빈 배열로 해석됩니다.

products?: PaymentProduct[]
상품 정보
(Optional)

입력된 값이 없을 경우에는 빈 배열로 해석됩니다.

productCount?: integer (32 bit)
상품 개수
(Optional)
productType?: PaymentProductType
상품 유형
(Optional)

상품 유형

shippingAddress?: SeparatedAddressInput
분리 형식 주소 입력 정보
(Optional)

분리 형식 주소 입력 정보

promotionId?: string
해당 결제에 적용할 프로모션 아이디
(Optional)
bypass?: object
PG사별 추가 파라미터 ("PG사별 연동 가이드" 참고)
(Optional)

BillingKeyPaymentMethodunion

type: string (Union Tag)
필드의 값이 일 때 타입은 BillingKeyPaymentMethodCard 입니다.
card?: Card
카드 상세 정보
(Optional)

카드 상세 정보

BillingKeyPaymentMethodCardobject

type: string
card?: Card
카드 상세 정보
(Optional)

카드 상세 정보

BillingKeyPaymentMethodEasyPayobject

type: string
provider?: EasyPayProvider
간편 결제사
(Optional)

간편 결제사

간편 결제 수단
(Optional)

간편 결제 수단

BillingKeyPaymentMethodEasyPayChargeobject

type: string

BillingKeyPaymentMethodEasyPayMethodunion

type: string (Union Tag)
필드의 값이 일 때 타입은 BillingKeyPaymentMethodCard 입니다.
card?: Card
카드 상세 정보
(Optional)

카드 상세 정보

BillingKeyPaymentMethodMobileobject

type: string
phoneNumber?: string
전화번호
(Optional)

BillingKeyPaymentMethodPaypalobject

type: string

BillingKeyPaymentMethodTransferobject

type: string
bank?: Bank
은행
(Optional)

은행

accountNumber?: string
계좌번호
(Optional)

BillingKeyPaymentMethodTypeenum

CARD카드
MOBILE모바일
EASY_PAY간편 결제
TRANSFER계좌 이체

BillingKeyPaymentSummaryobject

pgTxId: string
PG사 결제 아이디
paidAt: string (RFC 3339 date-time)
결제 완료 시점

BillingKeySortByenum

REQUESTED_AT발급 요청 시각
ISSUED_AT발급 완료 시각
DELETED_AT삭제 완료 시각
STATUS_TIMESTAMP상태 변경 시각

발급 완료 상태의 경우 ISSUED_AT, 삭제 완료 상태의 경우 DELETED_AT

BillingKeySortInputobject

빌링키 정렬 기준
(Optional)

빌링키 정렬 기준

order?: SortOrder
정렬 방식
(Optional)

정렬 방식

BillingKeyStatusenum

ISSUED
DELETED

BillingKeyTextSearchobject

통합검색 항목

통합검색 항목

value: string

BillingKeyTextSearchFieldenum

CARD_BIN
CARD_NUMBER
PG_MERCHANT_ID
CUSTOMER_NAME
CUSTOMER_EMAIL
CUSTOMER_PHONE_NUMBER
CUSTOMER_ADDRESS
CUSTOMER_ZIPCODE
USER_AGENT
BILLING_KEY
CHANNEL_GROUP_NAME

BillingKeyTimeRangeFieldenum

REQUESTED_AT발급 요청 시각
ISSUED_AT발급 완료 시각
DELETED_AT삭제 완료 시각
STATUS_TIMESTAMP상태 변경 시각

발급 완료 상태의 경우 ISSUED_AT, 삭제 완료 상태의 경우 DELETED_AT

CancelAmountExceedsCancellableAmountErrorobject

type: string
message?: string
(Optional)

CancelCashReceiptErrorunion

type: string (Union Tag)
필드의 값이 일 때 타입은 CashReceiptNotFoundError 입니다.
message?: string
(Optional)

CancelCashReceiptResponseobject

cancelledAmount: integer (64 bit)
취소 금액
cancelledAt: string (RFC 3339 date-time)
현금 영수증 취소 완료 시점

CancelPaymentBodyRefundAccountobject

bank: Bank
은행

은행

number: string
계좌번호
holderName: string
예금주
holderPhoneNumber?: string
예금주 연락처 - 스마트로 가상계좌 결제인 경우에 필요합니다.
(Optional)

CancelPaymentErrorunion

type: string (Union Tag)
필드의 값이 일 때 타입은 CancellableAmountConsistencyBrokenError 입니다.
message?: string
(Optional)

CancelPaymentResponseobject

cancellation: PaymentCancellation
결제 취소 내역

결제 취소 내역

CancelRequesterenum

CUSTOMER
ADMIN

CancelTaxAmountExceedsCancellableTaxAmountErrorobject

type: string
message?: string
(Optional)

CancelTaxFreeAmountExceedsCancellableTaxFreeAmountErrorobject

type: string
message?: string
(Optional)

CancellableAmountConsistencyBrokenErrorobject

type: string
message?: string
(Optional)

CancelledCashReceiptobject

status: string
현금영수증 상태
merchantId: string
고객사 아이디
storeId: string
상점 아이디
paymentId: string
결제 건 아이디
channel: SelectedChannel
(결제, 본인인증 등에) 선택된 채널 정보

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

amount: integer (64 bit)
결제 금액
taxFreeAmount?: integer (64 bit)
면세액
(Optional)
vatAmount?: integer (64 bit)
부가세액
(Optional)
currency: Currency
통화 단위

통화 단위

orderName: string
주문명
isManual: boolean
수동 발급 여부
발급 유형
(Optional)

발급 유형

pgReceiptId?: string
PG사 현금영수증 아이디
(Optional)
issueNumber: string
승인번호
url?: string
현금영수증 URL
(Optional)
issuedAt: string (RFC 3339 date-time)
발급 시점
cancelledAt: string (RFC 3339 date-time)
취소 시점

CancelledPaymentobject

status: string
결제 건 상태
id: string
결제 건 아이디
transactionId: string
결제 건 포트원 채번 아이디

V1 결제 건의 경우 imp_uid에 해당합니다.

merchantId: string
고객사 아이디
storeId: string
상점 아이디
method?: PaymentMethod
결제수단 정보
(Optional)

결제수단 정보

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

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

channelGroup?: ChannelGroupSummary
채널 그룹 정보
(Optional)

채널 그룹 정보

version: PortOneVersion
포트원 버전

포트원 버전

scheduleId?: string
결제 예약 건 아이디
(Optional)

결제 예약을 이용한 경우에만 존재

billingKey?: string
결제 시 사용된 빌링키
(Optional)

빌링키 결제인 경우에만 존재

webhooks?: PaymentWebhook[]
웹훅 발송 내역
(Optional)
requestedAt: string (RFC 3339 date-time)
결제 요청 시점
updatedAt: string (RFC 3339 date-time)
업데이트 시점
statusChangedAt: string (RFC 3339 date-time)
상태 업데이트 시점
orderName: string
주문명
amount: PaymentAmount
결제 금액 세부 정보

결제 금액 세부 정보

currency: Currency
통화 단위

통화 단위

customer: Customer
고객 정보

고객 정보

promotionId?: string
프로모션 아이디
(Optional)
isCulturalExpense?: boolean
문화비 지출 여부
(Optional)
escrow?: PaymentEscrow
에스크로 정보
(Optional)

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

products?: PaymentProduct[]
상품 정보
(Optional)
productCount?: integer (32 bit)
상품 갯수
(Optional)
customData?: string
사용자 지정 데이터
(Optional)
country?: Country
국가
(Optional)

국가

paidAt?: string (RFC 3339 date-time)
결제 완료 시점
(Optional)
pgTxId?: string
PG사 거래 아이디
(Optional)
cashReceipt?: PaymentCashReceipt
결제 건 내 현금영수증 정보
(Optional)

결제 건 내 현금영수증 정보

receiptUrl?: string
거래 영수증 URL
(Optional)
cancellations: PaymentCancellation[]
결제 취소 내역
cancelledAt: string (RFC 3339 date-time)
결제 취소 시점

CancelledPaymentCashReceiptobject

status: string
결제 건 내 현금영수증 상태
발급 유형
(Optional)

발급 유형

pgReceiptId?: string
PG사 영수증 발급 아이디
(Optional)
issueNumber: string
승인 번호
totalAmount: integer (64 bit)
총 금액
taxFreeAmount?: integer (64 bit)
면세액
(Optional)
currency: Currency
통화 단위

통화 단위

url?: string
현금영수증 URL
(Optional)
issuedAt: string (RFC 3339 date-time)
발급 시점
cancelledAt: string (RFC 3339 date-time)
취소 시점

CancelledPaymentEscrowobject

status: string
에스크로 상태
company: string
택배사
invoiceNumber: string
송장번호
sentAt?: string (RFC 3339 date-time)
발송 일시
(Optional)
appliedAt?: string (RFC 3339 date-time)
배송등록 처리 일자
(Optional)

CancelledPaymentTransactionobject

status: string
결제 시도 상태
id: string
결제 시도 아이디 (transactionId)

V1 결제 건의 경우 imp_uid에 해당합니다.

paymentId: string
결제 건 아이디
merchantId: string
고객사 아이디
storeId: string
상점 아이디
method?: PaymentMethod
결제수단 정보
(Optional)

결제수단 정보

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

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

channelGroup?: ChannelGroupSummary
채널 그룹 정보
(Optional)

채널 그룹 정보

version: PortOneVersion
포트원 버전

포트원 버전

scheduleId?: string
결제 예약 건 아이디
(Optional)

결제 예약을 이용한 경우에만 존재

billingKey?: string
결제 시 사용된 빌링키
(Optional)

빌링키 결제인 경우에만 존재

webhooks?: PaymentWebhook[]
웹훅 발송 내역
(Optional)
requestedAt: string (RFC 3339 date-time)
결제 요청 시점
updatedAt: string (RFC 3339 date-time)
업데이트 시점
statusChangedAt: string (RFC 3339 date-time)
상태 업데이트 시점
orderName: string
주문명
amount: PaymentAmount
결제 금액 세부 정보

결제 금액 세부 정보

currency: Currency
통화 단위

통화 단위

customer: Customer
고객 정보

고객 정보

promotionId?: string
프로모션 아이디
(Optional)
isCulturalExpense?: boolean
문화비 지출 여부
(Optional)
escrow?: PaymentEscrow
에스크로 정보
(Optional)

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

products?: PaymentProduct[]
상품 정보
(Optional)
productCount?: integer (32 bit)
상품 갯수
(Optional)
customData?: string
사용자 지정 데이터
(Optional)
country?: Country
국가
(Optional)

국가

paidAt?: string (RFC 3339 date-time)
결제 완료 시점
(Optional)
pgTxId?: string
PG사 거래 아이디
(Optional)
cashReceipt?: PaymentCashReceipt
결제 건 내 현금영수증 정보
(Optional)

결제 건 내 현금영수증 정보

receiptUrl?: string
거래 영수증 URL
(Optional)
cancellations: PaymentCancellation[]
결제 취소 내역
cancelledAt: string (RFC 3339 date-time)
결제 취소 시점

Cardobject

publisher?: string
발행사 코드
(Optional)
issuer?: string
발급사 코드
(Optional)
brand?: CardBrand
카드 브랜드
(Optional)

카드 브랜드

type?: CardType
카드 유형
(Optional)

카드 유형

ownerType?: CardOwnerType
카드 소유주 유형
(Optional)

카드 소유주 유형

bin?: string
카드 번호 앞 6자리 또는 8자리의 BIN (Bank Identification Number)
(Optional)
name?: string
카드 상품명
(Optional)
number?: string
마스킹된 카드 번호
(Optional)

CardBrandenum

LOCAL
MASTER
UNIONPAY
VISA
JCB
AMEX
DINERS

CardCredentialobject

number: string
카드 번호 (숫자만)
expiryYear: string
유효 기간 만료 연도 (2자리)
expiryMonth: string
유효 기간 만료 월 (2자리)
birthOrBusinessRegistrationNumber?: string
생년월일 (yyMMdd) 또는 사업자 등록 번호 (10자리, 숫자만)
(Optional)
passwordTwoDigits?: string
비밀번호 앞 2자리
(Optional)

CardOwnerTypeenum

PERSONAL개인
CORPORATE법인

CardPromotionobject

type: string
프로모션 유형
id: string
프로모션 아이디
storeId: string
상점 아이디
name: string
프로모션 이름
discountPolicy: PromotionDiscountPolicy
프로모션 할인 정책

프로모션 할인 정책

totalBudget: integer (64 bit)
총 예산
maxDiscountAmount?: integer (64 bit)
최대 할인 금액
(Optional)
spentAmount: integer (64 bit)
소진 금액
currency: Currency
통화 단위

통화 단위

startAt: string (RFC 3339 date-time)
프로모션 시작 시각
endAt: string (RFC 3339 date-time)
프로모션 종료 시각
terminatedAt?: string (RFC 3339 date-time)
프로모션 중단 시각
(Optional)
cardCompany: PromotionCardCompany
프로모션 적용 가능한 카드사

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

PromotionStatus
createdAt: string (RFC 3339 date-time)
프로모션 생성 시각
recoverOption: PromotionRecoverOption
PromotionRecoverOption

CardTypeenum

CREDIT신용카드
DEBIT체크카드
GIFT기프트카드

CashReceiptunion

status: string (Union Tag)
현금영수증 상태
필드의 값이 일 때 타입은 CancelledCashReceipt 입니다.
merchantId: string
고객사 아이디
storeId: string
상점 아이디
paymentId: string
결제 건 아이디
channel: SelectedChannel
(결제, 본인인증 등에) 선택된 채널 정보

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

amount: integer (64 bit)
결제 금액
taxFreeAmount?: integer (64 bit)
면세액
(Optional)
vatAmount?: integer (64 bit)
부가세액
(Optional)
currency: Currency
통화 단위

통화 단위

orderName: string
주문명
isManual: boolean
수동 발급 여부
발급 유형
(Optional)

발급 유형

pgReceiptId?: string
PG사 현금영수증 아이디
(Optional)
issueNumber: string
승인번호
url?: string
현금영수증 URL
(Optional)
issuedAt: string (RFC 3339 date-time)
발급 시점
cancelledAt: string (RFC 3339 date-time)
취소 시점

CashReceiptAlreadyIssuedErrorobject

type: string
message?: string
(Optional)

CashReceiptInputobject

입력 시 발급 유형

입력 시 발급 유형

customerIdentityNumber?: string
사용자 식별 번호
(Optional)

미발행 유형 선택 시 입력하지 않습니다.

CashReceiptInputTypeenum

PERSONAL소득공제용
CORPORATE지출증빙용
NO_RECEIPT미발행

PG사 설정에 따라 PG사가 자동으로 자진발급 처리할 수 있습니다.

CashReceiptNotFoundErrorobject

type: string
message?: string
(Optional)

CashReceiptNotIssuedErrorobject

type: string
message?: string
(Optional)

CashReceiptSummaryobject

issueNumber: string
발행 번호
url: string
현금 영수증 URL
pgReceiptId: string
PG사 현금영수증 아이디

CashReceiptTypeenum

PERSONAL소득공제용
CORPORATE지출증빙용

ChannelGroupSummaryobject

id: string
채널 그룹 아이디
name: string
채널 그룹 이름
isForTest: boolean
테스트 채널 그룹 여부

ChannelNotFoundErrorobject

type: string
message?: string
(Optional)

ChannelSpecificErrorobject

type: string
message?: string
(Optional)
succeededChannels: SelectedChannel[]
(결제, 본인인증 등에) 선택된 채널 정보

ChannelSpecificFailureunion

type: string (Union Tag)
필드의 값이 일 때 타입은 ChannelSpecificFailureInvalidRequest 입니다.
channel: SelectedChannel
(결제, 본인인증 등에) 선택된 채널 정보

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

message?: string
(Optional)

ChannelSpecificFailureInvalidRequestobject

type: string
channel: SelectedChannel
(결제, 본인인증 등에) 선택된 채널 정보

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

message?: string
(Optional)

ChannelSpecificFailurePgProviderobject

type: string
channel: SelectedChannel
(결제, 본인인증 등에) 선택된 채널 정보

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

message?: string
(Optional)
pgCode: string
pgMessage: string

CloseVirtualAccountErrorunion

type: string (Union Tag)
필드의 값이 일 때 타입은 ForbiddenError 입니다.
message?: string
(Optional)

CloseVirtualAccountResponseobject

closedAt: string (RFC 3339 date-time)
가상계좌 말소 시점

ConfirmEscrowErrorunion

type: string (Union Tag)
필드의 값이 일 때 타입은 ForbiddenError 입니다.
message?: string
(Optional)

ConfirmEscrowResponseobject

completedAt: string (RFC 3339 date-time)
에스크로 구매 확정 시점

ConfirmIdentityVerificationErrorunion

type: string (Union Tag)
필드의 값이 일 때 타입은 ForbiddenError 입니다.
message?: string
(Optional)

ConfirmIdentityVerificationResponseobject

identityVerification: VerifiedIdentityVerification
완료된 본인인증 내역

완료된 본인인증 내역

ConfirmedPaymentEscrowobject

status: string
에스크로 상태
company: string
택배사
invoiceNumber: string
송장번호
sentAt?: string (RFC 3339 date-time)
발송 일시
(Optional)
appliedAt?: string (RFC 3339 date-time)
배송등록 처리 일자
(Optional)
isAutomaticallyConfirmed: boolean
자동 구매 확정 처리 여부

Countryenum

ADAndorra
AEUnited Arab Emirates (the)
AFAfghanistan
AGAntigua and Barbuda
AIAnguilla
ALAlbania
AMArmenia
AOAngola
AQAntarctica
ARArgentina
ASAmerican Samoa
ATAustria
AUAustralia
AWAruba
AXÅland Islands
AZAzerbaijan
BABosnia and Herzegovina
BBBarbados
BDBangladesh
BEBelgium
BFBurkina Faso
BGBulgaria
BHBahrain
BIBurundi
BJBenin
BLSaint Barthélemy
BMBermuda
BNBrunei Darussalam
BOBolivia (Plurinational State of)
BQBonaire, Sint Eustatius and Saba
BRBrazil
BSBahamas (the)
BTBhutan
BVBouvet Island
BWBotswana
BYBelarus
BZBelize
CACanada
CCCocos (Keeling) Islands (the)
CDCongo (the Democratic Republic of the)
CFCentral African Republic (the)
CGCongo (the)
CHSwitzerland
CICôte d'Ivoire
CKCook Islands (the)
CLChile
CMCameroon
CNChina
COColombia
CRCosta Rica
CUCuba
CVCabo Verde
CWCuraçao
CXChristmas Island
CYCyprus
CZCzechia
DEGermany
DJDjibouti
DKDenmark
DMDominica
DODominican Republic (the)
DZAlgeria
ECEcuador
EEEstonia
EGEgypt
EHWestern Sahara
EREritrea
ESSpain
ETEthiopia
FIFinland
FJFiji
FKFalkland Islands (the) [Malvinas]
FMMicronesia (Federated States of)
FOFaroe Islands (the)
FRFrance
GAGabon
GBUnited Kingdom of Great Britain and Northern Ireland (the)
GDGrenada
GEGeorgia
GFFrench Guiana
GGGuernsey
GHGhana
GIGibraltar
GLGreenland
GMGambia (the)
GNGuinea
GPGuadeloupe
GQEquatorial Guinea
GRGreece
GSSouth Georgia and the South Sandwich Islands
GTGuatemala
GUGuam
GWGuinea-Bissau
GYGuyana
HKHong Kong
HMHeard Island and McDonald Islands
HNHonduras
HRCroatia
HTHaiti
HUHungary
IDIndonesia
IEIreland
ILIsrael
IMIsle of Man
INIndia
IOBritish Indian Ocean Territory (the)
IQIraq
IRIran (Islamic Republic of)
ISIceland
ITItaly
JEJersey
JMJamaica
JOJordan
JPJapan
KEKenya
KGKyrgyzstan
KHCambodia
KIKiribati
KMComoros (the)
KNSaint Kitts and Nevis
KPKorea (the Democratic People's Republic of)
KRKorea (the Republic of)
KWKuwait
KYCayman Islands (the)
KZKazakhstan
LALao People's Democratic Republic (the)
LBLebanon
LCSaint Lucia
LILiechtenstein
LKSri Lanka
LRLiberia
LSLesotho
LTLithuania
LULuxembourg
LVLatvia
LYLibya
MAMorocco
MCMonaco
MDMoldova (the Republic of)
MEMontenegro
MFSaint Martin (French part)
MGMadagascar
MHMarshall Islands (the)
MKNorth Macedonia
MLMali
MMMyanmar
MNMongolia
MOMacao
MPNorthern Mariana Islands (the)
MQMartinique
MRMauritania
MSMontserrat
MTMalta
MUMauritius
MVMaldives
MWMalawi
MXMexico
MYMalaysia
MZMozambique
NANamibia
NCNew Caledonia
NENiger (the)
NFNorfolk Island
NGNigeria
NINicaragua
NLNetherlands (Kingdom of the)
NONorway
NPNepal
NRNauru
NUNiue
NZNew Zealand
OMOman
PAPanama
PEPeru
PFFrench Polynesia
PGPapua New Guinea
PHPhilippines (the)
PKPakistan
PLPoland
PMSaint Pierre and Miquelon
PNPitcairn
PRPuerto Rico
PSPalestine, State of
PTPortugal
PWPalau
PYParaguay
QAQatar
RERéunion
RORomania
RSSerbia
RURussian Federation (the)
RWRwanda
SASaudi Arabia
SBSolomon Islands
SCSeychelles
SDSudan (the)
SESweden
SGSingapore
SHSaint Helena, Ascension and Tristan da Cunha
SISlovenia
SJSvalbard and Jan Mayen
SKSlovakia
SLSierra Leone
SMSan Marino
SNSenegal
SOSomalia
SRSuriname
SSSouth Sudan
STSao Tome and Principe
SVEl Salvador
SXSint Maarten (Dutch part)
SYSyrian Arab Republic (the)
SZEswatini
TCTurks and Caicos Islands (the)
TDChad
TFFrench Southern Territories (the)
TGTogo
THThailand
TJTajikistan
TKTokelau
TLTimor-Leste
TMTurkmenistan
TNTunisia
TOTonga
TRTürkiye
TTTrinidad and Tobago
TVTuvalu
TWTaiwan (Province of China)
TZTanzania, the United Republic of
UAUkraine
UGUganda
UMUnited States Minor Outlying Islands (the)
USUnited States of America (the)
UYUruguay
UZUzbekistan
VAHoly See (the)
VCSaint Vincent and the Grenadines
VEVenezuela (Bolivarian Republic of)
VGVirgin Islands (British)
VIVirgin Islands (U.S.)
VNViet Nam
VUVanuatu
WFWallis and Futuna
WSSamoa
YEYemen
YTMayotte
ZASouth Africa
ZMZambia
ZWZimbabwe

CreateManualTransferResponseobject

수기 정산건

수기 정산건

CreateOrderCancelTransferResponseobject

주문 취소 정산건

주문 취소 정산건

CreateOrderTransferResponseobject

주문 정산건

주문 정산건

CreatePaymentScheduleErrorunion

type: string (Union Tag)
필드의 값이 일 때 타입은 AlreadyPaidOrWaitingError 입니다.
message?: string
(Optional)

CreatePaymentScheduleResponseobject

결제 예약 건

결제 예약 건

CreatePlatformAdditionalFeePolicyErrorunion

type: string (Union Tag)
필드의 값이 일 때 타입은 ForbiddenError 입니다.
message?: string
(Optional)

CreatePlatformAdditionalFeePolicyResponseobject

additionalFeePolicy: PlatformAdditionalFeePolicy
추가 수수료 정책

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

CreatePlatformContractErrorunion

type: string (Union Tag)
필드의 값이 일 때 타입은 ForbiddenError 입니다.
message?: string
(Optional)

CreatePlatformContractResponseobject

contract: PlatformContract
계약

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

CreatePlatformDiscountSharePolicyErrorunion

type: string (Union Tag)
필드의 값이 일 때 타입은 ForbiddenError 입니다.
message?: string
(Optional)

CreatePlatformDiscountSharePolicyResponseobject

discountSharePolicy: PlatformDiscountSharePolicy
할인 분담 정책

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

CreatePlatformManualTransferErrorunion

type: string (Union Tag)
필드의 값이 일 때 타입은 ForbiddenError 입니다.
message?: string
(Optional)

CreatePlatformOrderCancelTransferBodyDiscountobject

sharePolicyId: string
할인 분담 정책 아이디
amount: integer (64 bit)
할인 금액
taxFreeAmount?: integer (64 bit)
면세 할인 금액
(Optional)

CreatePlatformOrderCancelTransferBodyExternalCancellationDetailobject

cancelledAt?: string (RFC 3339 date-time)
취소 일시
(Optional)

CreatePlatformOrderCancelTransferBodyOrderDetailobject

orderAmount?: integer (64 bit)
주문 취소 금액
(Optional)
주문 취소 항목 리스트
(Optional)
(Optional)

전체 금액 취소

CreatePlatformOrderCancelTransferBodyOrderDetailAllobject

CreatePlatformOrderCancelTransferBodyOrderLineobject

productId: string
상품 아이디
quantity: integer (32 bit)
상품 수량
상품 할인 정보

CreatePlatformOrderCancelTransferErrorunion

type: string (Union Tag)
필드의 값이 일 때 타입은 ForbiddenError 입니다.
message?: string
(Optional)

CreatePlatformOrderTransferBodyAdditionalFeeobject

policyId: string
추가 수수료 정책 아이디

CreatePlatformOrderTransferBodyDiscountobject

sharePolicyId: string
할인 분담 정책 아이디
amount: integer (64 bit)
할인 금액
taxFreeAmount?: integer (64 bit)
면세 할인 금액
(Optional)

CreatePlatformOrderTransferBodyExternalPaymentDetailobject

currency: Currency
통화 단위

통화 단위

orderName?: string
주문 명
(Optional)
paidAt?: string (RFC 3339 date-time)
결제 일시
(Optional)
결제 수단 입력 정보
(Optional)

결제 수단 입력 정보

CreatePlatformOrderTransferBodyOrderDetailobject

orderAmount?: integer (64 bit)
주문 금액
(Optional)
주문 항목 리스트
(Optional)

CreatePlatformOrderTransferBodyOrderLineobject

quantity: integer (32 bit)
상품 수량
상품 할인 정보
상품 추가 수수료 정보

CreatePlatformOrderTransferBodyProductobject

id: string
상품 아이디
name: string
상품 이름
amount: integer (64 bit)
상품 금액
taxFreeAmount?: integer (64 bit)
상품 면세 금액
(Optional)
tag?: string
태그
(Optional)

CreatePlatformOrderTransferErrorunion

type: string (Union Tag)
필드의 값이 일 때 타입은 ForbiddenError 입니다.
message?: string
(Optional)

CreatePlatformPartnerBodyobject

id?: string
파트너에 부여할 고유 아이디
(Optional)

고객사 서버에 등록된 파트너 지칭 아이디와 동일하게 설정하는 것을 권장합니다. 명시하지 않는 경우 포트원이 임의의 아이디를 발급해드립니다.

name: string
파트너 법인명 혹은 이름
파트너 담당자 정보

파트너 담당자 정보

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

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

defaultContractId: string
기본 계약 아이디

이미 존재하는 계약 아이디를 등록해야 합니다.

memo?: string
파트너에 대한 메모
(Optional)

총 256자까지 입력할 수 있습니다.

tags: string[]
파트너에 부여할 태그 리스트

최대 10개까지 입력할 수 있습니다.

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

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

userDefinedProperties?: PlatformProperties
PlatformProperties
(Optional)

CreatePlatformPartnerBodyAccountobject

bank: Bank
은행

은행

currency: Currency
통화 단위

통화 단위

number: string
계좌번호
holder: string
예금주명
accountVerificationId?: string
계좌 검증 아이디
(Optional)

CreatePlatformPartnerBodyContactobject

name: string
담당자 이름
phoneNumber?: string
담당자 휴대폰 번호
(Optional)
email: string
담당자 이메일

CreatePlatformPartnerBodyTypeobject

CreatePlatformPartnerBodyTypeBusiness
(Optional)
CreatePlatformPartnerBodyTypeWhtPayer
(Optional)
CreatePlatformPartnerBodyTypeNonWhtPayer
(Optional)

CreatePlatformPartnerBodyTypeBusinessobject

companyName: string
상호명
플랫폼 파트너 과세 유형
(Optional)

플랫폼 파트너 과세 유형

businessRegistrationNumber: string
사업자등록번호
representativeName: string
대표자 이름
companyAddress?: string
사업장 주소
(Optional)
businessType?: string
업태
(Optional)
businessClass?: string
업종
(Optional)
companyVerificationId?: string
사업자 조회 검증 아이디
(Optional)

CreatePlatformPartnerBodyTypeNonWhtPayerobject

birthdate?: string
생년월일
(Optional)

날짜를 나타내는 문자열로, yyyy-MM-dd 형식을 따릅니다.

CreatePlatformPartnerBodyTypeWhtPayerobject

birthdate?: string
생년월일
(Optional)

날짜를 나타내는 문자열로, yyyy-MM-dd 형식을 따릅니다.

CreatePlatformPartnerErrorunion

type: string (Union Tag)
필드의 값이 일 때 타입은 ForbiddenError 입니다.
message?: string
(Optional)

CreatePlatformPartnerResponseobject

partner: PlatformPartner
파트너

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

CreatePlatformPartnersErrorunion

type: string (Union Tag)
필드의 값이 일 때 타입은 ForbiddenError 입니다.
message?: string
(Optional)

CreatePlatformPartnersResponseobject

생성된 파트너 리스트

Currencyenum

KRW대한민국 원화
USD미국 달러
JPY일본 엔화
AEDUAE Dirham
AFNAfghani
ALLLek
AMDArmenian Dram
ANGNetherlands Antillean Guilder
AOAKwanza
ARSArgentine Peso
AUDAustralian Dollar
AWGAruban Florin
AZNAzerbaijan Manat
BAMConvertible Mark
BBDBarbados Dollar
BDTTaka
BGNBulgarian Lev
BHDBahraini Dinar
BIFBurundi Franc
BMDBermudian Dollar
BNDBrunei Dollar
BOBBoliviano
BOVMvdol
BRLBrazilian Real
BSDBahamian Dollar
BTNNgultrum
BWPPula
BYNBelarusian Ruble
BZDBelize Dollar
CADCanadian Dollar
CDFCongolese Franc
CHEWIR Euro
CHFSwiss Franc
CHWWIR Franc
CLFUnidad de Fomento
CLPChilean Peso
CNYYuan Renminbi
COPColombian Peso
COUUnidad de Valor Real
CRCCosta Rican Colon
CUCPeso Convertible
CUPCuban Peso
CVECabo Verde Escudo
CZKCzech Koruna
DJFDjibouti Franc
DKKDanish Krone
DOPDominican Peso
DZDAlgerian Dinar
EGPEgyptian Pound
ERNNakfa
ETBEthiopian Birr
EUREuro
FJDFiji Dollar
FKPFalkland Islands Pound
GBPPound Sterling
GELLari
GHSGhana Cedi
GIPGibraltar Pound
GMDDalasi
GNFGuinean Franc
GTQQuetzal
GYDGuyana Dollar
HKDHong Kong Dollar
HNLLempira
HRKKuna (Replaced by EUR)
HTGGourde
HUFForint
IDRRupiah
ILSNew Israeli Sheqel
INRIndian Rupee
IQDIraqi Dinar
IRRIranian Rial
ISKIceland Krona
JMDJamaican Dollar
JODJordanian Dinar
KESKenyan Shilling
KGSSom
KHRRiel
KMFComorian Franc
KPWNorth Korean Won
KWDKuwaiti Dinar
KYDCayman Islands Dollar
KZTTenge
LAKLao Kip
LBPLebanese Pound
LKRSri Lanka Rupee
LRDLiberian Dollar
LSLLoti
LYDLibyan Dinar
MADMoroccan Dirham
MDLMoldovan Leu
MGAMalagasy Ariary
MKDDenar
MMKKyat
MNTTugrik
MOPPataca
MRUOuguiya
MURMauritius Rupee
MVRRufiyaa
MWKMalawi Kwacha
MXNMexican Peso
MXVMexican Unidad de Inversion (UDI)
MYRMalaysian Ringgit
MZNMozambique Metical
NADNamibia Dollar
NGNNaira
NIOCordoba Oro
NOKNorwegian Krone
NPRNepalese Rupee
NZDNew Zealand Dollar
OMRRial Omani
PABBalboa
PENSol
PGKKina
PHPPhilippine Peso
PKRPakistan Rupee
PLNZloty
PYGGuarani
QARQatari Rial
RONRomanian Leu
RSDSerbian Dinar
RUBRussian Ruble
RWFRwanda Franc
SARSaudi Riyal
SBDSolomon Islands Dollar
SCRSeychelles Rupee
SDGSudanese Pound
SEKSwedish Krona
SGDSingapore Dollar
SHPSaint Helena Pound
SLELeone
SLLLeone
SOSSomali Shilling
SRDSurinam Dollar
SSPSouth Sudanese Pound
STNDobra
SVCEl Salvador Colon
SYPSyrian Pound
SZLLilangeni
THBBaht
TJSSomoni
TMTTurkmenistan New Manat
TNDTunisian Dinar
TOPPa’anga
TRYTurkish Lira
TTDTrinidad and Tobago Dollar
TWDNew Taiwan Dollar
TZSTanzanian Shilling
UAHHryvnia
UGXUganda Shilling
USNUS Dollar (Next day)
UYIUruguay Peso en Unidades Indexadas (UI)
UYUPeso Uruguayo
UYWUnidad Previsional
UZSUzbekistan Sum
VEDBolívar Soberano
VESBolívar Soberano
VNDDong
VUVVatu
WSTTala
XAFCFA Franc BEAC
XAGSilver
XAUGold
XBABond Markets Unit European Composite Unit (EURCO)
XBBBond Markets Unit European Monetary Unit (E.M.U.-6)
XBCBond Markets Unit European Unit of Account 9 (E.U.A.-9)
XBDBond Markets Unit European Unit of Account 17 (E.U.A.-17)
XCDEast Caribbean Dollar
XDRSDR (Special Drawing Right)
XOFCFA Franc BCEAO
XPDPalladium
XPFCFP Franc
XPTPlatinum
XSUSucre
XTSCodes specifically reserved for testing purposes
XUAADB Unit of Account
XXXThe codes assigned for transactions where no currency is involved
YERYemeni Rial
ZARRand
ZMWZambian Kwacha
ZWLZimbabwe Dollar

Customerobject

id?: string
고객 아이디
(Optional)

고객사가 지정한 고객의 고유 식별자입니다.

name?: string
이름
(Optional)
birthYear?: string
출생 연도
(Optional)
gender?: Gender
성별
(Optional)

성별

email?: string
이메일
(Optional)
phoneNumber?: string
전화번호
(Optional)
address?: Address
분리 형식 주소
(Optional)

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

zipcode?: string
우편번호
(Optional)

CustomerInputobject

id?: string
고객 아이디
(Optional)

고객사가 지정한 고객의 고유 식별자입니다.

고객 이름 입력 정보
(Optional)

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

birthYear?: string
출생 연도
(Optional)
birthMonth?: string
출생월
(Optional)
birthDay?: string
출생일
(Optional)
country?: Country
국가
(Optional)

국가

gender?: Gender
성별
(Optional)

성별

email?: string
이메일
(Optional)
phoneNumber?: string
전화번호
(Optional)
분리 형식 주소 입력 정보
(Optional)

분리 형식 주소 입력 정보

zipcode?: string
우편번호
(Optional)
businessRegistrationNumber?: string
사업자 등록 번호
(Optional)

CustomerNameInputobject

full?: string
한 줄 이름 형식
(Optional)
고객 분리형 이름
(Optional)

고객 분리형 이름

CustomerSeparatedNameobject

first: string
이름
last: string

DateRangeobject

from: string

날짜를 나타내는 문자열로, yyyy-MM-dd 형식을 따릅니다.

until: string

날짜를 나타내는 문자열로, yyyy-MM-dd 형식을 따릅니다.

DateTimeRangeobject

from: string (RFC 3339 date-time)
until: string (RFC 3339 date-time)

DayOfWeekenum

SUN
MON
TUE
WED
THU
FRI
SAT

DeleteBillingKeyErrorunion