PortOne REST API - V2

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

V2 API hostname: api.portone.io

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

요청 및 응답 형식

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

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

인증 방식

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

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

Authorization: PortOne MY_API_SECRET

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

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

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

하위호환성

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

현재 사용 가능한 입력 형식은 앞으로도 사용할 수 있습니다.
- 입력 형식 내 필드 정의가 삭제되지 않습니다.
- 필수 입력 정보가 추가되거나, 선택 입력 정보가 필수로 변경되지 않습니다.
  - 오로지 선택 입력 정보만 추가될 수 있습니다.
- 하위 필드의 형식(타입) 또한 위 규칙을 지키며 변경됩니다.
- enum 타입의 값이 삭제되지 않습니다.
출력 형식이 확장될 수 있지만, 축소되지 않습니다.
- 출력 형식 내 필드 정의가 삭제되지 않습니다.
- 사용 중인 필수 출력 정보가 선택사항으로 변경되거나 출력 시 누락되지 않습니다.
  - 이미 존재하는 용례 내에서는 필수 출력 정보가 언제나 유지됩니다.
  - 단, 기능이 추가 및 확장되는 등 새로운 용례로 사용될 때의 출력 정보에 한하여 선택사항으로 변경될 수 있습니다.
- 하위 필드의 형식(타입) 또한 위 규칙을 지키며 변경됩니다.
- 단, 새로운 필드 또는 enum 값, oneOf 케이스가 추가될 수 있습니다.
  - 알지 못하는 필드 및 값이 주어지더라도 crash가 발생하지 않도록 유의하여 개발해주세요.

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

인증 관련 API

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

결제 관련 API

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

결제 예약 관련 API

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

빌링키 관련 API

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

현금 영수증 관련 API

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

프로모션 관련 API

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

본인인증 관련 API

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

파트너 정산 관련 API

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

정책 관련 API

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

파트너 관련 API

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

정산 상세내역 관련 API

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

계좌 관련 API

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

정산 내역 관련 API

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

지급 내역 관련 API

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

일괄 지급 내역 관련 API

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

이체 내역 관련 API

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

특정 PG사 관련 API

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

대사 서비스 API

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

타입 정의

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

Addressunion

type: string (Union Tag)

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

oneLine: string

주소 (한 줄)

AlreadyPaidErrorobject

type: string

message?: string

(Optional)

AlreadyPaidOrWaitingErrorobject

type: string

message?: string

(Optional)

AmountExceededTypeenum

DISCOUNT_THAN_ORDER할인금액이 주문금액을 초과

DISCOUNT_TAX_FREE_THAN_DISCOUNT면세 할인금액이 할인금액을 초과

DISCOUNT_TAX_FREE_THAN_ORDER_TAX_FREE면세 할인금액이 면세 주문금액을 초과

PAYMENT_TAX_FREE_THAN_PAYMENT면세 결제금액이 결제금액을 초과

ApplyEscrowLogisticsErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

ApplyEscrowLogisticsResponseobject

invoiceNumber: string

송장 번호

sentAt: string (RFC 3339 date-time)

발송 시점

appliedAt: string (RFC 3339 date-time)

에스크로 정보 등록 시점

ArchivePlatformAdditionalFeePolicyErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

ArchivePlatformAdditionalFeePolicyResponseobject

additionalFeePolicy: PlatformAdditionalFeePolicy

추가 수수료 정책

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

ArchivePlatformContractErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

ArchivePlatformContractResponseobject

contract: PlatformContract

계약

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

ArchivePlatformDiscountSharePolicyErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

ArchivePlatformDiscountSharePolicyResponseobject

discountSharePolicy: PlatformDiscountSharePolicy

할인 분담 정책

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

ArchivePlatformPartnerErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

ArchivePlatformPartnerResponseobject

partner: PlatformPartner

파트너

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

Bankenum

BANK_OF_CHINA중국은행

KDB산업은행

HANYANG_SECURITIES한양증권

SK_SECURITIESSK증권

HANA_SECURITIES하나증권

KB_SECURITIESKB증권

KYONGNAM경남은행

WOORI_INVESTMENT_BANK우리종합금융

CITI한국씨티은행

SHINYOUNG_SECURITIES신영증권

KOREA_SECURITIES한국투자증권

SHINHAN신한은행

LEADING_SECURITIES리딩투자증권

UOB대화은행

KOREA_FOSS_SECURITIES한국포스증권

MERITZ_SECURITIES메리츠증권

MIZUHO미즈호은행

EBEST_SECURITIESLS증권

SANGSANGIN_SECURITIES상상인증권

IBK기업은행

DEUTSCHE도이치은행

KCIS한국신용정보원

KEXIM수출입은행

SHINHYUP신협

CCB중국건설은행

HANA하나은행

TOSS_SECURITIES토스증권

IBK_SECURITIESIBK투자증권

SHINHAN_SECURITIES신한투자증권

HANHWA_SECURITIES한화투자증권

LOCAL_NONGHYUP지역농축협

WOORI우리은행

SAMSUNG_SECURITIES삼성증권

K_BANK케이뱅크

DB_SECURITIESDB금융투자

SGI서울보증보험

JEJU제주은행

MIRAE_ASSET_SECURITIES미래에셋증권

SAVINGS_BANK저축은행

EUGENE_SECURITIES유진투자증권

DAEGU아이엠뱅크

BNK_SECURITIESBNK투자증권

KAKAO_PAY_SECURITIES카카오페이증권

SUHYUP수협은행

CAPE_SECURITIES케이프투자증권

JEONBUK전북은행

BNP_PARIBAS비엔피파리바은행

KOREA_SECURITIES_FINANCE한국증권금융

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)

BillingKeyFailureobject

message?: string

실패 사유

(Optional)

pgCode?: string

PG사 실패 코드

(Optional)

pgMessage?: string

PG사 실패 사유

(Optional)

failedAt: string (RFC 3339 date-time)

실패 시점

BillingKeyInfounion

status: string (Union Tag)

빌링키 상태

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

billingKey: string

빌링키

merchantId: string

고객사 아이디

storeId: string

상점 아이디

methods?: BillingKeyPaymentMethod[]

빌링키 결제수단 상세 정보

(Optional)

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

channels: SelectedChannel[]

빌링키 발급 시 사용된 채널

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

customer: Customer

고객 정보

customData?: string

사용자 지정 데이터

(Optional)

issueId?: string

고객사가 채번하는 빌링키 발급 건 고유 아이디

(Optional)

issueName?: string

빌링키 발급 건 이름

(Optional)

requestedAt?: string (RFC 3339 date-time)

발급 요청 시점

(Optional)

issuedAt: string (RFC 3339 date-time)

발급 시점

channelGroup?: ChannelGroupSummary

채널 그룹 정보

(Optional)

채널 그룹 정보

pgBillingKeyIssueResponses?: PgBillingKeyIssueResponse[]

채널 별 빌링키 발급 응답

(Optional)

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

deletedAt: string (RFC 3339 date-time)

발급 삭제 시점

BillingKeyInfoSummaryobject

billingKey: string

발급된 빌링키

channels?: SelectedChannel[]

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

(Optional)

issuedAt: string (RFC 3339 date-time)

빌링크 발급 완료 시점

BillingKeyNotFoundErrorobject

type: string

message?: string

(Optional)

BillingKeyNotIssuedErrorobject

type: string

message?: string

(Optional)

BillingKeyPaymentInputobject

storeId?: string

상점 아이디

(Optional)

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

billingKey: string

빌링키 결제에 사용할 빌링키

channelKey?: string

채널 키

(Optional)

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

orderName: string

주문명

customer?: CustomerInput

고객 정보 입력 정보

(Optional)

고객 정보 입력 정보

customData?: string

사용자 지정 데이터

(Optional)

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)

분리 형식 주소 입력 정보

promotionId?: string

해당 결제에 적용할 프로모션 아이디

(Optional)

bypass?: object

PG사별 추가 파라미터 ("PG사별 연동 가이드" 참고)

(Optional)

BillingKeyPaymentMethodunion

type: string (Union Tag)

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

card?: Card

카드 상세 정보

(Optional)

카드 상세 정보

BillingKeyPaymentMethodCardobject

type: string

card?: Card

카드 상세 정보

(Optional)

카드 상세 정보

BillingKeyPaymentMethodEasyPayobject

type: string

provider?: EasyPayProvider

간편 결제사

(Optional)

간편 결제사

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?: Bank

은행

(Optional)

은행

accountNumber?: string

계좌번호

(Optional)

BillingKeyPaymentSummaryobject

pgTxId: string

PG사 결제 아이디

paidAt: string (RFC 3339 date-time)

결제 완료 시점

CancelAmountExceedsCancellableAmountErrorobject

type: string

message?: string

(Optional)

CancelCashReceiptErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

CancelCashReceiptResponseobject

cancelledAmount: integer (64 bit)

취소 금액

cancelledAt: string (RFC 3339 date-time)

현금 영수증 취소 완료 시점

CancelPaymentBodyRefundAccountobject

bank: Bank

은행

number: string

계좌번호

holderName: string

예금주

holderPhoneNumber?: string

예금주 연락처 - 스마트로 가상계좌 결제인 경우에 필요합니다.

(Optional)

CancelPaymentErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

CancelPaymentResponseobject

cancellation: PaymentCancellation

결제 취소 내역

CancelRequesterenum

CUSTOMER

ADMIN

CancelTaxAmountExceedsCancellableTaxAmountErrorobject

type: string

message?: string

(Optional)

CancelTaxFreeAmountExceedsCancellableTaxFreeAmountErrorobject

type: string

message?: string

(Optional)

CancellableAmountConsistencyBrokenErrorobject

type: string

message?: string

(Optional)

CancelledCashReceiptobject

status: string

현금영수증 상태

merchantId: string

고객사 아이디

storeId: string

상점 아이디

paymentId: string

결제 건 아이디

channel: SelectedChannel

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

amount: integer (64 bit)

결제 금액

taxFreeAmount?: integer (64 bit)

면세액

(Optional)

vatAmount?: integer (64 bit)

부가세액

(Optional)

currency: Currency

통화 단위

orderName: string

주문명

isManual: boolean

수동 발급 여부

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

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

channelGroup?: ChannelGroupSummary

채널 그룹 정보

(Optional)

채널 그룹 정보

version: PortOneVersion

포트원 버전

scheduleId?: string

결제 예약 건 아이디

(Optional)

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

billingKey?: string

결제 시 사용된 빌링키

(Optional)

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

webhooks?: PaymentWebhook[]

웹훅 발송 내역

(Optional)

requestedAt: string (RFC 3339 date-time)

결제 요청 시점

updatedAt: string (RFC 3339 date-time)

업데이트 시점

statusChangedAt: string (RFC 3339 date-time)

상태 업데이트 시점

orderName: string

주문명

amount: PaymentAmount

결제 금액 세부 정보

currency: Currency

통화 단위

customer: Customer

고객 정보

promotionId?: string

프로모션 아이디

(Optional)

isCulturalExpense?: boolean

문화비 지출 여부

(Optional)

escrow?: PaymentEscrow

에스크로 정보

(Optional)

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

products?: PaymentProduct[]

상품 정보

(Optional)

productCount?: integer (32 bit)

상품 갯수

(Optional)

customData?: string

사용자 지정 데이터

(Optional)

country?: Country

국가

(Optional)

국가

paidAt?: string (RFC 3339 date-time)

결제 완료 시점

(Optional)

pgTxId?: string

PG사 거래 아이디

(Optional)

cashReceipt?: PaymentCashReceipt

결제 건 내 현금영수증 정보

(Optional)

결제 건 내 현금영수증 정보

receiptUrl?: string

거래 영수증 URL

(Optional)

cancellations: PaymentCancellation[]

결제 취소 내역

cancelledAt: string (RFC 3339 date-time)

결제 취소 시점

CancelledPaymentCashReceiptobject

status: string

결제 건 내 현금영수증 상태

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

유효 기간 만료 연도 (2자리)

expiryMonth: string

유효 기간 만료 월 (2자리)

birthOrBusinessRegistrationNumber?: string

생년월일 (yyMMdd) 또는 사업자 등록 번호 (10자리, 숫자만)

(Optional)

passwordTwoDigits?: string

비밀번호 앞 2자리

(Optional)

CardOwnerTypeenum

PERSONAL개인

CORPORATE법인

CardPromotionobject

type: string

프로모션 유형

id: string

프로모션 아이디

storeId: string

상점 아이디

프로모션 이름

discountType: PromotionDiscount

PromotionDiscount

totalBudget: integer (64 bit)

총 예산

minPaymentAmount?: integer (64 bit)

최소 결제 금액

(Optional)

maxDiscountAmount?: integer (64 bit)

최대 할인 금액

(Optional)

spentAmount: integer (64 bit)

소진 금액

currency: Currency

통화 단위

startAt: string (RFC 3339 date-time)

프로모션 시작 시각

endAt: string (RFC 3339 date-time)

프로모션 종료 시각

terminatedAt?: string (RFC 3339 date-time)

프로모션 중단 시각

(Optional)

cardCompany: PromotionCardCompany

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

status: PromotionStatus

PromotionStatus

createdAt: string (RFC 3339 date-time)

프로모션 생성 시각

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

ChannelGroupSummaryobject

id: string

채널 그룹 아이디

채널 그룹 이름

isForTest: boolean

테스트 채널 그룹 여부

ChannelNotFoundErrorobject

type: string

message?: string

(Optional)

ChannelSpecificErrorobject

type: string

message?: string

(Optional)

failures: ChannelSpecificFailure[]

succeededChannels: SelectedChannel[]

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

ChannelSpecificFailureunion

type: string (Union Tag)

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

channel: SelectedChannel

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

message?: string

(Optional)

ChannelSpecificFailureInvalidRequestobject

type: string

channel: SelectedChannel

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

message?: string

(Optional)

ChannelSpecificFailurePgProviderobject

type: string

channel: SelectedChannel

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

message?: string

(Optional)

pgCode: string

pgMessage: string

CloseVirtualAccountErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

CloseVirtualAccountResponseobject

closedAt: string (RFC 3339 date-time)

가상계좌 말소 시점

ConfirmEscrowErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

ConfirmEscrowResponseobject

completedAt: string (RFC 3339 date-time)

에스크로 구매 확정 시점

ConfirmIdentityVerificationErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

ConfirmIdentityVerificationResponseobject

identityVerification: VerifiedIdentityVerification

완료된 본인인증 내역

ConfirmedPaymentEscrowobject

status: string

에스크로 상태

company: string

택배사

invoiceNumber: string

송장번호

sentAt?: string (RFC 3339 date-time)

발송 일시

(Optional)

appliedAt?: string (RFC 3339 date-time)

배송등록 처리 일자

(Optional)

isAutomaticallyConfirmed: boolean

자동 구매 확정 처리 여부

Countryenum

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

CreateManualTransferResponseobject

transfer: PlatformManualTransfer

수기 정산건

CreateOrderCancelTransferResponseobject

transfer: PlatformOrderCancelTransfer

주문 취소 정산건

CreateOrderTransferResponseobject

transfer: PlatformOrderTransfer

주문 정산건

CreatePaymentScheduleErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

CreatePaymentScheduleResponseobject

schedule: PaymentScheduleSummary

결제 예약 건

CreatePlatformAdditionalFeePolicyErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

CreatePlatformAdditionalFeePolicyResponseobject

additionalFeePolicy: PlatformAdditionalFeePolicy

추가 수수료 정책

CreatePlatformContractErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

CreatePlatformContractResponseobject

contract: PlatformContract

계약

CreatePlatformDiscountSharePolicyErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

CreatePlatformDiscountSharePolicyResponseobject

discountSharePolicy: PlatformDiscountSharePolicy

할인 분담 정책

CreatePlatformManualTransferErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

CreatePlatformOrderCancelTransferBodyDiscountobject

sharePolicyId: string

할인 분담 정책 아이디

amount: integer (64 bit)

할인 금액

taxFreeAmount?: integer (64 bit)

면세 할인 금액

(Optional)

CreatePlatformOrderCancelTransferBodyExternalCancellationDetailobject

cancelledAt?: string (RFC 3339 date-time)

취소 일시

(Optional)

CreatePlatformOrderCancelTransferBodyOrderDetailobject

orderAmount?: integer (64 bit)

주문 취소 금액

(Optional)

orderLines?: CreatePlatformOrderCancelTransferBodyOrderLine[]

주문 취소 항목 리스트

(Optional)

all?: CreatePlatformOrderCancelTransferBodyOrderDetailAll

전체 금액 취소

(Optional)

전체 금액 취소

CreatePlatformOrderCancelTransferBodyOrderDetailAllobject

CreatePlatformOrderCancelTransferBodyOrderLineobject

productId: string

상품 아이디

quantity: integer (32 bit)

상품 수량

discounts: CreatePlatformOrderCancelTransferBodyDiscount[]

상품 할인 정보

CreatePlatformOrderCancelTransferErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

CreatePlatformOrderTransferBodyAdditionalFeeobject

policyId: string

추가 수수료 정책 아이디

CreatePlatformOrderTransferBodyDiscountobject

sharePolicyId: string

할인 분담 정책 아이디

amount: integer (64 bit)

할인 금액

taxFreeAmount?: integer (64 bit)

면세 할인 금액

(Optional)

CreatePlatformOrderTransferBodyExternalPaymentDetailobject

currency: Currency

통화 단위

orderName?: string

주문 명

(Optional)

paidAt?: string (RFC 3339 date-time)

결제 일시

(Optional)

method?: PlatformPaymentMethodInput

결제 수단 입력 정보

(Optional)

결제 수단 입력 정보

CreatePlatformOrderTransferBodyOrderDetailobject

orderAmount?: integer (64 bit)

주문 금액

(Optional)

orderLines?: CreatePlatformOrderTransferBodyOrderLine[]

주문 항목 리스트

(Optional)

CreatePlatformOrderTransferBodyOrderLineobject

product: CreatePlatformOrderTransferBodyProduct

상품

quantity: integer (32 bit)

상품 수량

discounts: CreatePlatformOrderTransferBodyDiscount[]

상품 할인 정보

additionalFees: CreatePlatformOrderTransferBodyAdditionalFee[]

상품 추가 수수료 정보

CreatePlatformOrderTransferBodyProductobject

id: string

상품 아이디

상품 이름

amount: integer (64 bit)

상품 금액

taxFreeAmount?: integer (64 bit)

상품 면세 금액

(Optional)

tag?: string

태그

(Optional)

CreatePlatformOrderTransferErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

CreatePlatformPartnerBodyobject

id?: string

파트너에 부여할 고유 아이디

(Optional)

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

파트너 법인명 혹은 이름

contact: CreatePlatformPartnerBodyContact

파트너 담당자 정보

account: CreatePlatformPartnerBodyAccount

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

defaultContractId: string

기본 계약 아이디

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

memo?: string

파트너에 대한 메모

(Optional)

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

tags: string[]

파트너에 부여할 태그 리스트

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

type: CreatePlatformPartnerBodyType

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

userDefinedProperties?: PlatformProperties

PlatformProperties

(Optional)

CreatePlatformPartnerBodyAccountobject

bank: Bank

은행

currency: Currency

통화 단위

number: string

계좌번호

holder: string

예금주명

accountVerificationId?: string

계좌 검증 아이디

(Optional)

CreatePlatformPartnerBodyContactobject

담당자 이름

phoneNumber?: string

담당자 휴대폰 번호

(Optional)

email: string

담당자 이메일

CreatePlatformPartnerBodyTypeobject

business?: CreatePlatformPartnerBodyTypeBusiness

CreatePlatformPartnerBodyTypeBusiness

(Optional)

whtPayer?: CreatePlatformPartnerBodyTypeWhtPayer

CreatePlatformPartnerBodyTypeWhtPayer

(Optional)

nonWhtPayer?: CreatePlatformPartnerBodyTypeNonWhtPayer

CreatePlatformPartnerBodyTypeNonWhtPayer

(Optional)

CreatePlatformPartnerBodyTypeBusinessobject

companyName: string

상호명

taxationType?: PlatformPartnerTaxationType

플랫폼 파트너 과세 유형

(Optional)

플랫폼 파트너 과세 유형

businessRegistrationNumber: string

사업자등록번호

representativeName: string

대표자 이름

companyAddress?: string

사업장 주소

(Optional)

businessType?: string

업태

(Optional)

businessClass?: string

업종

(Optional)

CreatePlatformPartnerBodyTypeNonWhtPayerobject

birthdate?: string

생년월일

(Optional)

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

CreatePlatformPartnerBodyTypeWhtPayerobject

birthdate?: string

생년월일

(Optional)

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

CreatePlatformPartnerErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

CreatePlatformPartnerResponseobject

partner: PlatformPartner

파트너

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

CreatePlatformPartnersErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

CreatePlatformPartnersResponseobject

partners: PlatformPartner[]

생성된 파트너 리스트

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

성

DateRangeobject

from: string

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

until: string

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

DayOfWeekenum

TUE

THU

SAT

MON

SUN

WED

FRI

DeleteBillingKeyErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

DeleteBillingKeyResponseobject

deletedAt: string (RFC 3339 date-time)

빌링키 삭제 완료 시점

DeletePlatformTransferErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

DeletePlatformTransferResponseobject

DeletedBillingKeyInfoobject

status: string

빌링키 상태

billingKey: string

빌링키

merchantId: string

고객사 아이디

storeId: string

상점 아이디

methods?: BillingKeyPaymentMethod[]

빌링키 결제수단 상세 정보

(Optional)

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

channels: SelectedChannel[]

빌링키 발급 시 사용된 채널

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

customer: Customer

고객 정보

customData?: string

사용자 지정 데이터

(Optional)

issueId?: string

고객사가 채번하는 빌링키 발급 건 고유 아이디

(Optional)

issueName?: string

빌링키 발급 건 이름

(Optional)

requestedAt?: string (RFC 3339 date-time)

발급 요청 시점

(Optional)

issuedAt: string (RFC 3339 date-time)

발급 시점

channelGroup?: ChannelGroupSummary

채널 그룹 정보

(Optional)

채널 그룹 정보

pgBillingKeyIssueResponses?: PgBillingKeyIssueResponse[]

채널 별 빌링키 발급 응답

(Optional)

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

deletedAt: string (RFC 3339 date-time)

발급 삭제 시점

DeliveredPaymentEscrowobject

status: string

에스크로 상태

company: string

택배사

invoiceNumber: string

송장번호

sentAt?: string (RFC 3339 date-time)

발송 일시

(Optional)

appliedAt?: string (RFC 3339 date-time)

배송등록 처리 일자

(Optional)

DiscountAmountExceedsTotalAmountErrorobject

type: string

message?: string

(Optional)

DownloadPlatformTransferSheetErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

EasyPayMethodTypeenum

CARD

TRANSFER

CHARGE

EasyPayProviderenum

KB_APP

PAYCO

NAVERPAY

CHAI

TOSS_BRANDPAY

LGPAY

SAMSUNGPAY

KPAY

SKPAY

KAKAOPAY

ALIPAY

LPAY

PINPAY

TMONEY

TOSSPAY

SSGPAY

APPLEPAY

HYPHEN

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)

상태 업데이트 시점

failure: IdentityVerificationFailure

본인인증 실패 정보

FailedPaymentobject

status: string

결제 건 상태

id: string

결제 건 아이디

transactionId: string

결제 건 포트원 채번 아이디

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

merchantId: string

고객사 아이디

storeId: string

상점 아이디

method?: PaymentMethod

결제수단 정보

(Optional)

결제수단 정보

channel?: SelectedChannel

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

(Optional)

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

channelGroup?: ChannelGroupSummary

채널 그룹 정보

(Optional)

채널 그룹 정보

version: PortOneVersion

포트원 버전

scheduleId?: string

결제 예약 건 아이디

(Optional)

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

billingKey?: string

결제 시 사용된 빌링키

(Optional)

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

webhooks?: PaymentWebhook[]

웹훅 발송 내역

(Optional)

requestedAt: string (RFC 3339 date-time)

결제 요청 시점

updatedAt: string (RFC 3339 date-time)

업데이트 시점

statusChangedAt: string (RFC 3339 date-time)

상태 업데이트 시점

orderName: string

주문명

amount: PaymentAmount

결제 금액 세부 정보

currency: Currency

통화 단위

customer: Customer

고객 정보

promotionId?: string

프로모션 아이디

(Optional)

isCulturalExpense?: boolean

문화비 지출 여부

(Optional)

escrow?: PaymentEscrow

에스크로 정보

(Optional)

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

products?: PaymentProduct[]

상품 정보

(Optional)

productCount?: integer (32 bit)

상품 갯수

(Optional)

customData?: string

사용자 지정 데이터

(Optional)

country?: Country

국가

(Optional)

국가

failedAt: string (RFC 3339 date-time)

결제 실패 시점

failure: PaymentFailure

결제 실패 정보

FailedPaymentCancellationobject

status: string

결제 취소 내역 상태

id: string

취소 내역 아이디

pgCancellationId?: string

PG사 결제 취소 내역 아이디

(Optional)

totalAmount: integer (64 bit)

취소 총 금액

taxFreeAmount: integer (64 bit)

취소 금액 중 면세 금액

vatAmount: integer (64 bit)

취소 금액 중 부가세액

easyPayDiscountAmount?: integer (64 bit)

적립형 포인트의 환불 금액

(Optional)

reason: string

취소 사유

cancelledAt?: string (RFC 3339 date-time)

취소 시점

(Optional)

requestedAt: string (RFC 3339 date-time)

취소 요청 시점

FailedPaymentScheduleobject

status: string

결제 예약 건 상태

id: string

결제 예약 건 아이디

merchantId: string

고객사 아이디

storeId: string

상점 아이디

paymentId: string

결제 건 아이디

billingKey: string

빌링키

orderName: string

주문명

isCulturalExpense: boolean

문화비 지출 여부

isEscrow: boolean

에스크로 결제 여부

customer: Customer

고객 정보

customData: string

사용자 지정 데이터

totalAmount: integer (64 bit)

결제 총 금액

taxFreeAmount?: integer (64 bit)

면세액

(Optional)

vatAmount?: integer (64 bit)

부가세

(Optional)

currency: Currency

통화 단위

installmentMonth?: integer (32 bit)

할부 개월 수

(Optional)

noticeUrls?: string[]

웹훅 주소

(Optional)

products?: PaymentProduct[]

상품 정보

(Optional)

createdAt: string (RFC 3339 date-time)

결제 예약 등록 시점

timeToPay: string (RFC 3339 date-time)

결제 예정 시점

startedAt: string (RFC 3339 date-time)

결제 시작 시점

completedAt: string (RFC 3339 date-time)

결제 완료 시점

FailedPgBillingKeyIssueResponseobject

type: string

channel: SelectedChannel

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

failure: BillingKeyFailure

발급 실패 상세 정보

ForbiddenErrorobject

type: string

message?: string

(Optional)

Genderenum

MALE남성

FEMALE여성

OTHER그 외 성별

GetAllPaymentsByCursorResponseobject

items: PaymentWithCursor[]

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

GetAllPaymentsErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

GetBillingKeyInfoErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

GetBillingKeyInfosErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

GetBillingKeyInfosResponseobject

items: BillingKeyInfo[]

조회된 빌링키 리스트

page: PageInfo

반환된 페이지 결과 정보

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

반환된 페이지 결과 정보

GetPlatformAccountHolderErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

GetPlatformAccountTransfersErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

GetPlatformAccountTransfersResponseobject

items: PlatformAccountTransfer[]

조회된 이체내역 리스트

page: PageInfo

반환된 페이지 결과 정보

GetPlatformAdditionalFeePoliciesErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

GetPlatformAdditionalFeePoliciesResponseobject

items: PlatformAdditionalFeePolicy[]

조회된 추가 수수료 정책 리스트

page: PageInfo

반환된 페이지 결과 정보

GetPlatformAdditionalFeePolicyErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

GetPlatformBulkPayoutsErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

GetPlatformBulkPayoutsResponseobject

items: PlatformBulkPayout[]

page: PageInfo

반환된 페이지 결과 정보

counts: PlatformBulkPayoutStatusStats

PlatformBulkPayoutStatusStats

GetPlatformContractErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

GetPlatformContractsErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

GetPlatformContractsResponseobject

items: PlatformContract[]

조회된 계약 리스트

page: PageInfo

반환된 페이지 결과 정보

GetPlatformDiscountSharePoliciesErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

GetPlatformDiscountSharePoliciesResponseobject

items: PlatformDiscountSharePolicy[]

조회된 할인 분담 정책 리스트

page: PageInfo

반환된 페이지 결과 정보

GetPlatformDiscountSharePolicyErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

GetPlatformPartnerErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

GetPlatformPartnerSettlementsErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

GetPlatformPartnerSettlementsResponseobject

items: PlatformPartnerSettlement[]

조회된 정산내역 리스트

page: PageInfo

반환된 페이지 결과 정보

counts: PlatformPartnerSettlementStatusStats

PlatformPartnerSettlementStatusStats

GetPlatformPartnersErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

GetPlatformPartnersResponseobject

items: PlatformPartner[]

조회된 파트너 리스트

page: PageInfo

반환된 페이지 결과 정보

GetPlatformPayoutsErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

GetPlatformPayoutsResponseobject

items: PlatformPayout[]

page: PageInfo

반환된 페이지 결과 정보

counts: PlatformPayoutStatusStats

PlatformPayoutStatusStats

GetPlatformTransferErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

GetPlatformTransferSummariesErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

GetPlatformTransferSummariesResponseobject

transferSummaries: PlatformTransferSummary[]

page: PageInfo

반환된 페이지 결과 정보

GetPromotionErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

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)

상태 업데이트 시점

failure: IdentityVerificationFailure

본인인증 실패 정보

IdentityVerificationAlreadySentErrorobject

type: string

message?: string

(Optional)

IdentityVerificationAlreadyVerifiedErrorobject

type: string

message?: string

(Optional)

IdentityVerificationFailureobject

reason?: string

실패 사유

(Optional)

pgCode?: string

PG사 실패 코드

(Optional)

pgMessage?: string

PG사 실패 메시지

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

특수 문자(-) 없이 숫자로만 이루어진 번호 형식입니다. 다날: 별도 계약이 필요합니다. KG이니시스: 항상 제공합니다.

birthDate: string

생년월일 (yyyy-MM-dd)

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

gender?: Gender

성별

(Optional)

성별

isForeigner?: boolean

외국인 여부

(Optional)

다날: 별도 계약이 필요합니다. KG이니시스: 항상 제공합니다.

ci?: string

CI (개인 고유 식별키)

(Optional)

개인을 식별하기 위한 고유 정보입니다. 다날: 항상 제공합니다. KG이니시스: 카카오를 제외한 인증사에서 제공합니다.

di?: string

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

(Optional)

중복 가입을 방지하기 위해 개인을 식별하는 사이트별 고유 정보입니다. 다날: 항상 제공합니다. KG이니시스: 제공하지 않습니다.

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)

IssueBillingKeyErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

IssueBillingKeyResponseobject

billingKeyInfo: BillingKeyInfoSummary

BillingKeyInfoSummary

channelSpecificFailures?: ChannelSpecificFailure[]

발급에 실패한 채널이 있을시 실패 정보

(Optional)

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

수동 발급 여부

IssuedBillingKeyInfoobject

status: string

빌링키 상태

billingKey: string

빌링키

merchantId: string

고객사 아이디

storeId: string

상점 아이디

methods?: BillingKeyPaymentMethod[]

빌링키 결제수단 상세 정보

(Optional)

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

channels: SelectedChannel[]

빌링키 발급 시 사용된 채널

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

customer: Customer

고객 정보

customData?: string

사용자 지정 데이터

(Optional)

issueId?: string

고객사가 채번하는 빌링키 발급 건 고유 아이디

(Optional)

issueName?: string

빌링키 발급 건 이름

(Optional)

requestedAt?: string (RFC 3339 date-time)

발급 요청 시점

(Optional)

issuedAt: string (RFC 3339 date-time)

발급 시점

channelGroup?: ChannelGroupSummary

채널 그룹 정보

(Optional)

채널 그룹 정보

pgBillingKeyIssueResponses?: PgBillingKeyIssueResponse[]

채널 별 빌링키 발급 응답

(Optional)

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

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)

발급 시점

IssuedPgBillingKeyIssueResponseobject

type: string

channel: SelectedChannel

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

pgTxId?: string

PG사 거래 아이디

(Optional)

method?: BillingKeyPaymentMethod

빌링키 발급 수단 정보

(Optional)

빌링키 발급 수단 정보

LoginViaApiSecretErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

LoginViaApiSecretResponseobject

accessToken: string

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

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

refreshToken: string

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

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

MaxTransactionCountReachedErrorobject

type: string

message?: string

(Optional)

MaxWebhookRetryCountReachedErrorobject

type: string

message?: string

(Optional)

ModifyEscrowLogisticsErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

ModifyEscrowLogisticsResponseobject

invoiceNumber: string

송장 번호

sentAt: string (RFC 3339 date-time)

발송 시점

modifiedAt: string (RFC 3339 date-time)

에스크로 정보 수정 시점

MonthDayobject

month: integer (32 bit)

day: integer (32 bit)

OneLineAddressobject

type: string

oneLine: string

주소 (한 줄)

PageInfoobject

number: integer (32 bit)

요청된 페이지 번호

size: integer (32 bit)

요청된 페이지 당 객체 수

totalCount: integer (32 bit)

실제 반환된 객체 수

PaidPaymentobject

status: string

결제 건 상태

id: string

결제 건 아이디

transactionId: string

결제 건 포트원 채번 아이디

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

merchantId: string

고객사 아이디

storeId: string

상점 아이디

method?: PaymentMethod

결제수단 정보

(Optional)

결제수단 정보

channel: SelectedChannel

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

channelGroup?: ChannelGroupSummary

채널 그룹 정보

(Optional)

채널 그룹 정보

version: PortOneVersion

포트원 버전

scheduleId?: string

결제 예약 건 아이디

(Optional)

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

billingKey?: string

결제 시 사용된 빌링키

(Optional)

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

webhooks?: PaymentWebhook[]

웹훅 발송 내역

(Optional)

requestedAt: string (RFC 3339 date-time)

결제 요청 시점

updatedAt: string (RFC 3339 date-time)

업데이트 시점

statusChangedAt: string (RFC 3339 date-time)

상태 업데이트 시점

orderName: string

주문명

amount: PaymentAmount

결제 금액 세부 정보

currency: Currency

통화 단위

customer: Customer

고객 정보

promotionId?: string

프로모션 아이디

(Optional)

isCulturalExpense?: boolean

문화비 지출 여부

(Optional)

escrow?: PaymentEscrow

에스크로 정보

(Optional)

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

products?: PaymentProduct[]

상품 정보

(Optional)

productCount?: integer (32 bit)

상품 갯수

(Optional)

customData?: string

사용자 지정 데이터

(Optional)

country?: Country

국가

(Optional)

국가

paidAt: string (RFC 3339 date-time)

결제 완료 시점

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

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

channelGroup?: ChannelGroupSummary

채널 그룹 정보

(Optional)

채널 그룹 정보

version: PortOneVersion

포트원 버전

scheduleId?: string

결제 예약 건 아이디

(Optional)

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

billingKey?: string

결제 시 사용된 빌링키

(Optional)

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

webhooks?: PaymentWebhook[]

웹훅 발송 내역

(Optional)

requestedAt: string (RFC 3339 date-time)

결제 요청 시점

updatedAt: string (RFC 3339 date-time)

업데이트 시점

statusChangedAt: string (RFC 3339 date-time)

상태 업데이트 시점

orderName: string

주문명

amount: PaymentAmount

결제 금액 세부 정보

currency: Currency

통화 단위

customer: Customer

고객 정보

promotionId?: string

프로모션 아이디

(Optional)

isCulturalExpense?: boolean

문화비 지출 여부

(Optional)

escrow?: PaymentEscrow

에스크로 정보

(Optional)

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

products?: PaymentProduct[]

상품 정보

(Optional)

productCount?: integer (32 bit)

상품 갯수

(Optional)

customData?: string

사용자 지정 데이터

(Optional)

country?: Country

국가

(Optional)

국가

paidAt?: string (RFC 3339 date-time)

결제 완료 시점

(Optional)

pgTxId?: string

PG사 거래 아이디

(Optional)

cashReceipt?: PaymentCashReceipt

결제 건 내 현금영수증 정보

(Optional)

결제 건 내 현금영수증 정보

receiptUrl?: string

거래 영수증 URL

(Optional)

cancellations: PaymentCancellation[]

결제 취소 내역

cancelledAt: string (RFC 3339 date-time)

결제 취소 시점

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

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

channelGroup?: ChannelGroupSummary

채널 그룹 정보

(Optional)

채널 그룹 정보

version: PortOneVersion

포트원 버전

scheduleId?: string

결제 예약 건 아이디

(Optional)

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

billingKey?: string

결제 시 사용된 빌링키

(Optional)

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

webhooks?: PaymentWebhook[]

웹훅 발송 내역

(Optional)

requestedAt: string (RFC 3339 date-time)

결제 요청 시점

updatedAt: string (RFC 3339 date-time)

업데이트 시점

statusChangedAt: string (RFC 3339 date-time)

상태 업데이트 시점

orderName: string

주문명

amount: PaymentAmount

결제 금액 세부 정보

currency: Currency

통화 단위

customer: Customer

고객 정보

promotionId?: string

프로모션 아이디

(Optional)

isCulturalExpense?: boolean

문화비 지출 여부

(Optional)

escrow?: PaymentEscrow

에스크로 정보

(Optional)

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

products?: PaymentProduct[]

상품 정보

(Optional)

productCount?: integer (32 bit)

상품 갯수

(Optional)

customData?: string

사용자 지정 데이터

(Optional)

country?: Country

국가

(Optional)

국가

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

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

channelGroup?: ChannelGroupSummary

채널 그룹 정보

(Optional)

채널 그룹 정보

version: PortOneVersion

포트원 버전

scheduleId?: string

결제 예약 건 아이디

(Optional)

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

billingKey?: string

결제 시 사용된 빌링키

(Optional)

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

webhooks?: PaymentWebhook[]

웹훅 발송 내역

(Optional)

requestedAt: string (RFC 3339 date-time)

결제 요청 시점

updatedAt: string (RFC 3339 date-time)

업데이트 시점

statusChangedAt: string (RFC 3339 date-time)

상태 업데이트 시점

orderName: string

주문명

amount: PaymentAmount

결제 금액 세부 정보

currency: Currency

통화 단위

customer: Customer

고객 정보

promotionId?: string

프로모션 아이디

(Optional)

isCulturalExpense?: boolean

문화비 지출 여부

(Optional)

escrow?: PaymentEscrow

에스크로 정보

(Optional)

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

products?: PaymentProduct[]

상품 정보

(Optional)

productCount?: integer (32 bit)

상품 갯수

(Optional)

customData?: string

사용자 지정 데이터

(Optional)

country?: Country

국가

(Optional)

국가

paidAt?: string (RFC 3339 date-time)

결제 완료 시점

(Optional)

pgTxId?: string

PG사 거래 아이디

(Optional)

cashReceipt?: PaymentCashReceipt

결제 건 내 현금영수증 정보

(Optional)

결제 건 내 현금영수증 정보

receiptUrl?: string

거래 영수증 URL

(Optional)

cancellations: PaymentCancellation[]

결제 취소 내역

cancelledAt: string (RFC 3339 date-time)

결제 취소 시점

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)

취소 시점

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)

분리 형식 주소 입력 정보

PaymentFailureobject

reason?: string

실패 사유

(Optional)

pgCode?: string

PG사 실패 코드

(Optional)

pgMessage?: string

PG사 실패 메시지

(Optional)

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?: Bank

은행

(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?: Bank

은행

(Optional)

은행

PaymentMethodTypeenum

GIFT_CERTIFICATE

VIRTUAL_ACCOUNT

MOBILE

CARD

TRANSFER

EASY_PAY

PaymentMethodVirtualAccountobject

type: string

bank?: Bank

은행

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

vatAmount?: integer (64 bit)

부가세

(Optional)

currency: Currency

통화 단위

installmentMonth?: integer (32 bit)

할부 개월 수

(Optional)

noticeUrls?: string[]

웹훅 주소

(Optional)

products?: PaymentProduct[]

상품 정보

(Optional)

createdAt: string (RFC 3339 date-time)

결제 예약 등록 시점

timeToPay: string (RFC 3339 date-time)

결제 예정 시점

startedAt: string (RFC 3339 date-time)

결제 시작 시점

completedAt: string (RFC 3339 date-time)

결제 완료 시점

PaymentScheduleAlreadyExistsErrorobject

type: string

message?: string

(Optional)

PaymentScheduleAlreadyProcessedErrorobject

type: string

message?: string

(Optional)

PaymentScheduleAlreadyRevokedErrorobject

type: string

message?: string

(Optional)

PaymentScheduleNotFoundErrorobject

type: string

message?: string

(Optional)

PaymentScheduleSummaryobject

id: string

결제 예약 건 아이디

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

해당 결제 건의 커서 정보

PendingPaymentScheduleobject

status: string

결제 예약 건 상태

id: string

결제 예약 건 아이디

merchantId: string

고객사 아이디

storeId: string

상점 아이디

paymentId: string

결제 건 아이디

billingKey: string

빌링키

orderName: string

주문명

isCulturalExpense: boolean

문화비 지출 여부

isEscrow: boolean

에스크로 결제 여부

customer: Customer

고객 정보

customData: string

사용자 지정 데이터

totalAmount: integer (64 bit)

결제 총 금액

taxFreeAmount?: integer (64 bit)

면세액

(Optional)

vatAmount?: integer (64 bit)

부가세

(Optional)

currency: Currency

통화 단위

installmentMonth?: integer (32 bit)

할부 개월 수

(Optional)

noticeUrls?: string[]

웹훅 주소

(Optional)

products?: PaymentProduct[]

상품 정보

(Optional)

createdAt: string (RFC 3339 date-time)

결제 예약 등록 시점

timeToPay: string (RFC 3339 date-time)

결제 예정 시점

startedAt: string (RFC 3339 date-time)

결제 시작 시점

completedAt: string (RFC 3339 date-time)

결제 완료 시점

PgBillingKeyIssueResponseunion

type: string (Union Tag)

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

channel: SelectedChannel

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

failure: BillingKeyFailure

발급 실패 상세 정보

PgProviderenum

KICC

SYRUP

PAYCO

KCP_BILLING

SMARTRO_V2

NAVERPAY

CHAI

NICE_V2

PAYPAL_V2

KPN

KAKAO

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

HYPHEN

INICIS_V2

KCP_V2

INICIS_UNIFIED

BLUEWALNUT

NICE

TOSSPAYMENTS

PAYPLE

KSNET

KCP

PgProviderErrorobject

type: string

message?: string

(Optional)

pgCode: string

pgMessage: string

PlatformAccountobject

bank: Bank

은행

currency: Currency

통화 단위

number: string

계좌번호

holder: string

예금주명

status: PlatformAccountStatus

플랫폼 계좌 상태

PlatformAccountHolderobject

holderName: string

계좌 예금주 이름

accountVerificationId: string

계좌 검증 아이디

PlatformAccountStatusenum

NOT_VERIFIED계좌 인증 안됨

EXPIRED계좌 인증 만료됨

VERIFY_FAILED계좌 인증 실패함

VERIFIED계좌 인증 완료됨

VERIFYING계좌 인증 중

UNKNOWN알 수 없는 상태

PlatformAccountTransferunion

type: string (Union Tag)

계좌 이체 유형

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

id: string

계좌 이체 아이디

currency: Currency

통화 단위

amount: integer (64 bit)

금액

depositMemo?: string

입금 계좌 적요

(Optional)

isForTest: boolean

createdAt: string (RFC 3339 date-time)

생성 일자

updatedAt: string (RFC 3339 date-time)

수정 일자

depositorName: string

입금자명

PlatformAccountVerificationAlreadyUsedErrorobject

type: string

message?: string

(Optional)

PlatformAccountVerificationFailedErrorobject

type: string

message?: string

(Optional)

PlatformAccountVerificationNotFoundErrorobject

type: string

message?: string

(Optional)

PlatformAdditionalFeePoliciesNotFoundErrorobject

type: string

ids: string[]

graphqlIds: string[]

message?: string

(Optional)

PlatformAdditionalFeePolicyobject

id: string

추가 수수료 정책 고유 아이디

graphqlId: string

추가 수수료 정책 이름

fee: PlatformFee

플랫폼 중개수수료 정보

memo?: string

해당 추가 수수료 정책에 대한 메모

(Optional)

vatPayer: PlatformPayer

금액 부담 주체

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

isArchived: boolean

보관 여부

appliedAt: string (RFC 3339 date-time)

변경 적용 시점

PlatformAdditionalFeePolicyAlreadyExistsErrorobject

type: string

message?: string

(Optional)

PlatformAdditionalFeePolicyNotFoundErrorobject

type: string

message?: string

(Optional)

PlatformAdditionalFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedErrorobject

type: string

id: string

graphqlId: string

feeCurrency: Currency

통화 단위

settlementCurrency: Currency

통화 단위

message?: string

(Optional)

PlatformArchivedAdditionalFeePolicyErrorobject

type: string

message?: string

(Optional)

PlatformArchivedContractErrorobject

type: string

message?: string

(Optional)

PlatformArchivedDiscountSharePolicyErrorobject

type: string

message?: string

(Optional)

PlatformArchivedPartnerErrorobject

type: string

message?: string

(Optional)

PlatformBulkPayoutobject

id: string

일괄 지급 고유 아이디

graphqlId: string

creatorId: string

method: PlatformPayoutMethod

PlatformPayoutMethod

arePayoutsGenerated: boolean

totalPayoutAmount: integer (64 bit)

status: PlatformBulkPayoutStatus

PlatformBulkPayoutStatus

payoutStats: PlatformBulkPayoutStats

PlatformBulkPayoutStats

statusUpdatedAt: string (RFC 3339 date-time)

createdAt: string (RFC 3339 date-time)

updatedAt: string (RFC 3339 date-time)

scheduledAt?: string (RFC 3339 date-time)

(Optional)

PlatformBulkPayoutStatsobject

amount: PlatformPayoutStatusStats

PlatformPayoutStatusStats

PlatformPayoutStatusStats

PlatformBulkPayoutStatusenum

STOPPED

PREPARED

CANCELLED

COMPLETED

SCHEDULED

PREPARING

ONGOING

PlatformBulkPayoutStatusStatsobject

scheduled: integer (64 bit)

preparing: integer (64 bit)

prepared: integer (64 bit)

ongoing: integer (64 bit)

stopped: integer (64 bit)

cancelled: integer (64 bit)

completed: integer (64 bit)

PlatformCancelOrderTransfersExistsErrorobject

type: string

message?: string

(Optional)

PlatformCancellableAmountExceededErrorobject

type: string

cancellableAmount: integer (64 bit)

requestAmount: integer (64 bit)

amountType: PlatformCancellableAmountType

금액 타입

message?: string

(Optional)

PlatformCancellableAmountTypeenum

SUPPLY_WITH_VAT공급대가

공급가액과 부가세를 더한 금액입니다.

TAX_FREE면세 금액

PlatformCancellableDiscountAmountExceededErrorobject

type: string

discountSharePolicyId: string

discountSharePolicyGraphqlId: string

cancellableAmount: integer (64 bit)

requestAmount: integer (64 bit)

productId?: string

(Optional)

message?: string

(Optional)

PlatformCancellableDiscountTaxFreeAmountExceededErrorobject

type: string

discountSharePolicyId: string

discountSharePolicyGraphqlId: string

cancellableAmount: integer (64 bit)

requestAmount: integer (64 bit)

productId?: string

(Optional)

message?: string

(Optional)

PlatformCancellableProductQuantityExceededErrorobject

type: string

productId: string

cancellableQuantity: integer (64 bit)

message?: string

(Optional)

PlatformCancellationAndPaymentTypeMismatchedErrorobject

type: string

message?: string

(Optional)

PlatformCancellationNotFoundErrorobject

type: string

message?: string

(Optional)

PlatformCannotArchiveScheduledAdditionalFeePolicyErrorobject

type: string

message?: string

(Optional)

PlatformCannotArchiveScheduledContractErrorobject

type: string

message?: string

(Optional)

PlatformCannotArchiveScheduledDiscountSharePolicyErrorobject

type: string

message?: string

(Optional)

PlatformCannotArchiveScheduledPartnerErrorobject

type: string

message?: string

(Optional)

PlatformCannotSpecifyTransferErrorobject

type: string

message?: string

(Optional)

PlatformContactobject

담당자 이름

phoneNumber?: string

담당자 휴대폰 번호

(Optional)

email: string

담당자 이메일

PlatformContractobject

id: string

계약 고유 아이디

graphqlId: string

계약 이름

memo?: string

계약 내부 표기를 위한 메모

(Optional)

platformFee: PlatformFee

플랫폼 중개수수료 정보

settlementCycle: PlatformSettlementCycle

정산 주기

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

platformFeeVatPayer: PlatformPayer

금액 부담 주체

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

subtractPaymentVatAmount: boolean

정산 시 결제금액 부가세 감액 여부

false인 경우 정산금에서 결제 금액 부가세를 감액하지 않고, true인 경우 정산금에서 결제 금액 부가세를 감액합니다.

isArchived: boolean

보관 여부

appliedAt: string (RFC 3339 date-time)

변경 적용 시점

PlatformContractAlreadyExistsErrorobject

type: string

message?: string

(Optional)

PlatformContractNotFoundErrorobject

type: string

message?: string

(Optional)

PlatformContractPlatformFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedErrorobject

type: string

id: string

graphqlId: string

feeCurrency: Currency

통화 단위

settlementCurrency: Currency

통화 단위

message?: string

(Optional)

PlatformContractsNotFoundErrorobject

type: string

ids: string[]

graphqlIds: string[]

message?: string

(Optional)

PlatformCurrencyNotSupportedErrorobject

type: string

message?: string

(Optional)

PlatformDepositAccountTransferobject

type: string

계좌 이체 유형

id: string

계좌 이체 아이디

currency: Currency

통화 단위

amount: integer (64 bit)

금액

depositMemo?: string

입금 계좌 적요

(Optional)

isForTest: boolean

createdAt: string (RFC 3339 date-time)

생성 일자

updatedAt: string (RFC 3339 date-time)

수정 일자

depositorName: string

입금자명

PlatformDiscountSharePoliciesNotFoundErrorobject

type: string

ids: string[]

graphqlIds: string[]

message?: string

(Optional)

PlatformDiscountSharePolicyobject

id: string

graphqlId: string

할인 분담 정책 이름

partnerShareRate: integer (32 bit)

할인 분담율

파트너가 분담할 할인금액의 비율을 의미하는 밀리 퍼센트 단위 (10^-5) 의 음이 아닌 정수이며, 파트너가 부담할 금액은 할인금액 * partnerShareRate * 10^5 로 책정합니다.

memo?: string

해당 할인 분담에 대한 메모

(Optional)

isArchived: boolean

보관 여부

appliedAt: string (RFC 3339 date-time)

변경 적용 시점

PlatformDiscountSharePolicyAlreadyExistsErrorobject

type: string

message?: string

(Optional)

PlatformDiscountSharePolicyIdDuplicatedErrorobject

type: string

id: string

graphqlId: string

message?: string

(Optional)

PlatformDiscountSharePolicyNotFoundErrorobject

type: string

message?: string

(Optional)

PlatformExternalApiFailedErrorobject

type: string

message?: string

(Optional)

PlatformExternalApiTemporarilyFailedErrorobject

type: string

message?: string

(Optional)

PlatformExternalPaymentobject

type: string

id: string

결제 아이디

orderName?: string

주문 명

(Optional)

currency: Currency

통화 단위

method?: PlatformPaymentMethod

결제 수단

(Optional)

결제 수단

paidAt?: string (RFC 3339 date-time)

결제 일시

(Optional)

PlatformFeeunion

type: string (Union Tag)

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

amount: integer (64 bit)

고정된 수수료 금액

PlatformFeeInputobject

fixedRate?: integer (32 bit)

정률 수수료

(Optional)

fixedAmount?: integer (64 bit)

정액 수수료

(Optional)

PlatformFixedAmountFeeobject

type: string

amount: integer (64 bit)

고정된 수수료 금액

PlatformFixedRateFeeobject

type: string

rate: integer (32 bit)

수수료율

총 금액 대비 수수료 비율을 의미하며, 밀리 퍼센트 단위 (10^-5) 의 음이 아닌 정수입니다. 총 금액 * rate * 10^5 (rate * 10^3 %) 만큼 수수료를 책정합니다.

PlatformInsufficientDataToChangePartnerTypeErrorobject

type: string

message?: string

(Optional)

PlatformManualTransferobject

type: string

id: string

정산건 아이디

graphqlId: string

partner: PlatformPartner

파트너

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

status: PlatformTransferStatus

정산 상태

memo?: string

메모

(Optional)

settlementDate: string

정산 일

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

settlementCurrency: Currency

통화 단위

payoutId?: string

(Optional)

payoutGraphqlId?: string

(Optional)

isForTest: boolean

테스트 모드 여부

userDefinedProperties: PlatformUserDefinedPropertyKeyValue[]

사용자 정의 속성

settlementAmount: integer (64 bit)

정산 금액

PlatformManualTransferSummaryobject

type: string

id: string

graphqlId: string

partner: PlatformTransferSummaryPartner

PlatformTransferSummaryPartner

status: PlatformTransferStatus

정산 상태

memo?: string

(Optional)

settlementDate: string

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

settlementCurrency: Currency

통화 단위

isForTest: boolean

partnerUserDefinedProperties: PlatformUserDefinedPropertyKeyValue[]

사용자 정의 속성

userDefinedProperties: PlatformUserDefinedPropertyKeyValue[]

사용자 정의 속성

settlementAmount: integer (64 bit)

PlatformNotEnabledErrorobject

type: string

message?: string

(Optional)

PlatformNotSupportedBankErrorobject

type: string

message?: string

(Optional)

PlatformOrderCancelTransferobject

type: string

id: string

정산건 아이디

graphqlId: string

partner: PlatformPartner

파트너

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

status: PlatformTransferStatus

정산 상태

memo?: string

메모

(Optional)

settlementDate: string

정산 일

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

settlementCurrency: Currency

통화 단위

payoutId?: string

(Optional)

payoutGraphqlId?: string

(Optional)

isForTest: boolean

테스트 모드 여부

userDefinedProperties: PlatformUserDefinedPropertyKeyValue[]

사용자 정의 속성

amount: PlatformOrderSettlementAmount

정산 금액 정보

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

contract: PlatformContract

계약

payment: PlatformPayment

결제 정보

settlementStartDate: string

정산 시작일

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

orderLines: PlatformOrderTransferOrderLine[]

주문 항목 리스트

additionalFees: PlatformOrderTransferAdditionalFee[]

정산 금액 계산 시 사용된 추가 수수료 정보

discounts: PlatformOrderTransferDiscount[]

정산 금액 계산 시 사용된 할인 정보

cancellation: PlatformOrderTransferCancellation

주문 취소 정보

parameters: TransferParameters

TransferParameters

PlatformOrderCancelTransferSummaryobject

type: string

id: string

graphqlId: string

storeId: string

partner: PlatformTransferSummaryPartner

PlatformTransferSummaryPartner

status: PlatformTransferStatus

정산 상태

memo?: string

(Optional)

settlementDate: string

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

settlementCurrency: Currency

통화 단위

isForTest: boolean

partnerUserDefinedProperties: PlatformUserDefinedPropertyKeyValue[]

사용자 정의 속성

userDefinedProperties: PlatformUserDefinedPropertyKeyValue[]

사용자 정의 속성

amount: PlatformOrderSettlementAmount

정산 금액 정보

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

payment: PlatformTransferSummaryPayment

PlatformTransferSummaryPayment

settlementStartDate: string

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

PlatformOrderDetailMismatchedErrorobject

type: string

message?: string

(Optional)

PlatformOrderSettlementAmountobject

settlement: integer (64 bit)

정산 금액

payment: integer (64 bit)

결제 금액

paymentVat: integer (64 bit)

결제 금액 부가세

paymentVatBurden: integer (64 bit)

결제 금액 부가세 부담금액

참조된 계약의 결제 금액 부가세 감액 여부에 따라 false인 경우 0원, true인 경우 결제 금액 부가세입니다.

taxFree: integer (64 bit)

결제 면세 금액

해당 필드는 deprecated되어 9월까지만 유지되고 이후 삭제될 예정입니다. 대신 paymentTaxFree 필드를 사용해주세요.

supply: integer (64 bit)

결제 공급가액

해당 필드는 deprecated되어 9월까지만 유지되고 이후 삭제될 예정입니다. 대신 paymentSupply 필드를 사용해주세요.

paymentTaxFree: integer (64 bit)

결제 면세 금액

paymentSupply: integer (64 bit)

결제 공급가액

order: integer (64 bit)

주문 금액

orderTaxFree: integer (64 bit)

면세 주문 금액

platformFee: integer (64 bit)

중개 수수료

platformFeeVat: integer (64 bit)

중개 수수료 부가세

additionalFee: integer (64 bit)

추가 수수료

additionalFeeVat: integer (64 bit)

추가 수수료 부가세

discount: integer (64 bit)

할인 금액

discountTaxFree: integer (64 bit)

면세 할인 금액

discountShare: integer (64 bit)

할인 분담 금액

discountShareTaxFree: integer (64 bit)

면세 할인 분담 금액

PlatformOrderTransferobject

type: string

id: string

정산건 아이디

graphqlId: string

partner: PlatformPartner

파트너

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

status: PlatformTransferStatus

정산 상태

memo?: string

메모

(Optional)

settlementDate: string

정산 일

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

settlementCurrency: Currency

통화 단위

payoutId?: string

(Optional)

payoutGraphqlId?: string

(Optional)

isForTest: boolean

테스트 모드 여부

userDefinedProperties: PlatformUserDefinedPropertyKeyValue[]

사용자 정의 속성

amount: PlatformOrderSettlementAmount

정산 금액 정보

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

contract: PlatformContract

계약

payment: PlatformPayment

결제 정보

settlementStartDate: string

정산 시작일

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

orderLines: PlatformOrderTransferOrderLine[]

주문 항목 리스트

additionalFees: PlatformOrderTransferAdditionalFee[]

정산 금액 계산 시 사용된 추가 수수료 정보

discounts: PlatformOrderTransferDiscount[]

정산 금액 계산 시 사용된 할인 정보

parameters: TransferParameters

TransferParameters

PlatformOrderTransferAdditionalFeeobject

policy: PlatformAdditionalFeePolicy

추가 수수료 정책

amount: integer (64 bit)

추가 수수료 금액

vat: integer (64 bit)

추가 수수료 부가세 금액

PlatformOrderTransferAlreadyCancelledErrorobject

type: string

message?: string

(Optional)

PlatformOrderTransferCancellationobject

id: string

주문 취소 아이디

cancelledAt: string (RFC 3339 date-time)

취소 일시

PlatformOrderTransferDiscountobject

sharePolicy: PlatformDiscountSharePolicy

할인 분담 정책

amount: integer (64 bit)

할인 금액

taxFreeAmount: integer (64 bit)

면세 할인 금액

shareAmount: integer (64 bit)

할인 분담 금액

shareTaxFreeAmount: integer (64 bit)

면세 할인 분담 금액

PlatformOrderTransferOrderLineobject

product: PlatformOrderTransferProduct

상품

quantity: integer (32 bit)

상품 수량

discounts: PlatformOrderTransferDiscount[]

상품 할인 정보

additionalFees: PlatformOrderTransferAdditionalFee[]

상품 추가 수수료 정보

amount: PlatformOrderSettlementAmount

정산 금액 정보

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

PlatformOrderTransferProductobject

id: string

상품 아이디

상품 이름

amount: integer (64 bit)

상품 금액

taxFreeAmount: integer (64 bit)

상품 면세 금액

tag?: string

태그

(Optional)

PlatformOrderTransferSummaryobject

type: string

id: string

graphqlId: string

storeId: string

partner: PlatformTransferSummaryPartner

PlatformTransferSummaryPartner

status: PlatformTransferStatus

정산 상태

memo?: string

(Optional)

settlementDate: string

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

settlementCurrency: Currency

통화 단위

isForTest: boolean

partnerUserDefinedProperties: PlatformUserDefinedPropertyKeyValue[]

사용자 정의 속성

userDefinedProperties: PlatformUserDefinedPropertyKeyValue[]

사용자 정의 속성

amount: PlatformOrderSettlementAmount

정산 금액 정보

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

payment: PlatformTransferSummaryPayment

PlatformTransferSummaryPayment

settlementStartDate: string

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

PlatformPartnerobject

id: string

파트너 고유 아이디

graphqlId: string

파트너 법인명 혹은 이름

contact: PlatformContact

플랫폼 파트너 담당자 연락 정보

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

account: PlatformAccount

플랫폼 정산 계좌

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

status: PlatformPartnerStatus

플랫폼 파트너 상태

defaultContractId: string

파트너에 설정된 기본 계약 아이디

memo?: string

파트너에 대한 메모

(Optional)

tags: string[]

파트너의 태그 리스트

type: PlatformPartnerType

파트너 유형별 추가 정보

isArchived: boolean

보관 여부

appliedAt: string (RFC 3339 date-time)

변경 적용 시점

userDefinedProperties: PlatformProperties

PlatformProperties

PlatformPartnerBusinessStatusenum

SUSPENDED휴업

NOT_VERIFIED인증 되지 않음

IN_BUSINESS사업 중

CLOSED폐업

VERIFY_FAILED인증 실패

NOT_FOUND대응되는 사업자 없음

VERIFYING인증 대기 중

PlatformPartnerIdAlreadyExistsErrorobject

type: string

message?: string

(Optional)

PlatformPartnerIdsAlreadyExistErrorobject

type: string

ids: string[]

graphqlIds: string[]

message?: string

(Optional)

PlatformPartnerIdsDuplicatedErrorobject

type: string

ids: string[]

graphqlIds: string[]

message?: string

(Optional)

PlatformPartnerManualSettlementobject

type: string

id: string

정산내역 아이디

graphqlId: string

partner: PlatformPartner

파트너

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

settlementDate: string

정산 일

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

settlementCurrency: Currency

통화 단위

status: PlatformPartnerSettlementStatus

정산 상태

memo?: string

메모

(Optional)

amount: integer (64 bit)

정산 금액

isForTest: boolean

테스트 모드 여부

PlatformPartnerNotFoundErrorobject

type: string

message?: string

(Optional)

PlatformPartnerOrderCancelSettlementobject

type: string

id: string

정산내역 아이디

graphqlId: string

partner: PlatformPartner

파트너

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

settlementDate: string

정산 일

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

settlementCurrency: Currency

통화 단위

status: PlatformPartnerSettlementStatus

정산 상태

memo?: string

메모

(Optional)

contract: PlatformContract

계약

settlementStartDateRange: DateRange

DateRange

amount: PlatformOrderSettlementAmount

정산 금액 정보

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

isForTest: boolean

테스트 모드 여부

PlatformPartnerOrderSettlementobject

type: string

id: string

정산내역 아이디

graphqlId: string

partner: PlatformPartner

파트너

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

settlementDate: string

정산 일

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

settlementCurrency: Currency

통화 단위

status: PlatformPartnerSettlementStatus

정산 상태

memo?: string

메모

(Optional)

contract: PlatformContract

계약

settlementStartDateRange: DateRange

DateRange

amount: PlatformOrderSettlementAmount

정산 금액 정보

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

isForTest: boolean

테스트 모드 여부

PlatformPartnerPayoutAccountTransferobject

type: string

계좌 이체 유형

id: string

계좌 이체 아이디

sequenceNumber: integer (32 bit)

거래 일련번호

currency: Currency

통화 단위

depositBank: Bank

은행

depositAccountNumber: string

입금 계좌 번호

amount: integer (64 bit)

금액

withdrawalMemo?: string

출금 계좌 적요

(Optional)

depositMemo?: string

입금 계좌 적요

(Optional)

balance?: integer (64 bit)

잔액

(Optional)

failReason?: string

실패 사유

(Optional)

isForTest: boolean

createdAt: string (RFC 3339 date-time)

생성 일자

updatedAt: string (RFC 3339 date-time)

수정 일자

partnerId: string

파트너 고유 아이디

partnerGraphqlId: string

bulkPayoutId: string

일괄 지급 고유 아이디

bulkPayoutGraphqlId: string

payoutId: string

지급 고유 아이디

payoutGraphqlId: string

PlatformPartnerSettlementunion

type: string (Union Tag)

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

id: string

정산내역 아이디

graphqlId: string

partner: PlatformPartner

파트너

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

settlementDate: string

정산 일

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

settlementCurrency: Currency

통화 단위

status: PlatformPartnerSettlementStatus

정산 상태

memo?: string

메모

(Optional)

amount: integer (64 bit)

정산 금액

isForTest: boolean

테스트 모드 여부

PlatformPartnerSettlementStatusenum

PAYOUT_FAILED지급 실패

PAYOUT_SCHEDULED지급 예약

PAYOUT_WITHHELD지급 보류

PAID_OUT지급 완료

PAYOUT_PREPARED지급 예정

IN_PAYOUT지급 중

PlatformPartnerSettlementStatusStatsobject

payoutScheduled: integer (64 bit)

payoutPrepared: integer (64 bit)

payoutWithheld: integer (64 bit)

payoutFailed: integer (64 bit)

inPayout: integer (64 bit)

paidOut: integer (64 bit)

PlatformPartnerStatusenum

PENDING승인 대기 중

APPROVED승인 완료

REJECTED승인 거절

PlatformPartnerTaxationTypeenum

NORMAL일반 과세

SIMPLE_TAX_INVOICE_ISSUER간이과세(세금계산서 발행)

SIMPLE간이과세(세금계산서 미발행)

TAX_FREE면세

PlatformPartnerTypeunion

type: string (Union Tag)

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

companyName: string

상호명

taxationType: PlatformPartnerTaxationType

플랫폼 파트너 과세 유형

businessStatus: PlatformPartnerBusinessStatus

플랫폼 파트너 사업자 상태

businessRegistrationNumber: string

사업자등록번호

representativeName: string

대표자 이름

companyAddress?: string

사업장 주소

(Optional)

businessType?: string

업태

(Optional)

businessClass?: string

업종

(Optional)

PlatformPartnerTypeBusinessobject

type: string

companyName: string

상호명

taxationType: PlatformPartnerTaxationType

플랫폼 파트너 과세 유형

businessStatus: PlatformPartnerBusinessStatus

플랫폼 파트너 사업자 상태

businessRegistrationNumber: string

사업자등록번호

representativeName: string

대표자 이름

companyAddress?: string

사업장 주소

(Optional)

businessType?: string

업태

(Optional)

businessClass?: string

업종

(Optional)

PlatformPartnerTypeNonWhtPayerobject

type: string

birthdate?: string

생년월일

(Optional)

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

PlatformPartnerTypeWhtPayerobject

type: string

birthdate?: string

생년월일

(Optional)

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

PlatformPayerenum

PARTNER파트너가 부담하는 경우

MERCHANT고객사가 부담하는 경우

PlatformPaymentunion

type: string (Union Tag)

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

id: string

결제 아이디

orderName?: string

주문 명

(Optional)

currency: Currency

통화 단위

method?: PlatformPaymentMethod

결제 수단

(Optional)

결제 수단

paidAt?: string (RFC 3339 date-time)

결제 일시

(Optional)

PlatformPaymentMethodunion

type: string (Union Tag)

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

PlatformPaymentMethodCardobject

type: string

PlatformPaymentMethodCardInputobject

PlatformPaymentMethodEasyPayobject

type: string

provider?: EasyPayProvider

간편 결제사

(Optional)

간편 결제사

methodType?: EasyPayMethodType

간편 결제 수단

(Optional)

간편 결제 수단

PlatformPaymentMethodEasyPayInputobject

provider?: EasyPayProvider

간편 결제사

(Optional)

간편 결제사

methodType?: EasyPayMethodType

간편 결제 수단

(Optional)

간편 결제 수단

PlatformPaymentMethodGiftCertificateobject

type: string

PlatformPaymentMethodGiftCertificateInputobject

PlatformPaymentMethodInputobject

card?: PlatformPaymentMethodCardInput

PlatformPaymentMethodCardInput

(Optional)

transfer?: PlatformPaymentMethodTransferInput

PlatformPaymentMethodTransferInput

(Optional)

virtualAccount?: PlatformPaymentMethodVirtualAccountInput

PlatformPaymentMethodVirtualAccountInput

(Optional)

giftCertificate?: PlatformPaymentMethodGiftCertificateInput

PlatformPaymentMethodGiftCertificateInput

(Optional)

mobile?: PlatformPaymentMethodMobileInput

PlatformPaymentMethodMobileInput

(Optional)

easyPay?: PlatformPaymentMethodEasyPayInput

간편 결제 입력 정보

(Optional)

간편 결제 입력 정보

PlatformPaymentMethodMobileobject

type: string

PlatformPaymentMethodMobileInputobject

PlatformPaymentMethodTransferobject

type: string

PlatformPaymentMethodTransferInputobject

PlatformPaymentMethodVirtualAccountobject

type: string

PlatformPaymentMethodVirtualAccountInputobject

PlatformPaymentNotFoundErrorobject

type: string

message?: string

(Optional)

PlatformPayoutobject

id: string

지급 고유 아이디

graphqlId: string

method: PlatformPayoutMethod

PlatformPayoutMethod

status: PlatformPayoutStatus

PlatformPayoutStatus

statusUpdatedAt: string (RFC 3339 date-time)

memo?: string

(Optional)

partner: PlatformPartner

파트너

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

account: PlatformPayoutAccount

PlatformPayoutAccount

currency: Currency

통화 단위

amount: integer (64 bit)

settlementAmount: integer (64 bit)

incomeTaxAmount: integer (64 bit)

localIncomeTaxAmount: integer (64 bit)

withdrawalMemo?: string

(Optional)

depositMemo?: string

(Optional)

createdAt: string (RFC 3339 date-time)

scheduledAt?: string (RFC 3339 date-time)

(Optional)

PlatformPayoutAccountobject

bank: Bank

은행

number: string

holder: string

PlatformPayoutMethodenum

DIRECT

AGENCY

PlatformPayoutStatusenum

STOPPED

PREPARED

CANCELLED

SUCCEEDED

SCHEDULED

PROCESSING

FAILED

PlatformPayoutStatusStatsobject

prepared: integer (64 bit)

cancelled: integer (64 bit)

stopped: integer (64 bit)

processing: integer (64 bit)

succeeded: integer (64 bit)

failed: integer (64 bit)

scheduled: integer (64 bit)

PlatformPortOnePaymentobject

type: string

id: string

결제 아이디

storeId: string

상점 아이디

channelKey: string

채널 키

orderName: string

주문 명

method?: PlatformPaymentMethod

결제 수단

(Optional)

결제 수단

currency: Currency

통화 단위

paidAt: string (RFC 3339 date-time)

결제 일시

PlatformPortOnePaymentCancelAmountTypeenum

SUPPLY_WITH_VAT공급대가

공급가액과 부가세를 더한 금액입니다.

TAX_FREE면세 금액

PlatformProductIdDuplicatedErrorobject

type: string

id: string

message?: string

(Optional)

PlatformProductIdNotFoundErrorobject

type: string

id: string

message?: string

(Optional)

PlatformPropertiesobject

[key: string]?: PlatformUserDefinedPropertyValue

PlatformUserDefinedPropertyValue

(Optional)

PlatformRemitAccountTransferobject

type: string

계좌 이체 유형

id: string

계좌 이체 아이디

sequenceNumber: integer (32 bit)

거래 일련번호

currency: Currency

통화 단위

depositBank: Bank

은행

depositAccountNumber: string

입금 계좌 번호

amount: integer (64 bit)

금액

withdrawalMemo?: string

출금 계좌 적요

(Optional)

depositMemo?: string

입금 계좌 적요

(Optional)

balance?: integer (64 bit)

잔액

(Optional)

failReason?: string

실패 사유

(Optional)

isForTest: boolean

createdAt: string (RFC 3339 date-time)

생성 일자

updatedAt: string (RFC 3339 date-time)

수정 일자

documentId: string

전자서명 아이디

PlatformSettlementAmountExceededErrorobject

type: AmountExceededType

AmountExceededType

message?: string

(Optional)

productId?: string

상품 아이디

(Optional)

주문 항목의 상품 아이디입니다.

requestedAmount: integer (64 bit)

요청 받은 금액

allowedAmount: integer (64 bit)

초과한 금액

PlatformSettlementCancelAmountExceededPortOneCancelErrorobject

type: string

registeredSettlementCancelAmount: integer (64 bit)

requestSettlementCancelAmount: integer (64 bit)

portOneCancelAmount: integer (64 bit)

amountType: PlatformPortOnePaymentCancelAmountType

금액 타입

message?: string

(Optional)

PlatformSettlementCycleobject

lagDays: integer (32 bit)

지체일 (d+n 의 n)

정산시작일(통상 주문완료일)로부터 더해진 다음 날짜로부터 가장 가까운 날에 정산이 됩니다. 최소 1 에서 최대 10 까지 지정할 수 있습니다.

datePolicy: PlatformSettlementCycleDatePolicy

플랫폼 정산 기준일

method: PlatformSettlementCycleMethod

플랫폼 정산 주기 계산 방식

PlatformSettlementCycleDatePolicyenum

HOLIDAY_BEFORE공휴일 전 영업일

HOLIDAY_AFTER공휴일 후 영업일

CALENDAR_DAY달력일

PlatformSettlementCycleInputobject

lagDays: integer (32 bit)

지체일 (d+n 의 n)

정산시작일(통상 주문완료일)로부터 더해진 다음 날짜로부터 가장 가까운 날에 정산이 됩니다. 최소 1 에서 최대 10 까지 지정할 수 있습니다.

datePolicy: PlatformSettlementCycleDatePolicy

플랫폼 정산 기준일

method: PlatformSettlementCycleMethodInput

플랫폼 정산 주기 계산 방식 입력 정보

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

PlatformSettlementCycleMethodunion

type: string (Union Tag)

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

PlatformSettlementCycleMethodDailyobject

type: string

PlatformSettlementCycleMethodDailyInputobject

PlatformSettlementCycleMethodInputobject

daily?: PlatformSettlementCycleMethodDailyInput

PlatformSettlementCycleMethodDailyInput

(Optional)

weekly?: PlatformSettlementCycleMethodWeeklyInput

PlatformSettlementCycleMethodWeeklyInput

(Optional)

monthly?: PlatformSettlementCycleMethodMonthlyInput

PlatformSettlementCycleMethodMonthlyInput

(Optional)

manualDates?: PlatformSettlementCycleMethodManualDatesInput

PlatformSettlementCycleMethodManualDatesInput

(Optional)

PlatformSettlementCycleMethodManualDatesobject

type: string

dates: MonthDay[]

월 및 일자 정보

PlatformSettlementCycleMethodManualDatesInputobject

dates: MonthDay[]

월 및 일자 정보

PlatformSettlementCycleMethodMonthlyobject

type: string

daysOfMonth: integer[]

PlatformSettlementCycleMethodMonthlyInputobject

daysOfMonth: integer[]

PlatformSettlementCycleMethodWeeklyobject

type: string

daysOfWeek: DayOfWeek[]

요일

PlatformSettlementCycleMethodWeeklyInputobject

daysOfWeek: DayOfWeek[]

요일

PlatformSettlementParameterNotFoundErrorobject

type: string

message?: string

(Optional)

PlatformSettlementParameterValueobject

decimal: integer (64 bit)

크기가 조정되지 않은 숫자

decimalScale?: integer (32 bit)

소수 자리수

(Optional)

정산 시 필요한 decimalScale이 지정되지 않은 경우 기본값으로 0을 사용합니다. 입력 가능한 법위는 0 ~ 5 입니다.

PlatformSettlementPaymentAmountExceededPortOnePaymentErrorobject

type: string

registeredSettlementPaymentAmount: integer (64 bit)

requestSettlementPaymentAmount: integer (64 bit)

portOnePaymentAmount: integer (64 bit)

message?: string

(Optional)

PlatformSettlementSupplyWithVatAmountExceededPortOnePaymentErrorobject

type: string

registeredSettlementSupplyWithVatAmount: integer (64 bit)

requestSettlementSupplyWithVatAmount: integer (64 bit)

portOneSupplyWithVatAmount: integer (64 bit)

message?: string

(Optional)

PlatformSettlementTaxFreeAmountExceededPortOnePaymentErrorobject

type: string

registeredSettlementTaxFreeAmount: integer (64 bit)

requestSettlementTaxFreeAmount: integer (64 bit)

portOneTaxFreeAmount: integer (64 bit)

message?: string

(Optional)

PlatformTransferunion

type: string (Union Tag)

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

id: string

정산건 아이디

graphqlId: string

partner: PlatformPartner

파트너

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

status: PlatformTransferStatus

정산 상태

memo?: string

메모

(Optional)

settlementDate: string

정산 일

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

settlementCurrency: Currency

통화 단위

payoutId?: string

(Optional)

payoutGraphqlId?: string

(Optional)

isForTest: boolean

테스트 모드 여부

userDefinedProperties: PlatformUserDefinedPropertyKeyValue[]

사용자 정의 속성

settlementAmount: integer (64 bit)

정산 금액

PlatformTransferAlreadyExistsErrorobject

type: string

transferId: string

transferGraphqlId: string

message?: string

(Optional)

PlatformTransferDiscountSharePolicyNotFoundErrorobject

type: string

discountSharePolicyId: string

discountSharePolicyGraphqlId: string

productId?: string

(Optional)

message?: string

(Optional)

PlatformTransferNonDeletableStatusErrorobject

type: string

message?: string

(Optional)

PlatformTransferNotFoundErrorobject

type: string

message?: string

(Optional)

PlatformTransferStatusenum

SETTLED정산 완료

SCHEDULED정산 예약

PAID_OUT지급 완료

IN_PROCESS정산 중

IN_PAYOUT지급 중

PlatformTransferSummaryunion

type: string (Union Tag)

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

id: string

graphqlId: string

partner: PlatformTransferSummaryPartner

PlatformTransferSummaryPartner

status: PlatformTransferStatus

정산 상태

memo?: string

(Optional)

settlementDate: string

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

settlementCurrency: Currency

통화 단위

isForTest: boolean

partnerUserDefinedProperties: PlatformUserDefinedPropertyKeyValue[]

사용자 정의 속성

userDefinedProperties: PlatformUserDefinedPropertyKeyValue[]

사용자 정의 속성

settlementAmount: integer (64 bit)

PlatformTransferSummaryExternalPaymentobject

type: string

id: string

orderName?: string

(Optional)

currency: Currency

통화 단위

methodType?: PaymentMethodType

PaymentMethodType

(Optional)

PlatformTransferSummaryPartnerobject

id: string

graphqlId: string

type: PlatformTransferSummaryPartnerType

파트너 유형

taxationType?: PlatformPartnerTaxationType

플랫폼 파트너 과세 유형

(Optional)

플랫폼 파트너 과세 유형

PlatformTransferSummaryPartnerTypeenum

BUSINESS사업자

WHT_PAYER원천징수 대상자

NON_WHT_PAYER원천징수 비대상자

PlatformTransferSummaryPaymentunion

type: string (Union Tag)

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

id: string

orderName?: string

(Optional)

currency: Currency

통화 단위

methodType?: PaymentMethodType

PaymentMethodType

(Optional)

PlatformTransferSummaryPortOnePaymentobject

type: string

id: string

orderName: string

currency: Currency

통화 단위

methodType?: PaymentMethodType

PaymentMethodType

(Optional)

PlatformUserDefinedPropertyKeyValueobject

key: string

사용자 정의 속성 키

value: PlatformUserDefinedPropertyValue

PlatformUserDefinedPropertyValue

PlatformUserDefinedPropertyNotFoundErrorobject

type: string

message?: string

(Optional)

PlatformUserDefinedPropertyValueobject

string: string

PortOneVersionenum

V1

V2

PreRegisterPaymentErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

PreRegisterPaymentResponseobject

Promotionunion

type: string (Union Tag)

프로모션 유형

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

id: string

프로모션 아이디

storeId: string

상점 아이디

프로모션 이름

discountType: PromotionDiscount

PromotionDiscount

totalBudget: integer (64 bit)

총 예산

minPaymentAmount?: integer (64 bit)

최소 결제 금액

(Optional)

maxDiscountAmount?: integer (64 bit)

최대 할인 금액

(Optional)

spentAmount: integer (64 bit)

소진 금액

currency: Currency

통화 단위

startAt: string (RFC 3339 date-time)

프로모션 시작 시각

endAt: string (RFC 3339 date-time)

프로모션 종료 시각

terminatedAt?: string (RFC 3339 date-time)

프로모션 중단 시각

(Optional)

cardCompany: PromotionCardCompany

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

status: PromotionStatus

PromotionStatus

createdAt: string (RFC 3339 date-time)

프로모션 생성 시각

PromotionAmountDiscountobject

type: string

프로모션 할인 유형

amount: integer (64 bit)

PromotionCardCompanyenum

HANA_CARD하나카드

HYUNDAI_CARD현대카드

BC_CARDBC카드

WOORI_CARD우리카드

LOTTE_CARD롯데카드

SAMSUNG_CARD삼성카드

SHINHAN_CARD신한카드

NH_CARDNH카드

KOOKMIN_CARD국민카드

PromotionDiscountunion

type: string (Union Tag)

프로모션 할인 유형

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

amount: integer (64 bit)

PromotionNotFoundErrorobject

type: string

message?: string

(Optional)

PromotionPayMethodDoesNotMatchErrorobject

type: string

message?: string

(Optional)

PromotionPercentDiscountobject

type: string

프로모션 할인 유형

percent: integer (32 bit)

PromotionStatusenum

IN_PROGRESS진행중

TERMINATED중단됨

COMPLETED완료됨

SCHEDULED예정됨

PAUSED일시 중지됨

BUDGET_EXHAUSTED예산 소진됨

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)

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

channelGroup?: ChannelGroupSummary

채널 그룹 정보

(Optional)

채널 그룹 정보

version: PortOneVersion

포트원 버전

scheduleId?: string

결제 예약 건 아이디

(Optional)

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

billingKey?: string

결제 시 사용된 빌링키

(Optional)

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

webhooks?: PaymentWebhook[]

웹훅 발송 내역

(Optional)

requestedAt: string (RFC 3339 date-time)

결제 요청 시점

updatedAt: string (RFC 3339 date-time)

업데이트 시점

statusChangedAt: string (RFC 3339 date-time)

상태 업데이트 시점

orderName: string

주문명

amount: PaymentAmount

결제 금액 세부 정보

currency: Currency

통화 단위

customer: Customer

고객 정보

promotionId?: string

프로모션 아이디

(Optional)

isCulturalExpense?: boolean

문화비 지출 여부

(Optional)

escrow?: PaymentEscrow

에스크로 정보

(Optional)

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

products?: PaymentProduct[]

상품 정보

(Optional)

productCount?: integer (32 bit)

상품 갯수

(Optional)

customData?: string

사용자 지정 데이터

(Optional)

country?: Country

국가

(Optional)

국가

RecoverPlatformAdditionalFeePolicyErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

RecoverPlatformAdditionalFeePolicyResponseobject

additionalFeePolicy: PlatformAdditionalFeePolicy

추가 수수료 정책

RecoverPlatformContractErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

RecoverPlatformContractResponseobject

contract: PlatformContract

계약

RecoverPlatformDiscountSharePolicyErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

RecoverPlatformDiscountSharePolicyResponseobject

discountSharePolicy: PlatformDiscountSharePolicy

할인 분담 정책

RecoverPlatformPartnerErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

RecoverPlatformPartnerResponseobject

partner: PlatformPartner

파트너

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

RefreshTokenErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

RefreshTokenResponseobject

accessToken: string

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

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

refreshToken: string

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

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

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)

RemainedAmountLessThanPromotionMinPaymentAmountErrorobject

type: string

message?: string

(Optional)

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

성공 웹훅 내역

RevokePaymentSchedulesErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

RevokePaymentSchedulesResponseobject

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)

vatAmount?: integer (64 bit)

부가세

(Optional)

currency: Currency

통화 단위

installmentMonth?: integer (32 bit)

할부 개월 수

(Optional)

noticeUrls?: string[]

웹훅 주소

(Optional)

products?: PaymentProduct[]

상품 정보

(Optional)

createdAt: string (RFC 3339 date-time)

결제 예약 등록 시점

timeToPay: string (RFC 3339 date-time)

결제 예정 시점

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)

vatAmount?: integer (64 bit)

부가세

(Optional)

currency: Currency

통화 단위

installmentMonth?: integer (32 bit)

할부 개월 수

(Optional)

noticeUrls?: string[]

웹훅 주소

(Optional)

products?: PaymentProduct[]

상품 정보

(Optional)

createdAt: string (RFC 3339 date-time)

결제 예약 등록 시점

timeToPay: string (RFC 3339 date-time)

결제 예정 시점

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 방식의 경우 필수로 입력합니다.

ipAddress: string

IP 주소

고객의 요청 속도 제한에 사용됩니다.

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)

vatAmount?: integer (64 bit)

부가세

(Optional)

currency: Currency

통화 단위

installmentMonth?: integer (32 bit)

할부 개월 수

(Optional)

noticeUrls?: string[]

웹훅 주소

(Optional)

products?: PaymentProduct[]

상품 정보

(Optional)

createdAt: string (RFC 3339 date-time)

결제 예약 등록 시점

timeToPay: string (RFC 3339 date-time)

결제 예정 시점

startedAt: string (RFC 3339 date-time)

결제 시작 시점

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)

vatAmount?: integer (64 bit)

부가세

(Optional)

currency: Currency

통화 단위

installmentMonth?: integer (32 bit)

할부 개월 수

(Optional)

noticeUrls?: string[]

웹훅 주소

(Optional)

products?: PaymentProduct[]

상품 정보

(Optional)

createdAt: string (RFC 3339 date-time)

결제 예약 등록 시점

timeToPay: string (RFC 3339 date-time)

결제 예정 시점

startedAt: string (RFC 3339 date-time)

결제 시작 시점

completedAt: string (RFC 3339 date-time)

결제 완료 시점

SumOfPartsExceedsCancelAmountErrorobject

type: string

message?: string

(Optional)

SumOfPartsExceedsTotalAmountErrorobject

type: string

message?: string

(Optional)

TransferParametersobject

[key: string]?: PlatformSettlementParameterValue

플랫폼 정산 파라미터 값

(Optional)

플랫폼 정산 파라미터 값

UnauthorizedErrorobject

type: string

message?: string

(Optional)

UpdatePlatformAdditionalFeePolicyErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

UpdatePlatformAdditionalFeePolicyResponseobject

additionalFeePolicy: PlatformAdditionalFeePolicy

추가 수수료 정책

UpdatePlatformContractErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

UpdatePlatformContractResponseobject

contract: PlatformContract

계약

UpdatePlatformDiscountSharePolicyErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

UpdatePlatformDiscountSharePolicyResponseobject

discountSharePolicy: PlatformDiscountSharePolicy

할인 분담 정책

UpdatePlatformPartnerBodyAccountobject

bank: Bank

은행

currency: Currency

통화 단위

number: string

계좌번호

holder: string

예금주명

accountVerificationId?: string

계좌 검증 아이디

(Optional)

UpdatePlatformPartnerBodyContactobject

name?: string

담당자 이름

(Optional)

phoneNumber?: string

담당자 휴대폰 번호

(Optional)

email?: string

담당자 이메일

(Optional)

UpdatePlatformPartnerBodyTypeobject

business?: UpdatePlatformPartnerBodyTypeBusiness

UpdatePlatformPartnerBodyTypeBusiness

(Optional)

whtPayer?: UpdatePlatformPartnerBodyTypeWhtPayer

UpdatePlatformPartnerBodyTypeWhtPayer

(Optional)

nonWhtPayer?: UpdatePlatformPartnerBodyTypeNonWhtPayer

UpdatePlatformPartnerBodyTypeNonWhtPayer

(Optional)

UpdatePlatformPartnerBodyTypeBusinessobject

companyName?: string

상호명

(Optional)

taxationType?: PlatformPartnerTaxationType

플랫폼 파트너 과세 유형

(Optional)

플랫폼 파트너 과세 유형

businessRegistrationNumber?: string

사업자등록번호

(Optional)

representativeName?: string

대표자 이름

(Optional)

companyAddress?: string

사업장 주소

(Optional)

businessType?: string

업태

(Optional)

businessClass?: string

업종

(Optional)

UpdatePlatformPartnerBodyTypeNonWhtPayerobject

birthdate?: string

생년월일

(Optional)

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

UpdatePlatformPartnerBodyTypeWhtPayerobject

birthdate?: string

생년월일

(Optional)

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

UpdatePlatformPartnerErrorunion

type: string (Union Tag)

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

message?: string

(Optional)

UpdatePlatformPartnerResponseobject

partner: PlatformPartner

파트너

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

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

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

channelGroup?: ChannelGroupSummary

채널 그룹 정보

(Optional)

채널 그룹 정보

version: PortOneVersion

포트원 버전

scheduleId?: string

결제 예약 건 아이디

(Optional)

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

billingKey?: string

결제 시 사용된 빌링키

(Optional)

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

webhooks?: PaymentWebhook[]

웹훅 발송 내역

(Optional)

requestedAt: string (RFC 3339 date-time)

결제 요청 시점

updatedAt: string (RFC 3339 date-time)

업데이트 시점

statusChangedAt: string (RFC 3339 date-time)

상태 업데이트 시점

orderName: string

주문명

amount: PaymentAmount

결제 금액 세부 정보

currency: Currency

통화 단위

customer: Customer

고객 정보

promotionId?: string

프로모션 아이디

(Optional)

isCulturalExpense?: boolean

문화비 지출 여부

(Optional)

escrow?: PaymentEscrow

에스크로 정보

(Optional)

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

products?: PaymentProduct[]

상품 정보

(Optional)

productCount?: integer (32 bit)

상품 갯수

(Optional)

customData?: string

사용자 지정 데이터

(Optional)

country?: Country

국가

(Optional)

국가

pgTxId?: string

PG사 거래 아이디

(Optional)

WebhookNotFoundErrorobject

type: string

message?: string

(Optional)

PortOne REST API - V2

요청 및 응답 형식

인증 방식

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

하위호환성

인증 관련 API

목차

결제 관련 API

목차

결제 예약 관련 API

목차

빌링키 관련 API

목차

현금 영수증 관련 API

목차

프로모션 관련 API

목차

본인인증 관련 API

목차

파트너 정산 관련 API

정책 관련 API

목차

파트너 관련 API

목차

정산 상세내역 관련 API

목차

계좌 관련 API

목차

정산 내역 관련 API

목차

지급 내역 관련 API

목차

일괄 지급 내역 관련 API

목차

이체 내역 관련 API

목차

특정 PG사 관련 API

목차

대사 서비스 API

타입 정의

Addressunion

AlreadyPaidErrorobject

AlreadyPaidOrWaitingErrorobject

AmountExceededTypeenum

ApplyEscrowLogisticsErrorunion

ApplyEscrowLogisticsResponseobject

ArchivePlatformAdditionalFeePolicyErrorunion

ArchivePlatformAdditionalFeePolicyResponseobject

ArchivePlatformContractErrorunion

ArchivePlatformContractResponseobject

ArchivePlatformDiscountSharePolicyErrorunion

ArchivePlatformDiscountSharePolicyResponseobject

ArchivePlatformPartnerErrorunion

ArchivePlatformPartnerResponseobject

Bankenum

BeforeRegisteredPaymentEscrowobject

BillingKeyAlreadyDeletedErrorobject

BillingKeyFailureobject

BillingKeyInfounion

BillingKeyInfoSummaryobject

BillingKeyNotFoundErrorobject

BillingKeyNotIssuedErrorobject

BillingKeyPaymentInputobject

BillingKeyPaymentMethodunion

BillingKeyPaymentMethodCardobject

BillingKeyPaymentMethodEasyPayobject

BillingKeyPaymentMethodEasyPayChargeobject

BillingKeyPaymentMethodEasyPayMethodunion

BillingKeyPaymentMethodMobileobject

BillingKeyPaymentMethodPaypalobject

BillingKeyPaymentMethodTransferobject

BillingKeyPaymentSummaryobject

CancelAmountExceedsCancellableAmountErrorobject

CancelCashReceiptErrorunion

CancelCashReceiptResponseobject

CancelPaymentBodyRefundAccountobject

CancelPaymentErrorunion

CancelPaymentResponseobject

CancelRequesterenum

CancelTaxAmountExceedsCancellableTaxAmountErrorobject