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

PortOne REST API - V1

결제완료된 정보, 결제취소, 상태별 결제목록 조회 등의 기능을 하는 REST API를 제공합니다.
비인증 결제, 정기 자동결제 등 부가기능을 위한 REST API도 제공합니다.

V1 API hostname: api.iamport.kr

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

인증 관련 API

포트원 API를 호출할 때는 액세스 토큰을 Authorization 헤더에 넣어주어야 합니다.
액세스 토큰은 access_token 발급 API post/users/getToken를 호출해서 발급받을 수 있습니다.

액세스 토큰 발급 API를 호출하려면 API 키와 API 시크릿을 인자로 넣어주어야 합니다.

API 키와 API 시크릿 확인하기
  1. 관리자 콘솔 상점・계정 관리 화면 접속
  2. 내 식별코드・API Keys 버튼 클릭
API 키와 API 시크릿은 관리자 콘솔 → 상점・계정 관리 메뉴 → 내 식별코드・API Keys 모달을 열어서 확인하실 수 있습니다
API 키와 API 시크릿은 관리자 콘솔 → 상점・계정 관리 메뉴 → 내 식별코드・API Keys 모달을 열어서 확인하실 수 있습니다

API 시크릿은 절대로 외부에 노출되어서는 안되는 값입니다.
실제 구현에서 액세스 토큰 발급은 꼭 서버사이드에서 해주세요.

액세스 토큰 발급 받기

access_token 발급 API post/users/getToken 호출

/users/getToken API를 호출해서 액세스 토큰을 발급받습니다
/users/getToken API를 호출해서 액세스 토큰을 발급받습니다

포트원 REST API 서버는 Google Public NTP의 시간과 동기화되고 있습니다.

하위 상점 연동을 할 경우 액세스 토큰을 발급받을 때 Agent 계정의 API 키 와 API 시크릿을 사용해야 합니다.

Agency & Tier 란?

액세스 토큰 사용하기

발급받은 액세스 토큰은 다른 API를 호출할 때
Authorization 헤더에 Bearer <액세스 토큰> 형식의 값을 넣어주면 됩니다.

자세한 내용은 MDN - HTTP 인증 문서를 참고해주세요.

하위 상점 연동을 할 경우 포트원 API 호출시 Tier 헤더에 하위 상점 티어 코드를 입력해야 합니다.

Agency & Tier 란?

액세스 토큰 만료기한 연장

만료된 액세스 토큰으로 API를 호출하면 401 Unauthorized 응답을 받습니다.
액세스 토큰의 만료기한은 발행시간부터 30분입니다.

  • 기존 액세스 토큰이 만료되기 전 access_token 발급 API post/users/getToken를 다시 호출했을 경우
    • 기존 액세스 토큰이 반환됩니다.
      만료기한이 1분 안쪽으로 남았을 때 요청했다면 기존 액세스 토큰의 만료시간이 5분 연장됩니다.
  • 기존 액세스 토큰이 만료된 다음 access_token 발급 API post/users/getToken를 다시 호출했을 경우
    • 새로운 액세스 토큰이 반환됩니다.

액세스 토큰의 재사용과 만료기한 5분 연장 동작방식은 다음과 같은 상황을 고려해서 설계되었습니다.

  • 한 고객사에서 여러 대의 웹서버가 동시에 경쟁적으로 REST API(/users/getToken)를 호출하는 상황
  • 한 고객사에서 여러 대의 웹서버가 시간 동기화 되어있지 않은 상황

결제 관련 API

결제 건과 관련된 기능을 제공합니다.

결제 금액 사전 등록 관련 API

사전 등록하는 결제금액과 관련된 기능을 제공합니다.

비인증 결제 관련 API

별도 결제창 호출없이 결제를 진행할 수 있는 비인증 결제 기능을 제공합니다.

정기 결제 관련 API

비인증 결제 중 정기 결제를 관리하는 기능을 제공합니다.

빌링키 관련 API

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

가상계좌 관련 API

가상계좌 결제와 관련된 기능을 제공합니다.

PG사 관련 API

PG사 별 추가로 지원하는 기능을 제공합니다.

카카오 관련 API

카카오페이에서 지원하는 기능을 제공합니다.

KCP 퀵페이 관련 API

KCP 퀵페이에서 지원하는 기능을 제공합니다.

네이버페이 관련 API

네이버페이에서 지원하는 기능을 제공합니다.

목차

(주문형-네이버페이) 네이버페이 주문환불 API
post/payments/{imp_uid}/naver/cancel
(주문형-네이버페이) 구매자의 환불요청 승인처리 API
post/payments/{imp_uid}/naver/approve-cancel
(주문형-네이버페이) 상품주문 발송처리 API
post/payments/{imp_uid}/naver/ship
(주문형-네이버페이) 교환승인된 상품 재발송처리 API
post/payments/{imp_uid}/naver/ship-exchanged
(주문형-네이버페이) 교환승인된 상품 수거완료처리 API
post/payments/{imp_uid}/naver/collect-exchanged
(주문형-네이버페이) 상품발주처리 API
post/payments/{imp_uid}/naver/place
(주문형-네이버페이) 상품반품요청 API
post/payments/{imp_uid}/naver/request-return
(주문형-네이버페이) 상품 반품승인 처리 API
post/payments/{imp_uid}/naver/approve-return
(주문형-네이버페이) 상품 반품거절 처리 API
post/payments/{imp_uid}/naver/reject-return
(주문형-네이버페이) 상품 반품보류 처리 API
post/payments/{imp_uid}/naver/withhold-return
(주문형-네이버페이) 반품보류상품 반품보류해제 처리 API
post/payments/{imp_uid}/naver/resolve-return
(결제형-네이버페이) 네이버페이 포인트 적립 API
post/payments/{imp_uid}/naver/point
(결제형-네이버페이) 에스크로 주문 확정 API
post/payments/{imp_uid}/naver/confirm
(주문형-네이버페이) 포트원 거래고유번호 기준 네이버페이 상품주문 조회 API
get/payments/{imp_uid}/naver/product-orders
(주문형-네이버페이) 네이버페이 상품주문번호로 상품주문 상세 조회 API
get/naver/product-orders/{product_order_id}
(주문형-네이버페이) 네이버페이 구매평 조회 API
get/naver/reviews
(결제형-네이버페이) 현금영수증 발급 가용액 조회 API
get/payments/{imp_uid}/naver/cash-amount

페이코 관련 API

페이코에서 지원하는 기능을 제공합니다.

페이먼트월 관련 API

페이먼트월에서 지원하는 기능을 제공합니다.

본인인증 관련 API

본인인증 요청 및 결과 조회와 관련된 기능을 제공합니다.

현금영수증 관련 API

포트원 결제건 및 외부 결제 건의 현금영수증 관리와 관련된 기능을 제공합니다.

에스크로 관련 API

에스크로 결제 건의 배송 정보와 관련된 기능을 제공합니다.

가맹점 정보 관련 API

가맹점 정보를 관리하는 기능을 제공합니다.

가맹점의 하위가맹점 관련 API

대표가맹점에 대한 하위가맹점 관리와 관련된 기능을 제공합니다.

하위 상점 관련 API

하위 상점과 관련된 기능을 제공합니다.

기타 API

부가적인 기능을 제공합니다.

베네피아 포인트 관련 API

베네피아 포인트(복지 포인트)와 관련된 기능을 제공합니다.

결제기관 관련 API

금융결제원 기준 카드사, 은행의 표준 코드와 기관정보 조회 기능을 제공합니다.

편의점 결제 관련 API

편의점 결제를 위한 수납 번호(barcode)와 관련된 기능을 제공합니다.

타입 정의

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

AuthAnnotationobject

access_token: string
access_token

인증이 필요한 REST API요청에 사용할 access_token

expired_at: integer
token 만료시각

access_token의 만료시각. UNIX timestamp

now: integer
현재시각

token 만료시각을 정확히 계산하기 위해 사용되는 현재시각. UNIX timestamp

AuthResponseobject

code?: integer
응답코드
(Optional)

0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다

message?: string
응답메세지
(Optional)

code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

response?: AuthAnnotation
(Optional)

BenepiaPointAnnotationobject

point?: integer
포인트
(Optional)

베네피아 보유 포인트

BenepiaPointResponseobject

code?: integer
응답코드
(Optional)

0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다

message?: string
응답메세지
(Optional)

code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

(Optional)

CertificationAnnotationobject

imp_uid: string
포트원 인증 고유번호

본인인증 결과건의 포트원 인증 고유번호

merchant_uid?: string
가맹점 주문번호
(Optional)

본인인증 결과건의 포트원 가맹점 주문번호

pg_tid?: string
PG사 본인인증결과 고유번호
(Optional)

본인인증 결과건의 PG사 본인인증결과 고유번호

pg_provider: string
pg사 구분코드

본인인증 제공 PG사의 명칭

name?: string
성명
(Optional)

인증된 사용자의 성명

gender?: string
성별
(Optional)

인증된 사용자의 성별

birthday?: string
생년월일
(Optional)

인증된 사용자의 생년월일 ISO8601 형식의 문자열. YYYY-MM-DD 10자리 문자열

foreigner: boolean
외국인 여부

다날 본인인증서비스 계약시 외국인 구분기능을 추가 요청하지 않은 경우 항상 false를 응답합니다.

  • true : 외국인
  • false : 내국인
phone?: string
휴대폰번호
(Optional)

특수 기호없이 숫자로만 구성된 휴대폰번호가 전달되며 통신사 사전승인이 이뤄지지 않으면 phone 속성은 존재하지 않습니다.

통신사 사전승인이 필요하므로 cs@portone.io 로 다날 CPID 와 함께 사용승인 요청주시면 안내도와드리겠습니다.

carrier?: string
통신사
(Optional)

통신사 사전승인이 이뤄지지 않으면 carrier 속성은 존재하지 않습니다.

통신사 사전승인이 필요하므로 cs@portone.io 로 다날 CPID 와 함께 사용승인 요청주시면 안내도와드리겠습니다.

  • SKT
  • KT
  • LGT
  • SKT_MVNO
  • KT_MVNO
  • LGT_MVNO
certified?: boolean
인증성공여부
(Optional)

본인인증 성공여부

certified_at?: integer
인증처리시각
(Optional)

본인인증 처리시각 UNIX timestamp

unique_key?: string
개인 고유구분 식별키
(Optional)

개인별로 고유하게 부여하는 개인 식별키(CI)

unique_in_site?: string
가맹점 내 개인 고유구분 식별키
(Optional)

본인인증 PG MID별로 할당되는 개인 식별키

origin?: string
웹 페이지 URL
(Optional)

본인인증 프로세스가 진행된 웹 페이지의 URL

foreigner_v2?: boolean
외국인 여부(nullable)
(Optional)

다날 본인인증서비스 계약시 외국인 구분기능 추가 요청을 해주셔야 사용이 가능합니다. 요청을 하지 않은 경우 null을 응답합니다.

  • true:외국인
  • false:내국인

CertificationOTPAnnotationobject

imp_uid: string
포트원 인증 고유번호

본인인증 결과건의 포트원 인증 고유번호

CertificationOTPResponseobject

code?: integer
응답코드
(Optional)

0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다

message?: string
응답메세지
(Optional)

code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

(Optional)

CertificationResponseobject

code?: integer
응답코드
(Optional)

0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다

message?: string
응답메세지
(Optional)

code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

(Optional)

CustomerAnnotationobject

customer_uid: string
구매자의 결제 수단 식별 고유번호

빌링키와 매핑되며 가맹점에서 채번하는 구매자의 결제 수단 식별 고유번호

pg_provider: string
PG사 구분코드

빌링키가 등록된 PG사 구분코드

pg_id: string
상점아이디(MID)

빌링키가 등록된 PG사 상점아이디(MID)

customer_id?: string
구매자 ID
(Optional)

구매자 식별 고유 번호

card_name: string
카드명

빌링키 발급 한 카드명

card_code?: string
카드사 코드
(Optional)
card_issuer_code?: string
카드 발급사 코드
(Optional)

카드 발급사 코드번호 (금융결제원 표준코드 번호)

발급사 코드 지원 pg사
- (신) 토스페이먼츠
- KSNET
- 페이팔 RT
- (신) 스마트로
- (신) 나이스페이먼츠
- 웰컴페이먼츠
- (신) 토스페이
card_issuer_name?: string
카드 발급사명
(Optional)

빌링키 발급 한 카드의 발급사명

발급사 코드를 지원하는 pg사에 한해 제공됩니다.
card_publisher_code?: string
카드 발행사 코드
(Optional)

카드 발행사 코드번호 (금융결제원 표준코드 번호)

발행사 코드 지원 pg사
- (신) 토스페이먼츠
- KSNET사
- 페이팔 RT
- (신) 스마트로
- (신) 나이스페이먼츠
- 웰컴페이먼츠
- (신) 토스페이
card_publisher_name?: string
카드 발행사명
(Optional)

빌링키 발급 한 카드의 발행사명

발행사 코드를 지원하는 pg사에 한해 제공됩니다.
card_number?: string
마스킹 카드번호
(Optional)

빌링키 발급 한 카드의 마스킹된 카드번호

card_type?: integer
카드유형
(Optional)

주의 : 해당 정보를 제공하지 않는 일부 PG사의 경우 null 로 응답됩니다.(ex. JTNet, 이니시스-빌링)

  • 0 : 신용카드
  • 1 : 체크카드
customer_name?: string
고객 성함
(Optional)

빌링키 발급 한 고객(카드소지자)의 성함

customer_tel?: string
전화번호
(Optional)

빌링키 발급 한 고객(카드소지자)의 전화번호

customer_email?: string
Email 주소
(Optional)

빌링키 발급 한 고객(카드소지자)의 Email 주소

customer_addr?: string
주소
(Optional)

빌링키 발급 한 고객(카드소지자)의 주소

customer_postcode?: string
우편번호
(Optional)

빌링키 발급 한 고객(카드소지자)의 우편번호

inserted: integer
발급 시각

빌링키가 발급된 시각 UNIX timestamp

updated: integer
업데이트 시각

빌링키가 업데이트된 시각 UNIX timestamp

CustomerResponseobject

code?: integer
응답코드
(Optional)

0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다

message?: string
응답메세지
(Optional)

code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

response?: CustomerAnnotation
(Optional)

EscrowLogisAnnotationobject

company: string
택배사코드

에스크로 결제건의 택배사 코드

invoice: string
송장번호

에스크로 결제건의 송장번호

sent_at: integer
발송 시각

에스크로 결제건의 배송 발송 시각 UNIX timestamp

applied_at: integer
등록 시각

에스크로 결제건의 배송 정보 등록 시각 UNIX timestamp

EscrowLogisInfoAnnotationobject

company: string
택배사코드

에스크로 결제건의 택배사 코드

invoice: string
송장번호

에스크로 결제건의 송장번호

sent_at: integer
발송 시각

에스크로 결제건의 배송 발송 시각 UNIX timestamp

receiving_at?: string
수령 시각
(Optional)

에스크로 결제건의 배송 수령 시각 UNIX timestamp

address?: string
발송 주소
(Optional)

에스크로 결제건의 배송 발송 주소

EscrowLogisProductsAnnotationobject

id: string
상품 고유 아이디
name: string
상품 이름
code?: string
상품 코드
(Optional)

가맹점에서 사용하는 상품 관리 코드

amount: number
상품 단위 가격
currency?: string
상품의 결제통화 구분코드
(Optional)

통화 e.g.) KRW, USD, VND, ... Default: KRW

quantity?: integer
상품의 수량
(Optional)

상품의 수량으로 기본값은 1입니다.

tag?: string
상품의 카테고리
(Optional)

상품의 카테고리 e.g) 도서, 가전기기, 인테리어 용품 등

EscrowLogisReceiverAnnotationobject

name?: string
성함
(Optional)

배송을 받는 수신자의 성함

tel?: string
전화번호
(Optional)

배송을 받는 수신자의 전화번호

addr?: string
주소
(Optional)

배송을 받는 수신자의 주소

postcode?: string
우편번호
(Optional)

배송을 받는 수신자의 우편번호

formed_address?: object
주소 구성
(Optional)

배송을 받는 수신자의 주소 구성

EscrowLogisResponseobject

code?: integer
응답코드
(Optional)

0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다

message?: string
응답메세지
(Optional)

code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

(Optional)

EscrowLogisSenderAnnotationobject

name?: string
성함
(Optional)

배송을 보내는 발신자의 성함

tel?: string
전화번호
(Optional)

배송을 보내는 발신자의 전화번호

addr?: string
주소
(Optional)

배송을 보내는 발신자의 주소

postcode?: string
우편번호
(Optional)

배송을 보내는 발신자의 우편번호

relationship?: string
발신자와의 관계
(Optional)

배송을 보내는 발신자와의 관계 (예 : 본인)

formed_address?: object
주소 구성
(Optional)

배송을 보내는 발신자의 주소 구성

ExternalReceiptAnnotationobject

merchant_uid: string
가맹점 주문번호

현금영수증을 발행한 가맹점의 주문번호

receipt_tid?: string
PG사 현금영수증 발행 고유번호
(Optional)

결제건에 대해 현금영수증 발행시 PG사의 발행고유번호

apply_num: string
국세청 발행번호

결제건에 대해 현금영수증 발행시 국세청 발행번호

type: string
타입(대상)

현금영수증 발행 대상의 타입

amount: integer
발행 금액

현금영수증 발행 금액

vat: integer
부가세액

현금영수증 발행금액 중 부가세액

receipt_url?: string
현금영수증 URL
(Optional)

발행된 현금영수증을 확인할 수 있는 URL

applied_at: integer
발행시각

현금영수증 발행시각 UNIX timestamp

cancelled_at?: integer
발행취소시각
(Optional)

현금영수증 발행취소시각 UNIX timestamp

ExternalReceiptResponseobject

code?: integer
응답코드
(Optional)

0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다

message?: string
응답메세지
(Optional)

code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

(Optional)

KakaoOrderAnnotationobject

KakaoOrderResponseobject

code?: integer
응답코드
(Optional)

0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다

message?: string
응답메세지
(Optional)

code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

(Optional)

KcpQuickMemberAnnotationobject

member_id: string
구매자 고유 아이디

구매자의 고유 아이디(memberID)

pg_provider: string
PG사 구분코드

유저 정보가 등록된 PG사 구분코드. kcp_quick(KCP 퀵페이)

pg_id?: string
PG사 상점아이디
(Optional)

유저 정보가 등록된 PG사 상점아이디(MID)

inserted: integer
등록 시각

유저 정보가 등록된 시각 UNIX timestamp

updated: integer
업데이트 시각

유저 정보가 업데이트된 시각 UNIX timestamp

KcpQuickMemberResponseobject

code?: integer
응답코드
(Optional)

0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다

message?: string
응답메세지
(Optional)

code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

(Optional)

MultipleCustomersResponseobject

code?: integer
응답코드
(Optional)

0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다

message?: string
응답메세지
(Optional)

code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

(Optional)

MultiplePaymentsResponseobject

code?: integer
응답코드
(Optional)

0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다

message?: string
응답메세지
(Optional)

code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

(Optional)

MultiplePgSettingResponseobject

code?: integer
응답코드
(Optional)

0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다

message?: string
응답메세지
(Optional)

code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

(Optional)

NaverAddressobject

base: string
기본주소
detail?: string
상세주소
(Optional)

네이버페이 상품 배송 상세주소

postcode: string
우편번호

네이버페이 상품 배송 우편번호

tel1: string
연락처 1

네이버페이 상품 배송 연락처 1

tel2?: string
연락처 2
(Optional)

네이버페이 상품 배송 연락처 2

name: string
성함

네이버페이 상품 배송 수취인 성함

NaverCashAmountAnnotationobject

amount_total: integer
총액

현금영수증 발급 가능한 총액

amount_by_npoint: integer
포인트 금액

현금영수증 발급가능한 총액 중 Npoint에 의한 금액

amount_by_primary: integer
메인 결제수단 금액

현금영수증 발급 가능한 총액 중 주 결제수단(신용카드, 계좌이체 등)에 의한 금액

amount_supply: integer
공급가액

현금영수증 발급 가능한 총액 중 공급가액

amount_vat: integer
부가세

현금영수증 발급 가능한 총액 중 부가세

NaverCashAmountResponseobject

code?: integer
응답코드
(Optional)

0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다

message?: string
응답메세지
(Optional)

code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

(Optional)

NaverOrdererobject

name: string
성함

네이버페이 주문자 성함

id: string
네이버 아이디

네이버페이 주문자의 마스킹된 네이버 아이디

tel: string
연락처

네이버페이 주문자의 연락처

NaverProductOrderAnnotationobject

product_order_id: string
상품주문번호

결제건의 네이버페이 상품주문번호

product_order_status: string
상품주문상태

네이버페이 상품주문상테

claim_type?: string
클레임 타입
(Optional)

네이버페이 상품주문관련 클레임 타입(취소/교환/환불 등 클레임에 대한 유형)

claim_status?: string
클레임 처리 상태
(Optional)

네이버페이 상품주문관련 클레임에 대한 처리 상태(취소/교환/환불 등 클레임에 대해 처리 진행 상태)

product_id: string
상품 고유 번호

네이버페이 상품의 고유 번호

product_name: string
상품명

네이버페이 상품명

product_option_id: string
상품 옵션 번호

네이버페이 상품 옵션 고유 번호

product_option_name: string
상품옵션명

네이버페이 상품옵션명

product_amount?: integer
상품금액
(Optional)

네이버페이 상품의 금액

delivery_amount?: integer
상품 배송비
(Optional)

네이버페이 상품의 배송비

quantity: integer
상품 수량

네이버페이 상품의 수량

orderer?: NaverOrderer
(Optional)
shipping_address?: NaverAddress
(Optional)
shipping_memo?: string
배송메모
(Optional)

네이버페이 상품주문별 배송메모

shipping_due?: integer
배송기한
(Optional)

네이버페이 상품주문별 배송기한 UNIX timestamp

individual_code?: string
개인통관고유부호
(Optional)

네이버페이 주문자의 개인통관고유부호

NaverProductOrderArrayResponseobject

code?: integer
응답코드
(Optional)

0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다

message?: string
응답메세지
(Optional)

code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

(Optional)

NaverProductOrderResponseobject

code?: integer
응답코드
(Optional)

0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다

message?: string
응답메세지
(Optional)

code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

(Optional)

NaverReviewAnnotationobject

review_id: string
구매평 고유 ID

네이버페이 구매평 고유 ID

score: string
구매 만족도
  • 일반 구매평 : 불만족 (0), 보통 (1), 만족 (2)
  • 프리미엄 구매평 : 추천 안 함(10), 보통(11), 추천(12), 적극추천(13)
title: string
구매평 내용 or 제목

네이버페이 일반 구매평 내용 또는 프리미엄 구매평 제목

content?: string
구매평 내용
(Optional)

네이버페이 프리미엄 구매평 내용으로 일반 구매평인 경우 없습니다.

product_order_id: string
상품 주문 번호

네이버페이 상품 주문 번호

product_id: string
상품 고유 번호

네이버페이 상품의 고유 번호

product_name: string
상품명

네이버페이 상품명

product_option_name?: string
상품 옵션
(Optional)

네이버페이 상품 옵션(옵션명)

writer: string
구매평 작성자 아이디

암호화된 네이버페이 구매평 작성자 아이디

created_at: integer
작성시각

네이버페이 구매평 작성시각 UNIX timestamp

modified_at?: integer
수정시각
(Optional)

네이버페이 구매평 수정시각 UNIX timestamp

NaverReviewsResponseobject

code?: integer
응답코드
(Optional)

0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다

message?: string
응답메세지
(Optional)

code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

(Optional)

PagedPaymentAnnotationobject

total: integer
전체 건수

조회한 결제 상태에 대한 전체 건수

previous: integer
이전 page숫자

이전 page숫자로 이전 페이지가 없는 경우 0을 반환합니다.

next: integer
다음 page숫자

다음 page숫자로 다음 페이지가 없는 경우 0을 반환합니다.

list?: PaymentAnnotation[]
결제 상세정보 배열
(Optional)

결제 상세정보 배열로 최대 20개를 반환합니다. 바로 아래 Payment structure를 확인해주세요.

PartnerReceiptResponseobject

code?: integer
응답코드
(Optional)

0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다

message?: string
응답메세지
(Optional)

code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

(Optional)

PartnerReceiptResultAnnotationobject

receipt_url?: string
매출전표 확인 URL
(Optional)

거래건에 대한 매출전표를 확인할 수 있는 URL

PartnerReceiptsAnnotationobject

business_registration_number: string
하위 상점 사업자 등록 번호

거래를 구성하는 하위 상점의 사업자 등록 점번호 ("-" 포함)

company_name: string
하위 상점 명

거래를 구성하는 하위 상점의 상점 명

amount: number
하위 상점 거래 금액

거래를 구성하는 하위 상점의 해당 결제건 내 거래 금액

tax_free?: number
하위 상점 거래 금액 중 면세 금액
(Optional)

거래를 구성하는 하위 상점의 해당 결제건 내 면세 금액

vat_amount?: number
하위 상점 거래 금액 중 부가세 금액
(Optional)

거래를 구성하는 하위 상점의 해당 결제건 내 부가세 금액

PaycoStatusAnnotationobject

status: string
주문상태코드
  • DELIVERY_START
  • PURCHASE_DECISION
  • CANCELED

PaycoStatusResponseobject

code?: integer
응답코드
(Optional)

0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다

message?: string
응답메세지
(Optional)

code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

(Optional)

PaymentAnnotationobject

imp_uid: string
포트원 거래고유번호

결제건의 포트원 거래고유번호

merchant_uid: string
가맹점 주문번호

결제건의 가맹점 주문번호

pay_method?: string
결제수단 구분코드
(Optional)

결제건의 결제수단을 구분하는 코드

channel?: string
결제환경 구분코드
(Optional)

결제건을 생성한 환경을 구분하는 코드

pg_provider?: string
PG사 구분코드
(Optional)

결제건의 PG사 구분코드

emb_pg_provider?: string
허브형결제 PG사 구분코드
(Optional)

허브형 결제인 경우 결제건의 허브형 결제 PG사를 구분하는 코드

pg_tid?: string
PG사 거래번호
(Optional)

결제건의 PG사 거래번호

pg_id?: string
PG사 상점아이디
(Optional)

결제건의 PG사 상점아이디

escrow?: boolean
에스크로결제 여부
(Optional)

에스크로 결제건인지 구분하는 코드

apply_num?: string
승인번호
(Optional)

결제건의 신용카드 승인번호

bank_code?: string
은행 표준코드
(Optional)

결제건의 은행 표준코드 (금융결제원기준) - 실시간계좌이체 결제건의 경우

bank_name?: string
은행명
(Optional)

결제건의 은행명 - 실시간계좌이체 결제 건의 경우

card_code?: string
카드사 코드번호
(Optional)

결제건의 카드사 코드번호 (금융결제원 표준코드번호) - 카드 결제 건의 경우

card_name?: string
카드사명
(Optional)

결제건의 카드사명 - 카드 결제 건의 경우

card_issuer_code?: string
카드 발급사 코드
(Optional)

결제건의 카드 발급사 코드번호 (금융결제원 표준코드 번호) - 카드 결제 건의 경우

발급사 코드 지원 pg사
- (신) 토스페이먼츠
- KSNET
- 페이팔 RT
- (신) 스마트로
- (신) 나이스페이먼츠
- 웰컴페이먼츠
- 토스페이먼츠 브랜드페이
- (신) 토스페이
card_issuer_name?: string
카드 발급사명
(Optional)

결제한 카드의 발급사명 - 카드 결제 건의 경우

발급사 코드를 지원하는 pg사에 한해 제공됩니다.
card_publisher_code?: string
카드 발행사 코드
(Optional)

결제건의 카드 발행사 코드번호(금융결제원 표준코드번호) - 카드 결제 건의 경우

발행사 코드 지원 pg사
- (신) 토스페이먼츠
- KSNET사
- 페이팔 RT
- (신) 스마트로
- (신) 나이스페이먼츠
- 웰컴페이먼츠
- 토스페이먼츠 브랜드페이
- (신) 토스페이
card_publisher_name?: string
카드 발행사명
(Optional)

결제 한 카드의 발행사명 - (카드 결제 건의 경우)

발행사 코드를 지원하는 pg사에 한해 제공됩니다.
card_quota?: integer
할부개월 수
(Optional)

결제건의 할부개월 수(일시불은 0으로 표기) - 신용카드 결제 건의 경우

card_number?: string
카드번호
(Optional)

7~12번째 자리를 마스킹하는 것이 일반적이지만, PG사의 정책/설정에 따라 상이할 수 있습니다.

card_type?: integer
카드 구분코드
(Optional)

주의 : 해당 정보를 제공하지 않는 일부 PG사의 경우 null로 응답됩니다.(ex. JTNet, 이니시스-빌링)

  • 0 : 신용카드
  • 1 : 체크카드
vbank_code?: string
가상계좌 은행 표준코드
(Optional)

결제건의 가상계좌 은행 표준코드(금융결제원기준)- 가상계좌 결제 건의 경우

vbank_name?: string
가상계좌 은행명
(Optional)

결제건의 입금받을 가상계좌 은행명 - 가상계좌 결제 건의 경우

vbank_num?: string
가상계좌 계좌번호
(Optional)

결제건의 입금받을 가상계좌 계좌번호 - 가상계좌 결제 건의 경우

vbank_holder?: string
가상계좌 예금주
(Optional)

결제건의 입금받을 가상계좌 예금주 - 가상계좌 결제 건의 경우

vbank_date?: integer
가상계좌 입금기한
(Optional)

결제건의 가상계좌 입금기한 - 가상계좌 결제 건의 경우

vbank_issued_at?: integer
가상계좌 생성시각
(Optional)

결제건의 가상계좌 생성시각 UNIX timestamp - 가상계좌 결제 건의 경우

name?: string
제품명
(Optional)

결제건의 제품명

amount: number
결제금액

결제건의 결제금액

cancel_amount: number
취소금액

결제건의 누적 취소금액

currency: string
결제통화 구분코드

외환분호 e.g) KRW, USD, VND, ... Default: KRW

buyer_name?: string
주문자명
(Optional)

결제건의 주문자명

buyer_email?: string
주문자 Email주소
(Optional)

결제건의 주문자의 Email주소

buyer_tel?: string
주문자 전화번호
(Optional)

결제건의 주문자 전화번호

buyer_addr?: string
주문자 주소
(Optional)

결제건의 주문자 주소

buyer_postcode?: string
주문자 우편번호
(Optional)

결제건의 주문자 우편번호

custom_data?: string
추가정보
(Optional)

결제 요청시 가맹점에서 전달한 추가정보 (JSON string으로 전달)

user_agent?: string
단말기의 UserAgent 문자열
(Optional)

구매자가 결제시 사용한 단말기의 UserAgent 문자열

status: string
결제상태

결제건의 결제상태

started_at?: integer
요청 시각
(Optional)

결제건의 결제요청 시각 UNIX timestamp

paid_at?: integer
결제 시각
(Optional)

결제상태가 결제완료(paid)가 아닌 경우 0으로 표시됩니다.

failed_at?: integer
실패시각
(Optional)

결제상태가 결제실패(failed)가 아닌경우 0으로 표시됩니다.

cancelled_at?: integer
취소시각
(Optional)

결제상태가 결제취소(cancelled)가 아닐 경우 0으로 표시됩니다.

fail_reason?: string
결제실패 사유
(Optional)

결제상태가 결제실패(failed)가 아닐 경우 null로 표시됩니다.

cancel_reason?: string
결제취소 사유
(Optional)

결제상태가 결제취소(cancelled)가 아닐 경우 null로 표시됩니다.

receipt_url?: string
매출전표 URL
(Optional)

결제건의 매출전표 URL로 PG사 또는 결제 수단에 따라 매출전표가 없을 수 있습니다.

cancel_history?: PaymentCancelAnnotation[]
취소 내역
(Optional)

결제건의 취소/부분취소 내역

cancel_receipt_urls?: string[]
(Optional)
(Deprecated : cancel_history 사용 권장) 취소/부분취소 시 생성되는 취소 매출전표 확인 URL. 부분취소 횟수만큼 매출전표가 별도로 생성됨
cash_receipt_issued?: boolean
현금영수증 발급 여부
(Optional)

결제건의 현금영수증 발급 여부

customer_uid?: string
구매자의 결제 수단 식별 고유번호
(Optional)

결제건에 사용된 빌링키와 매핑되며 가맹점에서 채번하는 구매자의 결제 수단 식별 고유번호

customer_uid_usage?: string
구매자의 결제 수단 식별 고유번호 사용 구분코드
(Optional)

결제처리에 사용된 구매자의 결제 수단 식별 고유번호의 사용 구분코드

PaymentBalanceAnnotationobject

tax_free: number
면세 공급가액

면세 공급가액으로 환불시 마이너스 차감된 최종 금액을 반환합니다.

supply: number
과세 공급가액

과세 공급가액으로 환불시 마이너스 차감된 최종 금액을 반환합니다.

vat: number
부가세액

부가세액으로 환불시 마이너스 차감된 최종 금액을 반환합니다.

service: number
봉사료

봉사료로 환불시 마이너스 차감된 최종 금액을 반환합니다.

PaymentBalanceHistoriesAnnotationobject

created?: integer
등록시각
(Optional)

결제건의 Balance정보가 등록된 시각 UNIX timestamp

PaymentBalanceResponseobject

code?: integer
응답코드
(Optional)

0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다

message?: string
응답메세지
(Optional)

code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

(Optional)

PaymentBalanceResponseAnnotationobject

amount: number
결제금액

결제건의 총 결제금액

histories?: PaymentBalanceHistoriesAnnotation[]
PaymentBalance이력
(Optional)

결제건의 Balance 이력을 반환합니다.

PaymentCancelAnnotationobject

pg_tid: string
PG사 승인취소번호

결제건의 PG사 승인취소번호

amount: number
취소 금액

결제건의 취소 금액

cancelled_at: integer
취소 시각

결제건의 결제취소된 시각 UNIX timestamp

reason: string
취소 사유

결제건의 결제취소 사유

cancellation_id: string
결제취소 아이디

결제건의 취소 아이디

receipt_url?: string
취소 매출전표 URL
(Optional)

결제건의 취소 매출전표 확인 URL로 PG사, 결제 수단에 따라 제공되지 않을 수 있습니다.

PaymentListResponseobject

code?: integer
응답코드
(Optional)

0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다

message?: string
응답메세지
(Optional)

code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

(Optional)

PaymentPrepareAnnotationobject

merchant_uid?: string
가맹점 주문번호
(Optional)

사전 등록한 가맹점의 주문번호

amount?: number
결제 예정 금액
(Optional)

사전 등록한 결제 예정 금액

PaymentPrepareResponseobject

code?: integer
응답코드
(Optional)

0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다

message?: string
응답메세지
(Optional)

code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

(Optional)

PaymentResponseobject

code?: integer
응답코드
(Optional)

0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다

message?: string
응답메세지
(Optional)

code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

response?: PaymentAnnotation
(Optional)

PaymentwallDeliveryAnnotationobject

code?: integer
응답코드
(Optional)

0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다

message?: string
응답메세지
(Optional)

code 값이 0이 아닐 때, ‘존재하지 않는 결제정보입니다’와 같은 오류 메세지를 포함합니다

(Optional)

PaymentwallDeliveryDetailAnnotationobject

error_code?: integer
에러코드
(Optional)

이 값이 없으면 정상적인 경우, 없으면 notices를 확인해봐야 합니다

error?: string
에러메세지
(Optional)

에러코드에 대응하는 오류메세지를 반환합니다.

notices?: string[]
자세한 에러메세지
(Optional)

error_code 값이 없는 경우 확인이 필요한 상세 에러메세지

PgSettingAnnotationobject

pg_provider: string
PG사 구분코드

설정된 PG사의 구분코드

pg_id: string
PG사 상점아이디

설정된 PG사의 상점아이디(MID)

sandbox: boolean
테스트모드 여부

설정된 PG사의 테스트모드 여부

type: string
PG설정 타입 구분코드

설정된 PG사의 타입 구분코드

channel_name?: string
채널이름
(Optional)

가맹점이 포트원 콘솔에 채널 추가시 설정한 결제 채널 이름

channel_key?: string
채널 고유 키
(Optional)

가맹점이 포트원 콘솔에 채널 추가시 포트원이 자동 생성한 채널 고유 키

ReceiptAnnotationobject

imp_uid: string
포트원 거래고유번호

결제건의 포트원 거래고유번호

receipt_tid?: string
PG사 현금영수증 발행 고유번호
(Optional)

결제건에 대해 현금영수증 발행시 PG사의 발행고유번호

apply_num: string
국세청 발행번호

결제건에 대해 현금영수증 발행시 국세청 발행번호

type: string
타입(대상)

현금영수증 발행 대상의 타입

amount: integer
발행 금액

현금영수증 발행 금액

vat: integer
부가세액

현금영수증 발행금액 중 부가세액

receipt_url?: string
현금영수증 URL
(Optional)

발행된 현금영수증을 확인할 수 있는 URL

applied_at: integer
발행시각

현금영수증 발행시각 UNIX timestamp

cancelled_at?: integer
발행취소시각
(Optional)

현금영수증 발행취소시각 UNIX timestamp

ReceiptResponseobject

code?: integer
응답코드
(Optional)

0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다

message?: string
응답메세지
(Optional)

code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

response?: ReceiptAnnotation
(Optional)

ResponseAnnotationobject

code?: integer
응답코드
(Optional)

0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다

message?: string
응답메세지
(Optional)

code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

ScheduleAnnotationobject

merchant_uid: string
가맹점의 주문번호

결제 예약건의 가맹점 주문번호

schedule_at: integer
예약시각

결제요청 예약시각 UNIX timestamp

currency: string
결제 통화 코드

통화 e.g.) KRW, USD, VND, ... Default: KRW

amount: number
결제금액

결제 예약을 요청한 결제금액

tax_free?: number
면세공급가액
(Optional)

결제 예약을 요청한 결제금액 중 면세공급가액

vat_amount?: number
부가세
(Optional)

결제 예약을 요청한 결제금액 중 부가세

name?: string
제품명
(Optional)

결제건의 제품명

buyer_name?: string
주문자명
(Optional)

결제건의 문자명

buyer_email?: string
주문자 Email주소
(Optional)

결제건의 주문자 Email주소

buyer_tel?: string
주문자 전화번호
(Optional)

결제건의 주문자 전화번호

buyer_addr?: string
주문자 주소
(Optional)

결제건의 주문자 주소

buyer_postcode?: string
주문자 우편번호
(Optional)

결제건의 주문자 우편번호

custom_data?: string
추가정보
(Optional)

예약된 결제가 수행될 때 함께 저장할 추가정보

notice_url?: string
Notification URL(Webhook URL)
(Optional)

해당 파리미터를 지정하지 않으면 웹훅은 관리자페이지의 Notification URL로 발송 됩니다

product_type?: string
주문 상품구분
(Optional)

판매 상품에 대한 구분 값

cash_receipt_type?: string
현금영수증 발행대상
(Optional)

현금영수증 발행대상 구분 값

card_quota?: number
카드 할부 개월 수
(Optional)

결제건의 카드 할부 개월 수로 기본값은 **0(일시불)**입니다.

interest_free_by_merchant?: boolean
가맹점부담 무이자 할부여부
(Optional)

카드할부 처리할 때, 할부이자가 발생하는 경우(카드사 무이자 프로모션 제외) 부과되는 할부이자를 고객대신 가맹점이 지불하고자 PG사와 계약한 경우 (Default : false)

use_card_point?: boolean
카드포인트 사용여부
(Optional)

PG사 영업담당자와 계약 당시 사전 협의가 필요하며 기본값은 false입니다.

product_count?: integer
결제 상품의 개수
(Optional)

결제 상품의 개수로 기본값은 1입니다.

extra?: object
추가 파라미터
(Optional)

결제 예약 요청시 필요한 추가 정보

bypass?: string
bypass 데이터
(Optional)

전달 한 값은 가공 없이 그대로 PG사로 전달 됩니다. 각 PG사별 스펙은 PG사별 연동 문서 참고해주세요

ScheduleResponseobject

code?: integer
응답코드
(Optional)

0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다

message?: string
응답메세지
(Optional)

code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

(Optional)

ScheduleResultAnnotationobject

customer_uid?: string
구매자의 결제 수단 식별 고유번호
(Optional)

빌링키와 매핑되며 가맹점에서 채번하는 구매자의 결제 수단 식별 고유번호

merchant_uid?: string
가맹점 주문번호
(Optional)

예약 결제건의 가맹점 주문번호

imp_uid?: string
포트원 거래고유번호
(Optional)

예약된 결제가 실행 전 철회되거나 아직 실행 전 예약 상태에 있으면 imp_uid는 null입니다.

customer_id?: string
구매자 ID
(Optional)

string 타입의 구매자 식별 고유번호

schedule_at?: integer
결제 예정 시각
(Optional)

결제 예약시 요청한 결제 예정 시각 UNIX timestamp

executed_at?: integer
결제 실행 시각
(Optional)

실제 결제가 실행된 시각 UNIX timestamp

revoked_at?: integer
결제 실행 철회 시각
(Optional)

예약 결제 실행을 철회한 시각 UNIX timestamp

amount?: number
결제금액
(Optional)

결제 예약시 요청한 결제금액

currency?: string
결제 통화 코드
(Optional)

통화 e.g.) KRW, USD, VND, ... Default: KRW

name?: string
제품명
(Optional)

예약 결제건의 제품명

buyer_name?: string
주문자명
(Optional)

예약 결제건의 주문자명

buyer_email?: string
주문자 Email주소
(Optional)

예약 결제건의 주문자 Email주소

buyer_tel?: string
주문자 전화번호
(Optional)

예약 결제건의 주문자 전화번호

buyer_addr?: string
주문자 주소
(Optional)

예약 결제건의 주문자 주소

buyer_postcode?: string
주문자 우편번호
(Optional)

예약 결제건의 주문자 우편번호

custom_data?: string
추가정보
(Optional)

예약된 결제가 수행될 때 결제정보와 함께 저장할 추가정보

schedule_status?: string
예약상태
(Optional)

결제건의 예약상태

payment_status?: string
결제상태
(Optional)

예약 결제건의 승인 상태

fail_reason?: string
실패사유
(Optional)

예약 결제건이 결제 승인에 실패한 경우, 실패사유

SingleScheduleResponseobject

code?: integer
응답코드
(Optional)

0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다

message?: string
응답메세지
(Optional)

code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

(Optional)

StandardCodeAnnotationobject

code: string
기관코드

금융결제표준코드

name: string
기관명

금융결제원기재명

StandardCodeListResponseobject

code?: integer
응답코드
(Optional)

0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다

message?: string
응답메세지
(Optional)

code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

(Optional)

StandardCodeResponseobject

code?: integer
응답코드
(Optional)

0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다

message?: string
응답메세지
(Optional)

code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

(Optional)

SubscribePaymentExtraobject

naverUseCfm?: string
이용 완료일(YYYYMMDD), 네이버페이 전용
(Optional)

이용 완료일(YYYYMMDD), 네이버페이 정기결졔 계약 시 이용완료일을 필수로 설정한 고객사의 경우 필수로 전달해야합니다.

TierAnnotationobject

tier_code: string
티어코드

알파벳 대문자 또는 숫자 3자리로 구성됩니다.

tier_name: string
티어명

하위가맹점(Tier)의 관리명칭

TierResponseobject

code?: integer
응답코드
(Optional)

0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다

message?: string
응답메세지
(Optional)

code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

response?: TierAnnotation
(Optional)

VbankHolderAnnotationobject

bank_holder: string
예금주명

가상계좌의 예금주명

VbankHolderResponseobject

code?: integer
응답코드
(Optional)

0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다

message?: string
응답메세지
(Optional)

code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

(Optional)