개발자센터
V1
V2
릴리즈 노트 기술 블로그

PortOne REST API - V2

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

V2 API hostname: api.portone.io

요청 및 응답 형식

요청과 응답의 본문은 JSON 형식입니다.
API 응답에 포함된 필드는 별도 안내 없이 추가될 수 있으니, 알지 못하는 필드가 있는 경우에는 무시하도록 개발해 주세요.

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

인증 방식

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

인증 관련 API를 제외한 모든 API는 HTTP Authorization 헤더로 인증 정보를 전달해 주셔야 합니다. Authorization 헤더에 전달하는 형식은 두 가지 중 하나입니다.

  • API Secret 직접 사용 (간편)
    Authorization: PortOne MY_API_SECRET
  • 액세스 토큰 사용
    Authorization: Bearer MY_ACCESS_TOKEN
액세스 토큰을 사용한 인증을 원하는 경우, 인증 관련 API를 이용해 주세요.

GET 요청 시 Body 대신 Query 사용

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

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


인증 관련 API

결제 관련 API

결제 예약 관련 API

빌링키 관련 API

현금 영수증 관련 API

본인인증 관련 API

B2B 서비스 API

B2B 관련 API 기능을 제공합니다. alpha 버전의 API 로서, 사용을 원하실 경우 관리자콘솔 및 홈페이지를 통해 문의해주세요.

목차

연동 사업자 조회
get/b2b-preview/member-companies/{brn}
연동 사업자 정보 수정
patch/b2b-preview/member-companies/{brn}
사업자 연동
post/b2b-preview/member-companies
담당자 조회
get/b2b-preview/member-companies/{brn}/contacts/{contactId}
담당자 정보 수정
patch/b2b-preview/member-companies/{brn}/contacts/{contactId}
사업자 인증서 등록 URL 조회
get/b2b-preview/member-companies/{brn}/certificate/registration-url
인증서 조회
get/b2b-preview/member-companies/{brn}/certificate
담당자 ID 존재 여부 확인
get/b2b-preview/member-companies/contacts/id-existence
예금주 조회
get/b2b-preview/bank-accounts/{bank}/{accountNumber}/holder
사업자 상태 조회
get/b2b-preview/company/{brn}/state
세금계산서 역발행 요청
post/b2b-preview/tax-invoices/request-reverse-issuance
세금 계산서 조회
get/b2b-preview/tax-invoices/{documentKey}
세금계산서 삭제
delete/b2b-preview/tax-invoices/{documentKey}
세금계산서 발행
post/b2b-preview/tax-invoices/issue
세금계산서 역발행 요청 취소
post/b2b-preview/tax-invoices/cancel-request
세금계산서 역발행 취소
post/b2b-preview/tax-invoices/cancel-issuance
세금계산서 역발행 요청 거부
post/b2b-preview/tax-invoices/refuse-request
세금 계산서 다건조회
get/b2b-preview/tax-invoices
세금 계산서 팝업 URL 조회
get/b2b-preview/tax-invoices/{documentKey}/popup-url
세금 계산서 프린트 URL 조회
get/b2b-preview/tax-invoices/{documentKey}/print-url
세금 계산서 PDF 다운로드 URL 조회
get/b2b-preview/tax-invoices/{documentKey}/pdf-download-url
세금계산서 임시 저장
post/b2b-preview/tax-invoices/register
세금계산서 역발행 요청
post/b2b-preview/tax-invoices/request
세금계산서 파일 업로드 링크 생성
post/b2b-preview/tax-invoices/file-upload-link
세금계산서 파일 첨부
post/b2b-preview/tax-invoices/attach-file
세금계산서 첨부파일 목록 조회
get/b2b-preview/tax-invoices/{documentKey}/attachments
세금계산서 첨부파일 삭제
delete/b2b-preview/tax-invoices/{documentKey}/attachments/{attachmentId}

특정 PG사 관련 API

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

타입 정의

API 요청/응답의 각 필드에서 사용되는 타입 정의들을 확인할 수 있습니다
AddressAlreadyPaidErrorAlreadyPaidOrWaitingErrorApplyEscrowLogisticsErrorApplyEscrowLogisticsResponseAttachB2bTaxInvoiceFileErrorB2bBankAccountNotFoundErrorB2bCertificateB2bCertificateTypeB2bCertificateUnregisteredErrorB2bCompanyAlreadyRegisteredErrorB2bCompanyContactB2bCompanyContactInputB2bCompanyNotFoundErrorB2bCompanyStateB2bCompanyStateBusinessStatusB2bCompanyStateTaxationTypeB2bContactNotFoundErrorB2bExternalServiceErrorB2bFileNotFoundErrorB2bFinancialSystemCommunicationErrorB2bFinancialSystemFailureErrorB2bFinancialSystemUnderMaintenanceErrorB2bForeignExchangeAccountErrorB2bHometaxUnderMaintenanceErrorB2bIdAlreadyExistsErrorB2bMemberCompanyB2bMemberCompanyNotFoundErrorB2bModificationB2bNotEnabledErrorB2bRecipientNotFoundErrorB2bRegularMaintenanceTimeErrorB2bSearchDateTypeB2bSupplierNotFoundErrorB2bSuspendedAccountErrorB2bTaxInvoiceB2bTaxInvoiceAdditionalContactB2bTaxInvoiceAttachmentB2bTaxInvoiceAttachmentNotFoundErrorB2bTaxInvoiceBeforeSendingB2bTaxInvoiceCompanyB2bTaxInvoiceContactB2bTaxInvoiceDocumentKeyTypeB2bTaxInvoiceInputB2bTaxInvoiceIssuanceCancelledB2bTaxInvoiceIssuedB2bTaxInvoiceItemB2bTaxInvoiceModificationTypeB2bTaxInvoiceNoRecipientDocumentKeyErrorB2bTaxInvoiceNoSupplierDocumentKeyErrorB2bTaxInvoiceNonDeletableStatusErrorB2bTaxInvoiceNotFoundErrorB2bTaxInvoiceNotIssuedStatusErrorB2bTaxInvoiceNotRegisteredStatusErrorB2bTaxInvoiceNotRequestedStatusErrorB2bTaxInvoicePurposeTypeB2bTaxInvoiceRegisteredB2bTaxInvoiceRequestCancelledB2bTaxInvoiceRequestRefusedB2bTaxInvoiceRequestedB2bTaxInvoiceSendingB2bTaxInvoiceSendingCompletedB2bTaxInvoiceSendingFailedB2bTaxInvoiceStatusB2bTaxInvoiceSummaryB2bTaxInvoiceWaitingSendingB2bTaxTypeBankBeforeRegisteredPaymentEscrowBillingKeyAlreadyDeletedErrorBillingKeyInfoBillingKeyInfoSummaryBillingKeyNotFoundErrorBillingKeyNotIssuedErrorBillingKeyPaymentInputBillingKeyPaymentMethodBillingKeyPaymentMethodCardBillingKeyPaymentMethodEasyPayBillingKeyPaymentMethodEasyPayChargeBillingKeyPaymentMethodEasyPayMethodBillingKeyPaymentMethodMobileBillingKeyPaymentMethodPaypalBillingKeyPaymentMethodTransferBillingKeyPaymentSummaryCancelAmountExceedsCancellableAmountErrorCancelB2bTaxInvoiceIssuanceErrorCancelB2bTaxInvoiceRequestErrorCancelCashReceiptErrorCancelCashReceiptResponseCancelPaymentBodyRefundAccountCancelPaymentErrorCancelPaymentResponseCancelRequesterCancelTaxAmountExceedsCancellableTaxAmountErrorCancelTaxFreeAmountExceedsCancellableTaxFreeAmountErrorCancellableAmountConsistencyBrokenErrorCancelledCashReceiptCancelledPaymentCancelledPaymentCashReceiptCancelledPaymentEscrowCardCardBrandCardCredentialCardOwnerTypeCardTypeCashReceiptCashReceiptAlreadyIssuedErrorCashReceiptInputCashReceiptInputTypeCashReceiptNotFoundErrorCashReceiptNotIssuedErrorCashReceiptSummaryCashReceiptTypeChannelNotFoundErrorCloseVirtualAccountErrorCloseVirtualAccountResponseConfirmEscrowErrorConfirmEscrowResponseConfirmIdentityVerificationErrorConfirmIdentityVerificationResponseConfirmedPaymentEscrowCountryCreateB2bTaxInvoiceFileUploadLinkCreateErrorCreateB2bTaxInvoiceFileUploadLinkResponseCreatePaymentScheduleErrorCreatePaymentScheduleResponseCurrencyCustomerCustomerInputCustomerNameInputCustomerSeparatedNameDateTimeRangeDeleteB2bTaxInvoiceAttachmentErrorDeleteB2bTaxInvoiceErrorDeleteBillingKeyErrorDeleteBillingKeyResponseDeliveredPaymentEscrowEasyPayProviderFailedIdentityVerificationFailedPaymentFailedPaymentCancellationFailedPaymentScheduleForbiddenErrorGenderGetAllPaymentsByCursorResponseGetAllPaymentsErrorGetB2bAccountHolderErrorGetB2bBankAccountHolderResponseGetB2bCertificateErrorGetB2bCertificateRegistrationUrlErrorGetB2bCertificateRegistrationUrlResponseGetB2bCompanyStateErrorGetB2bContactIdExistenceResponseGetB2bMemberCompanyContactErrorGetB2bMemberCompanyErrorGetB2bTaxInvoiceAttachmentsErrorGetB2bTaxInvoiceAttachmentsResponseGetB2bTaxInvoiceErrorGetB2bTaxInvoicePdfDownloadUrlErrorGetB2bTaxInvoicePdfDownloadUrlResponseGetB2bTaxInvoicePopupUrlErrorGetB2bTaxInvoicePopupUrlResponseGetB2bTaxInvoicePrintUrlErrorGetB2bTaxInvoicePrintUrlResponseGetB2bTaxInvoicesErrorGetB2bTaxInvoicesResponseGetBillingKeyInfoErrorGetCashReceiptErrorGetIdentityVerificationErrorGetKakaopayPaymentOrderErrorGetKakaopayPaymentOrderResponseGetPaymentErrorGetPaymentScheduleErrorGetPaymentSchedulesErrorGetPaymentSchedulesResponseGetPaymentsErrorGetPaymentsResponseIdentityVerificationIdentityVerificationAlreadySentErrorIdentityVerificationAlreadyVerifiedErrorIdentityVerificationMethodIdentityVerificationNotFoundErrorIdentityVerificationNotSentErrorIdentityVerificationOperatorIdentityVerificationRequestedCustomerIdentityVerificationVerifiedCustomerInstantBillingKeyPaymentMethodInputInstantBillingKeyPaymentMethodInputCardInstantPaymentMethodInputInstantPaymentMethodInputCardInstantPaymentMethodInputVirtualAccountInstantPaymentMethodInputVirtualAccountCashReceiptInfoInstantPaymentMethodInputVirtualAccountExpiryInstantPaymentMethodInputVirtualAccountOptionInstantPaymentMethodInputVirtualAccountOptionFixedInstantPaymentMethodInputVirtualAccountOptionTypeInstantPaymentSummaryInvalidRequestErrorIssueB2bTaxInvoiceErrorIssueBillingKeyErrorIssueBillingKeyResponseIssueCashReceiptCustomerInputIssueCashReceiptErrorIssueCashReceiptResponseIssueFailedCashReceiptIssuedCashReceiptIssuedPaymentCashReceiptLoginViaApiSecretErrorLoginViaApiSecretResponseModifyEscrowLogisticsErrorModifyEscrowLogisticsResponseOneLineAddressPageInfoPageInputPaidPaymentPartialCancelledPaymentPayInstantlyErrorPayInstantlyResponsePayPendingPaymentPayWithBillingKeyErrorPayWithBillingKeyResponsePaymentPaymentAlreadyCancelledErrorPaymentAmountPaymentAmountInputPaymentCancellationPaymentCashReceiptPaymentCashReceiptStatusPaymentClientTypePaymentEscrowPaymentEscrowReceiverInputPaymentEscrowSenderInputPaymentFilterInputPaymentFilterInputEscrowStatusPaymentInstallmentPaymentLogisticsPaymentLogisticsCompanyPaymentMethodPaymentMethodCardPaymentMethodEasyPayPaymentMethodEasyPayMethodPaymentMethodEasyPayMethodChargePaymentMethodGiftCertificatePaymentMethodGiftCertificateTypePaymentMethodMobilePaymentMethodTransferPaymentMethodTypePaymentMethodVirtualAccountPaymentMethodVirtualAccountRefundStatusPaymentMethodVirtualAccountTypePaymentNotFoundErrorPaymentNotPaidErrorPaymentNotWaitingForDepositErrorPaymentProductPaymentProductTypePaymentSchedulePaymentScheduleAlreadyExistsErrorPaymentScheduleAlreadyProcessedErrorPaymentScheduleAlreadyRevokedErrorPaymentScheduleFilterInputPaymentScheduleNotFoundErrorPaymentScheduleSortByPaymentScheduleSortInputPaymentScheduleStatusPaymentScheduleSummaryPaymentSortByPaymentStatusPaymentTextSearchPaymentTextSearchFieldPaymentTimestampTypePaymentWebhookPaymentWebhookPaymentStatusPaymentWebhookRequestPaymentWebhookResponsePaymentWebhookStatusPaymentWebhookTriggerPaymentWithCursorPendingPaymentSchedulePgProviderPgProviderErrorPortOneVersionPreRegisterPaymentErrorPreRegisterPaymentResponseReadyIdentityVerificationReadyPaymentRefreshTokenErrorRefreshTokenResponseRefuseB2bTaxInvoiceRequestErrorRegisterB2bMemberCompanyErrorRegisterB2bMemberCompanyResponseRegisterStoreReceiptBodyItemRegisterStoreReceiptErrorRegisterStoreReceiptResponseRegisteredPaymentEscrowRejectConfirmedPaymentEscrowRejectedPaymentEscrowRequestB2bTaxInvoiceRegisterErrorRequestB2bTaxInvoiceReverseIssuanceErrorRequestedPaymentCancellationResendIdentityVerificationErrorResendIdentityVerificationResponseResendWebhookErrorResendWebhookResponseRevokePaymentScheduleErrorRevokePaymentScheduleResponseRevokedPaymentScheduleScheduledPaymentScheduleSelectedChannelSelectedChannelTypeSendIdentityVerificationBodyCustomerSendIdentityVerificationErrorSendIdentityVerificationResponseSeparatedAddressSeparatedAddressInputSortOrderStartedPaymentScheduleSucceededPaymentCancellationSucceededPaymentScheduleSumOfPartsExceedsCancelAmountErrorSumOfPartsExceedsTotalAmountErrorUnauthorizedErrorUpdateB2bMemberCompanyContactErrorUpdateB2bMemberCompanyContactResponseUpdateB2bMemberCompanyErrorUpdateB2bMemberCompanyResponseVerifiedIdentityVerificationVirtualAccountIssuedPaymentWebhookNotFoundErrorgetB2bContactIdExistenceErrorrequestB2bTaxInvoiceError

Addressunion

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

AlreadyPaidErrorobject

type: string
message?: string
(Optional)

AlreadyPaidOrWaitingErrorobject

type: string
message?: string
(Optional)

ApplyEscrowLogisticsErrorunion

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

ApplyEscrowLogisticsResponseobject

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

AttachB2bTaxInvoiceFileErrorunion

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

B2bBankAccountNotFoundErrorobject

type: string
message?: string
(Optional)

B2bCertificateobject

registeredAt: string (RFC 3339 date-time)
등록일시
expiredAt: string (RFC 3339 date-time)
만료일시
issuerDn: string
발행자명
subjectDn: string
본인명
certificateType: B2bCertificateType
인증서 타입

인증서 타입

oid: string
OID
registrantContactName: string
등록 담당자 성명
registrantContactId: string
등록 담당자 ID

B2bCertificateTypeenum

E_TAX전자세금용 공동인증서
POP_BILL팝빌 특목용 공동인증서
ETC기타

B2bCertificateUnregisteredErrorobject

type: string
message?: string
(Optional)

B2bCompanyAlreadyRegisteredErrorobject

type: string
message?: string
(Optional)

B2bCompanyContactobject

id: string
담당자 ID

팝빌 로그인 계정으로 사용됩니다.

name: string
담당자 성명
phoneNumber: string
담당자 핸드폰 번호
email: string
담당자 이메일
registeredAt: string (RFC 3339 date-time)
등록 일시
isManager: boolean
관리자 여부

true일 경우 관리자, false일 경우 담당자입니다.

B2bCompanyContactInputobject

id: string
담당자 ID

팝빌 로그인 계정으로 사용됩니다.

password: string
비밀번호
name: string
담당자 성명
phoneNumber: string
담당자 핸드폰 번호
email: string
담당자 이메일

B2bCompanyNotFoundErrorobject

type: string
message?: string
(Optional)

B2bCompanyStateobject

사업자 과세 유형

사업자 과세 유형

taxationTypeDate?: string
과세 유형 변경 일자
(Optional)

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

영업 상태

영업 상태

closedSuspendedDate?: string
휴폐업 일자
(Optional)

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

B2bCompanyStateBusinessStatusenum

IN_BUSINESS영업중
CLOSED폐업
SUSPENDED휴업

B2bCompanyStateTaxationTypeenum

SIMPLE간이 과세
ASSIGNED_ID_NUMBER비영리법인 또는 국가기관, 고유번호가 부여된 단체
TAX_FREE면세
SIMPLE_TAX_INVOICE_ISSUER간이 과세 세금계산서 발급 사업자
NORMAL일반 과세

B2bContactNotFoundErrorobject

type: string
message?: string
(Optional)

B2bExternalServiceErrorobject

type: string
message: string

B2bFileNotFoundErrorobject

type: string
message?: string
(Optional)

B2bFinancialSystemCommunicationErrorobject

type: string
message?: string
(Optional)

B2bFinancialSystemFailureErrorobject

type: string
message?: string
(Optional)

B2bFinancialSystemUnderMaintenanceErrorobject

type: string
message?: string
(Optional)

B2bForeignExchangeAccountErrorobject

type: string
message?: string
(Optional)

B2bHometaxUnderMaintenanceErrorobject

type: string
message?: string
(Optional)

B2bIdAlreadyExistsErrorobject

type: string
message?: string
(Optional)

B2bMemberCompanyobject

brn: string
사업자등록번호
  • 없이 숫자로만 구성됩니다.
name: string
회사명
ceoName: string
대표자 성명
address: string
회사 주소
businessType: string
업태
businessClass: string
업종

B2bMemberCompanyNotFoundErrorobject

type: string
message?: string
(Optional)

B2bModificationobject

수정 사유

수정 사유

originalNtsApproveNumber: string
수정 대상 원본 세금계산서 국세청 승인 번호

B2bNotEnabledErrorobject

type: string
message?: string
(Optional)

B2bRecipientNotFoundErrorobject

type: string
message?: string
(Optional)

B2bRegularMaintenanceTimeErrorobject

type: string
message?: string
(Optional)

B2bSearchDateTypeenum

REGISTER등록일
WRITE작성일
ISSUE발행일

B2bSupplierNotFoundErrorobject

type: string
message?: string
(Optional)

B2bSuspendedAccountErrorobject

type: string
message?: string
(Optional)

B2bTaxInvoiceunion

status: string (Union Tag)
세금계산서 상태
필드의 값이 일 때 타입은 B2bTaxInvoiceBeforeSending 입니다.
taxType: B2bTaxType
과세 유형

과세 유형

serialNum?: string
일련번호
(Optional)
bookVolume?: integer (32 bit)
책번호 - 권
(Optional)

입력 범위(4자리) : 0 ~ 9999

bookIssue?: integer (32 bit)
책번호 - 호
(Optional)

입력 범위(4자리) : 0 ~ 9999

writeDate: string
작성일

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

영수/청구

영수/청구

supplyCostTotalAmount: integer (64 bit)
공급가액 합계
taxTotalAmount: integer (64 bit)
세액 합계
totalAmount: integer (64 bit)
합계 금액
cashAmount?: integer (64 bit)
현금
(Optional)
checkAmount?: integer (64 bit)
수표
(Optional)
creditAmount?: integer (64 bit)
외상
(Optional)
noteAmount?: integer (64 bit)
수표
(Optional)
remarks: string[]
비고

최대 3개

supplierDocumentKey?: string
공급자 문서번호
(Optional)
recipientDocumentKey?: string
공급받는자 문서번호
(Optional)
sendSms: boolean
문자 전송 여부
modification?: B2bModification
세금 계산서 수정
(Optional)

세금 계산서 수정

품목

최대 99개

추가 담당자

최대 3개

statusUpdatedAt: string (RFC 3339 date-time)
상태 변경 일시
issuedAt: string (RFC 3339 date-time)
발행 일시
ntsApproveNumber: string
국세청 승인번호

세금계산서 발행(전자서명) 시점에 자동으로 부여

B2bTaxInvoiceAdditionalContactobject

name?: string
성명
(Optional)

최대 100자

email: string
이메일

B2bTaxInvoiceAttachmentobject

id: string
첨부 파일 아이디
name: string
첨부 파일명
attachedAt: string (RFC 3339 date-time)
첨부 일시

B2bTaxInvoiceAttachmentNotFoundErrorobject

type: string
message?: string
(Optional)

B2bTaxInvoiceBeforeSendingobject

status: string
세금계산서 상태
taxType: B2bTaxType
과세 유형

과세 유형

serialNum?: string
일련번호
(Optional)
bookVolume?: integer (32 bit)
책번호 - 권
(Optional)

입력 범위(4자리) : 0 ~ 9999

bookIssue?: integer (32 bit)
책번호 - 호
(Optional)

입력 범위(4자리) : 0 ~ 9999

writeDate: string
작성일

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

영수/청구

영수/청구

supplyCostTotalAmount: integer (64 bit)
공급가액 합계
taxTotalAmount: integer (64 bit)
세액 합계
totalAmount: integer (64 bit)
합계 금액
cashAmount?: integer (64 bit)
현금
(Optional)
checkAmount?: integer (64 bit)
수표
(Optional)
creditAmount?: integer (64 bit)
외상
(Optional)
noteAmount?: integer (64 bit)
수표
(Optional)
remarks: string[]
비고

최대 3개

supplierDocumentKey?: string
공급자 문서번호
(Optional)
recipientDocumentKey?: string
공급받는자 문서번호
(Optional)
sendSms: boolean
문자 전송 여부
modification?: B2bModification
세금 계산서 수정
(Optional)

세금 계산서 수정

품목

최대 99개

추가 담당자

최대 3개

statusUpdatedAt: string (RFC 3339 date-time)
상태 변경 일시
issuedAt: string (RFC 3339 date-time)
발행 일시
ntsApproveNumber: string
국세청 승인번호

세금계산서 발행(전자서명) 시점에 자동으로 부여

B2bTaxInvoiceCompanyobject

brn: string
사업자등록번호
  • 를 제외한 10자리
taxRegistrationId?: string
종사업자 식별 번호
(Optional)

4자리 고정

name?: string
상호명
(Optional)

최대 200자

ceoName?: string
대표자 성명
(Optional)

최대 100자

address?: string
주소
(Optional)

최대 300자

businessType?: string
업태
(Optional)

최대 100자

businessClass?: string
종목
(Optional)

최대 100자

세금계산서 담당자
(Optional)

세금계산서 담당자

B2bTaxInvoiceContactobject

name?: string
성명
(Optional)
department?: string
부서
(Optional)
phoneNumber?: string
전화번호
(Optional)
mobilePhoneNumber?: string
휴대전화번호
(Optional)
email?: string
이메일
(Optional)

B2bTaxInvoiceDocumentKeyTypeenum

SUPPLIER공급자
RECIPIENT공급받는자

B2bTaxInvoiceInputobject

taxType: B2bTaxType
과세 유형

과세 유형

serialNum?: string
일련번호
(Optional)
bookVolume?: integer (32 bit)
(Optional)
bookIssue?: integer (32 bit)
(Optional)
writeDate: string
작성일

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

영수/청구

영수/청구

supplyCostTotalAmount: integer (64 bit)
공급가액 합계
taxTotalAmount: integer (64 bit)
세액 합계
totalAmount: integer (64 bit)
합계 금액
cashAmount?: integer (64 bit)
현금
(Optional)
checkAmount?: integer (64 bit)
수표
(Optional)
creditAmount?: integer (64 bit)
외상
(Optional)
noteAmount?: integer (64 bit)
수표
(Optional)
remarks?: string[]
비고
(Optional)

최대 3개

supplierDocumentKey?: string
공급자 문서번호
(Optional)

영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능

recipientDocumentKey?: string
공급받는자 문서번호
(Optional)

영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능

sendSms?: boolean
문자 전송 여부
(Optional)

공급자 담당자 휴대폰번호 {supplier.contact.mobile_phone_number} 값으로 문자 전송 전송시 포인트 차감되며, 실패시 환불 처리 기본값은 false

modification?: B2bModification
세금 계산서 수정
(Optional)

세금 계산서 수정

품목
(Optional)

최대 99개

추가 담당자
(Optional)

최대 3개

B2bTaxInvoiceIssuanceCancelledobject

status: string
세금계산서 상태
taxType: B2bTaxType
과세 유형

과세 유형

serialNum?: string
일련번호
(Optional)
bookVolume?: integer (32 bit)
책번호 - 권
(Optional)

입력 범위(4자리) : 0 ~ 9999

bookIssue?: integer (32 bit)
책번호 - 호
(Optional)

입력 범위(4자리) : 0 ~ 9999

writeDate: string
작성일

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

영수/청구

영수/청구

supplyCostTotalAmount: integer (64 bit)
공급가액 합계
taxTotalAmount: integer (64 bit)
세액 합계
totalAmount: integer (64 bit)
합계 금액
cashAmount?: integer (64 bit)
현금
(Optional)
checkAmount?: integer (64 bit)
수표
(Optional)
creditAmount?: integer (64 bit)
외상
(Optional)
noteAmount?: integer (64 bit)
수표
(Optional)
remarks: string[]
비고

최대 3개

supplierDocumentKey?: string
공급자 문서번호
(Optional)
recipientDocumentKey?: string
공급받는자 문서번호
(Optional)
sendSms: boolean
문자 전송 여부
modification?: B2bModification
세금 계산서 수정
(Optional)

세금 계산서 수정

품목

최대 99개

추가 담당자

최대 3개

statusUpdatedAt: string (RFC 3339 date-time)
상태 변경 일시
issuedAt: string (RFC 3339 date-time)
발행 일시
ntsApproveNumber: string
국세청 승인번호

세금계산서 발행(전자서명) 시점에 자동으로 부여

recipientBusinessStatus?: B2bCompanyStateBusinessStatus
영업 상태
(Optional)

영업 상태

recipientClosedSuspendedDate?: string
공급받는자 휴폐업일자
(Optional)

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

B2bTaxInvoiceIssuedobject

status: string
세금계산서 상태
taxType: B2bTaxType
과세 유형

과세 유형

serialNum?: string
일련번호
(Optional)
bookVolume?: integer (32 bit)
책번호 - 권
(Optional)

입력 범위(4자리) : 0 ~ 9999

bookIssue?: integer (32 bit)
책번호 - 호
(Optional)

입력 범위(4자리) : 0 ~ 9999

writeDate: string
작성일

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

영수/청구

영수/청구

supplyCostTotalAmount: integer (64 bit)
공급가액 합계
taxTotalAmount: integer (64 bit)
세액 합계
totalAmount: integer (64 bit)
합계 금액
cashAmount?: integer (64 bit)
현금
(Optional)
checkAmount?: integer (64 bit)
수표
(Optional)
creditAmount?: integer (64 bit)
외상
(Optional)
noteAmount?: integer (64 bit)
수표
(Optional)
remarks: string[]
비고

최대 3개

supplierDocumentKey?: string
공급자 문서번호
(Optional)
recipientDocumentKey?: string
공급받는자 문서번호
(Optional)
sendSms: boolean
문자 전송 여부
modification?: B2bModification
세금 계산서 수정
(Optional)

세금 계산서 수정

품목

최대 99개

추가 담당자

최대 3개

statusUpdatedAt: string (RFC 3339 date-time)
상태 변경 일시
issuedAt: string (RFC 3339 date-time)
발행 일시
ntsApproveNumber: string
국세청 승인번호

세금계산서 발행(전자서명) 시점에 자동으로 부여

B2bTaxInvoiceItemobject

purchaseDate?: string
결제일
(Optional)

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

name?: string
품명
(Optional)

최대 100자

spec?: string
규격
(Optional)

최대 100자

quantity?: integer (64 bit)
수량
(Optional)

입력 범위 : -99999999.99 ~ 999999999.99, 10^-quantityScale 단위로 치환됨

quantityScale?: integer (32 bit)
수량 단위
(Optional)

입력 범위 : 0 ~ 2, 기본값: 0

unitCostAmount?: integer (64 bit)
단가
(Optional)

입력 범위 : -99999999999999.99 ~ 999999999999999.99

unitCostAmountScale?: integer (32 bit)
단가 단위
(Optional)

입력 범위 : 0 ~ 2, 기본값: 0

supplyCostAmount?: integer (64 bit)
공급가액
(Optional)
taxAmount?: integer (64 bit)
세액
(Optional)
remark?: string
비고
(Optional)

B2bTaxInvoiceModificationTypeenum

DUPLICATE_ISSUANCE_DUE_TO_ERROR착오에 의한 이중 발급
CHANGE_IN_SUPPLY_COST공금가액 변동
CANCELLATION_OF_CONTRACT계약 해제
POST_ISSUANCE_LOCAL_LETTER_OF_CREDIT내국신용장 사후개설
CORRECTION_OF_ENTRY_ERRORS기재사항 착오 정정
RETURN환입

B2bTaxInvoiceNoRecipientDocumentKeyErrorobject

type: string
message?: string
(Optional)

B2bTaxInvoiceNoSupplierDocumentKeyErrorobject

type: string
message?: string
(Optional)

B2bTaxInvoiceNonDeletableStatusErrorobject

type: string
message?: string
(Optional)

B2bTaxInvoiceNotFoundErrorobject

type: string
message?: string
(Optional)

B2bTaxInvoiceNotIssuedStatusErrorobject

type: string
message?: string
(Optional)

B2bTaxInvoiceNotRegisteredStatusErrorobject

type: string
message?: string
(Optional)

B2bTaxInvoiceNotRequestedStatusErrorobject

type: string
message?: string
(Optional)

B2bTaxInvoicePurposeTypeenum

RECEIPT
INVOICE
NONE

B2bTaxInvoiceRegisteredobject

status: string
세금계산서 상태
taxType: B2bTaxType
과세 유형

과세 유형

serialNum?: string
일련번호
(Optional)
bookVolume?: integer (32 bit)
책번호 - 권
(Optional)

입력 범위(4자리) : 0 ~ 9999

bookIssue?: integer (32 bit)
책번호 - 호
(Optional)

입력 범위(4자리) : 0 ~ 9999

writeDate: string
작성일

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

영수/청구

영수/청구

supplyCostTotalAmount: integer (64 bit)
공급가액 합계
taxTotalAmount: integer (64 bit)
세액 합계
totalAmount: integer (64 bit)
합계 금액
cashAmount?: integer (64 bit)
현금
(Optional)
checkAmount?: integer (64 bit)
수표
(Optional)
creditAmount?: integer (64 bit)
외상
(Optional)
noteAmount?: integer (64 bit)
수표
(Optional)
remarks: string[]
비고

최대 3개

supplierDocumentKey?: string
공급자 문서번호
(Optional)
recipientDocumentKey?: string
공급받는자 문서번호
(Optional)
sendSms: boolean
문자 전송 여부
modification?: B2bModification
세금 계산서 수정
(Optional)

세금 계산서 수정

품목

최대 99개

추가 담당자

최대 3개

statusUpdatedAt: string (RFC 3339 date-time)
상태 변경 일시

B2bTaxInvoiceRequestCancelledobject

status: string
세금계산서 상태
taxType: B2bTaxType
과세 유형

과세 유형

serialNum?: string
일련번호
(Optional)
bookVolume?: integer (32 bit)
책번호 - 권
(Optional)

입력 범위(4자리) : 0 ~ 9999

bookIssue?: integer (32 bit)
책번호 - 호
(Optional)

입력 범위(4자리) : 0 ~ 9999

writeDate: string
작성일

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

영수/청구

영수/청구

supplyCostTotalAmount: integer (64 bit)
공급가액 합계
taxTotalAmount: integer (64 bit)
세액 합계
totalAmount: integer (64 bit)
합계 금액
cashAmount?: integer (64 bit)
현금
(Optional)
checkAmount?: integer (64 bit)
수표
(Optional)
creditAmount?: integer (64 bit)
외상
(Optional)
noteAmount?: integer (64 bit)
수표
(Optional)
remarks: string[]
비고

최대 3개

supplierDocumentKey?: string
공급자 문서번호
(Optional)
recipientDocumentKey?: string
공급받는자 문서번호
(Optional)
sendSms: boolean
문자 전송 여부
modification?: B2bModification
세금 계산서 수정
(Optional)

세금 계산서 수정

품목

최대 99개

추가 담당자

최대 3개

statusUpdatedAt: string (RFC 3339 date-time)
상태 변경 일시

B2bTaxInvoiceRequestRefusedobject

status: string
세금계산서 상태
taxType: B2bTaxType
과세 유형

과세 유형

serialNum?: string
일련번호
(Optional)
bookVolume?: integer (32 bit)
책번호 - 권
(Optional)

입력 범위(4자리) : 0 ~ 9999

bookIssue?: integer (32 bit)
책번호 - 호
(Optional)

입력 범위(4자리) : 0 ~ 9999

writeDate: string
작성일

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

영수/청구

영수/청구

supplyCostTotalAmount: integer (64 bit)
공급가액 합계
taxTotalAmount: integer (64 bit)
세액 합계
totalAmount: integer (64 bit)
합계 금액
cashAmount?: integer (64 bit)
현금
(Optional)
checkAmount?: integer (64 bit)
수표
(Optional)
creditAmount?: integer (64 bit)
외상
(Optional)
noteAmount?: integer (64 bit)
수표
(Optional)
remarks: string[]
비고

최대 3개

supplierDocumentKey?: string
공급자 문서번호
(Optional)
recipientDocumentKey?: string
공급받는자 문서번호
(Optional)
sendSms: boolean
문자 전송 여부
modification?: B2bModification
세금 계산서 수정
(Optional)

세금 계산서 수정

품목

최대 99개

추가 담당자

최대 3개

statusUpdatedAt: string (RFC 3339 date-time)
상태 변경 일시

B2bTaxInvoiceRequestedobject

status: string
세금계산서 상태
taxType: B2bTaxType
과세 유형

과세 유형

serialNum?: string
일련번호
(Optional)
bookVolume?: integer (32 bit)
책번호 - 권
(Optional)

입력 범위(4자리) : 0 ~ 9999

bookIssue?: integer (32 bit)
책번호 - 호
(Optional)

입력 범위(4자리) : 0 ~ 9999

writeDate: string
작성일

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

영수/청구

영수/청구

supplyCostTotalAmount: integer (64 bit)
공급가액 합계
taxTotalAmount: integer (64 bit)
세액 합계
totalAmount: integer (64 bit)
합계 금액
cashAmount?: integer (64 bit)
현금
(Optional)
checkAmount?: integer (64 bit)
수표
(Optional)
creditAmount?: integer (64 bit)
외상
(Optional)
noteAmount?: integer (64 bit)
수표
(Optional)
remarks: string[]
비고

최대 3개

supplierDocumentKey?: string
공급자 문서번호
(Optional)
recipientDocumentKey?: string
공급받는자 문서번호
(Optional)
sendSms: boolean
문자 전송 여부
modification?: B2bModification
세금 계산서 수정
(Optional)

세금 계산서 수정

품목

최대 99개

추가 담당자

최대 3개

statusUpdatedAt: string (RFC 3339 date-time)
상태 변경 일시

B2bTaxInvoiceSendingobject

status: string
세금계산서 상태
taxType: B2bTaxType
과세 유형

과세 유형

serialNum?: string
일련번호
(Optional)
bookVolume?: integer (32 bit)
책번호 - 권
(Optional)

입력 범위(4자리) : 0 ~ 9999

bookIssue?: integer (32 bit)
책번호 - 호
(Optional)

입력 범위(4자리) : 0 ~ 9999

writeDate: string
작성일

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

영수/청구

영수/청구

supplyCostTotalAmount: integer (64 bit)
공급가액 합계
taxTotalAmount: integer (64 bit)
세액 합계
totalAmount: integer (64 bit)
합계 금액
cashAmount?: integer (64 bit)
현금
(Optional)
checkAmount?: integer (64 bit)
수표
(Optional)
creditAmount?: integer (64 bit)
외상
(Optional)
noteAmount?: integer (64 bit)
수표
(Optional)
remarks: string[]
비고

최대 3개

supplierDocumentKey?: string
공급자 문서번호
(Optional)
recipientDocumentKey?: string
공급받는자 문서번호
(Optional)
sendSms: boolean
문자 전송 여부
modification?: B2bModification
세금 계산서 수정
(Optional)

세금 계산서 수정

품목

최대 99개

추가 담당자

최대 3개

statusUpdatedAt: string (RFC 3339 date-time)
상태 변경 일시
issuedAt: string (RFC 3339 date-time)
발행 일시
ntsApproveNumber: string
국세청 승인번호

세금계산서 발행(전자서명) 시점에 자동으로 부여

ntsSentAt: string (RFC 3339 date-time)
국세청 전송 일시

B2bTaxInvoiceSendingCompletedobject

status: string
세금계산서 상태
taxType: B2bTaxType
과세 유형

과세 유형

serialNum?: string
일련번호
(Optional)
bookVolume?: integer (32 bit)
책번호 - 권
(Optional)

입력 범위(4자리) : 0 ~ 9999

bookIssue?: integer (32 bit)
책번호 - 호
(Optional)

입력 범위(4자리) : 0 ~ 9999

writeDate: string
작성일

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

영수/청구

영수/청구

supplyCostTotalAmount: integer (64 bit)
공급가액 합계
taxTotalAmount: integer (64 bit)
세액 합계
totalAmount: integer (64 bit)
합계 금액
cashAmount?: integer (64 bit)
현금
(Optional)
checkAmount?: integer (64 bit)
수표
(Optional)
creditAmount?: integer (64 bit)
외상
(Optional)
noteAmount?: integer (64 bit)
수표
(Optional)
remarks: string[]
비고

최대 3개

supplierDocumentKey?: string
공급자 문서번호
(Optional)
recipientDocumentKey?: string
공급받는자 문서번호
(Optional)
sendSms: boolean
문자 전송 여부
modification?: B2bModification
세금 계산서 수정
(Optional)

세금 계산서 수정

품목

최대 99개

추가 담당자

최대 3개

statusUpdatedAt: string (RFC 3339 date-time)
상태 변경 일시
issuedAt: string (RFC 3339 date-time)
발행 일시
ntsApproveNumber: string
국세청 승인번호

세금계산서 발행(전자서명) 시점에 자동으로 부여

ntsSentAt: string (RFC 3339 date-time)
국세청 전송 일시
ntsResult?: string
국세청 전송 결과
(Optional)
ntsResultCode?: string
국세청 결과 코드
(Optional)

국세청 발급 결과 코드로 영문 3자리 + 숫자 3자리로 구성됨

ntsResultReceivedAt: string (RFC 3339 date-time)
국세청 결과 수신 일시

B2bTaxInvoiceSendingFailedobject

status: string
세금계산서 상태
taxType: B2bTaxType
과세 유형

과세 유형

serialNum?: string
일련번호
(Optional)
bookVolume?: integer (32 bit)
책번호 - 권
(Optional)

입력 범위(4자리) : 0 ~ 9999

bookIssue?: integer (32 bit)
책번호 - 호
(Optional)

입력 범위(4자리) : 0 ~ 9999

writeDate: string
작성일

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

영수/청구

영수/청구

supplyCostTotalAmount: integer (64 bit)
공급가액 합계
taxTotalAmount: integer (64 bit)
세액 합계
totalAmount: integer (64 bit)
합계 금액
cashAmount?: integer (64 bit)
현금
(Optional)
checkAmount?: integer (64 bit)
수표
(Optional)
creditAmount?: integer (64 bit)
외상
(Optional)
noteAmount?: integer (64 bit)
수표
(Optional)
remarks: string[]
비고

최대 3개

supplierDocumentKey?: string
공급자 문서번호
(Optional)
recipientDocumentKey?: string
공급받는자 문서번호
(Optional)
sendSms: boolean
문자 전송 여부
modification?: B2bModification
세금 계산서 수정
(Optional)

세금 계산서 수정

품목

최대 99개

추가 담당자

최대 3개

statusUpdatedAt: string (RFC 3339 date-time)
상태 변경 일시
issuedAt: string (RFC 3339 date-time)
발행 일시
ntsApproveNumber: string
국세청 승인번호

세금계산서 발행(전자서명) 시점에 자동으로 부여

ntsSentAt: string (RFC 3339 date-time)
국세청 전송 일시
ntsResult?: string
국세청 전송 결과
(Optional)
ntsResultCode?: string
국세청 결과 코드
(Optional)

국세청 발급 결과 코드로 영문 3자리 + 숫자 3자리로 구성됨

ntsResultReceivedAt: string (RFC 3339 date-time)
국세청 결과 수신 일시

B2bTaxInvoiceStatusenum

BEFORE_SENDING전송전
SENDING_FAILED전송실패
REQUEST_REFUSED공급자의 발행거부
REQUEST_CANCELLED_BY_RECIPIENT공급받는자에 의한 발행취소
ISSUANCE_CANCELLED_BY_SUPPLIER공급자에 의한 발행 취소
REQUESTED역발행대기 (전자 서명 요청됨)
ISSUED발행완료
SENDING_COMPLETED전송완료
REGISTERED임시저장
SENDING전송중
WAITING_SENDING전송대기

B2bTaxInvoiceSummaryobject

taxType: B2bTaxType
과세 유형

과세 유형

supplyCostTotalAmount: integer (64 bit)
공급가액 합계
taxTotalAmount: integer (64 bit)
세액 합계
영수/청구

영수/청구

supplierBrn: string
공급자 사업자등록번호
supplierName: string
공급자 상호
supplierDocumentKey?: string
공급자 문서번호
(Optional)
recipientBrn: string
공급받는자 사업자등록번호
recipientName: string
공급받는자 상호
recipientDocumentKey?: string
공급받는자 문서번호
(Optional)
recipientBusinessStatus?: B2bCompanyStateBusinessStatus
영업 상태
(Optional)

영업 상태

recipientClosedSuspendedDate?: string
공급받는자 휴폐업일자
(Optional)

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

issuedAt?: string (RFC 3339 date-time)
발행 일시
(Optional)
openedAt?: string (RFC 3339 date-time)
개봉 일시
(Optional)
statusUpdatedAt: string (RFC 3339 date-time)
상태 변경 일시
ntsApproveNumber?: string
국세청 승인번호
(Optional)

세금계산서 발행(전자서명) 시점에 자동으로 부여

ntsResult?: string
국세청 전송 결과
(Optional)
ntsSentAt?: string (RFC 3339 date-time)
국세청 전송 일시
(Optional)
ntsResultReceivedAt?: string (RFC 3339 date-time)
국세청 결과 수신 일시
(Optional)
ntsResultCode?: string
국세청 결과 코드
(Optional)

국세청 발급 결과 코드로 영문 3자리 + 숫자 3자리로 구성됨

B2bTaxInvoiceWaitingSendingobject

status: string
세금계산서 상태
taxType: B2bTaxType
과세 유형

과세 유형

serialNum?: string
일련번호
(Optional)
bookVolume?: integer (32 bit)
책번호 - 권
(Optional)

입력 범위(4자리) : 0 ~ 9999

bookIssue?: integer (32 bit)
책번호 - 호
(Optional)

입력 범위(4자리) : 0 ~ 9999

writeDate: string
작성일

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

영수/청구

영수/청구

supplyCostTotalAmount: integer (64 bit)
공급가액 합계
taxTotalAmount: integer (64 bit)
세액 합계
totalAmount: integer (64 bit)
합계 금액
cashAmount?: integer (64 bit)
현금
(Optional)
checkAmount?: integer (64 bit)
수표
(Optional)
creditAmount?: integer (64 bit)
외상
(Optional)
noteAmount?: integer (64 bit)
수표
(Optional)
remarks: string[]
비고

최대 3개

supplierDocumentKey?: string
공급자 문서번호
(Optional)
recipientDocumentKey?: string
공급받는자 문서번호
(Optional)
sendSms: boolean
문자 전송 여부
modification?: B2bModification
세금 계산서 수정
(Optional)

세금 계산서 수정

품목

최대 99개

추가 담당자

최대 3개

statusUpdatedAt: string (RFC 3339 date-time)
상태 변경 일시
issuedAt: string (RFC 3339 date-time)
발행 일시
ntsApproveNumber: string
국세청 승인번호

세금계산서 발행(전자서명) 시점에 자동으로 부여

B2bTaxTypeenum

TAXABLE과세
ZERO_RATED영세
FREE면세

Bankenum

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

BeforeRegisteredPaymentEscrowobject

status: string
에스크로 상태

BillingKeyAlreadyDeletedErrorobject

type: string
message?: string
(Optional)

BillingKeyInfoobject

billingKey: string
빌링키
merchantId: string
가맹점 아이디
storeId: string
상점 아이디
빌링키 결제수단 상세 정보
(Optional)

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

빌링키 발급 시 사용된 채널

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

customer: Customer
고객 정보

고객 정보

customData?: string
사용자 지정 데이터
(Optional)
issueId?: string
가맹점이 채번하는 빌링키 발급 건 고유 아이디
(Optional)
issueName?: string
빌링키 발급 건 이름
(Optional)
issuedAt: string (RFC 3339 date-time)
발급 시점

BillingKeyInfoSummaryobject

billingKey: string
발급된 빌링키
issuedAt: string (RFC 3339 date-time)
빌링크 발급 완료 시점

BillingKeyNotFoundErrorobject

type: string
message?: string
(Optional)

BillingKeyNotIssuedErrorobject

type: string
message?: string
(Optional)

BillingKeyPaymentInputobject

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

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

billingKey: string
빌링키 결제에 사용할 빌링키
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)

분리 형식 주소 입력 정보

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?: string
표준 은행 코드
(Optional)
accountNumber?: string
계좌번호
(Optional)

BillingKeyPaymentSummaryobject

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

CancelAmountExceedsCancellableAmountErrorobject

type: string
message?: string
(Optional)

CancelB2bTaxInvoiceIssuanceErrorunion

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

CancelB2bTaxInvoiceRequestErrorunion

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

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
(결제, 본인인증 등에) 선택된 채널 정보

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

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)

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

VISA
JCB
DINERS
MASTER
LOCAL
AMEX
UNIONPAY

CardCredentialobject

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

CardOwnerTypeenum

PERSONAL개인
CORPORATE법인

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지출증빙용

ChannelNotFoundErrorobject

type: string
message?: string
(Optional)

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

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

CreateB2bTaxInvoiceFileUploadLinkCreateErrorunion

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

CreateB2bTaxInvoiceFileUploadLinkResponseobject

fileId: string
파일 아이디
url: string
파일 업로드 링크

CreatePaymentScheduleErrorunion

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

CreatePaymentScheduleResponseobject

결제 예약 건

결제 예약 건

Currencyenum

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

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

DateTimeRangeobject

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

DeleteB2bTaxInvoiceAttachmentErrorunion

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

DeleteB2bTaxInvoiceErrorunion

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

DeleteBillingKeyErrorunion

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

DeleteBillingKeyResponseobject

deletedAt: string (RFC 3339 date-time)
빌링키 삭제 완료 시점

DeliveredPaymentEscrowobject

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

EasyPayProviderenum

KB_APP
PAYCO
NAVERPAY
CHAI
PINPAY
TOSS_BRANDPAY
LGPAY
APPLEPAY
SAMSUNGPAY
KPAY
SKPAY
KAKAOPAY
ALIPAY
LPAY
TOSSPAY
SSGPAY

FailedIdentityVerificationobject

status: string
본인인증 상태
id: string
본인인증 내역 아이디
channel?: SelectedChannel
(결제, 본인인증 등에) 선택된 채널 정보
(Optional)

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

요청 시 고객 정보

요청 시 고객 정보

customData?: string
사용자 지정 데이터
(Optional)
requestedAt: string (RFC 3339 date-time)
본인인증 요청 시점
updatedAt: string (RFC 3339 date-time)
업데이트 시점
statusChangedAt: string (RFC 3339 date-time)
상태 업데이트 시점

FailedPaymentobject

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

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

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

결제수단 정보

channel?: SelectedChannel
(결제, 본인인증 등에) 선택된 채널 정보
(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)

국가

failedAt: string (RFC 3339 date-time)
결제 실패 시점

FailedPaymentCancellationobject

status: string
결제 취소 내역 상태
id: string
취소 내역 아이디
pgCancellationId?: string
PG사 결제 취소 내역 아이디
(Optional)
totalAmount: integer (64 bit)
취소 총 금액
taxFreeAmount: integer (64 bit)
취소 금액 중 면세 금액
vatAmount: integer (64 bit)
취소 금액 중 부가세액
easyPayDiscountAmount?: integer (64 bit)
적립형 포인트의 환불 금액
(Optional)
reason: string
취소 사유
cancelledAt?: string (RFC 3339 date-time)
취소 시점
(Optional)
requestedAt: string (RFC 3339 date-time)
취소 요청 시점

FailedPaymentScheduleobject

status: string
결제 예약 건 상태
id: string
결제 예약 건 아이디
merchantId: string
가맹점 아이디
storeId: string
상점 아이디
paymentId: string
결제 건 아이디
billingKey: string
빌링키
orderName: string
주문명
isCulturalExpense: boolean
문화비 지출 여부
isEscrow: boolean
에스크로 결제 여부
customer: Customer
고객 정보

고객 정보

customData: string
사용자 지정 데이터
totalAmount: integer (64 bit)
결제 총 금액
taxFreeAmount?: integer (64 bit)
면세액
(Optional)
vatAmount?: integer (64 bit)
부가세
(Optional)
currency: Currency
통화 단위

통화 단위

installmentMonth?: integer (32 bit)
할부 개월 수
(Optional)
noticeUrls?: string[]
웹훅 주소
(Optional)
products?: PaymentProduct[]
상품 정보
(Optional)
createdAt: string (RFC 3339 date-time)
결제 예약 등록 시점
timeToPay: string (RFC 3339 date-time)
결제 예정 시점
startedAt: string (RFC 3339 date-time)
결제 시작 시점
completedAt: string (RFC 3339 date-time)
결제 완료 시점

ForbiddenErrorobject

type: string
message?: string
(Optional)

Genderenum

MALE남성
FEMALE여성
OTHER그 외 성별

GetAllPaymentsByCursorResponseobject

조회된 결제 건 및 커서 정보 리스트

GetAllPaymentsErrorunion

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

GetB2bAccountHolderErrorunion

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

GetB2bBankAccountHolderResponseobject

accountHolder: string
예금주

GetB2bCertificateErrorunion

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

GetB2bCertificateRegistrationUrlErrorunion

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

GetB2bCertificateRegistrationUrlResponseobject

url: string
인증서 등록 URL

GetB2bCompanyStateErrorunion

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

GetB2bContactIdExistenceResponseobject

exists: boolean
존재 여부

GetB2bMemberCompanyContactErrorunion

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

GetB2bMemberCompanyErrorunion

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

GetB2bTaxInvoiceAttachmentsErrorunion

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

GetB2bTaxInvoiceAttachmentsResponseobject

첨부파일 목록

GetB2bTaxInvoiceErrorunion

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

GetB2bTaxInvoicePdfDownloadUrlErrorunion

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

GetB2bTaxInvoicePdfDownloadUrlResponseobject

url: string
세금계산서 PDF 다운로드 URL

GetB2bTaxInvoicePopupUrlErrorunion

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

GetB2bTaxInvoicePopupUrlResponseobject

url: string
세금계산서 팝업 URL

GetB2bTaxInvoicePrintUrlErrorunion

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

GetB2bTaxInvoicePrintUrlResponseobject

url: string
세금계산서 프린트 URL

GetB2bTaxInvoicesErrorunion

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

GetB2bTaxInvoicesResponseobject

조회된 세금계산서 목록
page: PageInfo
반환된 페이지 결과 정보

반환된 페이지 결과 정보

GetBillingKeyInfoErrorunion

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

GetCashReceiptErrorunion

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

GetIdentityVerificationErrorunion

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

GetKakaopayPaymentOrderErrorunion

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

GetKakaopayPaymentOrderResponseobject

statusCode: integer (32 bit)
HTTP 상태 코드
body: string
HTTP 응답 본문 (JSON)

GetPaymentErrorunion

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

GetPaymentScheduleErrorunion

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

GetPaymentSchedulesErrorunion

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

GetPaymentSchedulesResponseobject

조회된 결제 예약 건 리스트
page: PageInfo
반환된 페이지 결과 정보

반환된 페이지 결과 정보

GetPaymentsErrorunion

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

GetPaymentsResponseobject

items: Payment[]
조회된 결제 건 리스트
page: PageInfo
반환된 페이지 결과 정보

반환된 페이지 결과 정보

IdentityVerificationunion

status: string (Union Tag)
본인인증 상태
필드의 값이 일 때 타입은 FailedIdentityVerification 입니다.
id: string
본인인증 내역 아이디
channel?: SelectedChannel
(결제, 본인인증 등에) 선택된 채널 정보
(Optional)

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

요청 시 고객 정보

요청 시 고객 정보

customData?: string
사용자 지정 데이터
(Optional)
requestedAt: string (RFC 3339 date-time)
본인인증 요청 시점
updatedAt: string (RFC 3339 date-time)
업데이트 시점
statusChangedAt: string (RFC 3339 date-time)
상태 업데이트 시점

IdentityVerificationAlreadySentErrorobject

type: string
message?: string
(Optional)

IdentityVerificationAlreadyVerifiedErrorobject

type: string
message?: string
(Optional)

IdentityVerificationMethodenum

SMS
APP

IdentityVerificationNotFoundErrorobject

type: string
message?: string
(Optional)

IdentityVerificationNotSentErrorobject

type: string
message?: string
(Optional)

IdentityVerificationOperatorenum

SKTSKT
KTKT
KT_MVNOKT 알뜰폰
LGU_MVNOLGU 알뜰폰
SKT_MVNOSKT 알뜰폰
LGULGU

IdentityVerificationRequestedCustomerobject

id?: string
식별 아이디
(Optional)
name?: string
이름
(Optional)
phoneNumber?: string
전화번호
(Optional)

특수 문자(-) 없이 숫자로만 이루어진 번호 형식입니다.

IdentityVerificationVerifiedCustomerobject

id?: string
식별 아이디
(Optional)
name: string
이름
본인인증 통신사
(Optional)

본인인증 통신사

phoneNumber?: string
전화번호
(Optional)

특수 문자(-) 없이 숫자로만 이루어진 번호 형식입니다.

birthDate: string
생년월일 (yyyy-MM-dd)

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

gender: Gender
성별

성별

isForeigner?: boolean
외국인 여부
(Optional)
ci: string
CI (개인 고유 식별키)
di: string
DI (사이트별 개인 고유 식별키)

InstantBillingKeyPaymentMethodInputobject

카드 수단 정보 입력 양식
(Optional)

카드 수단 정보 입력 양식

InstantBillingKeyPaymentMethodInputCardobject

credential: CardCredential
카드 인증 관련 정보

카드 인증 관련 정보

InstantPaymentMethodInputobject

카드 수단 정보 입력 정보
(Optional)

카드 수단 정보 입력 정보

가상계좌 수단 정보 입력 정보
(Optional)

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

InstantPaymentMethodInputCardobject

credential: CardCredential
카드 인증 관련 정보

카드 인증 관련 정보

installmentMonth?: integer (32 bit)
카드 할부 개월 수
(Optional)
useFreeInstallmentPlan?: boolean
무이자 할부 적용 여부
(Optional)
useFreeInterestFromMerchant?: boolean
무이자 할부 이자를 가맹점이 부담할지 여부
(Optional)
useCardPoint?: boolean
카드 포인트 사용 여부
(Optional)

InstantPaymentMethodInputVirtualAccountobject

bank: Bank
은행

은행

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

가상계좌 발급 방식

가상계좌 발급 방식

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

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

remitteeName?: string
예금주명
(Optional)

InstantPaymentMethodInputVirtualAccountCashReceiptInfoobject

입력 시 발급 유형

입력 시 발급 유형

customerIdentityNumber: string
사용자 식별 번호

InstantPaymentMethodInputVirtualAccountExpiryobject

validHours?: integer (32 bit)
유효 시간
(Optional)

시간 단위로 입력합니다.

dueDate?: string (RFC 3339 date-time)
만료 시점
(Optional)

InstantPaymentMethodInputVirtualAccountOptionobject

가상계좌 발급 유형

가상계좌 발급 유형

고정식 가상계좌 발급 유형
(Optional)

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

InstantPaymentMethodInputVirtualAccountOptionFixedobject

pgAccountId?: string
Account ID 고정식 가상계좌
(Optional)

가맹점이 가상계좌번호를 직접 관리하지 않고 PG사가 pgAccountId에 매핑되는 가상계좌번호를 내려주는 방식입니다. 동일한 pgAccountId로 가상계좌 발급 요청시에는 항상 같은 가상계좌번호가 내려옵니다.

accountNumber?: string
Account Number 고정식 가상계좌
(Optional)

PG사가 일정 개수만큼의 가상계좌번호를 발급하여 가맹점에게 미리 전달하고 가맹점이 그 중 하나를 선택하여 사용하는 방식입니다.

InstantPaymentMethodInputVirtualAccountOptionTypeenum

NORMAL회전식 가상계좌

일반적으로 사용되는 방식이며 PG사에서 직접 채번한 가상계좌번호를 사용합니다.

FIXED고정식 가상계좌

InstantPaymentSummaryobject

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

InvalidRequestErrorobject

type: string
message?: string
(Optional)

IssueB2bTaxInvoiceErrorunion

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

IssueBillingKeyErrorunion

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

IssueBillingKeyResponseobject

billingKeyInfo: BillingKeyInfoSummary

IssueCashReceiptCustomerInputobject

identityNumber: string
고객 식별값
name?: string
이름
(Optional)
email?: string
이메일
(Optional)
phoneNumber?: string
전화번호
(Optional)

IssueCashReceiptErrorunion

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

IssueCashReceiptResponseobject

cashReceipt: CashReceiptSummary
현금영수증 내역

현금영수증 내역

IssueFailedCashReceiptobject

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

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

orderName: string
주문명
isManual: boolean
수동 발급 여부

IssuedCashReceiptobject

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)
발급 시점

IssuedPaymentCashReceiptobject

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)
발급 시점

LoginViaApiSecretErrorunion

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

LoginViaApiSecretResponseobject

accessToken: string
인증에 사용하는 엑세스 토큰

하루의 유효기간을 가지고 있습니다.

refreshToken: string
토큰 재발급 및 유효기간 연장을 위해 사용하는 리프레시 토큰

일주일의 유효기간을 가지고 있으며, 리프레시 토큰을 통해 유효기간이 연장된 새로운 엑세스 토큰을 발급받을 수 있습니다.

ModifyEscrowLogisticsErrorunion

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

ModifyEscrowLogisticsResponseobject

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

OneLineAddressobject

type: string
oneLine: string
주소 (한 줄)

PageInfoobject

number: integer (32 bit)
요청된 페이지 번호
size: integer (32 bit)
요청된 페이지 당 객체 수
totalCount: integer (32 bit)
실제 반환된 객체 수

PageInputobject

number?: integer (32 bit)
0부터 시작하는 페이지 번호
(Optional)
size?: integer (32 bit)
각 페이지 당 포함할 객체 수
(Optional)

PaidPaymentobject

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

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

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

결제수단 정보

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

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

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)
결제 완료 시점
pgTxId?: string
PG사 거래 아이디
(Optional)
pgResponse?: string
PG사 거래 응답 본문
(Optional)
cashReceipt?: PaymentCashReceipt
결제 건 내 현금영수증 정보
(Optional)

결제 건 내 현금영수증 정보

receiptUrl?: string
거래 영수증 URL
(Optional)

PartialCancelledPaymentobject

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

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

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

결제수단 정보

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

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

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: