PortOne REST API - V2

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

V2 API hostname: api.portone.io

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

요청 및 응답 형식

요청과 응답의 본문은 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 기능을 제공합니다.

빌링키 관련 API

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

현금 영수증 관련 API

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

본인인증 관련 API

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

B2B 서비스 API

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

특정 PG사 관련 API

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

타입 정의

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

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

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

담당자 성명

phoneNumber: string

담당자 핸드폰 번호

email: string

담당자 이메일

registeredAt: string (RFC 3339 date-time)

등록 일시

isManager: boolean

관리자 여부

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

B2bCompanyContactInputobject

id: string

담당자 ID

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

password: string

비밀번호

담당자 성명

phoneNumber: string

담당자 핸드폰 번호

email: string

담당자 이메일

B2bCompanyNotFoundErrorobject

type: string

message?: string

(Optional)

B2bCompanyStateobject

taxationType: B2bCompanyStateTaxationType

사업자 과세 유형

taxationTypeDate?: string

과세 유형 변경 일자

(Optional)

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

businessStatus: B2bCompanyStateBusinessStatus

영업 상태

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

사업자등록번호

없이 숫자로만 구성됩니다.

회사명

ceoName: string

대표자 성명

address: string

회사 주소

businessType: string

업태

businessClass: string

업종

B2bMemberCompanyNotFoundErrorobject

type: string

message?: string

(Optional)

B2bModificationobject

type: B2bTaxInvoiceModificationType

수정 사유

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 형식을 따릅니다.

purposeType: B2bTaxInvoicePurposeType

영수/청구

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)

supplier: B2bTaxInvoiceCompany

recipientDocumentKey?: string

공급받는자 문서번호

(Optional)

recipient: B2bTaxInvoiceCompany

sendSms: boolean

문자 전송 여부

modification?: B2bModification

세금 계산서 수정

(Optional)

세금 계산서 수정

items: B2bTaxInvoiceItem[]

품목

최대 99개

contacts: B2bTaxInvoiceAdditionalContact[]

추가 담당자

최대 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

첨부 파일 아이디

첨부 파일명

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 형식을 따릅니다.

purposeType: B2bTaxInvoicePurposeType

영수/청구

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)

supplier: B2bTaxInvoiceCompany

recipientDocumentKey?: string

공급받는자 문서번호

(Optional)

recipient: B2bTaxInvoiceCompany

sendSms: boolean

문자 전송 여부

modification?: B2bModification

세금 계산서 수정

(Optional)

세금 계산서 수정

items: B2bTaxInvoiceItem[]

품목

최대 99개

contacts: B2bTaxInvoiceAdditionalContact[]

추가 담당자

최대 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자

contact?: B2bTaxInvoiceContact

세금계산서 담당자

(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 형식을 따릅니다.

purposeType: B2bTaxInvoicePurposeType

영수/청구

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)

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

supplier: B2bTaxInvoiceCompany

recipientDocumentKey?: string

공급받는자 문서번호

(Optional)

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

recipient: B2bTaxInvoiceCompany

sendSms?: boolean

문자 전송 여부

(Optional)

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

modification?: B2bModification

세금 계산서 수정

(Optional)

세금 계산서 수정

items?: B2bTaxInvoiceItem[]

품목

(Optional)

최대 99개

contacts?: B2bTaxInvoiceAdditionalContact[]

추가 담당자

(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 형식을 따릅니다.

purposeType: B2bTaxInvoicePurposeType

영수/청구

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)

supplier: B2bTaxInvoiceCompany

recipientDocumentKey?: string

공급받는자 문서번호

(Optional)

recipient: B2bTaxInvoiceCompany

sendSms: boolean

문자 전송 여부

modification?: B2bModification

세금 계산서 수정

(Optional)

세금 계산서 수정

items: B2bTaxInvoiceItem[]

품목

최대 99개

contacts: B2bTaxInvoiceAdditionalContact[]

추가 담당자

최대 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 형식을 따릅니다.

purposeType: B2bTaxInvoicePurposeType

영수/청구

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)

supplier: B2bTaxInvoiceCompany

recipientDocumentKey?: string

공급받는자 문서번호

(Optional)

recipient: B2bTaxInvoiceCompany

sendSms: boolean

문자 전송 여부

modification?: B2bModification

세금 계산서 수정

(Optional)

세금 계산서 수정

items: B2bTaxInvoiceItem[]

품목

최대 99개

contacts: B2bTaxInvoiceAdditionalContact[]

추가 담당자

최대 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 형식을 따릅니다.

purposeType: B2bTaxInvoicePurposeType

영수/청구

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)

supplier: B2bTaxInvoiceCompany

recipientDocumentKey?: string

공급받는자 문서번호

(Optional)

recipient: B2bTaxInvoiceCompany

sendSms: boolean

문자 전송 여부

modification?: B2bModification

세금 계산서 수정

(Optional)

세금 계산서 수정

items: B2bTaxInvoiceItem[]

품목

최대 99개

contacts: B2bTaxInvoiceAdditionalContact[]

추가 담당자

최대 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 형식을 따릅니다.

purposeType: B2bTaxInvoicePurposeType

영수/청구

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)

supplier: B2bTaxInvoiceCompany

recipientDocumentKey?: string

공급받는자 문서번호

(Optional)

recipient: B2bTaxInvoiceCompany

sendSms: boolean

문자 전송 여부

modification?: B2bModification

세금 계산서 수정

(Optional)

세금 계산서 수정

items: B2bTaxInvoiceItem[]

품목

최대 99개

contacts: B2bTaxInvoiceAdditionalContact[]

추가 담당자

최대 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 형식을 따릅니다.

purposeType: B2bTaxInvoicePurposeType

영수/청구

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)

supplier: B2bTaxInvoiceCompany

recipientDocumentKey?: string

공급받는자 문서번호

(Optional)

recipient: B2bTaxInvoiceCompany

sendSms: boolean

문자 전송 여부

modification?: B2bModification

세금 계산서 수정

(Optional)

세금 계산서 수정

items: B2bTaxInvoiceItem[]

품목

최대 99개

contacts: B2bTaxInvoiceAdditionalContact[]

추가 담당자

최대 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 형식을 따릅니다.

purposeType: B2bTaxInvoicePurposeType

영수/청구

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)

supplier: B2bTaxInvoiceCompany

recipientDocumentKey?: string

공급받는자 문서번호

(Optional)

recipient: B2bTaxInvoiceCompany

sendSms: boolean

문자 전송 여부

modification?: B2bModification

세금 계산서 수정

(Optional)

세금 계산서 수정

items: B2bTaxInvoiceItem[]

품목

최대 99개

contacts: B2bTaxInvoiceAdditionalContact[]

추가 담당자

최대 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 형식을 따릅니다.

purposeType: B2bTaxInvoicePurposeType

영수/청구

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)

supplier: B2bTaxInvoiceCompany

recipientDocumentKey?: string

공급받는자 문서번호

(Optional)

recipient: B2bTaxInvoiceCompany

sendSms: boolean

문자 전송 여부

modification?: B2bModification

세금 계산서 수정

(Optional)

세금 계산서 수정

items: B2bTaxInvoiceItem[]

품목

최대 99개

contacts: B2bTaxInvoiceAdditionalContact[]

추가 담당자

최대 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 형식을 따릅니다.

purposeType: B2bTaxInvoicePurposeType

영수/청구

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)

supplier: B2bTaxInvoiceCompany

recipientDocumentKey?: string

공급받는자 문서번호

(Optional)

recipient: B2bTaxInvoiceCompany

sendSms: boolean

문자 전송 여부

modification?: B2bModification

세금 계산서 수정

(Optional)

세금 계산서 수정

items: B2bTaxInvoiceItem[]

품목

최대 99개

contacts: B2bTaxInvoiceAdditionalContact[]

추가 담당자

최대 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 형식을 따릅니다.

purposeType: B2bTaxInvoicePurposeType

영수/청구

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)

supplier: B2bTaxInvoiceCompany

recipientDocumentKey?: string

공급받는자 문서번호

(Optional)

recipient: B2bTaxInvoiceCompany

sendSms: boolean

문자 전송 여부

modification?: B2bModification

세금 계산서 수정

(Optional)

세금 계산서 수정

items: B2bTaxInvoiceItem[]

품목

최대 99개

contacts: B2bTaxInvoiceAdditionalContact[]

추가 담당자

최대 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)

세액 합계

purposeType: B2bTaxInvoicePurposeType

영수/청구

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)

status: B2bTaxInvoiceStatus

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 형식을 따릅니다.

purposeType: B2bTaxInvoicePurposeType

영수/청구

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)

supplier: B2bTaxInvoiceCompany

recipientDocumentKey?: string

공급받는자 문서번호

(Optional)

recipient: B2bTaxInvoiceCompany

sendSms: boolean

문자 전송 여부

modification?: B2bModification

세금 계산서 수정

(Optional)

세금 계산서 수정

items: B2bTaxInvoiceItem[]

품목

최대 99개

contacts: B2bTaxInvoiceAdditionalContact[]

추가 담당자

최대 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

상점 아이디

methods?: BillingKeyPaymentMethod[]

빌링키 결제수단 상세 정보

(Optional)

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

channels: SelectedChannel[]

빌링키 발급 시 사용된 채널

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

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)

amount: PaymentAmountInput

금액 세부 입력 정보

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)

간편 결제사

method?: BillingKeyPaymentMethodEasyPayMethod

간편 결제 수단

(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

결제 취소 내역

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

수동 발급 여부

type?: CashReceiptType

발급 유형

(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)

cashReceipt?: PaymentCashReceipt

결제 건 내 현금영수증 정보

(Optional)

결제 건 내 현금영수증 정보

receiptUrl?: string

거래 영수증 URL

(Optional)

cancellations: PaymentCancellation[]

결제 취소 내역

cancelledAt: string (RFC 3339 date-time)

결제 취소 시점

CancelledPaymentCashReceiptobject

status: string

결제 건 내 현금영수증 상태

type?: CashReceiptType

발급 유형

(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

유효 기간 만료 연도

expiryMonth: string

유효 기간 만료 월

birthOrBusinessRegistrationNumber?: string

생년월일 또는 사업자 등록 번호

(Optional)

passwordTwoDigits?: string

비밀번호 앞 두자리

(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

수동 발급 여부

type?: CashReceiptType

발급 유형

(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

type: CashReceiptInputType

입력 시 발급 유형

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

schedule: PaymentScheduleSummary

결제 예약 건

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)

가맹점이 지정한 고객의 고유 식별자입니다.

name?: CustomerNameInput

고객 이름 입력 정보

(Optional)

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

birthYear?: string

출생 연도

(Optional)

birthMonth?: string

출생월

(Optional)

birthDay?: string

출생일

(Optional)

country?: Country

국가

(Optional)

국가

gender?: Gender

성별

(Optional)

성별

email?: string

이메일

(Optional)

phoneNumber?: string

전화번호

(Optional)

address?: SeparatedAddressInput

분리 형식 주소 입력 정보

(Optional)

분리 형식 주소 입력 정보

zipcode?: string

우편번호

(Optional)

businessRegistrationNumber?: string

사업자 등록 번호

(Optional)

CustomerNameInputobject

full?: string

한 줄 이름 형식

(Optional)

separated?: CustomerSeparatedName

고객 분리형 이름

(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)

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

requestedCustomer: IdentityVerificationRequestedCustomer

요청 시 고객 정보

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)

currency: Currency

통화 단위

installmentMonth?: integer (32 bit)

할부 개월 수

(Optional)

noticeUrls?: string[]

웹훅 주소

(Optional)

products?: PaymentProduct[]

상품 정보

(Optional)

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

items: PaymentWithCursor[]

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

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

attachments: B2bTaxInvoiceAttachment[]

첨부파일 목록

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

items: B2bTaxInvoiceSummary[]

조회된 세금계산서 목록

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

items: PaymentSchedule[]

조회된 결제 예약 건 리스트

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)

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

requestedCustomer: IdentityVerificationRequestedCustomer

요청 시 고객 정보

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)

이름

operator?: IdentityVerificationOperator

본인인증 통신사

(Optional)

본인인증 통신사

phoneNumber?: string

전화번호

(Optional)

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

birthDate: string

생년월일 (yyyy-MM-dd)

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

gender: Gender

성별

isForeigner?: boolean

외국인 여부

(Optional)

ci: string

CI (개인 고유 식별키)

di: string

DI (사이트별 개인 고유 식별키)

InstantBillingKeyPaymentMethodInputobject

card?: InstantBillingKeyPaymentMethodInputCard

카드 수단 정보 입력 양식

(Optional)

카드 수단 정보 입력 양식

InstantBillingKeyPaymentMethodInputCardobject

credential: CardCredential

카드 인증 관련 정보

InstantPaymentMethodInputobject

card?: InstantPaymentMethodInputCard

카드 수단 정보 입력 정보

(Optional)

카드 수단 정보 입력 정보

virtualAccount?: InstantPaymentMethodInputVirtualAccount

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

(Optional)

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

InstantPaymentMethodInputCardobject

credential: CardCredential

카드 인증 관련 정보

installmentMonth?: integer (32 bit)

카드 할부 개월 수

(Optional)

useFreeInstallmentPlan?: boolean

무이자 할부 적용 여부

(Optional)

useFreeInterestFromMerchant?: boolean

무이자 할부 이자를 가맹점이 부담할지 여부

(Optional)

useCardPoint?: boolean

카드 포인트 사용 여부

(Optional)

InstantPaymentMethodInputVirtualAccountobject

bank: Bank

은행

expiry: InstantPaymentMethodInputVirtualAccountExpiry

입금 만료 기한

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

option: InstantPaymentMethodInputVirtualAccountOption

가상계좌 발급 방식

cashReceipt: InstantPaymentMethodInputVirtualAccountCashReceiptInfo

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

remitteeName?: string

예금주명

(Optional)

InstantPaymentMethodInputVirtualAccountCashReceiptInfoobject

type: CashReceiptInputType

입력 시 발급 유형

customerIdentityNumber: string

사용자 식별 번호

InstantPaymentMethodInputVirtualAccountExpiryobject

validHours?: integer (32 bit)

유효 시간

(Optional)

시간 단위로 입력합니다.

dueDate?: string (RFC 3339 date-time)

만료 시점

(Optional)

InstantPaymentMethodInputVirtualAccountOptionobject

type: InstantPaymentMethodInputVirtualAccountOptionType

가상계좌 발급 유형

fixed?: InstantPaymentMethodInputVirtualAccountOptionFixed

고정식 가상계좌 발급 유형

(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

수동 발급 여부

type?: CashReceiptType

발급 유형

(Optional)

발급 유형

pgReceiptId?: string

PG사 현금영수증 아이디

(Optional)

issueNumber: string

승인 번호

url?: string

현금영수증 URL

(Optional)

issuedAt: string (RFC 3339 date-time)

발급 시점

IssuedPaymentCashReceiptobject

status: string

결제 건 내 현금영수증 상태

type?: CashReceiptType

발급 유형

(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: 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)

cashReceipt?: PaymentCashReceipt

결제 건 내 현금영수증 정보

(Optional)

결제 건 내 현금영수증 정보

receiptUrl?: string

거래 영수증 URL

(Optional)

cancellations: PaymentCancellation[]

결제 취소 내역

cancelledAt: string (RFC 3339 date-time)

결제 취소 시점

PastPaymentScheduleErrorobject

type: string

message?: string

(Optional)

PayInstantlyErrorunion

type: string (Union Tag)

필드의 값이 일 때 타입은 AlreadyPaidError 입니다.

message?: string

(Optional)

PayInstantlyResponseobject

payment: InstantPaymentSummary

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

PayPendingPaymentobject

status: string

결제 건 상태

id: string

결제 건 아이디

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)

국가

pgTxId?: string

PG사 거래 아이디

(Optional)

PayWithBillingKeyErrorunion

type: string (Union Tag)

필드의 값이 일 때 타입은 AlreadyPaidError 입니다.

message?: string

(Optional)

PayWithBillingKeyResponseobject

payment: BillingKeyPaymentSummary

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

Paymentunion

status: string (Union Tag)

결제 건 상태

필드의 값이 일 때 타입은 CancelledPayment 입니다.

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)

cashReceipt?: PaymentCashReceipt

결제 건 내 현금영수증 정보

(Optional)

결제 건 내 현금영수증 정보

receiptUrl?: string

거래 영수증 URL

(Optional)

cancellations: PaymentCancellation[]

결제 취소 내역

cancelledAt: string (RFC 3339 date-time)

결제 취소 시점

PaymentAlreadyCancelledErrorobject

type: string

message?: string

(Optional)

PaymentAmountobject

total: integer (64 bit)

총 결제금액

taxFree: integer (64 bit)

면세액

vat?: integer (64 bit)

부가세액

(Optional)

supply?: integer (64 bit)

공급가액

(Optional)

discount: integer (64 bit)

할인금액

카드사 프로모션, 아임포트 프로모션, 적립형 포인트 결제, 쿠폰 할인 등을 포함합니다.

paid: integer (64 bit)

실제 결제금액

cancelled: integer (64 bit)

취소금액

cancelledTaxFree: integer (64 bit)

취소금액 중 면세액

PaymentAmountInputobject

total: integer (64 bit)

총 금액

taxFree?: integer (64 bit)

면세액

(Optional)

vat?: integer (64 bit)

부가세액

(Optional)

가맹점에서 직접 계산이 필요한 경우 입력합니다. 입력하지 않으면 면세 금액을 제외한 금액의 1/11 로 자동 계산됩니다.

PaymentCancellationunion

status: string (Union Tag)

결제 취소 내역 상태

필드의 값이 일 때 타입은 FailedPaymentCancellation 입니다.

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)

취소 요청 시점

PaymentCashReceiptunion

status: string (Union Tag)

결제 건 내 현금영수증 상태

필드의 값이 일 때 타입은 CancelledPaymentCashReceipt 입니다.

type?: CashReceiptType

발급 유형

(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)

취소 시점

PaymentCashReceiptStatusenum

ISSUED

CANCELLED

PaymentClientTypeenum

SDK_MOBILE

SDK_PC

API

PaymentEscrowunion

status: string (Union Tag)

에스크로 상태

필드의 값이 일 때 타입은 BeforeRegisteredPaymentEscrow 입니다.

PaymentEscrowReceiverInputobject

name?: string

이름

(Optional)

phoneNumber?: string

전화번호

(Optional)

zipcode?: string

우편번호

(Optional)

address?: SeparatedAddressInput

분리 형식 주소 입력 정보

(Optional)

분리 형식 주소 입력 정보

PaymentEscrowSenderInputobject

name?: string

이름

(Optional)

phoneNumber?: string

전화번호

(Optional)

zipcode?: string

우편번호

(Optional)

relationship?: string

수취인과의 관계

(Optional)

address?: SeparatedAddressInput

분리 형식 주소 입력 정보

(Optional)

분리 형식 주소 입력 정보

PaymentFilterInputobject

merchantId?: string

가맹점 아이디

(Optional)

storeId?: string

상점 아이디

(Optional)

Merchant 사용자만 사용가능하며, 지정되지 않은 경우 가맹점 전체 결제 건을 조회합니다.

timestampType?: PaymentTimestampType

조회 시점 기준

(Optional)

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

from?: string (RFC 3339 date-time)

결제 요청/상태 승인 시점 범위의 시작

(Optional)

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

until?: string (RFC 3339 date-time)

결제 요청/상태 승인 시점 범위의 끝

(Optional)

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

status?: PaymentStatus[]

결제 상태 리스트

(Optional)

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

methods?: PaymentMethodType[]

결제수단 리스트

(Optional)

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

pgProvider?: PgProvider[]

PG사 리스트

(Optional)

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

isTest?: boolean

테스트 결제 필터링

(Optional)

isScheduled?: boolean

결제 예약 건 필터링

(Optional)

sortBy?: PaymentSortBy

결제 건 정렬 기준

(Optional)

결제 건 정렬 기준

sortOrder?: PaymentSortOrder

결제 건 정렬 방식

(Optional)

결제 건 정렬 방식

version?: PortOneVersion

포트원 버전

(Optional)

포트원 버전

webhookStatus?: PaymentWebhookStatus

웹훅 전송 상태

(Optional)

웹훅 전송 상태

platformType?: PaymentClientType

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

(Optional)

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

currency?: Currency

통화 단위

(Optional)

통화 단위

isEscrow?: boolean

에스크로 결제 여부

(Optional)

escrowStatus?: PaymentFilterInputEscrowStatus

에스크로 상태

(Optional)

에스크로 상태

cardBrand?: CardBrand

카드 브랜드

(Optional)

카드 브랜드

cardType?: CardType

카드 유형

(Optional)

카드 유형

cardOwnerType?: CardOwnerType

카드 소유주 유형

(Optional)

카드 소유주 유형

giftCertificateType?: PaymentMethodGiftCertificateType

상품권 종류

(Optional)

상품권 종류

cashReceiptType?: CashReceiptInputType

입력 시 발급 유형

(Optional)

입력 시 발급 유형

cashReceiptStatus?: PaymentCashReceiptStatus

결제건 내 현금영수증 상태

(Optional)

결제건 내 현금영수증 상태

cashReceiptIssuedAtRange?: DateTimeRange

시간 범위

(Optional)

시간 범위

cashReceiptCancelledAtRange?: DateTimeRange

시간 범위

(Optional)

시간 범위

textSearch?: PaymentTextSearch[]

통합 검색 리스트 필터

(Optional)

PaymentFilterInputEscrowStatusenum

CONFIRMED

REJECTED

CANCELLED

REJECT_CONFIRMED

DELIVERED

REGISTERED

PaymentInstallmentobject

month: integer (32 bit)

할부 개월 수

isInterestFree: boolean

무이자할부 여부

PaymentLogisticsobject

company: PaymentLogisticsCompany

물류 회사

invoiceNumber: string

송장번호

sentAt: string (RFC 3339 date-time)

발송시점

receivedAt?: string (RFC 3339 date-time)

수령시점

(Optional)

address?: SeparatedAddressInput

분리 형식 주소 입력 정보

(Optional)

분리 형식 주소 입력 정보

PaymentLogisticsCompanyenum

POST_REGISTERED등기우편

GOODSTOLUCK굿투럭

UPSUPS

CJ_INTLCJ대한통운 국제특송

LOTTE롯데글로벌로지스

CHUNIL천일택배

KGLKGL네트웍스

EMSEMS

ILYANG일양로지스

HAPDONG합동택배

SUNGWON성원글로벌카고

KUNYOUNG건영택배

LOGEN로젠택배

LX_PANTOSLX판토스

DHLDHL

HANJIN한진택배

FEDEXFedEx

ACIACI

WOORI우리택배

CJ대한통운

GSGS네트웍스

DONGWON동원로엑스

USPSUSPS

KYUNGDONG경동택배

SFSF Express

DAESIN대신택배

ETC기타

SLXSLX

GSM_NTONGSM NtoN

POST우체국택배

PaymentMethodunion

type: string (Union Tag)

필드의 값이 일 때 타입은 PaymentMethodCard 입니다.

card?: Card

카드 상세 정보

(Optional)

카드 상세 정보

approvalNumber?: string

승인 번호

(Optional)

installment?: PaymentInstallment

할부 정보

(Optional)

할부 정보

pointUsed?: boolean

카드 포인트 사용여부

(Optional)

PaymentMethodCardobject

type: string

card?: Card

카드 상세 정보

(Optional)

카드 상세 정보

approvalNumber?: string

승인 번호

(Optional)

installment?: PaymentInstallment

할부 정보

(Optional)

할부 정보

pointUsed?: boolean

카드 포인트 사용여부

(Optional)

PaymentMethodEasyPayobject

type: string

provider?: EasyPayProvider

간편 결제사

(Optional)

간편 결제사

easyPayMethod?: PaymentMethodEasyPayMethod

간편 결제 수단

(Optional)

간편 결제 수단

PaymentMethodEasyPayMethodunion

type: string (Union Tag)

필드의 값이 일 때 타입은 PaymentMethodCard 입니다.

card?: Card

카드 상세 정보

(Optional)

카드 상세 정보

approvalNumber?: string

승인 번호

(Optional)

installment?: PaymentInstallment

할부 정보

(Optional)

할부 정보

pointUsed?: boolean

카드 포인트 사용여부

(Optional)

PaymentMethodEasyPayMethodChargeobject

type: string

bank?: string

표준 은행 코드

(Optional)

PaymentMethodGiftCertificateobject

type: string

giftCertificateType?: PaymentMethodGiftCertificateType

상품권 종류

(Optional)

상품권 종류

approvalNumber: string

상품권 승인 번호

PaymentMethodGiftCertificateTypeenum

SMART_MUNSANG

CULTUREGIFT

BOOKNLIFE

CULTURELAND

HAPPYMONEY

PaymentMethodMobileobject

type: string

phoneNumber?: string

전화번호

(Optional)

PaymentMethodTransferobject

type: string

bank?: string

표준 은행 코드

(Optional)

PaymentMethodTypeenum

GIFT_CERTIFICATE

VIRTUAL_ACCOUNT

MOBILE

CARD

TRANSFER

EASY_PAY

PaymentMethodVirtualAccountobject

type: string

bank?: string

표준 은행 코드

(Optional)

accountNumber: string

계좌번호

accountType?: PaymentMethodVirtualAccountType

가상계좌 유형

(Optional)

가상계좌 유형

remitteeName?: string

계좌주

(Optional)

remitterName?: string

송금인(입금자)

(Optional)

expiredAt?: string (RFC 3339 date-time)

입금만료시점

(Optional)

issuedAt?: string (RFC 3339 date-time)

계좌발급시점

(Optional)

refundStatus?: PaymentMethodVirtualAccountRefundStatus

가상계좌 환불 상태

(Optional)

가상계좌 환불 상태

PaymentMethodVirtualAccountRefundStatusenum

PENDING처리중

PARTIAL_REFUND_FAILED부분 환불 실패

FAILED환불 실패

COMPLETED환불 완료

PaymentMethodVirtualAccountTypeenum

FIXED고정식

NORMAL회전식

PaymentNotFoundErrorobject

type: string

message?: string

(Optional)

PaymentNotPaidErrorobject

type: string

message?: string

(Optional)

PaymentNotWaitingForDepositErrorobject

type: string

message?: string

(Optional)

PaymentProductobject

id: string

상품 고유 식별자

가맹점이 직접 부여한 식별자입니다.

상품명

tag?: string

상품 태그

(Optional)

카테고리 등으로 활용될 수 있습니다.

code?: string

상품 코드

(Optional)

amount: integer (64 bit)

상품 단위가격

quantity: integer (32 bit)

주문 수량

PaymentProductTypeenum

PHYSICAL실물 상품

DIGITAL디지털 상품

서비스, 온라인 상품 등 실물이 존재하지 않는 무형의 상품을 의미합니다.

PaymentScheduleunion

status: string (Union Tag)

결제 예약 건 상태

필드의 값이 일 때 타입은 FailedPaymentSchedule 입니다.

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)

currency: Currency

통화 단위

installmentMonth?: integer (32 bit)

할부 개월 수

(Optional)

noticeUrls?: string[]

웹훅 주소

(Optional)

products?: PaymentProduct[]

상품 정보

(Optional)

timeToPay: string (RFC 3339 date-time)

결제 예정 시점

startedAt: string (RFC 3339 date-time)

결제 시작 시점

completedAt: string (RFC 3339 date-time)

결제 완료 시점

PaymentScheduleAlreadyExistsErrorobject

type: string

message?: string

(Optional)

PaymentScheduleAlreadyProcessedErrorobject

type: string

message?: string

(Optional)

PaymentScheduleAlreadyRevokedErrorobject

type: string

message?: string

(Optional)

PaymentScheduleFilterInputobject

storeId?: string

상점 아이디

(Optional)

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

billingKey?: string

빌링키

(Optional)

from?: string (RFC 3339 date-time)

결제 예정 시점 조건 범위의 시작

(Optional)

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

until?: string (RFC 3339 date-time)

결제 예정 시점 조건 범위의 끝

(Optional)

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

status?: PaymentScheduleStatus[]

결제 예약 건 상태 리스트

(Optional)

PaymentScheduleNotFoundErrorobject

type: string

message?: string

(Optional)

PaymentScheduleStatusenum

SCHEDULED예약 완료

STARTED결제 시작

FAILED결제 실패

REVOKED취소된 결제 예약

SUCCEEDED결제 성공

PaymentScheduleSummaryobject

id: string

결제 예약 건 아이디

PaymentSortByenum

REQUESTED_AT결제 요청 시점

STATUS_CHANGED_AT상태 변경 시점

PaymentSortOrderenum

DESC내림차순

ASC오름차순

PaymentStatusenum

PENDING

VIRTUAL_ACCOUNT_ISSUED

PAID

READY

FAILED

CANCELLED

PARTIAL_CANCELLED

PaymentTextSearchobject

field: PaymentTextSearchField

통합검색 항목

value: string

PaymentTextSearchFieldenum

CUSTOMER_EMAIL

USER_AGENT

FAIL_REASON

CARD_BIN

PG_MERCHANT_ID

RECEIPT_APPROVAL_NUMBER

TRANS_BANK

CARD_ISSUER

VIRTUAL_ACCOUNT_BANK

ORDER_NAME

TX_ID

CARD_ACQUIRER

CANCEL_REASON

CUSTOMER_NAME

SCHEDULE_ID

GIFT_CERTIFICATION_APPROVAL_NUMBER

PROMOTION_ID

PAYMENT_ID

CARD_APPROVAL_NUMBER

CUSTOMER_ADDRESS

PG_CANCELLATION_ID

ALL

PG_RECEIPT_ID

VIRTUAL_ACCOUNT_NUMBER

CARD_NUMBER

PG_TX_ID

BILLING_KEY

CUSTOMER_PHONE_NUMBER

CARD_RECEIPT_NAME

CARD_INSTALLMENT

CUSTOMER_ZIPCODE

VIRTUAL_ACCOUNT_HOLDER_NAME

PaymentTimestampTypeenum

CREATED_AT결제 건 생성 시점

STATUS_CHANGED_AT상태 변경 시점

PaymentWebhookobject

paymentStatus?: PaymentWebhookPaymentStatus

웹훅 발송 시 결제 건 상태

(Optional)

웹훅 발송 시 결제 건 상태

id: string

웹훅 아이디

status?: PaymentWebhookStatus

웹훅 전송 상태

(Optional)

웹훅 전송 상태

url: string

웹훅이 발송된 url

V1 결제 건인 경우, 값이 존재하지 않습니다.

isAsync?: boolean

비동기 웹훅 여부

(Optional)

V1 결제 건인 경우, 값이 존재하지 않습니다.

currentExecutionCount?: integer (32 bit)

현재 발송 횟수

(Optional)

maxExecutionCount?: integer (32 bit)

최대 발송 횟수

(Optional)

trigger?: PaymentWebhookTrigger

웹훅 실행 트리거

(Optional)

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

request?: PaymentWebhookRequest

웹훅 요청 정보

(Optional)

웹훅 요청 정보

response?: PaymentWebhookResponse

웹훅 응답 정보

(Optional)

웹훅 응답 정보

triggeredAt?: string (RFC 3339 date-time)

웹훅 처리 시작 시점

(Optional)

PaymentWebhookPaymentStatusenum

VIRTUAL_ACCOUNT_ISSUED

PAID

READY

FAILED

PAY_PENDING

CANCELLED

PARTIAL_CANCELLED

PaymentWebhookRequestobject

header?: string

요청 헤더

(Optional)

body: string

요청 본문

requestedAt?: string (RFC 3339 date-time)

요청 시점

(Optional)

PaymentWebhookResponseobject

code: string

응답 HTTP 코드

header: string

응답 헤더

body: string

응답 본문

respondedAt: string (RFC 3339 date-time)

응답 시점

PaymentWebhookStatusenum

SUCCEEDED

FAILED_NOT_OK_RESPONSE

FAILED_UNEXPECTED_ERROR

PaymentWebhookTriggerenum

ASYNC_CANCEL_APPROVED

VIRTUAL_ACCOUNT_DEPOSIT

ASYNC_CANCEL_FAILED

MANUAL

ASYNC_PAY_FAILED

ASYNC_PAY_APPROVED

PaymentWithCursorobject

payment: Payment

결제 건

cursor: string

해당 결제 건의 커서 정보

PgProviderenum

KICC

SYRUP

PAYCO

KCP_BILLING

SMARTRO_V2

NAVERPAY

CHAI

NICE_V2

PAYPAL_V2

KPN

KAKAO

INICIS_V2

DANAL

KAKAOPAY

EXIMBAY

ALIPAY

HTML5_INICIS

WELCOME

SMARTRO

SMILEPAY

PAYMENTWALL

KCP_QUICK

NAVERCO

DAOU

GALAXIA

PINPAY

SETTLE_ACC

TOSSPAY_V2

TOSSPAY

SETTLE_FIRM

INICIS

TOSS_BRANDPAY

JTNET

PAYPAL

DANAL_TPAY

KCP_DIRECT

SETTLE

MOBILIANS

UPLUS

INICIS_UNIFIED

BLUEWALNUT

NICE

TOSSPAYMENTS

PAYPLE

KSNET

KCP

PgProviderErrorobject

type: string

message?: string

(Optional)

pgCode: string

pgMessage: string

PortOneVersionenum

V1

V2

PreRegisterPaymentErrorunion

type: string (Union Tag)

필드의 값이 일 때 타입은 AlreadyPaidError 입니다.

message?: string

(Optional)

PreRegisterPaymentResponseobject

ReadyIdentityVerificationobject

status: string

본인인증 상태

id: string

본인인증 내역 아이디

channel?: SelectedChannel

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

(Optional)

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

requestedCustomer: IdentityVerificationRequestedCustomer

요청 시 고객 정보

customData?: string

사용자 지정 데이터

(Optional)

requestedAt: string (RFC 3339 date-time)

본인인증 요청 시점

updatedAt: string (RFC 3339 date-time)

업데이트 시점

statusChangedAt: string (RFC 3339 date-time)

상태 업데이트 시점

ReadyPaymentobject

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)

국가

RefreshTokenErrorunion

type: string (Union Tag)

필드의 값이 일 때 타입은 InvalidRequestError 입니다.

message?: string

(Optional)

RefreshTokenResponseobject

accessToken: string

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

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

refreshToken: string

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

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

RefuseB2bTaxInvoiceRequestErrorunion

type: string (Union Tag)

필드의 값이 일 때 타입은 B2bExternalServiceError 입니다.

message: string

RegisterB2bMemberCompanyErrorunion

type: string (Union Tag)

필드의 값이 일 때 타입은 B2bCompanyAlreadyRegisteredError 입니다.

message?: string

(Optional)

RegisterB2bMemberCompanyResponseobject

company: B2bMemberCompany

contact: B2bCompanyContact

RegisterStoreReceiptBodyItemobject

storeBusinessRegistrationNumber: string

하위 상점 사업자등록번호

storeName: string

하위 상점명

totalAmount: integer (64 bit)

결제 총 금액

taxFreeAmount?: integer (64 bit)

면세액

(Optional)

vatAmount?: integer (64 bit)

부가세액

(Optional)

supplyAmount?: integer (64 bit)

공급가액

(Optional)

currency: Currency

통화 단위

RegisterStoreReceiptErrorunion

type: string (Union Tag)

필드의 값이 일 때 타입은 ForbiddenError 입니다.

message?: string

(Optional)

RegisterStoreReceiptResponseobject

receiptUrl?: string

결제 영수증 URL

(Optional)

RegisteredPaymentEscrowobject

status: string

에스크로 상태

company: string

택배사

invoiceNumber: string

송장번호

sentAt?: string (RFC 3339 date-time)

발송 일시

(Optional)

appliedAt?: string (RFC 3339 date-time)

배송등록 처리 일자

(Optional)

RejectConfirmedPaymentEscrowobject

status: string

에스크로 상태

company: string

택배사

invoiceNumber: string

송장번호

sentAt?: string (RFC 3339 date-time)

발송 일시

(Optional)

appliedAt?: string (RFC 3339 date-time)

배송등록 처리 일자

(Optional)

RejectedPaymentEscrowobject

status: string

에스크로 상태

company: string

택배사

invoiceNumber: string

송장번호

sentAt?: string (RFC 3339 date-time)

발송 일시

(Optional)

appliedAt?: string (RFC 3339 date-time)

배송등록 처리 일자

(Optional)

RequestB2bTaxInvoiceRegisterErrorunion

type: string (Union Tag)

필드의 값이 일 때 타입은 B2bExternalServiceError 입니다.

message: string

RequestB2bTaxInvoiceReverseIssuanceErrorunion

type: string (Union Tag)

필드의 값이 일 때 타입은 B2bExternalServiceError 입니다.

message: string

RequestedPaymentCancellationobject

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)

취소 요청 시점

ResendIdentityVerificationErrorunion

type: string (Union Tag)

필드의 값이 일 때 타입은 ForbiddenError 입니다.

message?: string

(Optional)

ResendIdentityVerificationResponseobject

ResendWebhookErrorunion

type: string (Union Tag)

필드의 값이 일 때 타입은 ForbiddenError 입니다.

message?: string

(Optional)

ResendWebhookResponseobject

webhook: PaymentWebhook

성공 웹훅 내역

RevokePaymentScheduleErrorunion

type: string (Union Tag)

필드의 값이 일 때 타입은 BillingKeyAlreadyDeletedError 입니다.

message?: string

(Optional)

RevokePaymentScheduleResponseobject

revokedScheduleIds: string[]

취소 완료된 결제 예약 건 아이디 목록

revokedAt?: string (RFC 3339 date-time)

결제 예약 건 취소 완료 시점

(Optional)

RevokedPaymentScheduleobject

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)

currency: Currency

통화 단위

installmentMonth?: integer (32 bit)

할부 개월 수

(Optional)

noticeUrls?: string[]

웹훅 주소

(Optional)

products?: PaymentProduct[]

상품 정보

(Optional)

timeToPay: string (RFC 3339 date-time)

결제 예정 시점

revokedAt: string (RFC 3339 date-time)

결제 취소 시점

ScheduledPaymentScheduleobject

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)

currency: Currency

통화 단위

installmentMonth?: integer (32 bit)

할부 개월 수

(Optional)

noticeUrls?: string[]

웹훅 주소

(Optional)

products?: PaymentProduct[]

상품 정보

(Optional)

timeToPay: string (RFC 3339 date-time)

결제 예정 시점

SelectedChannelobject

type: SelectedChannelType

채널 타입

id?: string

채널 아이디

(Optional)

key?: string

채널 키

(Optional)

name?: string

채널 명

(Optional)

pgProvider: PgProvider

PG사 결제 모듈

pgMerchantId: string

PG사 가맹점 식별 아이디

SelectedChannelTypeenum

LIVE실 연동 채널

TEST테스트 연동 채널

SendIdentityVerificationBodyCustomerobject

id?: string

식별 아이디

(Optional)

이름

phoneNumber: string

전화번호

특수 문자(-) 없이 숫자만 입력합니다.

identityNumber?: string

주민등록번호 앞 7자리

(Optional)

SMS 방식의 경우 필수로 입력합니다.

SendIdentityVerificationErrorunion

type: string (Union Tag)

필드의 값이 일 때 타입은 ChannelNotFoundError 입니다.

message?: string

(Optional)

SendIdentityVerificationResponseobject

SeparatedAddressobject

type: string

oneLine: string

주소 (한 줄)

addressLine1: string

상세 주소 1

addressLine2: string

상세 주소 2

city?: string

시/군/구

(Optional)

province?: string

주/도/시

(Optional)

country?: Country

국가

(Optional)

국가

SeparatedAddressInputobject

addressLine1: string

상세 주소 1

addressLine2: string

상세 주소 2

city?: string

시/군/구

(Optional)

province?: string

주/도/시

(Optional)

country?: Country

국가

(Optional)

국가

StartedPaymentScheduleobject

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)

currency: Currency

통화 단위

installmentMonth?: integer (32 bit)

할부 개월 수

(Optional)

noticeUrls?: string[]

웹훅 주소

(Optional)

products?: PaymentProduct[]

상품 정보

(Optional)

timeToPay: string (RFC 3339 date-time)

결제 예정 시점

startedAt: string (RFC 3339 date-time)

결제 시작 시점

SucceededPaymentCancellationobject

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)

취소 요청 시점

receiptUrl?: string

취소 영수증 URL

(Optional)

SucceededPaymentScheduleobject

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)

currency: Currency

통화 단위

installmentMonth?: integer (32 bit)

할부 개월 수

(Optional)

noticeUrls?: string[]

웹훅 주소

(Optional)

products?: PaymentProduct[]

상품 정보

(Optional)

timeToPay: string (RFC 3339 date-time)

결제 예정 시점

startedAt: string (RFC 3339 date-time)

결제 시작 시점

completedAt: string (RFC 3339 date-time)

결제 완료 시점

SumOfPartsExceedsCancelAmountErrorobject

type: string

message?: string

(Optional)

SumOfPartsExceedsTotalAmountErrorobject

type: string

message?: string

(Optional)

UnauthorizedErrorobject

type: string

message?: string

(Optional)

UpdateB2bMemberCompanyContactErrorunion

type: string (Union Tag)

필드의 값이 일 때 타입은 B2bContactNotFoundError 입니다.

message?: string

(Optional)

UpdateB2bMemberCompanyContactResponseobject

contact: B2bCompanyContact

UpdateB2bMemberCompanyErrorunion

type: string (Union Tag)

필드의 값이 일 때 타입은 B2bMemberCompanyNotFoundError 입니다.

message?: string

(Optional)

UpdateB2bMemberCompanyResponseobject

memberCompany: B2bMemberCompany

VerifiedIdentityVerificationobject

status: string

본인인증 상태

id: string

본인인증 내역 아이디

channel?: SelectedChannel

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

(Optional)

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

verifiedCustomer: IdentityVerificationVerifiedCustomer

인증된 고객 정보

customData?: string

사용자 지정 데이터

(Optional)

requestedAt: string (RFC 3339 date-time)

본인인증 요청 시점

updatedAt: string (RFC 3339 date-time)

업데이트 시점

statusChangedAt: string (RFC 3339 date-time)

상태 업데이트 시점

verifiedAt: string (RFC 3339 date-time)

본인인증 완료 시점

pgTxId: string

본인인증 내역 PG사 아이디

pgRawResponse: string

PG사 응답 데이터

VirtualAccountIssuedPaymentobject

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)

국가

WebhookNotFoundErrorobject

type: string

message?: string

(Optional)

getB2bContactIdExistenceErrorunion

type: string (Union Tag)

필드의 값이 일 때 타입은 B2bExternalServiceError 입니다.

message: string

requestB2bTaxInvoiceErrorunion

type: string (Union Tag)

필드의 값이 일 때 타입은 B2bExternalServiceError 입니다.

message: string

PortOne REST API - V2

요청 및 응답 형식

인증 방식

GET 요청 시 Body 대신 Query 사용

인증 관련 API

목차

결제 관련 API

목차

결제 예약 관련 API

목차

빌링키 관련 API

목차

현금 영수증 관련 API

목차

본인인증 관련 API

목차

B2B 서비스 API

목차

특정 PG사 관련 API

목차

타입 정의

Addressunion

AlreadyPaidErrorobject

AlreadyPaidOrWaitingErrorobject

ApplyEscrowLogisticsErrorunion

ApplyEscrowLogisticsResponseobject

AttachB2bTaxInvoiceFileErrorunion

B2bBankAccountNotFoundErrorobject

B2bCertificateobject

B2bCertificateTypeenum

B2bCertificateUnregisteredErrorobject

B2bCompanyAlreadyRegisteredErrorobject

B2bCompanyContactobject

B2bCompanyContactInputobject

B2bCompanyNotFoundErrorobject

B2bCompanyStateobject

B2bCompanyStateBusinessStatusenum

B2bCompanyStateTaxationTypeenum

B2bContactNotFoundErrorobject

B2bExternalServiceErrorobject

B2bFileNotFoundErrorobject

B2bFinancialSystemCommunicationErrorobject

B2bFinancialSystemFailureErrorobject

B2bFinancialSystemUnderMaintenanceErrorobject

B2bForeignExchangeAccountErrorobject

B2bHometaxUnderMaintenanceErrorobject

B2bIdAlreadyExistsErrorobject

B2bMemberCompanyobject

B2bMemberCompanyNotFoundErrorobject

B2bModificationobject

B2bNotEnabledErrorobject

B2bRecipientNotFoundErrorobject

B2bRegularMaintenanceTimeErrorobject

B2bSearchDateTypeenum

B2bSupplierNotFoundErrorobject

B2bSuspendedAccountErrorobject

B2bTaxInvoiceunion

B2bTaxInvoiceAdditionalContactobject

B2bTaxInvoiceAttachmentobject

B2bTaxInvoiceAttachmentNotFoundErrorobject

B2bTaxInvoiceBeforeSendingobject

B2bTaxInvoiceCompanyobject

B2bTaxInvoiceContactobject

B2bTaxInvoiceDocumentKeyTypeenum

B2bTaxInvoiceInputobject

B2bTaxInvoiceIssuanceCancelledobject

B2bTaxInvoiceIssuedobject

B2bTaxInvoiceItemobject

B2bTaxInvoiceModificationTypeenum

B2bTaxInvoiceNoRecipientDocumentKeyErrorobject

B2bTaxInvoiceNoSupplierDocumentKeyErrorobject

B2bTaxInvoiceNonDeletableStatusErrorobject

B2bTaxInvoiceNotFoundErrorobject

B2bTaxInvoiceNotIssuedStatusErrorobject

B2bTaxInvoiceNotRegisteredStatusErrorobject

B2bTaxInvoiceNotRequestedStatusErrorobject

B2bTaxInvoicePurposeTypeenum

B2bTaxInvoiceRegisteredobject

B2bTaxInvoiceRequestCancelledobject

B2bTaxInvoiceRequestRefusedobject